Spring Cloud 学习 | - 05 - 服务消费（Feign方式）

男娘i 2022-02-25 00:04 240阅读 0赞

### 文章目录 ###

*  Spring Cloud 学习 | - 05 - 服务消费（Feign方式）
 *   *  1. Feign简介
     *  2. 启动Eureka注册中心
     *  3. 启动服务提供者
     *   *  3.1 修改提供者Service
         *  3.2 修改提供者Controller
         *  3.3 启动2个服务提供者
     *  4. Feign方式服务消费者
     *   *  4.1 新建项目及其依赖
         *  4.2 启用Feign功能
         *  4.3 编写Feign客户端
         *  4.4 测试接口
         *  4.5 负载均衡

# Spring Cloud 学习 | - 05 - 服务消费（Feign方式） #

> 学习 `Spring Cloud` 之路，文中 `Spring Boot` 版本为 `2.1.3.RELEASE`，`Spring Cloud` 版本为 `Greenwich.SR1` 。因能力有限，难免会有不足或者错误之处，还望不吝指正，谢！

之前 [Spring Cloud 学习 | - 03 - 服务消费（Rest + Ribbon实现负载均衡）][Spring Cloud _ _ - 03 - _Rest _ Ribbon]，我们使用Rest+Ribbon方式实现消费的负载均衡。如果只是这样，那么以后我们可能需要编写大量重复代码，而且格式基本相同，只是参数不同罢了，能不能有一种更优雅简洁的方式实现呢？我们可以用Feign方式实现。

## 1. Feign简介 ##

Feign是Netflix开发的声明式、模块化的HTTP客户端。Feign可以帮助我们更加便捷、优雅的调用HTTP API， 可以做到使用HTTP请求远程服务时能与调用本地方法一样的编码体验，完全感知不到这是远程方法，更感知不到这是个HTTP请求。  
在Spring Cloud中，使用Feign非常简单——创建一个接口，并在接口上添加一些注解，代码便完成了。Feign支持多种注解，礼服Feign自带的注解或JAX-RS注解等。  
Spring Cloud对Feign进行了增强，使Feign支持了Spring MVC注解，并整合了RIbbon和Eureka，从而让Feign的使用更加方便。

## 2. 启动Eureka注册中心 ##

详细请查阅[Spring Cloud 学习 | - 01 - Eureka服务注册与发现][Spring Cloud _ _ - 01 - Eureka]一文。

## 3. 启动服务提供者 ##

### 3.1 修改提供者Service ###

Service接口：

public interface UserService { 
        /** * 查询所有用户 * @return */
        List findAll();
    
        /** * hello,${name} * @param name * @return */
        String hello(String name);
    }

实现类：

@Service
    public class UserServiceImpl implements UserService { 
        /** * 查询所有用户 * @return */
        @Override
        public List findAll() { 
            List list = Arrays.asList("Cindy","Pony","Marry");
            return list;
        }
    
        @Override
        public String hello(String name) { 
            return "Hello, " + name;
        }
    }

### 3.2 修改提供者Controller ###

代码如下：

@RestController
    @RequestMapping("/user")
    public class UserController { 
        @Value("${server.port}")
        private String port;
        @Autowired
        private UserService userService;
    
        private Map<String, Object> data = null;
    
        @GetMapping("/{name}")
        public Map<String, Object> hello(@PathVariable String name) { 
            String hello = userService.hello(name);
            data = new HashMap<>(4);
            data.put("port", port);
            data.put("msg", hello);
            return data;
        }
    }

### 3.3 启动2个服务提供者 ###

启动2个user-provider服务，端口分别为8090和8091，详细步骤请参阅[https://blog.csdn.net/xudc0521/article/details/88878904\#31\_2\_181][https_blog.csdn.net_xudc0521_article_details_88878904_31_2_181]。

## 4. Feign方式服务消费者 ##

### 4.1 新建项目及其依赖 ###

利用Spring Initializr快速创建一个Spring Boot项目，主要依赖如下：

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
            </dependency>

### 4.2 启用Feign功能 ###

在XxxApplication主启动类上加上注解`@EnableFeignClients`，同时也要加上服务发现的注解`@EnableDiscoveryClient`，完整代码如下：

@SpringBootApplication
    @EnableDiscoveryClient
    @EnableFeignClients // 启用Feign功能
    public class UserConsumerFeignApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(UserConsumerFeignApplication.class, args);
        }
    
    }

### 4.3 编写Feign客户端 ###

新建一个接口`UserService`，修改代码如下：

@FeignClient("user-provider")
    public interface UserService { 
        /** * hello,${name} * @param name * @return */
        @GetMapping("/user/{name}")
        Map<String, Object> hello(@PathVariable String name);
    }

>  *  首先这是一个接口，Feign会通过动态代理，帮我们生成实现类
>  *  @FeignClient()声明这是一个Feign客户端，value值指定服务提供者名称，即调用哪个服务
>  *  接口中的定义方法，完全采用SpringMVC的注解，Feign会根据注解帮我们生成URL，并访问获取结果

### 4.4 测试接口 ###

添加一个Junit方法测试，代码如下：

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class UserConsumerFeignApplicationTests { 
    
        @Autowired
        private UserService userService;
    
        @Test
        public void contextLoads() { 
            for (int i = 0; i < 10; i++) { 
                Map<String, Object> map = userService.hello("Cindy" + i);
                System.err.println(map);
            }
        }
    }

输出结果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0UwOTYyMDEyNg_size_16_color_FFFFFF_t_70]

### 4.5 负载均衡 ###

Feign中本身已经集成了Ribbon依赖和自动配置，默认实现了负载均衡。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0UwOTYyMDEyNg_size_16_color_FFFFFF_t_70 1]  
因此我们不需要额外引入依赖，也不需要再注册`RestTemplate`对象。

[Spring Cloud _ _ - 03 - _Rest _ Ribbon]: https://blog.csdn.net/xudc0521/article/details/88878904
[Spring Cloud _ _ - 01 - Eureka]: https://blog.csdn.net/xudc0521/article/details/88850150
[https_blog.csdn.net_xudc0521_article_details_88878904_31_2_181]: https://blog.csdn.net/xudc0521/article/details/88878904#31_2_181
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0UwOTYyMDEyNg_size_16_color_FFFFFF_t_70]: /images/20220225/46a3e63c45c2445d90fe51c0e2112370.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0UwOTYyMDEyNg_size_16_color_FFFFFF_t_70 1]: /images/20220225/bcab0322b27645a787e34b8951479a21.png