Feign的扩展点要基于Feign的架构图,如下:
1、日志配置
有时候我们遇到 Bug,比如接口调用失败、参数没收到等问题,或者想看看调用性能,就需要配置 Feign 的日志了,以此让 Feign 把请求信息输出来。
1)定义一个配置类,指定日志级别
// 注意: 此处配置@Configuration注解就会全局生效,如果想指定对应微服务生效,就不能配置@Configuration
@Configuration
public class FeignConfig {
/**
* 日志级别
*
* @return
*/
@Bean
public Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
}
日志等级有 4 种,分别是:
NONE【性能最佳,适用于生产】:不记录任何日志(默认值)。
BASIC【适用于生产环境追踪问题】:仅记录请求方法、URL、响应状态代码以及执行时间。
HEADERS:记录BASIC级别的基础上,记录请求和响应的header。
FULL【比较适用于开发及测试环境定位问题】:记录请求和响应的header、body和元数据。
2) 局部配置,让调用的微服务生效,在@FeignClient 注解中指定使用的配置类
- 在yml配置文件中配置 Client 的日志级别才能正常输出日志,格式是"logging.level.feign接口包路径=debug"
logging:
level:
com.feigndemo.feign: debug
4)局部配置可以在yml中配置
对应属性配置类: org.springframework.cloud.openfeign.FeignClientProperties.FeignClientCon
figuration
feign:
client:
config:
service-namer: #对应微服务
loggerLevel: FULL
2、契约配置,没啥用,纯给自己找麻烦
Spring Cloud 在 Feign 的基础上做了扩展,可以让 Feign 支持 Spring MVC 的注解来调用。原生的 Feign 是不支持 Spring MVC 注解的,如果你想在 Spring Cloud 中使用原生的注解方式来定义客户端也是可以的,通过配置契约来改变这个配置,Spring Cloud 中默认的是 SpringMvcContract。
feign:
client:
config:
service-namer: #对应微服务
loggerLevel: FULL
contract: feign.Contract.Default #指定Feign原生注解契约配置
3、通过拦截器实现参数传递
可以通过feign的拦截器,将认证信息在服务间传递,比如下面的代码将authorization认证信息往后传递。
@Component
public class FeignInterceptor implements RequestInterceptor {
@Override
public void apply(RequestTemplate requestTemplate) {
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
if (requestAttributes!=null){
HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
if (request!=null){
Enumeration<String> headerNames = request.getHeaderNames();
if (headerNames!=null){
while (headerNames.hasMoreElements()){
String headerName = headerNames.nextElement();
if (headerName.equals("authorization")){
String headerValue = request.getHeader(headerName);
requestTemplate.header(headerName,headerValue);//核心代码
}
}
}
}
}
}
}
@Configuration // 全局配置
public class FeignConfig {
/**
* 自定义拦截器
* @return
*/
@Bean
public FeignInterceptor feignInterceptor (){
return new FeignInterceptor();
}
}
上面通过@Bean的方式配置拦截器,也可以在yml里配置:
feign:
client:
config:
service-name: #对应微服务
requestInterceptors[0]: #配置拦截器
com.interceptor.FeignInterceptor
4、客户端组件配置
Feign 中默认使用 JDK 原生的 URLConnection 发送 HTTP 请求,版本比较老还不支持连接池,性能不太行。我们可以集成别的组件来替换掉 URLConnection,比如 Apache HttpClient,OkHttp。
配置Apache HttpClient
引入依赖:
<!-- Apache HttpClient -->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.7</version>
</dependency>
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
<version>10.1.0</version>
</dependency>
然后修改yml配置,将 Feign 的 Apache HttpClient启用 :
feign:
#feign 使用 Apache HttpClient 可以忽略,默认开启
httpclient:
enabled: true
关于配置可参考源码: org.springframework.cloud.openfeign.FeignAutoConfiguration
配置 OkHttp
引入依赖
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
</dependency>
然后修改yml配置,将 Feign 的 HttpClient 禁用,启用 OkHttp,配置如下:
feign:
#feign 使用 okhttp
httpclient:
enabled: false
okhttp:
enabled: true
5、GZIP 压缩配置
开启压缩可以有效节约网络资源,提升接口性能,我们可以配置 GZIP 来压缩数据:
feign:
# 配置 GZIP 来压缩数据
compression:
request:
enabled: true
# 配置压缩的类型
mime-types: text/xml,application/xml,application/json
# 最小压缩值
min-request-size: 2048
response:
enabled: true
注意:只有当 Feign 的 Http Client 不是 okhttp3 的时候,压缩才会生效,配置源码在FeignAcceptGzipEncodingAutoConfiguration
6、编码器解码器配置
Feign 中提供了自定义的编码解码器设置,同时也提供了多种编码器的实现,比如 Gson、Jaxb、Jackson。我们可以用不同的编码解码器来处理数据的传输。如果你想传输 XML 格式的数据,可以自定义 XML 编码解码器来实现获取使用官方提供的 Jaxb。
扩展点:Encoder & Decoder
public interface Encoder {
void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException;
}
public interface Decoder {
Object decode(Response response, Type type) throws IOException, DecodeException, FeignException;
}
Java配置方式
配置编码解码器只需要在 Feign 的配置类中注册 Decoder 和 Encoder 这两个类即可:
@Bean
public Decoder decoder() {
return new JacksonDecoder();
}
@Bean
public Encoder encoder() {
return new JacksonEncoder();
}
yml配置方式
feign:
client:
config:
mall-order: #对应微服务
# 配置编解码器
encoder: feign.jackson.JacksonEncoder
decoder: feign.jackson.JacksonDecoder