矩阵变量产生不正确的HATEOAS链接

时间:2014-11-12 20:00:09

标签: java spring rest spring-mvc hateoas

修改

我现在在两个不同的应用服务器上测试了它:Tomcat 8.0.15和JBoss 6.2 EAP。在Tomcat上正确生成链接,而在JBoss上生成的链接不正确。我还创建了一个小示例项目来演示问题:

https://github.com/Vile2539/hateoas-link-test/tree/master

原始问题

我最近一直在改变我的一些Spring REST服务,使用matrix variables而不是路径变量。但是,这导致ControllerLinkBuilder生成一些不正确的HATEOAS链接。

我现在有什么:

控制器方法

此问题总共有@RequestMapping /test-items。此外,根据我的理解和测试,@PathVariable是必需的,因为单独的URL模板是不够的。这就是{fullString}存在的原因。

@RequestMapping(value = "/{fullString}/test", method = RequestMethod.GET, produces = {MediaType.APPLICATION_JSON_VALUE + ";charset=UTF-8"})
@ResponseBody
public PagedCollectionResource test(@PathVariable String fullString, @MatrixVariable String testVariable, Pageable pageable) {
    Link link = linkTo(methodOn(TestControllerImpl.class).test(fullString, testVariable, pageable)).withSelfRel();
    Page<TestItem> testItems = testService.getPagedTestItems(testVariable, pageable);
    return testService.getPagedCollectionResource(testItems, link);
}

Spring配置

<mvc:annotation-driven enable-matrix-variables="true">
    <mvc:path-matching path-helper="pathHelper"/>
    <mvc:argument-resolvers>
        <bean class="org.springframework.data.web.PageableHandlerMethodArgumentResolver"/>
    </mvc:argument-resolvers>
</mvc:annotation-driven>

<bean id="pathHelper" class="org.springframework.web.util.UrlPathHelper">
    <property name="alwaysUseFullPath" value="true"/>
    <property name="urlDecode" value="false"/>
    <property name="removeSemicolonContent" value="false"/>
</bean>

服务电话

http://localhost:8080/testItem/test-items/stringhere;testVariable=036/test

结果

"links":[{"rel":"self","href":"http://localhost:8080/testItem/test-items/stringhere/test-items/stringhere;testVariable=036/test{?page,size,sort}"}]

正如您所看到的,由于某种原因,还有一个/test-items/stringhere。我几乎可以肯定它是由矩阵变量引起的,它似乎是在ControllerLinkBuilder methodOn调用期间,但我无法弄清楚原因。

有人会对如何解决此问题提出任何建议,或者(理想情况下)修复它并消除对{fullString}路径变量的需求吗?

其他问题

此外,使用矩阵变量的原因是为了解决URL编码问题。我之前使用连字符-分隔路径变量,所以类似于:

{variable1}-{variable2}

不幸的是,两者都可以包含特殊字符,例如/-&等。使用上面显示的alwaysUseFullPathurlDecode属性,我能够传入大部分编码的特殊字符 - 所以用正斜杠调用上面的代码是:

/test-items/%2Fab-v%2Fc/test
variable1 = /ab
variable2 = v/c

然而,这不适用于连字符 - 编码的连字符将被取消编码并导致错误的路径变量:

/test-items/a%2db-vc/test
variable1 = a
variable2 = b-vc

然而,对连字符进行双重编码确实有效 - 但显然是一个可怕的黑客。

如果有人在保持GET电话的同时有任何关于解决这个问题的建议,我会非常感激。不能对URL中的字符顺序或类型做出任何假设(因此路径变量不能简单地用2个连字符分隔)。

1 个答案:

答案 0 :(得分:0)

这是一个较晚的更新,但被工作淹没了。

我通过为我自己的LinkBuilder类扩展LinkBuilderSupport解决了这个问题:

public class RootContextLinkBuilder extends LinkBuilderSupport<RootContextLinkBuilder> {
    ...
}

初始实施的问题出在getBuilder()方法中。 ControllerLinkBuilder使用了ServletUriComponentsBuilder.fromServletMapping(request);,我将其更改为ServletUriComponentsBuilder.fromContextPath(request);。现在生成正确的href,并以与ControllerLinkBuilder相同的方式调用。

对于我的其他问题,我们坚持使用矩阵变量,因此没有解决这个问题。