UTF-8 encoding problem in Spring MVC

Question

I' ve a Spring MVC bean and I would like to return turkish character by setting encoding UTF-8. but although my string is "şŞğĞİıçÇöÖüÜ" it returns as "??????çÇöÖüÜ". and also when I look at the response page, which is internet explorer page, encoding is western european iso, not UTF-8.

Here is the code:

    @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;
}

See http://stackoverflow.com/questions/3616359/who-sets-response-content-type-in-spring-mvc-responsebody/3617594#3617594 — axtavt, Apr 13 '11 at 12:49
possible duplicate of [Spring MVC response encoding issue](http://stackoverflow.com/questions/6638284/spring-mvc-response-encoding-issue) — kamaci, Aug 01 '12 at 12:04
response.setContentType(contentType); you don't need to write such code using frameworks, especially Spring. produces = "text/plain;charset=UTF-8" is your choice — Yura, Apr 04 '16 at 16:07

score 76 · Answer 1 · edited Jun 08 '14 at 16:42

76

I've figured it out, you can add to request mapping produces = "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

edited Jun 08 '14 at 16:42

Michael Kohne

11,661
3
44
75

answered Aug 19 '12 at 02:44

Charlie Wu

7,559
5
29
40

1

Solution 1 of the linked blog post works for me, i.e. writing bytes to the outputstream. The other two solutions don't work for me. – rwitzel Mar 19 '15 at 17:40
For me, it works, I was looking so long for solution. Thank you. – Marko Mar 22 '15 at 14:58
1

@rwitzel Maybe you need this too: response.setCharacterEncoding("UTF-8"); I have filter for that. – Marko Mar 22 '15 at 15:00
2

For me also , "Solution 1 of the linked blog post works for me, i.e. writing bytes to the output stream. The other two solutions don't work for me." – vijayakumar gopalakrishnan Mar 27 '16 at 12:23
the site is no longer hosted. I've added solution 1 to this blog post https://monsterbrain.github.io/2019/04/01/spring-mvc-ajax-utf-8-problem/ – Monster Brain Apr 01 '19 at 08:44

score 27 · Answer 2 · answered Feb 22 '12 at 12:16

27

in your dispatcher servlet context xml, you have to add a propertie "<property name="contentType" value="text/html;charset=UTF-8" />" on your viewResolver bean. we are using freemarker for views.

it looks something like this:

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

answered Feb 22 '12 at 12:16

aki

1,641
2
18
23

Also fixed my issues with Thymeleaf. Thanks. – Gábor Nagy Sep 22 '14 at 20:40

score 7 · Answer 3 · answered Mar 20 '15 at 09:29

7

Convert the JSON string to UTF-8 on your own.

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

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

answered Mar 20 '15 at 09:29

rwitzel

1,605
15
20

2

Only solution that worked for me, using `response.getOutputStream().write(jsonObject.toString().getBytes("UTF-8"));` – Joaquín L. Robles Jul 14 '15 at 15:37

Xobotun · Answer 4 · 2019-11-11T14:40:57.807

5

In Spring 5, or maybe in earlier versions, there is MediaType class. It has already correct line, if you want to follow DRY:

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

So I use this set of controller-related annotations:

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

It is marked deprecated in the docs, but I've run into this issue and it is better than copy-pastying the aforementioned line on every method/controller throughout your application, I think.

edited Nov 11 '19 at 14:40

answered Nov 11 '19 at 14:35

Xobotun

910
1
14
25

1

It's deprecated since 5.2 see [docs.spring.io](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/MediaType.html) – Valerij Dobler Feb 27 '21 at 22:45
1

@Vala.D. Thanks for pointing this out. When I used this option, we were surely using som 5.0.* version, and were planning to move to 5.1.* branch, IIRC. Still, that's some arguable reason they decided to deprecate it, as we had the problem with encoding with some rest-like service. And unlike "modern browsers", those internal webservices tend to be legacy-ish sometimes. :D – Xobotun Mar 25 '21 at 16:42
1

I had the same problems with an rest service, that's how I got here in the first place. – Valerij Dobler Mar 26 '21 at 07:52

score 3 · Answer 5 · edited Oct 14 '21 at 11:09

3

You need add charset in the RequestMapping annotation:

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

edited Oct 14 '21 at 11:09

Neuron - Freedom for Ukraine

4,303
4
29
51

answered Jun 04 '20 at 12:38

Andres Gutierrez

31
3

score 2 · Answer 6 · edited May 23 '17 at 12:33

There are some similar questions: Spring MVC response encoding issue, Custom HttpMessageConverter with @ResponseBody to do Json things.

However, my simple solution:

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

and the view html_utf8.jsp

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

No additional classes and configuration.
And You can also create another view (for example json_utf8) for other content type.

score 1 · Answer 7 · answered Aug 22 '16 at 20:41

I've resolved this issue by inferring the produced return type into the first GET requestMethod. The important part here is the

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

So every one how use /account/**, Spring will return application/json;charset=UTF-8 content type.

@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);
      }
}

So, you do not have to set up for each method in your Controller, you can do it for the entire class. If you need more control over a specific method, you just only have to infer the produces return content type.

score 1 · Answer 8 · answered Oct 07 '16 at 09:06

Also add to your beans :

   <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>

For @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>

If you use <mvc:annotation-driven/> it should be after beans.

score 1 · Answer 9 · answered Jun 10 '18 at 20:19

If you are using Spring MVC version 5 you can set the encoding also using the @GetMapping annotation. Here is an example which sets the content type to JSON and also the encoding type to UTF-8:

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

More information on the @GetMapping annotation here:

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

score 1 · Answer 10 · answered Jul 23 '18 at 08:23

When you try to send special characters like è,à,ù, etc etc, may be you see in your Jsp Post page many characters like '£','Ä’ or ‘Æ’. To solve this problem in 99% of cases you may move in your web.xml this piece of code at the head of file:

   <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>

For complete example see here : https://lentux-informatica.com/spring-mvc-utf-8-encoding-problem-solved/

Paul Cuddihy · Answer 11 · 2020-09-24T14:00:29.910

I found that "@RequestMapping produces=" and other configuration changes didn't help me. By the time you do resp.getWriter(), it is also too late to set the encoding on the writer.

Adding a header to the HttpServletResponse works.

@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();
    }
}

UTF-8 encoding problem in Spring MVC

11 Answers11

Linked