Spring/Rest @PathVariable 字符编码

Question

Spring/Rest @PathVariable 字符编码

springrestcharacter-encodinguri

27

在我所使用的环境中（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显然使用请求编码，这是一件非常奇怪的事情，因为这涉及到正文，而不是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"/>

...在这种情况下，收件人可以做正确的事情；但是当然，这将使许多其他事情更加困难。

- Julian Reschke

5个回答

4

对于我而言，即使使用字符编码过滤器，路径变量仍以ISO-8859-1解码。这是我解决该问题的方法，请告知是否有其他建议！

如果想在服务器上查看实际的UTF-8解码字符，您可以执行以下操作并查看值（需要将“HttpServletRequest httpServletRequest”添加到您的控制器参数中）：

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

现在我已经在服务器上获得了正确解码的数据，因此我可以自由地进行任何操作（例如手动从解码后的URI中获取参数）。

- 11101101b

3

请确保您的调度Servlet的URL映射不要比CharacterEncodingFilter更短，否则它甚至不会触发该过滤器。 - checketts

那就是问题所在！谢谢！ - 11101101b

3

尝试在服务器配置文件server.xml中配置连接器。在您的Connector标签中添加useBodyEncodingForURI="true"或URIEncoding="UTF-8"。例如：

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

- Avseiytsev Dmitriy

1

但是，你不觉得必须要去修改Tomcat配置（URIEncoding）才能让它工作很烦吗？如果Servlet API提供了一种获取路径和请求参数的未解码表示的方法，应用程序（或Spring）可以完全自行处理解码。显然，HttpServletRequest#getPathInfo和HttpServletRequest#getQueryString甚至可以提供这个功能，但对于后者，这意味着Spring必须自己解析和解码查询字符串，而不能依赖于HttpServletRequest#getParameter和相关函数。显然他们没有这样做，这意味着你不能安全地依赖于servlet容器的配置来捕获除us-ascii字符串以外的任何内容，也不能使用@RequestParam或@PathVariable。

- Olaf Klischat

0

今天我在尝试使用葡萄牙语单词时遇到了这个问题。可以通过以下方式访问 SpringBoot 中 Avseiytsev Dmitriy 的 answer：

server.tomcat.uri-encoding=UTF-8

在 application.properties 文件中

我已经测试过，这个方法可行。

如果你正在使用 TDD 来开发应用程序，并且使用 MockMvc 来测试一个 GET 请求，可以按照以下方式进行：

mockMvc.perform(get("/api/v1/categories/" + NAME2)
                    .characterEncoding("UTF-8")
                    .contentType(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.name", equalTo(NAME2)));

NAME2变量是一个字符串：José

- bksoares

默认的 server.tomcat.uri-encoding 是 UTF-8。 - 袁文涛

当我尝试在没有特别设置的情况下使用该函数时，它不起作用。只有在这种方式下设置后，它才能正常工作。我不知道为什么。而且测试是相同的...只有当我编写编码部分时才能正常工作。 - bksoares

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Hurda · Accepted Answer

我认为你需要在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>