当前位置:首页 > 技术分析 > 正文内容

Spring Cloud Feign 总结问题,注意点,性能调优,切换okhttp3

ruisui883个月前 (02-03)技术分析24

Feign常见问题总结

FeignClient接口如使用@PathVariable ,必须指定value属性

//在一些早期版本中, @PathVariable("id") 中的 "id" ,也就是value属性,必须指定,不能省略。
@FeignClient("microservice-provider-user")
public interface UserFeignClient {
 @RequestMapping(value = "/simple/{id}", method = RequestMethod.GET)
 public User findById(@PathVariable("id") Long id);
 ...
}

Java代码自定义Feign Client的注意点与坑

@FeignClient(name = "microservice-provider-user", configuration = UserFeignConfig.class)
public interface UserFeignClient {
 @GetMapping("/users/{id}")
 User findById(@PathVariable("id") Long id);
}

/**
 * 该Feign Client的配置类,注意:
 * 1. 该类可以独立出去;
 * 2. 该类上也可添加@Configuration声明是一个配置类;
 * 配置类上也可添加@Configuration注解,声明这是一个配置类;
 * 但此时千万别将该放置在主应用程序上下文@ComponentScan所扫描的包中,
 * 否则,该配置将会被所有Feign Client共享,无法实现细粒度配置!
 * 个人建议:像我一样,不加@Configuration注解
 *
 * @author zhouli
 */
class UserFeignConfig {
 @Bean
 public Logger.Level logger() {
 return Logger.Level.FULL;
 }
}
  • 配置类上也可添加@Configuraiton 注解,声明这是一个配置类;但此时千万别将该放置在主应用程序上下文@ComponentScan 所扫描的包中,否则,该配置将会被所有Feign Client共享(相当于变成了通用配置,其实本质还是Spring父子上下文扫描包重叠导致的问题),无法实现细粒度配置!
  • 个人建议:像我一样,不加@Configuration注解,省得进坑。
  • 最佳实践:尽量用配置属性自定义Feign的配置!!!

@FeignClient 注解属性

//@FeignClient(name = "microservice-provider-user")
//在早期的Spring Cloud版本中,无需提供name属性,从Brixton版开始,@FeignClient必须提供name属性,否则应用将无法正常启动!
//另外,name、url等属性支持占位符。例如:
@FeignClient(name = "${feign.name}", url = "${feign.url}")

类级别的@RequestMapping会被Spring MVC加载

@RequestMapping("/users")
@FeignClient(name = "microservice-user")
public class TestFeignClient {
 // ...
}

类上的@RequestMapping 注解也会被Spring MVC加载。该问题现已经被解决,早期的版本有两种解决方案:方案1:不在类上加@RequestMapping 注解;方案2:添加如下代码:

@Configuration
@ConditionalOnClass({ Feign.class })
public class FeignMappingDefaultConfiguration {
 @Bean
 public WebMvcRegistrations feignWebRegistrations() {
 return new WebMvcRegistrationsAdapter() {
 @Override
 public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
 return new FeignFilterRequestMappingHandlerMapping();
 }
 };
 }

 private static class FeignFilterRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
 @Override
 protected boolean isHandler(Class<?> beanType) {
 return super.isHandler(beanType) && !beanType.isInterface();
 }
 }
}

首次请求失败Ribbon的饥饿加载(eager-load)模式

如需产生Hystrix Stream监控信息,需要做一些额外操作Feign本身已经整合了Hystrix,可直接使用@FeignClient(value = "microservice-provider-user", fallback = XXX.class) 来指定fallback类,fallback类继承@FeignClient所标注的接口即可。

但是假设如需使用Hystrix Stream进行监控,默认情况下,访问http://IP:PORT/actuator/hystrix.stream 是会返回404,这是因为Feign虽然整合了Hystrix,但并没有整合Hystrix的监控。如何添加监控支持呢?需要以下几步:

第一步:添加依赖,示例:

<!-- 整合hystrix,其实feign中自带了hystrix,引入该依赖主要是为了使用其中的hystrix-metrics-event-stream,用于dashboard -->
<dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-starter-hystrix</artifactId>
</dependency>

第二步:在启动类上添加@EnableCircuitBreaker 注解,示例:

@SpringBootApplication
@EnableFeignClients
@EnableDiscoveryClient
@EnableCircuitBreaker
public class MovieFeignHystrixApplication {
 public static void main(String[] args) {
 SpringApplication.run(MovieFeignHystrixApplication.class, args);
 }
}

第三步:在application.yml中添加如下内容,暴露hystrix.stream端点:

management:
 endpoints:
 web:
 exposure:
 include: 'hystrix.stream'

这样,访问任意Feign Client接口的API后,再访问http://IP:PORT/actuator/hystrix.stream ,就会展示一大堆Hystrix监控数据了。

原文链接:http://www.itmuch.com/spring-cloud-sum/feign-problems/

Feign 上传文件

加依赖

<dependency>
 <groupId>io.github.openfeign.form</groupId>
 <artifactId>feign-form</artifactId>
 <version>3.0.3</version>
</dependency>
<dependency>
 <groupId>io.github.openfeign.form</groupId>
 <artifactId>feign-form-spring</artifactId>
 <version>3.0.3</version>
</dependency>

编写Feign Client

@FeignClient(name = "ms-content-sample", configuration = UploadFeignClient.MultipartSupportConfig.class)
public interface UploadFeignClient {
 @RequestMapping(value = "/upload", method = RequestMethod.POST,
 produces = {MediaType.APPLICATION_JSON_UTF8_VALUE},
 consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
 @ResponseBody
 String handleFileUpload(@RequestPart(value = "file") MultipartFile file);

 class MultipartSupportConfig {
 @Bean
 public Encoder feignFormEncoder() {
 return new SpringFormEncoder();
 }
 }
}

如代码所示,在这个Feign Client中,我们引用了配置类MultipartSupportConfig ,在MultipartSupportConfig 中,我们实例化了SpringFormEncoder 。这样这个Feign Client就能够上传啦。

注意点

//RequestMapping注解中的produeces 、consumes 不能少;
@RequestMapping(value = "/upload", method = RequestMethod.POST,
 produces = {MediaType.APPLICATION_JSON_UTF8_VALUE},
 consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
  • 接口定义中的注解@RequestPart(value = "file") 不能写成@RequestParam(value = "file") 。
  • 最好将Hystrix的超时时间设长一点,例如5秒,否则可能文件还没上传完,Hystrix就超时了,从而导致客户端侧的报错。

原文链接:http://www.itmuch.com/spring-cloud-sum/spring-cloud-feign-upload/

Feign实现Form表单提交

添加依赖:

<dependency>
 <groupId>io.github.openfeign.form</groupId>
 <artifactId>feign-form</artifactId>
 <version>3.2.2</version>
</dependency>
<dependency>
 <groupId>io.github.openfeign.form</groupId>
 <artifactId>feign-form-spring</artifactId>
 <version>3.2.2</version>
</dependency>

Feign Client示例:

@FeignClient(name = "xxx", url = "http://www.itmuch.com/", configuration = TestFeignClient.FormSupportConfig.class)
public interface TestFeignClient {
 @PostMapping(value = "/test",
 consumes = {MediaType.APPLICATION_FORM_URLENCODED_VALUE},
 produces = {MediaType.APPLICATION_JSON_UTF8_VALUE}
 )
 void post(Map<String, ?> queryParam);

 class FormSupportConfig {
 @Autowired
 private ObjectFactory<HttpMessageConverters> messageConverters;
 // new一个form编码器,实现支持form表单提交
 @Bean
 public Encoder feignFormEncoder() {
 return new SpringFormEncoder(new SpringEncoder(messageConverters));
 }
 // 开启Feign的日志
 @Bean
 public Logger.Level logger() {
 return Logger.Level.FULL;
 }
 }
}

调用示例:

@GetMapping("/user/{id}")
public User findById(@PathVariable Long id) {
 HashMap<String, String> param = Maps.newHashMap();
 param.put("username","zhangsan");
 param.put("password","pwd");
 this.testFeignClient.post(param);
 return new User();
}

日志:

...[TestFeignClient#post] ---> POST http://www.baidu.com/test HTTP/1.1
...[TestFeignClient#post] Accept: application/json;charset=UTF-8
...[TestFeignClient#post] Content-Type: application/x-www-form-urlencoded; charset=UTF-8
...[TestFeignClient#post] Content-Length: 30
...[TestFeignClient#post] 
...[TestFeignClient#post] password=pwd&username=zhangsan
...[TestFeignClient#post] ---> END HTTP (30-byte body)

由日志可知,此时Feign已能使用Form表单方式提交数据。

原文链接:http://www.itmuch.com/spring-cloud-sum/feign-form-params/

Feign GET请求如何构造多参数

假设需请求的URL包含多个参数,例如http://microservice-provider-user/get?id=1&username=张三 ,该如何使用Feign构造呢?我们知道,Spring Cloud为Feign添加了Spring MVC的注解支持,那么我们不妨按照Spring MVC的写法尝试一下:

@FeignClient("microservice-provider-user")
public interface UserFeignClient {
 @RequestMapping(value = "/get", method = RequestMethod.GET)
 public User get0(User user);
}

然而,这种写法并不正确,控制台会输出类似如下的异常。

feign.FeignException: status 405 reading UserFeignClient#get0(User); content:
{"timestamp":1482676142940,"status":405,"error":"Method Not Allowed","exception":"org.springframework.web.HttpRequestMethodNotSupportedException","message":"Request method 'POST' not supported","path":"/get"}

由异常可知,尽管我们指定了GET方法,Feign依然会使用POST方法发送请求。于是导致了异常。正确写法如下

方法一[推荐]注意:使用该方法无法使用Fegin的继承模式

@FeignClient("microservice-provider-user")
public interface UserFeignClient {
 @GetMapping("/get")
 public User get0(@SpringQueryMap User user);
}

方法二[推荐]

@FeignClient(name = "microservice-provider-user")
public interface UserFeignClient {
 @RequestMapping(value = "/get", method = RequestMethod.GET)
 public User get1(@RequestParam("id") Long id, @RequestParam("username") String username);
}

这是最为直观的方式,URL有几个参数,Feign接口中的方法就有几个参数。使用@RequestParam注解指定请求的参数是什么。

方法三[不推荐]多参数的URL也可使用Map来构建。当目标URL参数非常多的时候,可使用这种方式简化Feign接口的编写。

@FeignClient(name = "microservice-provider-user")
public interface UserFeignClient {
 @RequestMapping(value = "/get", method = RequestMethod.GET)
 public User get2(@RequestParam Map<String, Object> map);
}

在调用时,可使用类似以下的代码。

public User get(String username, String password) {
 HashMap<String, Object> map = Maps.newHashMap();
 map.put("id", "1");
 map.put("username", "张三");
 return this.userFeignClient.get2(map);
}

注意:这种方式不建议使用。主要是因为可读性不好,而且如果参数为空的时候会有一些问题,例如map.put("username", null); 会导致服务调用方(消费者服务)接收到的username是"" ,而不是null。

原文链接:http://www.itmuch.com/spring-cloud-sum/feign-multiple-params-2/

切换为 Okhttp3 提升 QPS 性能优化

加依赖引入okhttp3

<dependency>
 <groupId>io.github.openfeign</groupId>
 <artifactId>feign-okhttp</artifactId>
 <version>${version}</version>
</dependency>

写配置

feign:
 # feign启用hystrix,才能熔断、降级
 # hystrix:
 # enabled: true
 # 启用 okhttp 关闭默认 httpclient
 httpclient:
 enabled: false #关闭httpclient
 # 配置连接池
 max-connections: 200 #feign的最大连接数
 max-connections-per-route: 50 #fegin单个路径的最大连接数
 okhttp:
 enabled: true
 # 请求与响应的压缩以提高通信效率
 compression:
 request:
 enabled: true
 min-request-size: 2048
 mime-types: text/xml,application/xml,application/json
 response:
 enabled: true

参数配置

/**
 * 配置 okhttp 与连接池
 * ConnectionPool 默认创建5个线程,保持5分钟长连接
 */
@Configuration
@ConditionalOnClass(Feign.class)
@AutoConfigureBefore(FeignAutoConfiguration.class) //SpringBoot自动配置
public class OkHttpConfig {

 // 默认老外留给你彩蛋中文乱码,加上它就 OK
 @Bean
 public Encoder encoder() {
 return new FormEncoder();
 }

 @Bean
 public okhttp3.OkHttpClient okHttpClient() {
 return new okhttp3.OkHttpClient.Builder()
 //设置连接超时
 .connectTimeout(10, TimeUnit.SECONDS)
 //设置读超时
 .readTimeout(10, TimeUnit.SECONDS)
 //设置写超时
 .writeTimeout(10, TimeUnit.SECONDS)
 //是否自动重连
 .retryOnConnectionFailure(true)
 .connectionPool(new ConnectionPool(10, 5L, TimeUnit.MINUTES))
 .build();
 }
}

原文链接:https://mp.weixin.qq.com/s/PAjXS9d6Sxa04pw1Lw2HXQ

https://zc.happyloves.cn:4443/wordpress/

扫描二维码推送至手机访问。

版权声明:本文由ruisui88发布,如需转载请注明出处。

本文链接:http://www.ruisui88.com/post/1178.html

标签: feign 使用
分享给朋友:

“Spring Cloud Feign 总结问题,注意点,性能调优,切换okhttp3” 的相关文章

培训机构财务及缴费管理系统

学校收费软件是专门为学校财务量身打造的用于灵活性收取学生费用,智能化管理学生缴欠费信息的一款智能系统。1.灵活性全面的学生档案(学籍)信息化管理要计费,一定要有学生信息。所以就算是财务的收费软件,关于学生的档案资料(学籍)管理,同样是计费系统软件不可缺少的部分。档案资料属性,全面、灵活性、能自定义。...

gitlab常用命令大全

GitLab常用命令大全GitLab是一个基于Git的Web平台,它不仅提供代码托管,还集成了持续集成/持续交付(CI/CD)、代码审查、问题追踪等功能。在日常使用GitLab的过程中,我们常常需要使用一系列命令来管理代码仓库、处理分支和标签等。以下是GitLab常用的Git命令大全,并附上详细解释...

Python中的11 种数组算法

1. 创建数组 创建数组意味着留出一个连续的内存块来存储相同类型的元素。在大多数语言中,您可以在创建数组时指定数组的大小。假设您正在书架上整理一组书籍,并且您需要为正好 10 本书预留空间。功能架上的每个空间都对应于数组中的一个索引。# Example in Python arr = [1, 2,...

关于Vue页面跳转传参,参数不同, 但页面只获取参数一次的问题

#头条创作挑战赛#1.问题描述问题描述: element 展示表格(页面A),点击表格的每一行的查看详情按钮,可以携带此行的信息参数跳转到另一个页面(页面B),但是从A页面到B页面,只有第一次跳转的时候B页面可以获取到A页面的参数,返回再次A->B ,B页面无法获取到参数。2.解决办法:方法一...

Vue真是太好了 壹万多字的Vue知识点 超详细!

1??、Vue和其他两大框架的区别Angular 学习成本太高React 代码可读性差Vue 学习成本较低 很容易上手VUE官方: https://cn.vuejs.org/v2/guide/comparison.html?2??、Vue是什么Vue是一套用于构建用户界面的渐进式框架 "前端...

vue打开新窗口并且实现传参,有图有真相

我要实现的功能是打开一个新窗口用来展示新页面,而且需要传参数,并且参数不能显示在地址栏里面,而且当我刷新页面的时候,传过来的参数不能丢失,要一直存在,除非我手动关闭这个新窗口,即浏览器的标签页。通过面向百度编程,发现网上的根本达不到这个效果,而且还都是坑,明明实现不了,还若有其事的写出来,于是我在标...