接口调用方式
1:HTTPclient
Apache common 下,
2:OKhttp
安卓端最火,轻量
简洁高效 支持多重协议
3:Reset template webClient
Spring提供访问rest服务端
feign
声明式,模块化的HTTP客户端
像调用接口的方式dubbo调用,不需要httpclient 那样解析,在调用无需关注远程交互
feign的设计机构
feign调用方式
@FeignClient(value = "mall-order",path = "/order")
public interface OrderFeignService {
@RequestMapping("/findOrderByUserId/{userId}")
public R findOrderByUserId(@PathVariable("userId") Integer userId);
}
@Autowired
OrderFeignService orderFeignService;
//feign调用
R result = orderFeignService.findOrderByUserId(id);
fign的单独使用
引入依赖
<dependency>
<groupId>com.netflix.feign</groupId>
<artifactId>feign-core</artifactId>
<version>8.18.0</version>
</dependency>
<dependency>
<groupId>com.netflix.feign</groupId>
<artifactId>feign-jackson</artifactId>
<version>8.18.0</version>
</dependency>
public interface RemoteService {
@Headers({"Content-Type: application/json","Accept: application/json"})
@RequestLine("GET /order/findOrderByUserId/{userId}")
public R findOrderByUserId(@Param("userId") Integer userId);
public class FeignDemo {
public static void main(String[] args) {
//基于json
// encoder指定对象编码方式,decoder指定对象解码方式
RemoteService service = Feign.builder()
.encoder(new JacksonEncoder())
.decoder(new JacksonDecoder())
.options(new Request.Options(1000, 3500))
.retryer(new Retryer.Default(5000, 5000, 3))
.target(RemoteService.class, "http://localhost:8020/");
System.out.println(service.findOrderByUserId(1));
}
fegin与SpringCloudAlibaba整合
依赖
<!-- openfeign 远程调用 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
@FeignClient(value = "mall-order",path = "/order")
public interface OrderFeignService {
@RequestMapping("/findOrderByUserId/{userId}")
public R findOrderByUserId(@PathVariable("userId") Integer userId);
}
启动类上加注解@EnableFeignClients
@SpringBootApplication
@EnableFeignClients
public class MallUserFeignDemoApplication {
public static void main(String[] args) {
SpringApplication.run(MallUserFeignDemoApplication.class, args);
}
}
调用
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
OrderFeignService orderFeignService;
@RequestMapping(value = "/findOrderByUserId/{id}")
public R findOrderByUserId(@PathVariable("id") Integer id) {
//feign调用
R result = orderFeignService.findOrderByUserId(id);
return result;
}
}
Spring Cloud Feign 的自定义配置和使用
1:日志配置
需要定义个配置类指定日志级别
// 注意: 此处配置@Configuration注解就会全局生效,如果想指定对应微服务生效,就不能配置
//@Configuration,不注释就是全局的,注释后,可以在配置中单独指定
public class FeignConfig {
/**
* 日志级别
* @return
*/
@Bean
public Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
}
四种日志级别
- none:性能最佳适用生产,不记录日志,也是默认的
- basic:生产环境追踪用,记录请求方法,URL,响应,耗时
- headers:baseic的基础上加上header
- Full:就是全部的了,包括body,元数据
2: 局部日志,只针调用的微服务有效
在@FeignClient注解这顶只用即可
3:在yml配置执行client的日志级别
可以在对应的配置文件找对应的可能的还要其他的东西logging:
level:
com.tuling.mall.feigndemo.feign: debug
feign:
client:
config:
mall-order: #对应微服务
loggerLevel: FULL #设置对应微服务的日志级别
org.springframework.cloud.openfeign.FeignClientProperties.FeignClientConfiguration
契约配置
Spring cloud 对feign做了扩展,可以支持MVC的注解调用,
可以使用Spring的注解了默认的类是: Spring Cloud 中默认的是 SpringMvcContract。
修改契约配置,支持feign原生注解
/**
* 修改契约配置,支持Feign原生的注解
* @return
*/
@Bean
public Contract feignContract() {
return new Contract.Default();
}
注意:修改契约配置后,OrderFeignService 不再支持springmvc的注解,需要使用Feign原生的注解
使用feign原生注解
@FeignClient(value = "mall-order",path = "/order")
public interface OrderFeignService {
@RequestLine("GET /findOrderByUserId/{userId}")
public R findOrderByUserId(@Param("userId") Integer userId);
}
通过配置指定对应的契约
feign:
client:
config:
mall-order: #对应微服务
loggerLevel: FULL
contract: feign.Contract.Default #指定Feign原生注解契约配置
拦截器,很重要、
比如添加header ,做实名认证,接口鉴权
@Configuration // 全局配置
public class FeignConfig {
@Bean
public BasicAuthRequestInterceptor basicAuthRequestInterceptor() {
//自定义自己的拦截逻辑,比如添加header
return new BasicAuthRequestInterceptor("fox", "123456");
}
}
RequestInterceptor
public interface RequestInterceptor {
/**
* Called for every request. Add data using methods on the supplied {@link RequestTemplate}.
*/
void apply(RequestTemplate template);
}
这样,每次feign发起HTTP之前都会调用,
可以统一添加Header
代码示例
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 {
@Bean
public Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
/**
* 自定义拦截器
* @return
*/
@Bean
public FeignAuthRequestInterceptor feignAuthRequestInterceptor(){
return new FeignAuthRequestInterceptor();
}
}
也可以在yml中配置拦截器
feign:
client:
config:
mall-order: #对应微服务
requestInterceptors[0]: #配置拦截器
com.tuling.mall.feigndemo.interceptor.FeignAuthRequestInterceptor
4:超时时间配置
通过options配置
@Configuration
public class FeignConfig {
@Bean
public Request.Options options() {
// 默认毫秒,连接超时时间,请求处理的超时时间
return new Request.Options(5000, 10000);
}
}
配置文件方式配置
feign:
client:
config:
mall-order: #对应微服务
# 连接超时时间,默认2s
connectTimeout: 5000
# 请求处理超时时间,默认5s
readTimeout: 10000
fegin底层是ribbon,但是时间一feign为准
5:客户端组件配置,就是底层http具体是走那种方式
feign原生使用JDK的URL connection 发送HTTP,可以替换的
发起调用的执行逻辑 Feign.Client#execute 可以扩展
替换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>
修改配置就可以启用HTTPclient
feign:
#feign 使用 Apache HttpClient 可以忽略,默认开启
httpclient:
enabled: true
修改配置就能用
是因为org.springframework.cloud.openfeign.FeignAutoConfiguration预留了ApacheHttpClient的位置
okhttpClient 也可以
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
</dependency>
feign:
#feign 使用 okhttp
httpclient:
enabled: false
okhttp:
enabled: true
引入依赖,打开配置就可以用了
feign.okhttp.OkHttpClient#execute
6: GZIP压缩配置
节约资源,提高接口性能的
feign:
# 配置 GZIP 来压缩数据
compression:
request:
enabled: true
# 配置压缩的类型
mime-types: text/xml,application/xml,application/json
# 最小压缩值
min-request-size: 2048
response:
enabled: true
okhttp3是无效的
源码FeignAcceptGzipEncodingAutoConfiguration
核心代码就是 @ConditionalOnMissingBean(type=”okhttp3.OkHttpClient”),表示 Spring BeanFactory 中不包含指定的 bean 时条件匹配,也就是没有启用 okhttp3 时才会进行压缩配置。
7:编解码器的配置
feign 提供了自定义的编解码器 ,比如Gson,JackSon可以自定义
扩展feign.codec.Encoder ¥ feign.codec.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;
}
@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
fegin 与 openFegin的区别
消息转化器
MessageConverter
拦截器实现认证
FeginAutoConfiguration 条件注解
自动配置,是要引入就可以切换了
如何找怎么配置
从FeginAutoConfiguration 找到FeginClientProperties.java文件
切入点,如何找到
GZIP压缩配置
方法