Spring / Rest @PathVariable字符编码

时间:2010-12-17 13:17:50

标签: spring rest character-encoding uri

在我正在使用的环境中(Tomcat 6),路径段中的百分比序列显然在映射到@PathVariable时使用ISO-8859-1进行解码。

我希望它是UTF-8。

我已经将Tomcat配置为使用UTF-8(使用server.xml中的URIEncoding属性)。

Spring / Rest是自己进行解码吗?如果是,我可以在哪里覆盖默认编码?

其他信息;这是我的测试代码:

@RequestMapping( value = "/enc/{foo}", method = RequestMethod.GET )
public HttpEntity<String> enc( @PathVariable( "foo" ) String foo, HttpServletRequest req )
{
  String resp;

  resp = "      path variable foo: " + foo + "\n" + 
         "      req.getPathInfo(): " + req.getPathInfo() + "\n" +
         "req.getPathTranslated(): " + req.getPathTranslated() + "\n" + 
         "    req.getRequestURI(): " + req.getRequestURI() + "\n" + 
         "   req.getContextPath(): " + req.getContextPath() + "\n";

  HttpHeaders headers = new HttpHeaders();
  headers.setContentType( new MediaType( "text", "plain", Charset.forName( "UTF-8" ) ) );
  return new HttpEntity<String>( resp, headers );
}

如果我使用以下URI路径执行HTTP GET请求:

/TEST/enc/%c2%a3%20and%20%e2%82%ac%20rates

是UTF-8编码的百分比编码形式的

/TEST/enc/£ and € rates

我得到的输出是:

      path variable foo: £ and ⬠rates
      req.getPathInfo(): /enc/£ and € rates
req.getPathTranslated(): C:\Users\jre\workspace\.metadata\.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps\TEST\enc\£ and € rates
    req.getRequestURI(): /TEST/enc/%C2%A3%20and%20%E2%82%AC%20rates
   req.getContextPath(): /TEST

对我来说,显示Tomcat(在设置URIEncoding属性之后)做正确的事情(参见getPathInfo()),但路径变量仍在ISO-8859-1中解码。

答案是

Spring / Rest显然使用请求编码,这是一件非常奇怪的事情,因为这是关于 body ,而不是URI。叹息。

添加:

<filter>
  <filter-name>CharacterEncodingFilter</filter-name>
  <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
  <init-param>
      <param-name>encoding</param-name>
      <param-value>UTF-8</param-value>
  </init-param>
</filter>
<filter-mapping>
  <filter-name>CharacterEncodingFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>

修复了问题。它应该更简单。

实际上,情况更糟:

如果方法确实具有请求主体,并且该方法未以UTF-8编码,则需要额外的forceEncoding参数。这似乎有效,但我担心它会在以后引起更多问题。

另一种方法

与此同时,我发现可以禁用解码,我的指定

<property name="urlDecode" value="false"/>

...在这种情况下,收件人可以正确的东西;但当然这会让很多其他事情变得更难。

4 个答案:

答案 0 :(得分:27)

我需要将过滤器添加到web.xml

<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

答案 1 :(得分:4)

即使使用字符编码过滤器,路径变量仍然在ISO-8859-1中解码。以下是我必须做的事情来解决这个问题。如果您有任何其他想法,请告诉我们!

要查看服务器上实际的UTF-8解码字符,您可以执行此操作并查看该值(您需要在控制器参数中添加“HttpServletRequest httpServletRequest”):

String requestURI = httpServletRequest.getRequestURI();
String decodedURI = URLDecoder.decode(requestURI, "UTF-8");

然后我可以做任何我想做的事情(比如从解码的URI手动获取参数),现在我在服务器上有正确的解码数据。

答案 2 :(得分:3)

尝试在server.xml中配置Tomcat上的连接器。 将useBodyEncodingForURI="true"URIEncoding="UTF-8"添加到您的Connector标记中。 例如:

    <Connector port="8080" protocol="HTTP/1.1"
           connectionTimeout="20000"
           useBodyEncodingForURI="true"
           redirectPort="8443" />

答案 3 :(得分:0)

但是难道你不得不乱用Tomcat配置(URIEncoding)来完成这项工作吗?如果servlet API提供了一种在未解码的表示中获取路径和请求参数的方法,那么应用程序(或Spring)可以完全独立地处理解码。显然,HttpServletRequest#getPathInfoHttpServletRequest#getQueryString甚至可以提供此功能,但对于后者,这意味着Spring必须解析和解码查询字符串本身而不依赖于HttpServletRequest#getParameter和朋友。显然他们没有这样做,这意味着你不能让@RequestParam@PathVariable安全地捕获除了us-ascii字符串以外的任何东西而不依赖于servlet容器的配置。