什么时候使用@QueryParam和@PathParam

我不是在问这里已经问过的问题: @PathParam和@QueryParam有什么区别

这是一个“最佳实践”或惯例问题。

什么时候使用@PathParam vs @QueryParam。

我能想到的是，这个决定可能是用这两者来区分信息模式。让我在下面说明我的LTPO -不完美的观察。

PathParam的使用可以保留在信息类别中，这将很好地归入信息树的一个分支。PathParam可以用于下钻到实体类层次结构。

然而，QueryParam可以保留用于指定属性以定位类的实例。

例如,

/ Vehicle /车?车主= 123 / House /克?该区域= newengland

(category) ?instance

@GET
@Path("/employee/{dept}")
Patient getEmployee(@PathParam("dept")Long dept, @QueryParam("id")Long id) ;

vs / category (instance)

@GET
@Path("/employee/{dept}/{id}")
Patient getEmployee(@PathParam("dept")Long dept, @PathParam("id")Long id) ;

vs ?类别+实例

@GET
@Path("/employee")
Patient getEmployee(@QueryParam("dept")Long dept, @QueryParam("id")Long id) ;

我不认为这样做有一个标准的惯例。是吗?然而，我想知道人们如何使用PathParam和QueryParam来区分他们的信息，就像我上面举例的那样。我也很想知道这种做法背后的原因。

当前回答

@QueryParam可以方便地与默认值注释一起使用，这样如果没有传递查询参数，就可以避免空指针异常。

当您希望解析来自GET请求的查询参数时，您可以简单地为处理GET请求的方法定义相应的参数，并使用@QueryParam注释对它们进行注释

@PathParam提取URI值并与@Path匹配。从而得到输入参数。 @PathParam可以有多个，并且设置为方法参数 @ path(" /休息”) 公共类Abc { @ get @ path(" /味精/ {p0} / {p1}”) 与@ (" text / plain”) public String add(@PathParam("p0") Integer param1， @PathParam("p1") Integer param2) ｛返回String.valueOf (param1 + param2); ｝｝

在上面的例子中， http://localhost: 8080 / Restr /休息/味精/ {p0} / {p1}, P0匹配param1 p1匹配param2。对于URI来说 http://localhost: 8080 / Restr /休息/味精/ 4/6, 结果是10。

在REST服务中，JAX-RS提供了@QueryParam和@FormParam来接受来自HTTP请求的数据。HTTP表单可以通过不同的方法提交，比如GET和POST。

@QueryParam:接受GET请求并从查询字符串中读取数据。

@FormParam:接受POST请求并从HTML表单或媒体的任何请求中获取数据

2016-01-21 12:03:12

其他回答

我喜欢以下几点:

@PathParam

当需要参数时，例如ID, productNo .

GET /user/details/{ID}
GET /products/{company}/{productNo}

@QueryParam

当您需要传递可选参数，如过滤器，在线状态和他们可以为空

GET /user/list?country=USA&status=online
GET /products/list?sort=ASC

同时使用时

GET /products/{company}/list?sort=ASC

2022-06-02 10:16:17

这是个很有趣的问题。

你可以同时使用它们，关于这个主题没有任何严格的规则，但是使用URI路径变量有一些优点:

缓存: 大多数互联网上的web缓存服务不缓存GET请求时，他们包含查询参数。他们这样做是因为有很多RPC系统使用GET请求来更改服务器中的数据(失败!!)Get必须是一个安全的方法)

但是如果使用路径变量，所有这些服务都可以缓存GET请求。

层次结构: 路径变量可以表示层次结构: /城市/街道/的地方

它为用户提供了关于数据结构的更多信息。

但如果你的数据没有任何层次关系，你仍然可以使用Path变量，使用逗号或分号:

/城市/经度,纬度

作为规则，当参数的顺序重要时使用逗号，当顺序不重要时使用分号:

/ IconGenerator /红色,蓝色,绿色

除了这些原因之外，在某些情况下，使用查询字符串变量是非常常见的:

当您需要浏览器自动将HTML表单变量放入URI时当你处理算法的时候。例如谷歌引擎使用查询字符串:

http:// www.google.com/search ? q =休息

总而言之，没有任何强烈的理由使用这种方法，但只要可以，就使用URI变量。

2015-02-13 09:11:39

可以使用查询参数进行过滤，使用路径参数进行分组。下面的链接有关于何时使用pathParams或QueryParams的很好的信息

2012-07-19 00:43:40

对于资源名称和id，我使用@PathParams。对于可选变量，我使用@QueryParams

2020-11-20 09:59:31