Feign常見問題總結
FeignClient接口如使用@PathVariable ，必須指定value屬性
<code>//在一些早期版本中， @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);
...
}/<code>Java代碼自定義Feign Client的注意點與坑
<code>@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;
}
}/<code>
- 配置類上也可添加@Configuraiton 註解，聲明這是一個配置類；但此時千萬別將該放置在主應用程序上下文@ComponentScan 所掃描的包中，否則，該配置將會被所有Feign Client共享（相當於變成了通用配置，其實本質還是Spring父子上下文掃描包重疊導致的問題），無法實現細粒度配置！
- 個人建議：像我一樣，不加@Configuration註解，省得進坑。
- 最佳實踐：儘量用配置屬性自定義Feign的配置！！！
@FeignClient 註解屬性
<code>//@FeignClient(name = "microservice-provider-user")
//在早期的Spring Cloud版本中，無需提供name屬性，從Brixton版開始，@FeignClient必須提供name屬性，否則應用將無法正常啟動！
//另外，name、url等屬性支持佔位符。例如：
@FeignClient(name = "${feign.name}", url = "${feign.url}")/<code>
類級別的@RequestMapping會被Spring MVC加載
<code>@RequestMapping("/users")
@FeignClient(name = "microservice-user")
public class TestFeignClient {
// ...
}/<code>類上的@RequestMapping 註解也會被Spring MVC加載。該問題現已經被解決，早期的版本有兩種解決方案：方案1：不在類上加@RequestMapping 註解；方案2：添加如下代碼：
<code>@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();
}
}
}/<code>
首次請求失敗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的監控。如何添加監控支持呢？需要以下幾步：
第一步：添加依賴，示例：
<code>
<dependency>
<groupid>org.springframework.cloud/<groupid>
<artifactid>spring-cloud-starter-hystrix/<artifactid>
/<dependency>/<code>
第二步：在啟動類上添加@EnableCircuitBreaker 註解，示例：
<code>@SpringBootApplication
@EnableFeignClients
@EnableDiscoveryClient
@EnableCircuitBreaker
public class MovieFeignHystrixApplication {
public static void main(String[] args) {
SpringApplication.run(MovieFeignHystrixApplication.class, args);
}
}/<code>
第三步：在application.yml中添加如下內容，暴露hystrix.stream端點：
<code>management:
endpoints:
web:
exposure:
include: 'hystrix.stream'/<code>
這樣，訪問任意Feign Client接口的API後，再訪問http://IP:PORT/actuator/hystrix.stream ，就會展示一大堆Hystrix監控數據了。
原文鏈接：http://www.itmuch.com/spring-cloud-sum/feign-problems/
Feign 上傳文件
加依賴
<code><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>/<code>
編寫Feign Client
<code>@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();
}
}
}/<code>
如代碼所示，在這個Feign Client中，我們引用了配置類MultipartSupportConfig ，在MultipartSupportConfig 中，我們實例化了SpringFormEncoder 。這樣這個Feign Client就能夠上傳啦。
注意點
<code>//RequestMapping註解中的produeces 、consumes 不能少；
@RequestMapping(value = "/upload", method = RequestMethod.POST,
produces = {MediaType.APPLICATION_JSON_UTF8_VALUE},
consumes = MediaType.MULTIPART_FORM_DATA_VALUE)/<code>
- 接口定義中的註解@RequestPart(value = "file") 不能寫成@RequestParam(value = "file"） 。
- 最好將Hystrix的超時時間設長一點，例如5秒，否則可能文件還沒上傳完，Hystrix就超時了，從而導致客戶端側的報錯。
原文鏈接：http://www.itmuch.com/spring-cloud-sum/spring-cloud-feign-upload/
Feign實現Form表單提交
添加依賴：
<code><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>/<code>
Feign Client示例：
<code>@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;
}
}
}/<httpmessageconverters>/<string>/<code>
調用示例：
<code>@GetMapping("/user/{id}")
public User findById(@PathVariable Long id) {
HashMap<string> param = Maps.newHashMap();
param.put("username","zhangsan");
param.put("password","pwd");
this.testFeignClient.post(param);
return new User();
}/<string>/<code>日誌：
<code>...[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)/<code>
由日誌可知，此時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的寫法嘗試一下：
<code>@FeignClient("microservice-provider-user")
public interface UserFeignClient {
@RequestMapping(value = "/get", method = RequestMethod.GET)
public User get0(User user);
}/<code>然而，這種寫法並不正確，控制檯會輸出類似如下的異常。
<code>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"}/<code>
由異常可知，儘管我們指定了GET方法，Feign依然會使用POST方法發送請求。於是導致了異常。正確寫法如下
方法一[推薦]注意:使用該方法無法使用Fegin的繼承模式
<code>@FeignClient("microservice-provider-user")
public interface UserFeignClient {
@GetMapping("/get")
public User get0(@SpringQueryMap User user);
}/<code>方法二[推薦]
<code>@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);
}/<code>
這是最為直觀的方式，URL有幾個參數，Feign接口中的方法就有幾個參數。使用@RequestParam註解指定請求的參數是什麼。
方法三[不推薦]多參數的URL也可使用Map來構建。當目標URL參數非常多的時候，可使用這種方式簡化Feign接口的編寫。
<code>@FeignClient(name = "microservice-provider-user")
public interface UserFeignClient {
@RequestMapping(value = "/get", method = RequestMethod.GET)
public User get2(@RequestParam Map<string> map);
}/<string>/<code>
在調用時，可使用類似以下的代碼。
<code>public User get(String username, String password) {
HashMap<string> map = Maps.newHashMap();
map.put("id", "1");
map.put("username", "張三");
return this.userFeignClient.get2(map);
}/<string>/<code>注意：這種方式不建議使用。主要是因為可讀性不好，而且如果參數為空的時候會有一些問題，例如map.put("username", null); 會導致服務調用方（消費者服務）接收到的username是"" ，而不是null。
原文鏈接：http://www.itmuch.com/spring-cloud-sum/feign-multiple-params-2/
切換為 Okhttp3 提升 QPS 性能優化
加依賴引入okhttp3
<code><dependency>
<groupid>io.github.openfeign/<groupid>
<artifactid>feign-okhttp/<artifactid>
<version>${version}/<version>
/<dependency>/<code>
寫配置
<code>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/<code>
參數配置
<code>/**
* 配置 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();
}
}/<code>
原文鏈接：https://mp.weixin.qq.com/s/PAjXS9d6Sxa04pw1Lw2HXQ
https://zc.happyloves.cn:4443/wordpress/
分享到:
閱讀更多 趙小胖0914 的文章
