之前在一篇博客中写了利用RestTemplate发起远程调用的代码,但是存在一下问题:代码可读性差,编程体验不统一;如果参数特别多的话,参数复杂URL难以维护。
Feign官方地址:https://github.com/OpenFeign/feign
Fegin的使用步骤如下:
1)引入依赖
我们在order-service服务的pom文件中引入feign的依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2)添加注解
在order-service的启动类添加注解开启Feign的功能:
3)编写Feign的客户端
在order-service中新建一个接口,内容如下:
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
服务名称:userservice
请求方式:GET
请求路径:/user/{id}
请求参数:Long id
返回值类型:User
这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。
测试
修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:
自定义配置
Feign可以支持很多的自定义配置,比如修改日志级别、响应结果的解析器、请求参数编码、支持的注解格式、失败重试机制等等,但是一般情况下,默认值就能满足使用,如果要配置的话,一般需要配置的就是日志级别。
包含四种不同的级别:NONE、BASIC、HEADERS、FULL
NONE:不记录任何日志信息,这是默认值
BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据
配置方式有基于配置文件和Java代码的方式:
基于配置文件修改feign的日志级别可以针对单个服务:
feign:
client:
config:
userservice: # 针对某个微服务的配置
loggerLevel: FULL # 日志级别
也可以针对所有服务:
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:
public class DefaultFeignConfiguration {
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC; // 日志级别为BASIC
}
}
如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
如果是局部生效,则把它放到对应的@FeignClient这个注解中:
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
Feign使用优化
Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
URLConnection:默认实现,不支持连接池
Apache HttpClient :支持连接池
OKHttp:支持连接池
因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。
用Apache的HttpClient来举例:
1)引入依赖
在order-service的pom文件中引入Apache的HttpClient依赖:
<!--httpClient的依赖 -->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
2)配置连接池
在order-service的application.yml中添加配置:
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使用的代码优化方式:
因为Feign的客户端与服务提供者的controller代码非常相似,就会造成代码看起来非常冗余。
一是可以通过继承来共享:
1)定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。
2)Feign客户端和Controller都继承该接口
优点:
简单
实现了代码共享
缺点:
服务提供方、服务消费方紧耦合
参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解
二是可以利用抽取的方式:
将Feign的Client抽取为独立模块,并且把接口有关的实体类POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用,所有微服务引用该依赖包,即可直接使用。
这里面会有一个扫描包的问题:
方式一:
指定Feign应该扫描的包:(全都扫描过来,再来挑取)
示例:
@EnableFeignClients(basePackages = "xxx.xxx.feign.clients")
方式二:
指定需要加载的Client接口:(精确扫描)
示例:
@EnableFeignClients(clients = {UserClient.class})