为什么@MatrixParam值似乎只来自最后一段?

时间:2012-11-01 01:45:26

标签: java tomcat uri jax-rs

我正在探索在JAX-RS应用程序中使用MatrixURIs。在这个过程中,我注意到@MatrixParam带注释的参数似乎只从最终段中获取矩阵参数(这使得尝试使用sub-resource locators有点痛苦)。我想知道这是一个错误,还是规范的一部分(为什么?),或者只是一个未定义的破解。

我知道我可能会想出一种方法来使用@Context注入UriInfo对象(它会根据定位器链中的位置发生变化而改变),但这感觉很难看。

快速浏览JAX-RS 1.1 spec ...我发现最接近这个不受支持的是:§3.2

  

由于注入发生在对象创建时,因此仅对默认的每请求资源类生命周期支持在资源类字段和bean属性上使用这些注释(@Context除外)。

但那是在讨论构造函数/字段注入,而不是像§3.3.2中那样的方法参数:

  

调用资源方法时,根据注释的语义,从请求中映射使用@FormParam注释的参数或3.2节中列出的注释之一。

但是注释的语义当然看似含糊不清。

运行时环境详细信息:

  • 泽西岛1.13,1.15
  • Tomcat 7.0.29
  • Java 1.6.0_31(Apple)
  • MacOS X 10.7.5

示例资源:

public class Zero {

    public static final String[] IDS = { "1", "2", "3" };

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public Map<String, Object> getMe(@Context final UriInfo info) {
        final UriBuilder builder = info.getAbsolutePathBuilder().path("one");
        final UriBuilder two = builder.clone().matrixParam("id", "{one}", "{two}");

        final List<String> links = new ArrayList<String>();
        for (int i = 0; i < IDS.length; i++) {
            final String first = IDS[i];
            for (int j = i + 1; j < IDS.length; j++) {
                final String second = IDS[j];
                links.add(two.build(first, second).toASCIIString());
            }
        }

        final Map<String, Object> toReturn = new HashMap<String, Object>();
        toReturn.put("class", getClass().getSimpleName());
        toReturn.put("next", builder.build().toASCIIString());
        toReturn.put("skip", links);

        return toReturn;
    }

    /*************************/
    /**** <PROBLEM CHILD> ****/
    /*************************/
    @Path("one")
    public Object getNext(@MatrixParam("id") final Set<String> ids) {
        if (ids.isEmpty()) {
            return new One();
        }
        return new Two(ids.toArray(new String[ids.size()]));
    }
    /*************************/
    /**** </PROBLEM CHILD> ***/
    /*************************/

    public static class One {
        @GET
        @Produces(MediaType.APPLICATION_JSON)
        public Map<String, Object> getMe(@Context final UriInfo info) {
            final UriBuilder builder = info.getAbsolutePathBuilder().path("{id}");
            final List<String> links = new ArrayList<String>();
            for (final String id : IDS) {
                links.add(builder.build(id).toASCIIString());
            }
            final Map<String, Object> toReturn = new HashMap<String, Object>();
            toReturn.put("class", getClass().getSimpleName());
            toReturn.put("next", links);
            toReturn.put("last", getLastURI(info));
            return toReturn;
        }

        @Path("{id}")
        public Two getNext(@PathParam("id") final String id) {
            return new Two(id);
        }
    }

    public static class Two {

        private final String[] myids;
        private final Three three;

        public Two(final String... ids) {
            three = new Three(ids);
            myids = ids;
        }

        @GET
        @Produces(MediaType.APPLICATION_JSON)
        public Map<String, Object> getMe(@Context final UriInfo info) {
            final UriBuilder builder = info.getAbsolutePathBuilder().path("three");
            final Map<String, Object> toReturn = new HashMap<String, Object>();
            toReturn.put("class", getClass().getSimpleName());
            toReturn.put("ids", myids);
            toReturn.put("next", builder.build().toASCIIString());
            toReturn.put("last", getLastURI(info));
            return toReturn;
        }

        @Path("three")
        public Three getNext() {
            return three;
        }
    }

    public static class Three {
        private final String[] myids;

        public Three(final String... ids) {
            myids = ids;
        }

        @GET
        @Produces(MediaType.APPLICATION_JSON)
        public Map<String, Object> getMe(@Context final UriInfo info) {
            final Map<String, Object> toReturn = new HashMap<String, Object>();
            toReturn.put("class", getClass().getSimpleName());
            toReturn.put("ids", myids);
            toReturn.put("last", getLastURI(info));
            return toReturn;
        }
    }

    /**
     * Helper method since info.getMatchedURIs doesn't play nice with Matrix Params
     * @param info info object
     * @return parent URI
     */
    public static final String getLastURI(final UriInfo info) {
        final List<PathSegment> segments = info.getPathSegments(false);
        final UriBuilder builder = info.getBaseUriBuilder();
        for (int i = 0; i < segments.size() - 1; i++) {
            final PathSegment segment = segments.get(i);
            builder.path(segment.getPath());
            final MultivaluedMap<String, String> matrixParams = segment.getMatrixParameters();
            if (!matrixParams.isEmpty()) {
                for (final Map.Entry<String, List<String>> param : matrixParams.entrySet()) {
                    final String name = param.getKey();
                    final String[] values = param.getValue().toArray(new String[param.getValue().size()]);
                    builder.matrixParam(name, values);
                }
            }
        }
        return builder.build().toASCIIString();
    }
}

上面的示例输出:

http://localhost:8080/context/zero/one/2

{
"last":"http://localhost:8080/context/zero/one",
"ids":["2"],
"next":"http://localhost:8080/context/zero/one/2/three",
"class":"Two"
}

http://localhost:8080/context/zero/one/2/three

{
"last":"http://localhost:8080/context/zero/one/2",
"ids":["2"],
"class":"Three"
}

http://localhost:8080/context/zero/one;id=1;id=2

{
"last":"http://localhost:8080/context/zero",
"ids":["2","1"],
"next":"http://localhost:8080/context/zero/one;id=1;id=2/three",
"class":"Two"
}

http://localhost:8080/context/zero/one;id=1;id=2/three

{
"last": "http://localhost:8080/context/zero/one;id=1;id=2",
"ids": ["three"],
"next": "http://localhost:8080/context/zero/one;id=1;id=2/three/three",
"class": "Two"
}

1 个答案:

答案 0 :(得分:2)

我不能肯定地说,但我怀疑这是设计上的。假设您有两个这样的URI:

/foo/bar

在这两个级别上,可以有一个名为filter的矩阵parm。你最终可能会得到这样的网址:

/foo;filter=13/bar;filter=April

在该路径的Jersey资源中,您将使用@MatrixParam(“过滤器”)注释一个参数。 Jersey应填写哪个过滤参数?如果没有提供一个或另一个怎么办?

刚刚实现了一些矩阵参数,我可以看到当前实现中的值。指定@MatrixParam仅拉取最后一个级别。如果您希望URI中的矩阵参数更早,请指定@PathParameter并使参数类型为PathSegment。从路径段中,您可以拉出矩阵参数。

通常,资源类将具有全局@Path,并且每个方法都将自己的@Path添加到类级别设置。在这种情况下,似乎更有意义的是@MatrixParameter仅适用于最后一个路径段。

因此,将所有内容放在一起(对于上面的示例)会产生以下内容

@Path("{fooPath: foo}")
public class FooResource {

@GET
@Path("bar")
public String getFooBar(@PathParam("fooPath") PathSegment fooPath,
    @MatrixParam("filter") String filter) {
    MultivaluedMap<String, String> mParms = fooPath.getMatrixParameters();
    List<String> parms = mParms.get("filter");
    String fooFilter = parms.get(0);
    // ... the rest of your code
    }
}