Spring MVC 中的 UTF-8 编码问题

Question

我有一个 Spring MVC bean，我想通过设置编码 UTF-8 返回土耳其字符。但是虽然我的字符串是“şŞğĞİıçÇöÖüÜ”，但它返回为“??????çÇöÖüÜ”。而且当我查看响应页面（即 Internet Explorer 页面）时，编码是西欧 iso，而不是 UTF-8。

代码如下：

    @RequestMapping(method=RequestMethod.GET,value="/GetMyList")
public @ResponseBody String getMyList(HttpServletRequest request, HttpServletResponse response) throws CryptoException{
    String contentType= "text/html;charset=UTF-8";
    response.setContentType(contentType);
    try {
        request.setCharacterEncoding("utf-8");
    } catch (UnsupportedEncodingException e) {
        // TODO Auto-generated catch block
        e.printStackTrace();
    }
    response.setCharacterEncoding("utf-8");     
    String str="şŞğĞİıçÇöÖüÜ";
    return str;
}   

Answer 1

我想通了，你可以添加到请求映射中产生 = "text/plain;charset=UTF-8"

@RequestMapping(value = "/rest/create/document", produces = "text/plain;charset=UTF-8")
@ResponseBody
public void create(Document document, HttpServletRespone respone) throws UnsupportedEncodingException {

    Document newDocument = DocumentService.create(Document);

    return jsonSerializer.serialize(newDocument);
}

see this blog post for more details on the solution

Answer 2

在您的调度程序 servlet 上下文 xml 中，您必须添加一个属性 "<property name="contentType" value="text/html;charset=UTF-8" />" 在您的 viewResolver bean 上。 我们正在使用 freemarker 进行视图。

看起来像这样：

<bean id="viewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
       ...
       <property name="contentType" value="text/html;charset=UTF-8" />
       ...
</bean>

Answer 3

自行将 JSON 字符串转换为 UTF-8。

@RequestMapping(value = "/example.json", method = RequestMethod.GET)
@ResponseBody
public byte[] example() throws Exception {

    return "{ 'text': 'äöüß' } ".getBytes("UTF-8");
}

Answer 4

在 Spring 5 中，或者可能在早期版本中，有 MediaType class。如果你想遵循 DRY，它已经有正确的线路：

public static final String APPLICATION_JSON_UTF8_VALUE = "application/json;charset=UTF-8";

所以我使用了这组控制器相关的注解：

@RestController
@RequestMapping(value = "my/api/url", produces = APPLICATION_JSON_UTF8_VALUE)
public class MyController {
    // ... Methods here
}

它在文档中被标记为已弃用，但我遇到了这个问题，我认为它比在整个应用程序中的每个方法/控制器上复制粘贴上述行要好。

Answer 5

您需要在RequestMapping 注解中添加字符集：

@RequestMapping(path = "/account",  produces = "application/json;charset=UTF-8")

Answer 6

还有一些类似的问题：Spring MVC response encoding issue、Custom HttpMessageConverter with @ResponseBody to do Json things。

但是，我的简单解决方案：

@RequestMapping(method=RequestMethod.GET,value="/GetMyList")
public ModelAndView getMyList(){
  String test = "čćžđš";
  ...
  ModelAndView mav = new ModelAndView("html_utf8");
  mav.addObject("responseBody", test);
}

和视图 html_utf8.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>${responseBody}

没有额外的类和配置。
并且您还可以为其他内容类型创建另一个视图（例如 json_utf8）。

Answer 7

我通过将生成的返回类型推断到第一个 GET 请求方法中解决了这个问题。这里的重要部分是

produces="application/json;charset=UTF-8

所以每一个如何使用 /account/**，Spring 都会返回 application/json;charset=UTF-8 内容类型。

@Controller
@Scope("session") 
@RequestMapping(value={"/account"}, method = RequestMethod.GET,produces="application/json;charset=UTF-8")
public class AccountController {

   protected final Log logger = LogFactory.getLog(getClass());

   ....//More parameters and method here...

   @RequestMapping(value={"/getLast"}, method = RequestMethod.GET)
   public @ResponseBody String getUltimo(HttpServletResponse response) throws JsonGenerationException, JsonMappingException, IOException{

      ObjectWriter writer = new ObjectMapper().writer().withDefaultPrettyPrinter();
      try {
        Account account = accountDao.getLast();
        return writer.writeValueAsString(account);
      }
      catch (Exception e) {
        return errorHandler(e, response, writer);
      }
}

因此，您不必为 Controller 中的每个方法进行设置，您可以为整个类设置。如果您需要对特定方法进行更多控制，您只需推断产生的返回内容类型。

Answer 8

还可以添加到您的 bean 中：

   <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
    <property name="messageConverters">
        <array>
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <constructor-arg index="0" name="defaultCharset" value="UTF-8"/>
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/plain;charset=UTF-8</value>
                        <value>text/html;charset=UTF-8</value>
                        <value>application/json;charset=UTF-8</value>
                        <value>application/x-www-form-urlencoded;charset=UTF-8</value>
                    </list>
                </property>
        </bean></bean>

对于@ExceptionHandler：

enter code<bean class="org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver">
    <property name="messageConverters">
        <array>
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <constructor-arg index="0" name="defaultCharset" value="UTF-8"/>
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/plain;charset=UTF-8</value>
                        <value>text/html;charset=UTF-8</value>
                        <value>application/json;charset=UTF-8</value>
                        <value>application/x-www-form-urlencoded;charset=UTF-8</value>
                    </list>
                </property>
            </bean>
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/plain;charset=UTF-8</value>
                        <value>text/html;charset=UTF-8</value>
                        <value>application/json;charset=UTF-8</value>
                        <value>application/x-www-form-urlencoded;charset=UTF-8</value>
                    </list>
                </property>
            </bean>
        </array>
    </property>
</bean>

如果你使用<mvc:annotation-driven/>，它应该在beans之后。

Answer 9

如果您使用的是 Spring MVC 版本 5，您也可以使用 @GetMapping 注释设置编码。这是一个将内容类型设置为 JSON 并将编码类型设置为 UTF-8 的示例：

@GetMapping(value="/rest/events", produces = "application/json; charset=UTF-8")

更多关于@GetMapping注解的信息在这里：

https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/GetMapping.html

Answer 10

当您尝试发送 è、à、ù 等特殊字符时，您可能会在 Jsp 帖子页面中看到许多字符，例如 '£'、'Ä' 或 'Æ'。 要在 99% 的情况下解决此问题，您可以在 web.xml 中将这段代码移至文件头部：

   <filter>
        <filter-name>encodingFilter</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>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

完整的例子见这里：https://lentux-informatica.com/spring-mvc-utf-8-encoding-problem-solved/

Answer 11

我发现“@RequestMappingproduce=”和其他配置更改对我没有帮助。到你做 resp.getWriter() 的时候，在 writer 上设置编码也为时已晚。

向 HttpServletResponse 添加标头是可行的。

@RequestMapping(value="/test", method=RequestMethod.POST)
public void test(HttpServletResponse resp) {
    try {
        resp.addHeader("content-type", "application/json; charset=utf-8");
        PrintWriter w = resp.getWriter();
        w.write("{\"name\" : \"μr μicron\"}");
        w.flush();
        w.close();
    } catch (Exception e) {
        e.printStackTrace();
    }
}