日志配置
有时候我们遇到 Bug，比如接口调用失败、参数没收到等问题，或者想看看调用性能，就需要配置 Feign 的日志了，以此让 Feign 把请求信息输出来。
配置类
// 注意： 此处配置@Configuration注解就会全局生效，如果想指定对应微服务生效，就不能配置
public class FeignConfig {
/**
* 日志级别
*
* @return
*/
@Bean
public Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
}
日志等级
public static enum Level {
NONE,
BASIC,
HEADERS,
FULL;
private Level() {
}
}
- NONE【性能最佳，适用于生产】：不记录任何日志（默认值）。
- BASIC【适用于生产环境追踪问题】：仅记录请求方法、URL、响应状态代码以及执行时间。
- HEADERS：记录BASIC级别的基础上，记录请求和响应的header。
- FULL【比较适用于开发及测试环境定位问题】：记录请求和响应的header、body和元数据。
日志级别
public static enum Level {
NONE,
BASIC,
HEADERS,
FULL;
private Level() {
}
}
局部配置，仅对配置的微服务生效
@FeignClient(value = "mall-order",path = "/order",configuration = FeignConfig.class)
public interface OrderFeignService {
@RequestMapping("/findOrderByUserId/{userId}")
public R findOrderByUserId(@PathVariable("userId") Integer userId);
}
yaml文件配置
在yml配置文件中执行 Client 的日志级别才能正常输出日志，格式是"
logging:
? level:
? ? #接口路径包
? ? com.tuling.mall.feigndemo.feign: debug
契约配置
Spring Cloud 在 Feign 的基础上做了扩展，可以让 Feign 支持 Spring MVC 的注解来调用。原生的 Feign 是不支持 Spring MVC 注解的，如果你想在 Spring Cloud 中使用原生的注解方式来定义客户端也是可以的，通过配置契约来改变这个配置，Spring Cloud 中默认的是 SpringMvcContract。
修改契约配置，支持Feign原生的注解
/**
* 修改契约配置，支持Feign原生的注解
* @return
*/
@Bean
public Contract feignContract() {
return new Contract.Default();
}
}
注意：修改契约配置后，OrderFeignService 不再支持springmvc的注解，需要使用Feign原生的注解
OrderFeignService 中配置使用Feign原生的注解
@FeignClient(value = "mall-order",path = "/order")
public interface OrderFeignService {
@RequestLine("GET /findOrderByUserId/{userId}")
public R findOrderByUserId(@Param("userId") Integer userId);
}
补充，也可以通过yml配置契约
feign:
client:
config:
mall-order: #对应微服务
loggerLevel: FULL
contract: feign.Contract.Default #指定Feign原生注解契约配置
通过拦截器实现认证
配置 Basic 认证
@Configuration // 全局配置
public class FeignConfig {
/**
* 开启Basic认证
* @return
*/
@Bean
public BasicAuthRequestInterceptor basicAuthRequestInterceptor() {
return new BasicAuthRequestInterceptor("xxxx","123456");
}
public class BasicAuthRequestInterceptor implements RequestInterceptor {
private final String headerValue;
public BasicAuthRequestInterceptor(String username, String password) {
this(username, password, Util.ISO_8859_1);
}
public BasicAuthRequestInterceptor(String username, String password, Charset charset) {
Util.checkNotNull(username, "username", new Object[0]);
Util.checkNotNull(password, "password", new Object[0]);
this.headerValue = "Basic " + base64Encode((username + ":" + password).getBytes(charset));
}
private static String base64Encode(byte[] bytes) {
return Base64.encode(bytes);
}
public void apply(RequestTemplate template) {
template.header("Authorization", new String[]{this.headerValue});
}
}
使用场景
- 统一添加 header 信息
- 对 body 中的信息做修改或替换
自定义拦截器
public class FeignAuthRequestInterceptor implements RequestInterceptor {
@Override
public void apply(RequestTemplate template) {
// 业务逻辑 模拟认证逻辑
String access_token = UUID.randomUUID().toString();
template.header("Authorization",access_token);
}
}
添加自定义拦截器
@Configuration // 全局配置
public class FeignConfig {
/**
* 开启Basic认证
* @return
*/
@Bean
public BasicAuthRequestInterceptor basicAuthRequestInterceptor() {
return new BasicAuthRequestInterceptor("fox","123456");
}
/**
* 自定义拦截器
* @return
*/
@Bean
public FeignAuthRequestInterceptor feignAuthRequestInterceptor(){
return new FeignAuthRequestInterceptor();
}
ymal添加拦截器
feign:
client:
config:
mall-order: #对应微服务
requestInterceptors[0]: #配置拦截器
com.tuling.mall.feigndemo.interceptor.FeignAuthRequestInterceptor
超时时间配置
通过 Options 可以配置连接超时时间和读取超时时间，Options 的第一个参数是连接的超时时间（ms），默认值是 2s；第二个是请求处理的超时时间（ms），默认值是 5s。
配置类
@Configuration
public class FeignConfig {
@Bean
public Request.Options options() {
return new Request.Options(5000, 10000);
}
}
配置ymal
feign:
client:
config:
mall-order: #对应微服务
# 连接超时时间，默认2s
connectTimeout: 5000
# 请求处理超时时间，默认5s
readTimeout: 10000
客户端组件配置
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?
配置 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
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
核心代码就是 @ConditionalOnMissingBean（type="okhttp3.OkHttpClient"），表示 Spring BeanFactory 中不包含指定的 bean 时条件匹配，也就是没有启用 okhttp3 时才会进行压缩配置。
编码器解码器配置
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
|