1116 字
6 分钟
SpringCloud06-Feign
2023-12-16
2023-12-20

简单的介绍了SpringCloud中的Feign。

http客户端Feign#

restTemplate方式调用存在的问题#

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

存在以下的问题:

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

Feign的使用方法#

  • 引入依赖
<!--feign客户端依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
  • 在order-service的启动类添加注解开启Feign的功能
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients(clients = UserClient.class,defaultConfiguration = DefaultFeignConfiguration.class)
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
}
  • 编写Feign客户端
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@Pathvariable("id") Long id);
}

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

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

自定义Feign的参数配置#

类型作用说明
feign.Logger.Level修改日志级别包含四种不同的级别:NONE、BASIC、HEADERS、FULL
feign.codec.Decoder响应结果的解析器http远程调用的结果做解析,例如解析json字符串为java对象
feign.codec.Encoder请求参数编码将请求参数编码,便于通过http请求发送
feign.Contract支持的注解格式默认是SpringMVC的注解
feign.Retryer失败重试机制请求失败的重试机制,默认是没有,不过会使用Ribbon的重试

一般我们需要配置的就是日志级别,有两种配置方法

方式一:配置文件方式#

全局生效

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

局部生效

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

方式二:java代码方式#

需要先声明一个Bean

public class FeignclientConfiguration {
@Bean
public Logger.Level feignLogLevel() {
return Logger.Level.BASIC;
}
}
  • 如果是全局配置,则把它放到@EnableFeignclients这个注解中
@EnableFeignclients(defaultConfiguration = FeignclientConfiguration.class)
  • 如果是局部配置,则把它放到@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的性能优化-连接池配置#

  • 引入依赖
<!--引入HttpClient依赖-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
  • 配置连接池
feign:
client:
config:
default: #default全局的配置
loggerLevel: BASIC #日志级别,BASIC就是基本的请求和响应信息
httpclient:
enabled: true # 支持HttpClient的开关
max-connections: 200 # 最大连接数
max-connections-per-route: 50 # 单个路径的最大连接数

实践分析#

  • 方式一(继承):给消费者的Feignclient和提供者的controller定义统一的父接口作为标准。

公共父接口由 Feign 客户端继承、服务端 Controller 实现

原理示意:公共父接口统一方法契约,两端分别继承或实现,但运行时仍是跨进程的 HTTP 调用。接口复用会把契约变更传递到两端;尤其要核对当前版本对映射注解继承的支持,不能只凭 Java 接口继承就认定远程路由已经正确配置。

  • 方式二(抽取):将FeignClient抽取为独立模块,并且把接口有关的PO]O、默认的Feign配置都放到这个模块中,提供给所有消费者使用

多个消费者依赖包含客户端接口与传输对象的独立 Feign 模块

原理示意:把客户端接口、相关传输对象和默认配置抽成独立模块供消费者依赖,服务端保留自己的 Controller 实现。模块依赖只解决代码可见性;还要让 @EnableFeignClients 的扫描范围或显式客户端列表覆盖该接口,才能注册并注入调用代理。

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

  • 方式一:指定FeignClient所在包
@EnableFeignclients(basePackages = "cn.itcast.feign.clients")
  • 方式二:指定FeignClient字节码
@EnableFeignclients(clients = {Userclient.class})