Spring Cloud（Greenwich版）-06-Spring Cloud集成Feign

淡淡的烟草味﹌ 2023-06-15 09:56 9阅读 0赞

![SpringCloud集成Feign][SpringCloud_Feign]

##### 前言 #####

上一章使用Ribbon实现了商品和多个用户微服务之间的负载均衡效果，到现在我们的微服务架构已经“初具规模”啦。接下来会继续完善我们的微服务架构，本章将会引入全新的组件——Feign。

看过前面的文章就知道我们采用的是RestTemplate来实现商品和用户微服务间的通信。  
如下图所示：  
![RestTemplate通信][RestTemplate]

代码示例：

@GetMapping("/goods/{id}")
    public User findById(@PathVariable Long id){
        // 这里用到了RestTemplate调用用户微服务，获取用户信息
        User user = this.restTemplate.getForObject("http://127.0.0.1:8080/users/"+id,User.class);
         // 执行商品微服务业务......
         return user;
    }

上述利用RestTemplate实现了商品和用户微服务的简单调用，其实RestTemplate已经实现了对HTTP请求的封装处理，形成了一套模版化的调用方法。但是在实际开发中，由于对服务依赖对调用可能不止于一处，往往一个接口会被多处调用，所以我们通常都会针对各个微服务自行封装一些客户端累来包装这些依赖服务的调用。这个时候我们会发现，由于RestTemplate的封装，几乎每一个调用都是简单的模版化内容。

this.restTemplate.getForObject("http://127.0.0.1:8080/simple/"+id,User.class);

这段代码随着业务的复杂和开发人员的频繁变更，新人将会有一连串的问题冒出来，这时就得讨好老员工，如果还在职的话就恭喜你，如果…\[捂脸\]。  
记得之前有看到一位SpringCloud大佬在讲解Feign的时候列举了某度的一个连接，这里小编专门找出来给大家秀一下：

https://www.baidu.com/s?wd=asf&rsv_spt=1&rsv_iqid=0xa25bbeba000047fd&issp=1&f=8&rsv_bp=0&rsv_idx=2&ie=utf-8&tn=baiduhome_pg&rsv_enter=1&rsv_sug3=3&rsv_sug1=2&rsv_sug7=100&rsv_sug2=0&inputT=328&rsv_sug4=328

![我是谁？][format_png]  
如果需求在持续变更，所需参数越来越多…

好了，言归正传。基于上面那么多的不足，就需要使用Feign来解决以上问题了！

##### Ribbon简介及使用场景 #####

> Feign是Netflix开发的声明式、模板化的HTTP客户端，其灵感来自Retrofit、JAXRS-2.0以及WebSocket。Feign可帮助我们更加便捷、优雅地调用HTTP API。

那在SpringCloud中，集成Feign组件非常简单，只需2步：  
1、创建一个接口  
2、在接口添加Feign注解

###### TIPS ######

Feign的GitHub：https://github.com/OpenFeign/feign

##### Coding Start #####

第一步：复制商品和用户微服务项目

复制项目microservice-consumer-goods，将pom.xml文件中ArtifactId内容修改为 microservice-consumer-goods-feign 。如下图所示：  
![microservice-consumer-goods-feign][]

复制项目microservice-provider-user，将pom.xml文件中ArtifactId 内容修改为microservice-provider-user-feign。如下图所示：

![microservice-provider-user-feign][]

**设置端口**

备注：记得修改端口，不然启动会出现端口冲突问题
    microservice-consumer-goods-feign:8095
    microservice-provider-user-feign:8094

##### 第二步：添加Feign依赖 #####

商品微服务作为调用方需要引入feign依赖：

<dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>

##### 第三步：加注解 #####

商品微服务启动类上添加 @EnableFeignClients ；

@SpringBootApplication
    @EnableFeignClients
    public class MicroserviceConsumerFeignGoodsApplication {
    	public static void main(String[] args) {
    		SpringApplication.run(MicroserviceConsumerFeignGoodsApplication.class, args);
    	}
    }

##### 第四步：编写Feign Client #####

@FeignClient(name = "microservice-provider-user-feign",url = "http://127.0.0.1:8094/")
    public interface UserFeignClient {
        @GetMapping("/users/{id}")
        User findUserById(@PathVariable("id") Long id);
    }

写到这里就结束了，@FeignClient 注解中的name值是请求用户微服务的服务名称（命名可以随意，但是不能省略，否则不能正常启动）。URL属性是制定请求的用户微服务的服务连接。

##### 第五步：编写商品业务Controller #####

@RequestMapping("/goods")
    @RestController
    public class GoodsController {
        @Autowired
        private UserFeignClient userFeignClient;
        @GetMapping("/users/{id}")
        public User findUserById(@PathVariable Long id){
            return this.userFeignClient.findUserById(id);
        }
    }

只需使用@Autowire注解，即可注入上面编写的Feign Client。

##### 第六步：启动测试 #####

*  启动microservice-discovery-eureka
 *  启动microservice-provider-user-feign
 *  启动microservice-provider-goods-feign

![Eureka控制台][Eureka]

查看Eureka 控制台可以看出商品和用户微服务都已经注册成功！

执行：http://127.0.0.1:8095/goods/users/2  
查询用户ID为2的用户信息如下：  
![8.pic.jpg][]

##### 第七步：RestTemplate与FeignClient如何选择？ #####

先看一下两种的优势与劣势对比：  
![对比][format_png 1]

正常情况下小编会建议大家使用Feign，一个项目里面只保留一种编码风格。但是查过资料的同学会吐槽Feign的性能问题，这点是没办法优化的，Spring Cloud官方成人，物流Feign如何改进，其灵活性也无法超越RestTemplate！  
不过大家放心啦，大部分的业务场景下都是OK的——项目中的性能瓶颈一般不都出现在HTTP客户端上，自身的业务也需要做相应处理！

原则：尽量使用Feign，避免使用RestTemplate  
(因为如果作为架构师，做决定很重要，要让大家编码风格统一，代码可维护性、可读性高)  
合理选择即可。。。

##### 配套代码 #####

关于Spring Cloud（Greenwich版） 系列完整的教程，可以点击下方主代码库链接查看哦~~~ 。  
主代码库：https://github.com/yundianzixun/spring-cloud-study

Eureka Server：https://github.com/yundianzixun/spring-cloud-study/tree/master/microservice-discovery-eureka

商品微服务：https://github.com/yundianzixun/spring-cloud-study/tree/master/microservice-consumer-goods-feign

用户微服务：https://github.com/yundianzixun/spring-cloud-study/tree/master/microservice-consumer-user-feign

[SpringCloud_Feign]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy84MTIyNzcyLWZiNjVkZWZhODk0NmIwN2MuanBn?x-oss-process=image/format,png
[RestTemplate]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy84MTIyNzcyLTEyYWQwMDEzMjIxMzQxMmMuanBn?x-oss-process=image/format,png
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy84MTIyNzcyLThmNTVmMDI0ZTllODg1YWYuanBn?x-oss-process=image/format,png
[microservice-consumer-goods-feign]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy84MTIyNzcyLTdjNTEzYjE4MzMxYmM1MTkuanBn?x-oss-process=image/format,png
[microservice-provider-user-feign]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy84MTIyNzcyLWE2MDY0NDk3YTVhZGYzNmMuanBn?x-oss-process=image/format,png
[Eureka]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy84MTIyNzcyLTc0OWY2OTU2ODgyZjljY2UuanBn?x-oss-process=image/format,png
[8.pic.jpg]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy84MTIyNzcyLWNjMjY2YmFjNGZmNjE0YjkuanBn?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy84MTIyNzcyLTIzZDMyNjZkMDU2MmJhYzQuanBn?x-oss-process=image/format,png