Jersey 客户端/JAX-RS 和可选（非默认）@QueryParam（客户端）

Question

我有一个 RESTful API，它的文档说某个查询参数是可选的，并且不提供默认参数。因此，我可以提供该值，也可以不将其作为参数在 GET 请求中发送。

例子：

• queryA 为必填项
• queryB 是可选的（可以在没有它的情况下发送GET）

这应该可行：

http://www.example.com/service/endpoint?queryA=foo&queryB=bar

这也应该有效：

http://www.example.com/service/endpoint?queryA=foo

如何为Jersey-Proxy 制作一个可以做到这一点的客户端界面？ 我没有要与之交互的服务器端代码，因此我通过 Jersey-Proxy 使用 org.glassfish.jersey.client.proxy.WebResourceFactory 来生成客户端以与服务器 API 进行交互。

示例界面：

import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/service")
@Produces("application/json")
public interface ServiceInterface {

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first,
            @QueryParam("queryB") String second);

}

我知道我可以制作另一种方法：

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first);

但是当您有多个可选字段时会发生什么？我不想对它们进行所有可能的突变！

Answer 1

界面一直都是对的

我不敢相信这么容易：

import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/service")
@Produces("application/json")
public interface ServiceInterface {

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first,
            @QueryParam("queryB") String second);

}

请注意与问题界面不同的地方？？没有。那是因为这就是答案！

---

不要将@DefaultValue 用于可选参数

如果你想将一个参数默认为一个特定的值，你可以在参数中使用@DefaultValue注解：

import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/service")
@Produces("application/json")
public interface ServiceInterface {

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first,
            @QueryParam("queryB") @DefaultValue("default") String second);

}

---

将null 传递给您不想要的@QueryParam

如果要使@QueryParam 可选，则不要应用@DefaultValue 注释。 要使用查询参数传递值，只需正常传递值即可。如果您希望查询参数根本不显示，只需传递null！

import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/service")
@Produces("application/json")
public interface ServiceInterface {

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first,
            // Pass null to this parameter to not put it in the GET request
            @QueryParam("queryB") String second);

}

所以调用ServiceInterface.getEndpoint("firstQueryParam", "secondQueryParam");调用：

http://targethost.com/service/endpoint?queryA=firstQueryParam&queryB=secondQueryParam

并致电ServiceInterface.getEndpoint("firstQueryParam", null); 致电：

http://targethost.com/service/endpoint?queryA=firstQueryParam

还有瓦拉！没有第二个查询参数！ :)

原始值注意事项

如果您的 API 采用原始值（例如 int、float、boolean 等），则为该原始值使用对象包装类 (Autoboxing)（例如 Integer、Float、 Boolean 等）。然后，您可以将null 传递给方法：

public Response getEndpoint(@QueryParam("queryA") Boolean first);

Answer 2

您可以将UriInfo 实例（或HttpServletRequest 之类的其他东西）注入到您的方法中，并从中获取您想要的任何数据。

例如

@Path("/endpoint")
@GET
public Response getEndpoint(@Context UriInfo info, @QueryParam("queryA") String queryA) {
  String queryB = info.getQueryParameters().getFirst("queryB");
  if (null != queryB) {
    // do something with it
  }
  ...
}