什么时候使用@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来区分他们的信息，就像我上面举例的那样。我也很想知道这种做法背后的原因。

当前回答

根据我的理解:

使用@PathParam -当它是一个强制性的项目，如Id 获得/气球/ {id} 使用@QueryParam -当你有确切的资源，但需要过滤一些可选的特征，如颜色，大小等。得到/气球/ 123 ?颜色= red&size =

其他回答

原因其实很简单。当使用查询参数时，你可以输入字符，如“/”，你的客户端不需要对它们进行html编码。还有其他原因，但这只是一个简单的例子。至于何时使用路径变量。我想说的是，当你处理id或者路径变量是一个查询的方向时。

根据我的理解:

我喜欢以下几点:

@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

REST本身可能不是一个标准，但是阅读一般的REST文档和博客文章应该会给你一些指导，让你更好地构造API url。大多数其他api倾向于在路径中只有资源名称和资源id。如:

/departments/{dept}/employees/{id}

一些REST api使用查询字符串进行过滤，分页和排序，但由于REST不是一个严格的标准，我建议检查一些REST api，如github和stackoverflow，看看什么可以很好地为您的用例工作。

我建议在路径中放入任何必需的参数，而任何可选参数都应该是查询字符串参数。当尝试编写匹配不同组合的URL处理程序时，在路径中放置可选参数最终会变得非常混乱。

您可以同时支持查询参数和路径参数，例如，在资源聚合的情况下——当子资源的集合本身有意义时。

/departments/{id}/employees
/employees?dept=id

查询参数可支持分层和非分层子集设置;路径参数仅分级。

资源可以显示多个层次结构。如果要查询跨层次边界的广泛子集合，则支持短路径。

/inventory?make=toyota&model=corolla
/inventory?year=2014

使用查询参数组合正交层次结构。

/inventory/makes/toyota/models/corolla?year=2014
/inventory/years/2014?make=toyota&model=corolla
/inventory?make=toyota&model=corolla&year=2014

在组合的情况下只使用路径参数——当一个资源脱离了它的父元素就没有意义了，而且所有子元素的全局集合本身并不是一个有用的资源。

/words/{id}/definitions
/definitions?word=id   // not useful

推荐文章