OpenFeign高级用法：缓存、QueryMap、MatrixVariable、CollectionFormat优雅地远程调用

码到三十五： 个人主页

微服务架构中，服务之间的通信变得尤为关键。OpenFeign，一个声明式的Web服务客户端，使得REST API的调用变得更加简单和优雅。OpenFeign集成了Ribbon和Hystrix，具有负载均衡和容错的能力，并且在Spring Cloud的加持下，可以轻松地与注册中心（nacos，Eureka）和配置中心（Spring Cloud Config，nacos）等组件集成。

- - 一、OpenFeign简介
  - 二、OpenFeign的使用
  - - 1. 添加依赖
    - 2. 启用OpenFeign
    - 3. 定义Feign客户端
    - 4. 注入和使用Feign客户端
  - 三、@FeignClient注解
  - 四、feign缓存
  - - 1. Feign缓存的意义
    - 2. feign缓存的使用
  - 五、@QueryMap支持
  - - 使用方法
  - 六、@MatrixVariable支持
  - - 使用 `@MatrixVariable`
    - URI 结构
  - 七、@CollectionFormat支持
  - 八、其他高级特性
  - 总结

一、OpenFeign简介

OpenFeign是一个声明式的Web服务客户端，它使得编写HTTP客户端变得更简单。使用Feign，你只需要创建一个接口并用注解来配置它，Feign会自动完成接口的实现。OpenFeign具有可插拔的注解特性，同时也支持JAX-RS注解和Feign注解。此外，它还支持负载均衡和容错，通过集成Spring Cloud alibaba和Spring Cloud，可以轻松地查找服务并进行调用。
在这里插入图片描述

二、OpenFeign的使用

1. 添加依赖

首先需要在项目中添加OpenFeign的依赖。Maven可以在pom.xml文件中添加以下依赖：

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

2. 启用OpenFeign

在spring Boot应用主类上添加@EnableFeignClients注解，以启用OpenFeign。

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

3. 定义Feign客户端

定义Feign客户端接口，并使用@FeignClient注解进行配置。假设有一个名为user-service的远程服务，可以这样定义一个Feign客户端：

@FeignClient("user-service")
public interface UserClient {@GetMapping("/users/{id}")User getUser(@PathVariable("id") Long id);
}

@FeignClient注解指定了要调用的远程服务的名称（在本例中是user-service），而接口中的方法则定义了具体的HTTP请求。@GetMapping注解表示这是一个GET请求，@PathVariable注解则用于从URL路径中提取参数。

4. 注入和使用Feign客户端

一旦你定义了Feign客户端接口，你就可以在你的服务中注入并使用它了。例如：

@Service
public class UserService {private final UserClient userClient;@Autowiredpublic UserService(UserClient userClient) {this.userClient = userClient;}public User getUser(Long userId) {return userClient.getUser(userId);}
}

在这个例子中，UserService类注入了UserClient的实例，并通过它来调用远程服务。当你调用getUser方法时，OpenFeign会自动将HTTP请求发送到指定的远程服务，并将响应映射到Java对象上。

在这里插入图片描述

三、@FeignClient注解

@FeignClient注解是用于标记Feign客户端接口的关键注解。通过此注解，OpenFeign能够自动生成接口的实现，使得开发者能够以声明式的方式调用远程服务。

下面是@FeignClient注解的详细参数及其用法：

name：
- 含义：指定Feign客户端的名称，这个名称通常用于服务发现和服务间的负载均衡。在微服务架构中，这个名称通常与服务提供者在服务注册中心注册的服务名相对应。
- 用法：@FeignClient(name = "serviceName")，其中"serviceName"是远程服务的名称。
url：
- 含义：直接指定Feign客户端的请求地址。当该参数被设置时，Feign将不再从服务注册中心获取服务地址，而是直接使用这个URL作为请求的目标地址。
- 用法：@FeignClient(url = "http://localhost:8080")，指定具体的服务地址。
- 注意：如果同时指定了name和url，url会覆盖name中定义的地址。
configuration：
- 含义：指定Feign客户端的配置类。在这个配置类中，可以自定义Feign的各种参数，如请求拦截器、编码器、解码器等。
- 用法：@FeignClient(configuration = CustomFeignConfiguration.class)，其中CustomFeignConfiguration是自定义的配置类。
fallback：
- 含义：指定Feign客户端的降级方案。当请求出现异常时，如远程服务不可用或请求超时，Feign会返回fallback指定的实例的数据。这通常用于实现熔断和降级逻辑，以提高系统的稳定性。
- 用法：@FeignClient(fallback = UserClientFallback.class)，其中UserClientFallback是实现了Feign客户端接口的降级处理类。
fallbackFactory：
- 含义：与fallback类似，但是提供了一个工厂类来创建降级逻辑的实例。这个工厂类需要实现FallbackFactory接口，并覆盖create(Throwable cause)方法。这个方法返回一个实现了Feign客户端接口的实例，用于处理降级逻辑。
- 用法：通常与Hystrix等熔断框架结合使用，提供更灵活的降级策略。
path：
- 含义：定义所有方法请求的基础路径。这样可以在Feign客户端的接口方法中省略这个基础路径。
- 用法：@FeignClient(path = "/api/users")，指定所有请求的基础路径。
qualifier：
- 含义：当使用Spring的自动装配功能时，可以使用qualifier参数来指定一个bean的名称，以便在多个相同类型的Feign客户端之间进行区分。
- 用法：通常与@Qualifier注解结合使用，用于解决自动装配时的歧义。
decode404：
- 含义：指定当服务端返回404状态时是否抛出FeignException。默认情况下，Feign会将404视为一个正常的响应（即不会抛出异常）。如果将此参数设置为true，则当服务端返回404状态时，Feign会抛出一个FeignException。
- 用法：在需要特殊处理404响应的场景中使用。
primary：
- 含义：当存在多个相同类型的bean时，将此参数设置为true可以将该bean设置为首选bean。这样，在使用@Autowired进行自动装配时，Spring会优先选择标记为primary的bean。
- 用法：在需要指定首选bean的场景中使用。

此外，@FeignClient注解还支持使用Spring Expression Language (SpEL) 表达式来动态地指定某些参数值。例如，可以使用${property.name}来从配置文件或环境变量中读取值。这种动态配置方式使得Feign客户端更加灵活和可配置。

四、feign缓存

1. Feign缓存的意义

在网络请求中，频繁地调用相同的接口会消耗大量的时间和资源。通过引入缓存机制，可以将一些不经常变化且查询频繁的数据存储在本地，从而减少对远程服务的调用，提高系统的响应速度和性能。

Feign 缓存是通过结合 Spring Framework 的缓存抽象来实现的。当你使用 @EnableCaching 注解时，Spring Boot 会启用对 @Cacheable、@CacheEvict、@CachePut 等缓存相关注解的支持。对于 Feign 客户端来说，这意味着你可以在 Feign 接口的方法上使用这些注解来控制缓存行为。

2. feign缓存的使用

启用缓存

首先在 Spring Boot 应用中使用 @EnableCaching 注解来启用缓存支持。这通常是在配置类或者启动类上添加的。

@EnableCaching
@SpringBootApplication
public class MyApp {public static void main(String[] args) {SpringApplication.run(MyApp.class, args);}
}

使用 @Cacheable 注解

在Feign 客户端接口中，可以使用 @Cacheable 注解来标记需要缓存的方法。这个注解指定了缓存的名称（cacheNames）和用于生成缓存键的表达式（key）。

@FeignClient("some-service")
public interface SomeServiceClient {@Cacheable(cacheNames = "infos", key = "#id")@GetMapping("/info/{id}")public Object info(@PathVariable("id") Integer id);
}

info 方法被标记为可缓存的。当这个方法被调用时，Spring 会检查名为 infos 的缓存中是否已经有对应 id 的缓存项。如果有，就直接返回缓存的数据；如果没有，就执行远程调用，并将结果存储到缓存中。

配置缓存管理器

通过配置文件来指定缓存管理器的类型和其他相关设置。使用了Redis 作为缓存存储，并配置了 Redis 缓存的相关参数。

spring:cache:type: redis # 指定缓存类型为 Redisredis:key-prefix: 'feign:' # 设置 Redis 缓存键的前缀time-to-live: 60s # 设置缓存的有效期为 60 秒

这样配置后，Feign 客户端的缓存数据会被存储到 Redis 中，并且每个缓存项的有效期为 60 秒。这意味着在 60 秒内对同一个 id 的多次请求都会直接从 Redis 缓存中获取数据，而不会触发远程调用。当缓存过期后，下一次请求会触发远程调用，并更新缓存。

五、@QueryMap支持

在Feign中使用@QueryMap或Spring Cloud OpenFeign中的@SpringQueryMap注解可以非常方便地将一个POJO（Plain Old Java Object，即简单的Java对象）或Map的属性和值映射为HTTP GET请求的查询参数。这在构建具有多个查询参数的API调用时特别有用，因为它允许你以声明式的方式组织这些参数，而不是手动构建查询字符串。

简单点说：可以将一个对象中的所有属性值以get的方式拼接到地址栏进行传递。

@QueryMap 和 @SpringQueryMap

@QueryMap: OpenFeign原生提供的注解，用于将POJO映射为查询参数。但是，它与Spring不兼容，因为它没有value属性。
@SpringQueryMap: Spring Cloud OpenFeign提供的与Spring兼容的注解，功能和@QueryMap类似，但可以在Spring环境中使用。

使用方法

定义参数对象:
创建一个简单的Java类Params，并为其添加属性和getter方法。这些属性和方法将用于生成查询参数。

   public class Params {private Long id;private String name;// getters and setters}

在Feign客户端中使用@SpringQueryMap:
在Feign客户端接口中，使用@GetMapping注解来定义一个GET请求，并使用@SpringQueryMap注解来标记你的POJO参数。

   @FeignClient("some-service")public interface DemoFeign {@GetMapping("/format")Object format(@SpringQueryMap Params params);}

调用Feign客户端:
在服务中创建一个Params对象，设置其属性，并通过Feign客户端调用该方法。

   @GetMapping("/format")public Object format(Params params) {return demoFeign.format(params);}

日志输出:
当调用这个方法时，Feign会自动将Params对象的属性转换为查询参数，并附加到GET请求的URL上。可以通过查看Feign的请求日志来确认这一点。

[DemoFeign#format] ---> GET http://localhost:8088/demos/format?name=test&id=111 HTTP/1.1

通过这种方式，可以简洁地将复杂的查询参数组织到一个对象中，并让Feign自动处理参数到查询字符串的转换，从而简化了代码并提高了可读性。

六、@MatrixVariable支持

在Spring Cloud OpenFeign中，@MatrixVariable 注解被用来处理 URI 中的矩阵变量。矩阵变量是 URI 的一种特殊参数形式，允许你在 URI 路径段中直接包含键值对。这种形式的参数在某些 RESTful API 设计中很有用，尤其是当你需要在 URI 中传递多个参数，并且这些参数都是针对同一资源的时候。

使用 `@MatrixVariable`

@MatrixVariable 被用来接收一个映射（Map），其中键是字符串，值是字符串列表。这在处理可能包含多个值的矩阵变量时非常有用。

@GetMapping("/m3/{params}")
public Object matrix3(@MatrixVariable Map<String, List<String>> params) {// ...
}

{params} 是一个路径占位符，它表示这个部分将由传递的矩阵变量填充。@MatrixVariable 注解告诉 Spring，params 参数应该接收来自 URI 矩阵变量的值。

URI 结构

一个包含矩阵变量的 URI 看起来像这样：

/m3/someValue;key1=value1a,value1b;key2=value2

在这个 URI 中：

/m3/someValue 是基本的路径。
;key1=value1a,value1b;key2=value2 是矩阵变量部分，其中 key1 和 key2 是矩阵变量的名称，value1a,value1b 和 value2 是相应的值。

注意事项

路径占位符的名称（在这个例子中是 {params}）必须与 @MatrixVariable 注解的变量名一致，或者你可以在注解中明确指定名称。
矩阵变量的值可以是单个值，也可以是用逗号分隔的多个值，这取决于你的 API 如何设计。
使用矩阵变量时，要确保你的 URI 编码和解码逻辑能够正确处理这些变量，特别是当值中包含特殊字符时。

七、@CollectionFormat支持

在Feign中，@CollectionFormat 注解用于指定集合参数的格式化方式。当你在Feign客户端的方法中使用集合类型的参数（如 List<String>）时，这个注解能够帮助你定义如何将集合中的元素串联起来，以便通过HTTP请求发送给服务端。

@CollectionFormat 注解接受一个 feign.CollectionFormat 枚举值，该枚举定义了不同的格式化选项。在你提供的例子中，展示了两种格式化方式：CSV 和 PIPES。

CSV (Comma Separated Values):
当使用 feign.CollectionFormat.CSV 时，集合中的元素会使用逗号 , 进行分隔。这是最常见和默认的格式。

示例：
```
@GetMapping("/cf")
@CollectionFormat(feign.CollectionFormat.CSV)
public Object cf(@RequestParam("ids") List<String> ids);
```
调用该方法并传递 List.of("S1", "S2", "S3") 时，生成的URL查询参数会是 ids=S1,S2,S3。
PIPES (| separator):
当使用 feign.CollectionFormat.PIPES 时，集合中的元素会使用竖线 | 进行分隔。

示例：
```
@GetMapping("/cf")
@CollectionFormat(feign.CollectionFormat.PIPES)
public Object cf(@RequestParam("ids") List<String> ids);
```
同样地，调用该方法并传递 List.of("S1", "S2", "S3") 时，生成的URL查询参数会是 ids=S1|S2|S3。

这个注解在处理需要特定格式的集合参数时非常有用，尤其是当服务端期望接收特定格式的集合数据时。通过使用 @CollectionFormat，你可以确保Feign客户端发送的请求符合服务端的期望，从而避免格式错误导致的问题。

@CollectionFormat 可以应用于整个Feign客户端类或者单独的方法上。如果应用于类上，它将影响该类中所有使用集合参数的方法。如果只需要对某个特定方法应用不同的集合格式，可以将注解直接应用于该方法上。

八、其他高级特性

OpenFeign还提供了许多高级特性，如负载均衡、容错、请求拦截和重试等。这些特性可以帮助构建更健壮、更可靠的微服务架构。

负载均衡：OpenFeign集成了Ribbon，支持多种负载均衡策略，如轮询、随机等。你可以根据需要选择合适的策略来分发请求。
容错：通过与Hystrix的集成，OpenFeign提供了熔断和降级功能。当远程服务出现故障或响应过慢时，可以自动切换到降级逻辑，保证系统的稳定性。
请求拦截：可以使用RequestInterceptor接口实现自定义的请求拦截器，用于在发送请求之前或之后执行特定的逻辑，如添加认证信息、记录日志等。
重试机制：OpenFeign支持配置请求的重试次数和间隔，以提高系统的可靠性。