使用Jersey 2.21的REST API请求中的可选参数

Question

我在玩Jersey 2.21，我想知道是否有可能在向服务器发出的请求中包含“可选”参数。

我想成功访问这两种方法：

http://localhost:8080/my_domain/rest/api/myMethod/1
http://localhost:8080/my_domain/rest/api/myMethod

如您所见，我正在尝试使integer（id）参数成为可选参数。

我声明myMethod如下：

@GET
@Path("myMethod/{id}")
@Produces(MediaType.APPLICATION_JSON + ";charset=UTF-8")
public String myMethod(@PathParam("id") Integer id, @Context HttpHeaders hh)

这有效：

http://localhost:8080/my_domain/rest/api/myMethod/1

这也有效：

http://localhost:8080/my_domain/rest/api/myMethod/

但这 行不通 ，我也不明白为什么。它抛出一个404 Not Found错误：

http://localhost:8080/my_domain/rest/api/myMethod

您能为我指出正确的方向进行解决吗？我不希望在所有REST方法调用中都必须使用斜杠，并且希望在可能的情况下取消斜杠。

Answer 1

因此，在仔细研究了Jax-RS的Optional@PathParam中的一些答案之后，问题是使用此方法

@Path("/myMethod{id: (/\\d+)?}") 
public Response get(@PathParam("id") int id) {}

使/处于捕获组中。因此，当Jersey尝试解析时/1，它将获得一个异常并发送404。我们可以使用String，但是随后它变得很丑陋，因为我们需要摆脱前导/并 自行解析它。

@Path("/myMethod{id: (/\\d+)?}") 
public Response get(@PathParam("id") String id) {
    id = id.replace("/", "");
    int parsed = Integer.parseInt(id);
}

我想出的另一种解决方案（一种适用于OP的解决方案）是/将数字与数字分隔成两个不同的路径表达式，这样/就不会在实际的id中捕获前导并且不会导致解析失败

@Path("/method{noop: (/)?}{id: ((?<=/)\\d+)?}")
public Response get(@PathParam("id") int id) {}

在{noop: (/)?}捕获可选/。并且后面{id:((?<=/)\\d+)?}使用正号，表示\\d+当且仅当前面有一个/（(?<=/)）时才允许使用数字（）。这是必需的，因为/是可选的。如果我们不使用此断言，/myMethod123则将被允许。

这是使用Jersey测试框架的完整测试案例

public class OptionalParamTest extends JerseyTest {

    @Path("optional")
    public static class Resource {
        @GET
        @Path("/method{noop: (/)?}{id: ((?<=/)\\d+)?}")
        public String get(@PathParam("id") int id) {
            return String.valueOf(id);
        }
    }

    @Override
    public ResourceConfig configure() {
        return new ResourceConfig(Resource.class);
    }

    @Test
    public void should_return_id_1() {
        Response response = target("optional/method/1").request().get();
        System.out.println("status=" + response.getStatus());
        assertEquals("1", response.readEntity(String.class));
    }

    @Test
    public void should_return_id_0_with_no_id() {
        Response response = target("optional/method").request().get();
        assertEquals(200, response.getStatus());
        assertEquals("0", response.readEntity(String.class));
    }

    @Test
    public void should_return_404_with_numbers_and_no_slash() {
        Response response = target("optional/method12").request().get();
        assertEquals(404, response.getStatus());
    }

    @Test
    public void should_return_404_with_numbers_and_letters() {
        Response response = target("optional/method/12b").request().get();
        assertEquals(404, response.getStatus());
    }

    @Test
    public void should_return_404_with_only_letters() {
        Response response = target("optional/method/ab").request().get();
        assertEquals(404, response.getStatus());
    } 
}

这是测试的依赖项

<dependency>
    <groupId>org.glassfish.jersey.test-framework.providers</groupId>
    <artifactId>jersey-test-framework-provider-grizzly2</artifactId>
    <version>${jersey2.version}</version>
    <scope>test</scope>
</dependency>

编辑

对于测试，最好使用盒装Integer而不是int方法参数。使用前者，您将能够执行空检查，而不用接收0原始图元的默认值。