Matarialize中文社区-Spring Cloud OpenFeign

Spring Cloud OpenFeign

~~情~非~ 2024-07-30 17:12:07

313 Spring Cloud OpenFeign 专栏

Spring Cloud OpenFeign 是一个声明式的 REST 客户端，它让编写 HTTP 客户端变得简单和优雅。在微服务架构中，各个服务之间常常需要相互通信，而 OpenFeign 通过声明式接口和注解的方式简化了服务调用，自动处理负载均衡、熔断器和重试等功能。

Spring Cloud OpenFeign 的主要功能

声明式 HTTP 客户端：通过接口和注解定义 HTTP 请求，无需编写具体的 HTTP 请求代码。
负载均衡：与 Spring Cloud LoadBalancer 集成，实现客户端负载均衡。
熔断器：可以与 Hystrix 或 Resilience4j 集成，提供熔断和重试机制。
超时和重试：支持请求的超时设置和重试策略。
请求拦截器：可以对请求进行拦截和修改。
日志记录：提供了请求和响应的详细日志记录功能。

Spring Cloud OpenFeign 使用示例

下面是一个使用 Spring Cloud OpenFeign 的完整示例，包括项目创建、配置和使用。

1. 创建 Spring Boot 项目

使用 Spring Initializr 创建一个新的 Spring Boot 项目，选择以下依赖：

Spring Web
Spring Cloud OpenFeign
Spring Boot Actuator

2. 添加依赖

在 pom.xml 中添加 Spring Cloud OpenFeign 依赖：

<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>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

3. 启用 Feign 客户端

在项目的主类中，使用 @EnableFeignClients 注解启用 Feign 客户端：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients
public class FeignClientApplication {

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

4. 创建 Feign 客户端接口

定义一个接口，并使用 Feign 的注解来声明 HTTP 请求：

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

// 定义 Feign 客户端接口
@FeignClient(name = "user-service", url = "http://localhost:8081")
public interface UserClient {

    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") Long id);
}

在上面的代码中：

@FeignClient：定义一个 Feign 客户端，name 指定服务的名称，url 指定服务的地址（在使用 Eureka 或其他注册中心时可以省略 url）。
@GetMapping：定义 HTTP GET 请求，类似于 Spring MVC 的注解。
@PathVariable：用于从 URL 中提取路径变量。

5. 创建实体类

创建一个简单的实体类，用于接收用户信息：

public class User {
    private Long id;
    private String name;
    private String email;

    // Getters and Setters
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

6. 使用 Feign 客户端

在 Spring Boot 应用中使用 Feign 客户端调用其他服务：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @Autowired
    private UserClient userClient;

    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        return userClient.getUserById(id);
    }
}

7. 配置文件

在 application.yml 中配置基本信息：

server:
  port: 8080

spring:
  application:
    name: feign-client-service

feign:
  client:
    config:
      default:
        connect-timeout: 5000
        read-timeout: 5000
        loggerLevel: full

feign.client.config.default.connect-timeout：设置连接超时时间。
feign.client.config.default.read-timeout：设置读取超时时间。
feign.client.config.default.loggerLevel：设置日志记录级别（NONE、BASIC、HEADERS、FULL）。

8. 启动项目

运行 FeignClientApplication 类，启动 Spring Boot 应用。

9. 测试 Feign 客户端

使用 Curl 或 Postman 测试 Feign 客户端：

curl http://localhost:8080/users/1

假设用户服务返回如下 JSON 响应：

{
  "id": 1,
  "name": "John Doe",
  "email": "john.doe@example.com"
}

Feign 客户端将接收到并返回相同的响应。

10. 添加熔断器

为了增强服务的稳定性和容错能力，可以为 Feign 客户端添加熔断器。Spring Cloud OpenFeign 可以与 Resilience4j 或 Hystrix 集成来实现熔断器。

使用 Resilience4j 添加熔断器

添加依赖

在 pom.xml 中添加 Resilience4j 依赖：

<dependency>
    <groupId>io.github.resilience4j</groupId>
    <artifactId>resilience4j-spring-boot2</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-circuitbreaker-resilience4j</artifactId>
</dependency>

配置熔断器

在 application.yml 中配置 Resilience4j 熔断器：

resilience4j:
  circuitbreaker:
    configs:
      default:
        registerHealthIndicator: true
        slidingWindowSize: 100
        failureRateThreshold: 50
        waitDurationInOpenState: 10000
        permittedNumberOfCallsInHalfOpenState: 10
        minimumNumberOfCalls: 10
        slidingWindowType: COUNT_BASED

使用熔断器

在 Feign 客户端接口上添加熔断器的回退方法：

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(name = "user-service", url = "http://localhost:8081", fallback = UserClientFallback.class)
public interface UserClient {

    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") Long id);
}

// 定义回退类
@Component
public class UserClientFallback implements UserClient {

    @Override
    public User getUserById(Long id) {
        User user = new User();
        user.setId(id);
        user.setName("Default User");
        user.setEmail("default@example.com");
        return user;
    }
}

在上面的代码中，当 getUserById 方法调用失败时，将使用 UserClientFallback 中的回退方法提供默认的响应。