Feign Client 不解析 Query 参数

Question

这是我的界面。

public interface SCIMServiceStub {

    @RequestLine("GET /Users/{id}")
    SCIMUser getUser(@Param("id") String id);

    @RequestLine("GET /Groups?filter=displayName+Eq+{roleName}")
    SCIMGroup isValidRole(@Param("roleName") String roleName);

}

这里getUser 调用工作正常。但是isValidRole 无法正常工作，因为请求最终是这样发送的。

/Groups?filter=displayName+Eq+{roleName}"

此处{roleName} 未解决。我在这里想念什么？感谢一些帮助，因为我现在一无所知。

编辑：还有1个问题：有没有办法避免查询参数的自动url编码？

Answer 1

最近（2019.04）open feign issue和spring doc说：

OpenFeign @QueryMap 注解支持 POJO 用作 GET 参数映射。

Spring Cloud OpenFeign 提供了等效的@SpringQueryMap注解，用于将POJO或Map参数注解为2.1.0以来的查询参数映射。

你可以这样使用它：

    @GetMapping("user")
    String getUser(@SpringQueryMap User user);

public class User {
    private String name;
    private int age;
    ...
}

Answer 2

好像是已经打开的bug导致的——https://github.com/OpenFeign/feign/issues/424

就像在 cmets 中一样，您可以定义自己的 Param.Expander 作为解决方法，如下所示。

@RequestLine("GET /Groups?filter={roleName}")
String isValidRole(@Param(value = "roleName", expander = PrefixExpander.class) String roleName);

static final class PrefixExpander implements Param.Expander {
    @Override
    public String expand(Object value) {
        return "displayName+Eq+" + value;
    }
}

Answer 3

使用@QueryMap 工作正常

网址：/api/v1/task/search?status=PENDING&size=20&page=0

Map<String, String> parameters = new LinkedHashMap<>()
        parameters.put("status", "PENDING")
        parameters.put("size", "20")
        parameters.put("page", "0")
        def tasks = restClientFactory.taskApiClient.searchTasks(parameters)

客户端界面内部

@RequestLine("GET /api/v1/task/search?{parameters}")
List<Task> searchTasks(@QueryMap Map<String, String> parameters)

Answer 4

下面的 Spring feign 客户端可以正常工作：

@GetMapping("/Groups?filter=displayName+Eq+{roleName}")
    SCIMGroup isValidRole(@PathVariable(value = "roleName") String roleName);