Spring Cloud 声明式REST客户端 OpenFeign -- 10. 注解@QueryMap支持

使用@SpringQueryMap注解

最新推荐文章于 2025-10-15 14:36:49 发布

原创最新推荐文章于 2025-10-15 14:36:49 发布 · 5.4k 阅读

2 ·

CC 4.0 BY-SA版权

Spring cloud 专栏收录该内容

15 篇文章

订阅专栏

在Spring Cloud OpenFeign中，@SpringQueryMap注解允许将POJO对象作为GET请求的参数map使用，解决了OpenFeign默认注解@QueryMap与Spring不兼容的问题。本文介绍如何使用@SpringQueryMap将一个包含多个属性的POJO转化为查询参数。

OpenFeign注解@QueryMap 支持将POJO对象用作GET map参数。但很不幸，该OpenFeign缺省注解跟Spring不兼容，因为它缺少一个属性value。

但是Spring Cloud OpenFeign提供了一个功能上等价的注解@SpringQueryMap ,使用该注解，可以将一个POJO或者Map作为一个请求参数query parameter map.

比如，我们有一个POJO Params,定义两个属性param1和param2 :

// Params.java
public class Params {
    private String param1;
    private String param2;

    // [Getters and setters omitted for brevity]
}

那么下面的feign客户端就可以使用注解@SpringQueryMap将Params作为一个query parameter map使用 :

@FeignClient("demo")
public class DemoTemplate {

    // 该用法相当于要传递两个GET参数 : param1 和 param2
    @GetMapping(path = "/demo")
    String demoEndpoint(@SpringQueryMap Params params);
}