【SpringCloud-学习笔记】http客户端Feign

妖狐艹你老母 2023-09-28 18:51 9阅读 0赞

## 一、RestTemplate方式调用存在的问题 ##

先来看我们以前利用RestTemplate发起远程调用的代码：

String url = "http://userservice/user/" + order.getUserId();
    User user = restTemplate.getForObject(url, User.class);

存在下面的问题：

*  代码可读性差，编程体验不统一
 *  参数复杂URL难以维护

## 二、Feign的介绍 ##

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign  
其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。  
![在这里插入图片描述][48ba279129f14330907de7b3ae673f26.png]

## 三、定义和使用Feign客户端 ##

使用Feign的步骤如下：

1.  引入依赖：

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

1.  在order-service的启动类添加注解开启Feign的功能：  
    ![在这里插入图片描述][221fce8143d7427986cb97e2515f85d6.png]  
    使用Feign的步骤如下：
2.  编写Feign客户端：

@FeignClient("userservice")
    public interface UserClient {
        
        @GetMapping("/user/{id}") 
        User findById(@PathVariable("id") Long id);
    }

主要是基于SpringMVC的注解来声明远程调用的信息，比如：

*  服务名称：userservice
 *  请求方式：GET
 *  请求路径：/user/\{id\}
 *  请求参数：Long id
 *  返回值类型：User

1.  用Feign客户端代替RestTemplate  
    ![在这里插入图片描述][7106cd7947a24ccdb0f661930f6b14e3.png]

## 四、总结 ##

Feign的使用步骤

*  引入依赖
 *  添加@EnableFeignClients注解
 *  编写FeignClient接口
 *  使用FeignClient中定义的方法代替RestTemplate

--------------------

## 一、自定义Feign的配置 ##

Feign运行自定义配置来覆盖默认配置，可以修改的配置如下：  
![在这里插入图片描述][ca60f2bff5aa43cb8cdab4bef4878352.png]  
一般我们需要配置的就是日志级别。

配置Feign日志有两种方式：  
方式一：配置文件方式

1.  全局生效：

feign:
      client:
        config: 
          default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
            loggerLevel: FULL #  日志级别

1.  部生效：

feign:
      client:
        config: 
          userservice: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
            loggerLevel: FULL #  日志级别

方式二：java代码方式，需要先声明一个Bean：

public class FeignClientConfiguration {
        
        @Bean
        public Logger.Level feignLogLevel(){
        
            return Logger.Level.BASIC; 
        }
    }

1.  而后如果是全局配置，则把它放到@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)

1.  如果是局部配置，则把它放到@FeignClient这个注解中：

@FeignClient(value = "userservice", configuration = FeignClientConfiguration.class)

## 二、总结： ##

Feign的日志配置:

1.  方式一是配置文件，feign.client.config.xxx.loggerLevel

*  如果xxx是default则代表全局
 *  如果xxx是服务名称，例如userservice则代表某服务

1.  方式二是java代码配置Logger.Level这个Bean

*  如果在@EnableFeignClients注解声明则代表全局
 *  如果在@FeignClient注解中声明则代表某服务

--------------------

## 一、Feign的性能优化 ##

Feign底层的客户端实现：

*  URLConnection：默认实现，不支持连接池
 *  Apache HttpClient ：支持连接池
 *  OKHttp：支持连接池

因此优化Feign的性能主要包括：

*  使用连接池代替默认的URLConnection
 *  日志级别，最好用basic或none

## 二、Feign的性能优化-连接池配置 ##

Feign添加HttpClient的支持：  
引入依赖：

<dependency>
        <groupId>io.github.openfeign</groupId>
        <artifactId>feign-httpclient</artifactId>
    </dependency>

配置连接池：

feign:
      client:
        config:
          default: # default全局的配置
            loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息 
      httpclient:
        enabled: true # 开启feign对HttpClient的支持
        max-connections: 200 # 最大的连接数
        max-connections-per-route: 50 # 每个路径的最大连接数

## 三、总结 ##

Feign的优化：

1.  日志级别尽量用basic
2.  使用HttpClient或OKHttp代替URLConnection
    
     *  引入feign-httpClient依赖
     *  配置文件开启httpClient功能，设置连接池参数

--------------------

## 一、Feign的最佳实践 ##

方式一（继承）：给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

*  服务紧耦合
 *  父接口参数列表中的映射不会被继承  
    ![在这里插入图片描述][557513e477a04b489c63f6a288c02ed2.png]  
    方式二（抽取）：将FeignClient抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用  
    ![在这里插入图片描述][6ee4d54ba9ae498097df5110f584d8ab.png]

## 二、总结 ##

Feign的最佳实践：

1.  让controller和FeignClient继承同一接口
2.  将FeignClient、POJO、Feign的默认配置都定义到一个项目中，供所有消费者使用

--------------------

## 一、抽取FeignClient ##

实现最佳实践方式二的步骤如下：

1.  首先创建一个module，命名为feign-api，然后引入feign的starter依赖
2.  将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
3.  在order-service中引入feign-api的依赖
4.  修改order-service中的所有与上述三个组件有关的import部分，改成导入feign-api中的包
5.  重启测试

## 二、Feign的最佳实践 ##

当定义的FeignClient不在SpringBootApplication的扫描包范围时，这些FeignClient无法使用。有两种方式解决：  
方式一：指定FeignClient所在包

@EnableFeignClients(basePackages = "cn.itcast.feign.clients")

方式二：指定FeignClient字节码

@EnableFeignClients(clients = {
        UserClient.class})

## 三、总结 ##

不同包的FeignClient的导入有两种方式：

1.  在@EnableFeignClients注解中添加basePackages，指定FeignClient所在的包
2.  在@EnableFeignClients注解中添加clients，指定具体FeignClient的字节码

[48ba279129f14330907de7b3ae673f26.png]: https://img-blog.csdnimg.cn/48ba279129f14330907de7b3ae673f26.png
[221fce8143d7427986cb97e2515f85d6.png]: https://img-blog.csdnimg.cn/221fce8143d7427986cb97e2515f85d6.png
[7106cd7947a24ccdb0f661930f6b14e3.png]: https://img-blog.csdnimg.cn/7106cd7947a24ccdb0f661930f6b14e3.png
[ca60f2bff5aa43cb8cdab4bef4878352.png]: https://img-blog.csdnimg.cn/ca60f2bff5aa43cb8cdab4bef4878352.png
[557513e477a04b489c63f6a288c02ed2.png]: https://img-blog.csdnimg.cn/557513e477a04b489c63f6a288c02ed2.png
[6ee4d54ba9ae498097df5110f584d8ab.png]: https://img-blog.csdnimg.cn/6ee4d54ba9ae498097df5110f584d8ab.png