如何传递包含斜杠字符的字符串路径参数?

2022-01-21 00:00:00 spring java jersey

我有这个 REST 资源:

I have this REST resource:

@GET
@Path("{business},{year},{sample}")
@Produces(MediaType.APPLICATION_JSON)
public Response getSample(
        @PathParam("business") String business,
        @PathParam("year") String year,
        @PathParam("sample") String sampleId {
    Sample sample = dao.findSample(business, year, sampleId);
    return Response.ok(sample).build();
}

sample 参数可以包含斜杠字符:例如 6576/M982.

sample param can contain slash character: 6576/M982, for instance.

我用 http://ip:port/samples/2000,2006,6576/M982 调用它，但显然不起作用.

I'm calling it with http://ip:port/samples/2000,2006,6576/M982 but does not work, obviously.

我也尝试过使用 http://ip:port/samples/2000,2006,6576%2FM982，将斜杠编码为 %2F，但没有也不起作用，它没有到达端点.

I have also tried with http://ip:port/samples/2000,2006,6576%2FM982, encoding the slash as %2F, but doesn't work either, it doesn't reach the endpoint.

编辑

我正在使用 Retrofit 调用端点，我这样做:

I'm using Retrofit to call the endpoint and I do this:

@GET("/samples/{business},{year},{sampleId}")
Observable<Sample> getSampleById(
        @Path("business") String business,
        @Path("year") String year,
        @Path(value = "sampleId", encoded = true) String sampleId);

使用encoded = true，但还是不行.

推荐答案

、、/等保留字符必须进行URL编码.

Reserved characters such as , and / must be URL encoded.

  • , 被编码为 %2C
  • / 被编码为 %2F
  • , is encoded as %2C
  • / is encoded as %2F

试试http://ip:port/samples/2000%2C2006%2C6576%2FM982.

RFC 3986 定义了以下一组 可用作分隔符的保留字符.因此，它们需要 URL 编码:

The RFC 3986 defines the following set of reserved characters that can be used as delimiters. Hence, they require URL encoding:

: / ? # / [ ] / @ ! $ & ' ( ) * + , ; =

未保留字符不需要 URL 编码:

Unreserved characters do not require URL encoding:

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
a b c d e f g h i j k l m n o p q r s t u v w x y z
0 1 2 3 4 5 6 7 8 9 - _ . ~

如果 URL 编码 , 不适合您，您可以考虑使用查询参数.您的代码将如下所示:

If URL encoding , is not a good alternative for you, you could consider using query parameters. Your code will be like:

@GET
@Produces(MediaType.APPLICATION_JSON)
public Response getSample(@QueryParam("business") String business, 
                          @QueryParam("year") String year,
                          @QueryParam("sample") String sampleId {
    ...
}

您的网址将类似于 http://ip:port/samples?business=2000&year=2006&sample=6576%2FM982.

请注意，/ 仍然需要进行 URL 编码.

Please note that the / still needs to be URL encoded.

相关文章