SpringCloud整合聲明式HTTP客戶端-Feign

文章目錄

• 一、Feign介紹
• • 1. 什么是Feign？
  • 2. Feign組件：
• 二、基于Feign實現微服務遠程調用
• • 2.1. 引入feign依賴
  • 2.2. 啟動類加@EnableFeignClients注解
  • 2.3. 添加屬性配置(暫無)
  • 2.4. 創建一個feign接口類
  • 2.5. 修改Ribbon調用Feign方式
  • • 2.5.1. Feign調用方式
    • 2.5.2. 以前Ribbon調用方式
  • 2.6. 驗證
  • • 2.6.1. 啟動nacos注冊中心
    • 2.6.2. 啟動user-center應用
    • 2.6.3. 啟動content-center應用
    • 2.6.4. 瀏覽器訪問
• 三、細粒度自定義配置
• • 3. 自定義Feign日志級別
  • • 3.1. java代碼配置方式
    • • 3.1.1. 創建feign配置類
      • 3.1.2. 在feign接口類上指定feign的配置類
      • 3.1.4. 添加監聽feign接口的打印體日志
      • 3.1.5. 驗證
    • 3.2. 屬性配置方式
    • 3.2.1 添加配置信息
    • 3.2.2 重啟content-center應用
• 四、 全局配置自定義
• • • 4.1. java代碼方式(全局)
    • • 4.1.1 在啟動類上添加注解
      • 4.1.2 feign配置類
      • 4.1.3 重啟content-center應用
    • 4.2. 配置屬性方式(全局)
    • • 4.2.1 啟動類
      • 4.2.2 配置文件屬性
      • 4.2.3 重啟content-center應用
• 五、 feign支持的配置項
• • • 5.1. 代碼方式
    • 5.2. 屬性配置方式：
• 六、 配置最佳實踐總結
• • • 6.1. Ribbon配置vs Feign配置
    • 6.2. Feign代碼方式vs屬性方式
    • 6.3. 配置優先級：
• 七、 最佳實踐：

一、Feign介紹

1. 什么是Feign？

Feign是Netfix開源的聲明式HTTP客戶端
Github地址：https://github.com/openfeign/feign

2. Feign組件：

接口作用默認值

Feign.Builder	Feign的入口	Feign.Builder
Client	Feign底層用默認去請求	和Ribbon配合時：LoadBalancerFeignClient；不和Ribbon配合時feign.Client.default
Contract	契約，注解支持	SpringMvcContract
Encoder	編碼器，用于將對象轉換成http請求消息體	SpringEncoder
Decoder	解碼器，將相應消息體轉換成對象	ResponseEntityDecoder
Logger	日志管理器	Slf4jLogger
RequestInterceptor	用于為每個請求添加通用邏輯	無

二、基于Feign實現微服務遠程調用

2.1. 引入feign依賴

<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId></dependency>

2.2. 啟動類加@EnableFeignClients注解

//掃描mybatis那些包里面的接口 @SpringBootApplication @MapperScan("com.itmuch") @EnableFeignClients public class ContentCenterApplication {public static void main(String[] args) {SpringApplication.run(ContentCenterApplication.class, args);} }

2.3. 添加屬性配置(暫無)

2.4. 創建一個feign接口類

//@FeignClient(name = "應用名稱") @FeignClient(name = "user-center") public interface UserCenterFeignClient {/*** http://localhost:8082/users/{id}* @param id* @return*/@GetMapping("/users/{id}")UserDTO finById(@PathVariable Integer id); }

2.5. 修改Ribbon調用Feign方式

2.5.1. Feign調用方式

@Slf4j @Service @RequiredArgsConstructor(onConstructor = @__(@Autowired)) public class ShareServiceImpl implements IShareService {private final ShareMapper shareMapper;private final UserCenterFeignClient userCenterFeignClient;@Overridepublic ShareDTO findById(Integer id) {//獲取分享詳情Share share = this.shareMapper.selectByPrimaryKey(id);//發布人idInteger userId = share.getUserId();//怎么調用用戶微服務的/users/{userId}呢? // Feign重構后UserDTO userDTO = userCenterFeignClient.finById(userId);//消息的裝配ShareDTO shareDTO = new ShareDTO();BeanUtils.copyProperties(share, shareDTO);shareDTO.setWxNickname(userDTO.getWxNickname());return shareDTO;} }

2.5.2. 以前Ribbon調用方式

@Slf4j @Service @RequiredArgsConstructor(onConstructor = @__(@Autowired)) public class ShareServiceImpl implements IShareService {private final ShareMapper shareMapper;private final RestTemplate restTemplate;@Overridepublic ShareDTO findById(Integer id) {//獲取分享詳情Share share = this.shareMapper.selectByPrimaryKey(id);//發布人idInteger userId = share.getUserId();//怎么調用用戶微服務的/users/{userId}呢?//Ribbo重構后UserDTO userDTO = this.restTemplate.getForObject("http://user-center/users/{userId}", UserDTO.class, userId);//消息的裝配ShareDTO shareDTO = new ShareDTO();BeanUtils.copyProperties(share, shareDTO);shareDTO.setWxNickname(userDTO.getWxNickname());return shareDTO;}

2.6. 驗證

2.6.1. 啟動nacos注冊中心

2.6.2. 啟動user-center應用

2.6.3. 啟動content-center應用

2.6.4. 瀏覽器訪問

訪問：http://localhost:8082/shares/2

三、細粒度自定義配置

3. 自定義Feign日志級別

級別打印內容

NONE(默認值)	不記錄任何日志
BASIC	請求方法、URL、響應狀態碼以及執行時間
HEADERS	記錄BASIC級別的基礎上，記錄請求和相應的header
FULL	記錄請求響應的header、body和元數據

3.1. java代碼配置方式

3.1.1. 創建feign配置類

/*** feign的配置類* 這個類別加@Configuration注解,* 否則必須挪到@ComponentScan能掃描的包以外*/ public class UserCenterFeignConfiguration {@Beanpublic Logger.Level level(){ // 讓feign打印所有的請求細節return Logger.Level.FULL;} }

3.1.2. 在feign接口類上指定feign的配置類

@FeignClient(name = "user-center",configuration = UserCenterFeignConfiguration.class) public interface UserCenterFeignClient {/*** http://localhost:8082/users/{id}* @param id* @return*/@GetMapping("/users/{id}")UserDTO finById(@PathVariable Integer id); }

3.1.4. 添加監聽feign接口的打印體日志

logging:level:com.itmuch.contentcenter.feignclient.UserCenterFeignClient: debug

3.1.5. 驗證

訪問：http://localhost:8082/shares/2

3.2. 屬性配置方式

3.2.1 添加配置信息

• feign接口：

@FeignClient(name = "user-center") public interface UserCenterFeignClient {/*** http://localhost:8082/users/{id}* @param id* @return*/@GetMapping("/users/{id}")UserDTO finById(@PathVariable Integer id); }

• application.yml添加配置信息

##監聽feign接口的日志 logging:level:com.itmuch.contentcenter.feignclient.UserCenterFeignClient: debug #feign 細粒度日志級別屬性配置形式 feign:client:config:user-center: #想要調用微服務的應用名稱loggerLevel: full

3.2.2 重啟content-center應用

訪問：http://localhost:8082/shares/2

四、 全局配置自定義

4.1. java代碼方式(全局)

4.1.1 在啟動類上添加注解

@EnableFeignClients(defaultConfiguration = GlobalFeignConfiguration.class)
defaultConfiguration 指向feign的配置類即可

//掃描mybatis那些包里面的接口 @SpringBootApplication @MapperScan("com.itmuch") @EnableFeignClients(defaultConfiguration = GlobalFeignConfiguration.class) public class ContentCenterApplication {public static void main(String[] args) {SpringApplication.run(ContentCenterApplication.class, args);}}

4.1.2 feign配置類

/*** feign的配置類* 這個類別加@Configuration注解,* 否則必須挪到@ComponentScan能掃描的包以外*/ public class GlobalFeignConfiguration {@Beanpublic Logger.Level level(){ // 讓feign打印所有的請求細節return Logger.Level.FULL;} }

4.1.3 重啟content-center應用

訪問：http://localhost:8082/shares/2

4.2. 配置屬性方式(全局)

4.2.1 啟動類

@SpringBootApplication @MapperScan("com.itmuch") @EnableFeignClients public class ContentCenterApplication {public static void main(String[] args) {SpringApplication.run(ContentCenterApplication.class, args);}

4.2.2 配置文件屬性

##監聽feign接口的日志 logging:level:com.itmuch.contentcenter.feignclient.UserCenterFeignClient: debug #feign 全局日志級別屬性配置形式 feign:client:config:default:loggerLevel: full

4.2.3 重啟content-center應用

訪問：http://localhost:8082/shares/2

五、 feign支持的配置項

5.1. 代碼方式

配置項作用

Logger.level	置頂日志級別
Retryer	指定充實策略
ErrorDecoder	指定錯誤解碼器
Request.Options	超時時間
Conection<Requestinterception>	攔截器
SetterFactory	用于設置Hystrix的配置屬性，Feign整合Hystrix才會用

5.2. 屬性配置方式：

feign:client:config:<feignName>:connectTimeout: 5000 #連接超時時間readdTimeout: 5000 #連接超時時間loggerLevel: fullerrorDecoder: com.example.SimpleErrorDecoder #錯誤解碼器retryer: com.example.SimpleRetryer #重試策略requestInterceptors:- com.example.FooRequestInterceptor #攔截器#是否對404錯誤碼解碼#處理邏輯詳見feign.SynchronousMethodHander #executeAndDecodedecode404: falseencoder: com.example.SimpleEncoder #編碼器decoder: com.example.SimpleDecoder #解碼器contract: com.example.SimpleContract #契約

六、 配置最佳實踐總結

6.1. Ribbon配置vs Feign配置

方式粒度RibbonFeign

代碼	局部	@RibbonClient(Configuration=xx.class) X必須加@Configuration且必須放在父子上下文無法掃描的包	@FenginClient(configuration=Y.class) Y的@Configuration可選，如果有，不許放在父子上下文無法掃描的包即可
方式	全局	@RibbonClients(defaultConfiguration)	@EnableFeignClients//(defaultConfiguration = GlobalFeignConfiguration.class)
屬性	局部	.ribbon.NFLoadBalancerClassName	feign.client.config..loggerLevel
方式	全局		feign.client.config.default.loggerLevel

6.2. Feign代碼方式vs屬性方式

配置方式優點缺點

代碼配置	基于代碼靈活	如果Feign的配置類加了@Configuration注解需要注意父子上下文，線上修改需要重新打包、發布
屬性配置	易上手，配置更加直觀，線上修改不需要重新打包、發布優先級更高	極端場景下沒有代碼配置靈活

6.3. 配置優先級：

全局代碼<全局屬性<細粒度代碼<細粒度屬性

七、 最佳實踐：

盡量使用屬性配置，屬性配置實現不了了的阿情況下在考慮用代碼配置
在同一個微服務內盡量保持單一性，比如同一使用屬性配置，不要兩種方式混用，增加定位代碼的復雜性

總結

以上是生活随笔為你收集整理的05_SpringCloud整合声明式HTTP客户端-Feign的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。