URL矩阵参数与请求参数

时间:2010-01-12 10:14:50

标签: http url rest parameters jax-rs

我想知道是否在我的网址中使用矩阵或查询参数。我发现该主题的discussion较旧,不满意。

实施例

乍一看,矩阵参数似乎只有优点:

  • 更具可读性
  • 没有编码和解码“&”在XML文档中是必需的
  • 带“?”的网址在很多情况下都没有缓存;带有矩阵参数的URL被缓存
  • 矩阵参数可以出现在路径中的任何位置,并且不限于其结尾
  • 矩阵参数可以有多个值:paramA=val1,val2

但也有缺点:

  • 只有少数像[{3}}这样的框架支持矩阵参数
  • 当浏览器通过GET提交表单时,params成为查询参数。因此它最终会出现两种相同任务的参数。为了不混淆REST服务的用户并限制服务开发人员的工作量,在这方面使用始终查询参数会更容易。

由于服务开发人员可以选择支持矩阵参数的框架,因此唯一的缺点是浏览器会默认创建查询参数。

还有其他缺点吗?你会做什么?

3 个答案:

答案 0 :(得分:198)

重要的区别在于矩阵参数适用于特定路径元素,而查询参数作为整体应用于请求。当对多个级别的资源和子资源进行复杂的REST样式查询时,这就起到了作用:

http://example.com/res/categories;name=foo/objects;name=green/?page=1

这真的归结为命名空间。如果仅使用查询参数,则最终会使用“category_name”和“object_name”等参数,并且您将失去请求中参数的位置所添加的清晰度。此外,当使用像JAX-RS这样的框架时,所有查询参数都会显示在每个资源处理程序中,从而导致潜在的冲突和混淆。

如果您的查询只有一个“级别”,那么差异并不重要,两种类型的参数可以有效地互换,但查询参数通常得到更好的支持和更广泛的认可。一般来说,我建议您坚持使用HTML表单和简单的单级HTTP API之类的查询参数。

答案 1 :(得分:11)

- 降级到评论部分太重要了.--

我不确定矩阵网址的重要性。根据TBL写的w3c设计文章,它只是一个设计理念,并明确指出它不是网络的一个特征。使用它时,没有实现相对URL之类的东西。如果你想使用它,那很好;没有标准的方法可以使用它,因为它不是标准的。 - 史蒂夫波默罗伊

如此简短的回答是,如果出于商业目的需要RS,最好使用请求参数。

答案 2 :(得分:8)

除了Tim Sylvester's回答之外,我想提供一个如何使用 JAX-RS 处理矩阵参数的示例。

  1. 最后一个资源元素的矩阵参数

    http://localhost:8080/res/categories/objects;name=green
    

    您可以使用@MatrixParam注释

    访问它们
    @GET
    @Path("categories/objects")
    public String objects(@MatrixParam("name") String objectName) {
      return objectName;
    }
    

    <强> 响应

    green
    

    但是像Javadoc状态一样

      

    请注意,@MatrixParam注释值是指矩阵参数的名称,该参数位于注入了矩阵值的Path-annotated Java结构的最后匹配路径段中参数。

    ......是什么让我们进入第2点

  2. 网址中间的矩阵参数

    http://localhost:8080/res/categories;name=foo/objects;name=green
    

    您可以使用路径变量和@PathParam PathSegment来访问矩阵参数。

    @GET
    @Path("{categoryVar:categories}/objects")
    public String objectsByCategory(@PathParam("categoryVar") PathSegment categorySegment, 
                                    @MatrixParam("name") String objectName) {
      MultivaluedMap<String, String> matrixParameters = categorySegment.getMatrixParameters();
      String categorySegmentPath = categorySegment.getPath();
      String string = String.format("object %s, path:%s, matrixParams:%s%n", objectName,
              categorySegmentPath, matrixParameters);
      return string;
    }
    

    <强> 响应

    object green, path:categories, matrixParams:[name=foo]
    

    由于矩阵参数以MultivaluedMap的形式提供,您可以通过

    访问每个参数
    List<String> names = matrixParameters.get("name");
    

    或者如果你只需要第一个

    String name = matrixParameters.getFirst("name");
    
  3. 将所有矩阵参数作为一个方法参数

    http://localhost:8080/res/categories;name=foo/objects;name=green//attributes;name=size
    

    使用List<PathSegment>全部获取

    @GET
    @Path("all/{var:.+}")
    public String allSegments(@PathParam("var") List<PathSegment> pathSegments) {
      StringBuilder sb =  new StringBuilder();
    
      for (PathSegment pathSegment : pathSegments) {
        sb.append("path: ");
        sb.append(pathSegment.getPath());
        sb.append(", matrix parameters ");
        sb.append(pathSegment.getMatrixParameters());
        sb.append("<br/>");
      }
    
      return sb.toString();
    }
    

    <强> 响应

    path: categories, matrix parameters [name=foo]
    path: objects, matrix parameters [name=green]
    path: attributes, matrix parameters [name=size]