Spring Cloud OpenFeign：基於Ribbon和Hystrix的宣告式服務呼叫

MacroZheng發表於2019-10-08
SpringCloud

SpringBoot實戰電商專案mall（20k+star）地址：github.com/macrozheng/…

摘要

Spring Cloud OpenFeign 是宣告式的服務呼叫工具，它整合了Ribbon和Hystrix，擁有負載均衡和服務容錯功能，本文將對其用法進行詳細介紹。

Feign簡介

Feign是宣告式的服務呼叫工具，我們只需建立一個介面並用註解的方式來配置它，就可以實現對某個服務介面的呼叫，簡化了直接使用RestTemplate來呼叫服務介面的開發量。Feign具備可插拔的註解支援，同時支援Feign註解、JAX-RS註解及SpringMvc註解。當使用Feign時，Spring Cloud整合了Ribbon和Eureka以提供負載均衡的服務呼叫及基於Hystrix的服務容錯保護功能。

建立一個feign-service模組

這裡我們建立一個feign-service模組來演示feign的常用功能。

在pom.xml中新增相關依賴

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
複製程式碼

在application.yml中進行配置

server:
  port: 8701
spring:
  application:
    name: feign-service
eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8001/eureka/
複製程式碼

在啟動類上新增@EnableFeignClients註解來啟用Feign的客戶端功能

@EnableFeignClients
@EnableDiscoveryClient
@SpringBootApplication
public class FeignServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(FeignServiceApplication.class, args);
    }

}
複製程式碼

新增UserService介面完成對user-service服務的介面繫結

我們通過@FeignClient註解實現了一個Feign客戶端，其中的value為user-service表示這是對user-service服務的介面呼叫客戶端。我們可以回想下user-service中的UserController，只需將其改為介面，保留原來的SpringMvc註釋即可。

/**
 * Created by macro on 2019/9/5.
 */
@FeignClient(value = "user-service")
public interface UserService {
    @PostMapping("/user/create")
    CommonResult create(@RequestBody User user);

    @GetMapping("/user/{id}")
    CommonResult<User> getUser(@PathVariable Long id);

    @GetMapping("/user/getByUsername")
    CommonResult<User> getByUsername(@RequestParam String username);

    @PostMapping("/user/update")
    CommonResult update(@RequestBody User user);

    @PostMapping("/user/delete/{id}")
    CommonResult delete(@PathVariable Long id);
}
複製程式碼

新增UserFeignController呼叫UserService實現服務呼叫

/**
 * Created by macro on 2019/8/29.
 */
@RestController
@RequestMapping("/user")
public class UserFeignController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public CommonResult getUser(@PathVariable Long id) {
        return userService.getUser(id);
    }

    @GetMapping("/getByUsername")
    public CommonResult getByUsername(@RequestParam String username) {
        return userService.getByUsername(username);
    }

    @PostMapping("/create")
    public CommonResult create(@RequestBody User user) {
        return userService.create(user);
    }

    @PostMapping("/update")
    public CommonResult update(@RequestBody User user) {
        return userService.update(user);
    }

    @PostMapping("/delete/{id}")
    public CommonResult delete(@PathVariable Long id) {
        return userService.delete(id);
    }
}
複製程式碼

負載均衡功能演示

  • 啟動eureka-service，兩個user-service，feign-service服務，啟動後註冊中心顯示如下：

Spring Cloud OpenFeign：基於Ribbon和Hystrix的宣告式服務呼叫

2019-10-04 15:15:34.829  INFO 9236 --- [nio-8201-exec-5] c.macro.cloud.controller.UserController  : 根據id獲取使用者資訊，使用者名稱稱為：macro
2019-10-04 15:15:35.492  INFO 9236 --- [io-8201-exec-10] c.macro.cloud.controller.UserController  : 根據id獲取使用者資訊，使用者名稱稱為：macro
2019-10-04 15:15:35.825  INFO 9236 --- [nio-8201-exec-9] c.macro.cloud.controller.UserController  : 根據id獲取使用者資訊，使用者名稱稱為：macro
複製程式碼

Feign中的服務降級

Feign中的服務降級使用起來非常方便，只需要為Feign客戶端定義的介面新增一個服務降級處理的實現類即可，下面我們為UserService介面新增一個服務降級實現類。

新增服務降級實現類UserFallbackService

需要注意的是它實現了UserService介面，並且對介面中的每個實現方法進行了服務降級邏輯的實現。

/**
 * Created by macro on 2019/9/5.
 */
@Component
public class UserFallbackService implements UserService {
    @Override
    public CommonResult create(User user) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult<User> getUser(Long id) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult<User> getByUsername(String username) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult update(User user) {
        return new CommonResult("呼叫失敗，服務被降級",500);
    }

    @Override
    public CommonResult delete(Long id) {
        return new CommonResult("呼叫失敗，服務被降級",500);
    }
}
複製程式碼

修改UserService介面，設定服務降級處理類為UserFallbackService

修改@FeignClient註解中的引數，設定fallback為UserFallbackService.class即可。

@FeignClient(value = "user-service",fallback = UserFallbackService.class)
public interface UserService {
}
複製程式碼

修改application.yml，開啟Hystrix功能

feign:
  hystrix:
    enabled: true #在Feign中開啟Hystrix
複製程式碼

服務降級功能演示

  • 關閉兩個user-service服務，重新啟動feign-service;

  • 呼叫http://localhost:8701/user/1進行測試，可以發現返回了服務降級資訊。

Spring Cloud OpenFeign：基於Ribbon和Hystrix的宣告式服務呼叫

日誌列印功能

Feign提供了日誌列印功能，我們可以通過配置來調整日誌級別，從而瞭解Feign中Http請求的細節。

日誌級別

  • NONE：預設的，不顯示任何日誌；
  • BASIC：僅記錄請求方法、URL、響應狀態碼及執行時間；
  • HEADERS：除了BASIC中定義的資訊之外，還有請求和響應的頭資訊；
  • FULL：除了HEADERS中定義的資訊之外，還有請求和響應的正文及後設資料。

通過配置開啟更為詳細的日誌

我們通過java配置來使Feign列印最詳細的Http請求日誌資訊。

/**
 * Created by macro on 2019/9/5.
 */
@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}
複製程式碼

在application.yml中配置需要開啟日誌的Feign客戶端

配置UserService的日誌級別為debug。

logging:
  level:
    com.macro.cloud.service.UserService: debug
複製程式碼

檢視日誌

呼叫http://localhost:8701/user/1進行測試，可以看到以下日誌。

2019-10-04 15:44:03.248 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] ---> GET http://user-service/user/1 HTTP/1.1
2019-10-04 15:44:03.248 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] ---> END HTTP (0-byte body)
2019-10-04 15:44:03.257 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] <--- HTTP/1.1 200 (9ms)
2019-10-04 15:44:03.257 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] content-type: application/json;charset=UTF-8
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] date: Fri, 04 Oct 2019 07:44:03 GMT
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] transfer-encoding: chunked
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] 
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] {"data":{"id":1,"username":"macro","password":"123456"},"message":"操作成功","code":200}
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] <--- END HTTP (92-byte body)
複製程式碼

Feign的常用配置

Feign自己的配置

feign:
  hystrix:
    enabled: true #在Feign中開啟Hystrix
  compression:
    request:
      enabled: false #是否對請求進行GZIP壓縮
      mime-types: text/xml,application/xml,application/json #指定壓縮的請求資料型別
      min-request-size: 2048 #超過該大小的請求會被壓縮
    response:
      enabled: false #是否對響應進行GZIP壓縮
logging:
  level: #修改日誌級別
    com.macro.cloud.service.UserService: debug
複製程式碼

Feign中的Ribbon配置

在Feign中配置Ribbon可以直接使用Ribbon的配置，具體可以參考Spring Cloud Ribbon：負載均衡的服務呼叫。

Feign中的Hystrix配置

在Feign中配置Hystrix可以直接使用Hystrix的配置，具體可以參考Spring Cloud Hystrix：服務容錯保護。

使用到的模組

springcloud-learning
├── eureka-server -- eureka註冊中心
├── user-service -- 提供User物件CRUD介面的服務
└── feign-service -- feign服務呼叫測試服務
複製程式碼

專案原始碼地址

github.com/macrozheng/…

公眾號

mall專案全套學習教程連載中，關注公眾號第一時間獲取。

公眾號圖片

相關文章