springcloud系列10——Feign的简介及基础使用

╰+哭是因爲堅強的太久メ 2022-05-12 08:56 252阅读 0赞

## Feign简介 ##

Feign 是一个声明web服务客户端，这使得编写web服务客户端更容易，使用Feign 创建一个接口并对它进行注解，它具有可插拔的注解支持包括Feign注解与JAX-RS注解，Feign还支持可插拔的编码器与解码器，Spring Cloud 增加了对 Spring MVC的注解，Spring Web 默认使用了HttpMessageConverters, Spring Cloud集成了Ribbon 和 Eureka使Feign支持http client负载均衡。

上面其实是对Spring Cloud官方文档`Declarative REST Client: Feign`一节的翻译。

## Feign基本使用 ##

### 添加spring-cloud-starter-openfeign依赖 ###

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

### 应用启动类上加入@EnableFeignClients ###

@SpringBootApplication
    @EnableEurekaClient
    @EnableFeignClients
    public class App { 
        @Bean
        @LoadBalanced
        public RestTemplate restTemplate() {
            return new RestTemplate();
        }
        public static void main( String[] args )
        {
            SpringApplication.run(App.class,args);
        }
    }

### 定义一个接口类并加入@FeignClient ###

@FeignClient("microservice-springcloud-user")
    public interface UserFeignClient { 
        @RequestMapping(value = "/sample/{userId}", method = RequestMethod.GET)
        User findUserById(@PathVariable("userId") Long userId);
        @RequestMapping(value = "/user/{userId}", method = RequestMethod.POST)
        User updateUser(@PathVariable("userId") Long userId, @RequestParam("name") String name,@RequestParam("balance") BigDecimal balance);
    }

上面的例子代码中提供了2个get请求和一个post请求。@FeignClient中value为服务id。

### 在Controller中注入上面创建的接口 ###

@RestController
    public class MovieController { 
        @Autowired
        private UserFeignClient userFeignClient;
        @GetMapping("/findUser/{userId}")
        public User findUserById(@PathVariable Long userId) {
            return this.userFeignClient.findUserById(userId);
        }
        @PostMapping("/user/{userId}")
        public User updateUserById(@PathVariable Long userId, User user) {
            return this.userFeignClient.updateUser(userId,user.getName(),user.getBalance());
        }
    }

## 测试 ##

*  1.启动Eureka Server；
 *  2.启动microservice-springcloud-user服务；
 *  3.启动microservice-springcloud-movie（本例）；

### 1.GET请求测试 ###

浏览器输入[http://localhost:7901/findUser/1][http_localhost_7901_findUser_1]  
![63299360.jpg][]  
可以看到，请求成功。

### 2.POST请求测试 ###

使用ARC（一个Chrome浏览器的http插件）测试POST请求，请求也是成功的  
![14379739.jpg][]

### 问题 ###

*  1.在UserFeignClient中不能使用GetMapping，要使用RequestMapping注解；
 *  2.url路径中的参数，在@PathVariable注解中必须指定value，如`@PathVariable("userId") Long userId`，使用@RequestParam也需要指定value；
 *  3.不支持复杂对象，需要结合@RequestParam实现复杂对象。如果使用复杂对象，比如：

@RequestMapping(value = "/user/{userId}", method = RequestMethod.POST)
    User updateUser(@PathVariable("userId") Long userId, User user);

比如上面方法中的User为复杂对象，在使用ARC（一个Chrome浏览器的http插件）测试时，后台Controller接收是正常的，但UserFeignClient调用microservice-springcloud-user时User里面属性都是null，如下图。  
后台Controller  
![25881628.jpg][]

UserFeignClient  
![29148360.jpg][]

参考：[Spring Cloud官方文档][Spring Cloud]

[http_localhost_7901_findUser_1]: http://localhost:7901/findUser/1
[63299360.jpg]: http://omh46px9n.bkt.clouddn.com/18-2-2/63299360.jpg
[14379739.jpg]: http://omh46px9n.bkt.clouddn.com/18-2-2/14379739.jpg
[25881628.jpg]: http://omh46px9n.bkt.clouddn.com/18-2-2/25881628.jpg
[29148360.jpg]: http://omh46px9n.bkt.clouddn.com/18-2-2/29148360.jpg
[Spring Cloud]: http://cloud.spring.io/spring-cloud-static/Edgware.SR1/multi/multi_spring-cloud-feign.html