Who sets response content-type in Spring MVC ResponseBody

Question

I m having in my Annotation driven Spring MVC Java web application runned on jetty web server  currently in maven jetty plugin    I m trying to do some AJAX support with one controller method returning just String help text  Resources are in UTF-8 encoding and so is the string  but my response from server comes with   content-encoding  text plain charset ISO-8859-1    even when my browser sends   Accept-Charset  windows-1250 utf-8 q 0 7   q 0 7   I m using somehow default configuration of spring  I have found a hint to add this bean to the configuration  but I think it s just not used  because it says it does not support the encoding and a default one is used instead    lt bean class  org springframework http converter StringHttpMessageConverter  gt       lt property name  supportedMediaTypes  value  text plain charset UTF-8    gt   lt  bean gt    My controller code is  note that this change of response type is not working for me     RequestMapping value    ajax gethelp   public  ResponseBody String handleGetHelp Locale loc  String code  HttpServletResponse response        log debug  Getting help for code      code       response setContentType  text plain charset UTF-8        String help   messageSource getMessage code  null  loc       log debug  Help is      help       return help

User · Accepted Answer

Simple declaration of the StringHttpMessageConverter bean is not enough  you need to inject it into AnnotationMethodHandlerAdapter    lt bean class    org springframework web servlet mvc annotation AnnotationMethodHandlerAdapter  gt       lt property name  messageConverters  gt           lt array gt               lt bean class    org springframework http converter StringHttpMessageConverter  gt                   lt property name  supportedMediaTypes  value    text plain charset UTF-8    gt               lt  bean gt           lt  array gt       lt  property gt   lt  bean gt    However  using this method you have to redefine all HttpMessageConverters  and also it doesn t work with  lt mvc annotation-driven   gt    So  perhaps the most convenient but ugly method is to intercept instantiation of the AnnotationMethodHandlerAdapter with BeanPostProcessor   public class EncodingPostProcessor implements BeanPostProcessor       public Object postProcessBeforeInitialization Object bean  String name              throws BeansException           if  bean instanceof AnnotationMethodHandlerAdapter                HttpMessageConverter lt   gt    convs     AnnotationMethodHandlerAdapter  bean  getMessageConverters                for  HttpMessageConverter lt   gt  conv  convs                    if  conv instanceof StringHttpMessageConverter                          StringHttpMessageConverter  conv  setSupportedMediaTypes                          Arrays asList new MediaType  text    html                                Charset forName  UTF-8                                                         return bean             public Object postProcessAfterInitialization Object bean  String name              throws BeansException           return bean            -   lt bean class    EncodingPostProcessor     gt

User · Answer

I m using the CharacterEncodingFilter  configured in web xml  Maybe that helps        lt filter gt       lt filter-name gt characterEncodingFilter lt  filter-name gt       lt filter-class gt org springframework web filter CharacterEncodingFilter lt  filter-class gt       lt init-param gt           lt param-name gt encoding lt  param-name gt           lt param-value gt UTF-8 lt  param-value gt       lt  init-param gt       lt init-param gt           lt param-name gt forceEncoding lt  param-name gt           lt param-value gt true lt  param-value gt       lt  init-param gt   lt  filter gt

User · Answer

Note that in Spring MVC 3 1 you can use the MVC namespace to configure message converters    lt mvc annotation-driven gt     lt mvc message-converters register-defaults  true  gt       lt bean class  org springframework http converter StringHttpMessageConverter  gt         lt property name  supportedMediaTypes  value    text plain charset UTF-8    gt       lt  bean gt     lt  mvc message-converters gt   lt  mvc annotation-driven gt    Or code-based configuration    Configuration  EnableWebMvc public class WebConfig extends WebMvcConfigurerAdapter      private static final Charset UTF8   Charset forName  UTF-8        Override   public void configureMessageConverters List lt HttpMessageConverter lt   gt  gt  converters        StringHttpMessageConverter stringConverter   new StringHttpMessageConverter        stringConverter setSupportedMediaTypes Arrays asList new MediaType  text    plain   UTF8         converters add stringConverter           Add other converters

User · Answer

You can use produces to indicate the type of the response you are sending from the controller  This  produces  keyword will be most useful in ajax request and was very helpful in my project   RequestMapping value     aURLMapping htm   method   RequestMethod GET  produces    text html  charset utf-8     public  ResponseBody String getMobileData

User · Answer

package com your package spring fix   import java io UnsupportedEncodingException  import java net URLDecoder  import java net URLEncoder           author Szilard Jakab  JaKi     Workaround for Spring 3  ResponseBody issue - get incorrectly     encoded parameters     from the URL  in example   JSON response     Tested   Spring 3 0 4     public class RepairWrongUrlParamEncoding       private static String restoredParamToOriginal                  param wrongUrlParam        return Repaired url param  UTF-8 encoded         throws UnsupportedEncodingException            public static String repair String wrongUrlParam  throws                                              UnsupportedEncodingException          First step  encode the incorrectly converted UTF-8 strings back to                    the original URL format            restoredParamToOriginal   URLEncoder encode wrongUrlParam   ISO-8859-1            Second step  decode to UTF-8 again from the original one            return URLDecoder decode restoredParamToOriginal   UTF-8              After I have tried lot of workaround for this issue   I thought this out and it works fine

User · Answer

The simple way to solve this problem in Spring 3 1 1 is that  add following configuration codes in servlet-context xml       lt annotation-driven gt       lt message-converters register-defaults  true  gt       lt beans bean class  org springframework http converter StringHttpMessageConverter  gt       lt beans property name  supportedMediaTypes  gt           lt beans value gt text plain charset UTF-8 lt  beans value gt       lt  beans property gt       lt  beans bean gt       lt  message-converters gt       lt  annotation-driven gt    Don t need to override or implement anything

User · Answer

if none of the above worked for you try to make ajax requests on  POST  not  GET    that worked for me nicely     none of the above did  I also have the characterEncodingFilter

User · Answer

if you decide to fix this problem through the following configuration    lt mvc annotation-driven gt     lt mvc message-converters register-defaults  true  gt       lt bean class  org springframework http converter StringHttpMessageConverter  gt         lt property name  supportedMediaTypes  value    text plain charset UTF-8    gt       lt  bean gt     lt  mvc message-converters gt   lt  mvc annotation-driven gt    you should confirm that there should only one mvc annotation-driven tag in all your   xml file  otherwise  the configuration may not be effective

User · Answer

I was fighting this issue recently and found a much better answer available in Spring 3 1    RequestMapping value    ajax gethelp   produces    text plain     So  as easy as JAX-RS just like all the comments indicated it could should be

User · Answer

Thanks digz6666  your solution works for me with a slight changes because I m using json    responseHeaders add  Content-Type    application json  charset utf-8      The answer given by axtavt  whch you ve recommended  wont work for me  Even if I ve added the correct media type    if  conv instanceof StringHttpMessageConverter                                             StringHttpMessageConverter  conv  setSupportedMediaTypes                          Arrays asList                                  new MediaType  text    html   Charset forName  UTF-8                                     new MediaType  application    json   Charset forName  UTF-8

User · Answer

According to the link   If a character encoding is not specified  the Servlet specification requires that an encoding of ISO-8859-1 is used   If you are using spring 3 1 or later use the fallowing configuration to set charset UTF-8 to response body  RequestMapping value    your mapping  url   produces    text plain charset UTF-8

User · Answer

public final class ConfigurableStringHttpMessageConverter extends AbstractHttpMessageConverter lt String gt         private Charset defaultCharset       public Charset getDefaultCharset             return defaultCharset             private final List lt Charset gt  availableCharsets       private boolean writeAcceptCharset   true       public ConfigurableStringHttpMessageConverter             super new MediaType  text    plain   StringHttpMessageConverter DEFAULT CHARSET   MediaType ALL           defaultCharset   StringHttpMessageConverter DEFAULT CHARSET          this availableCharsets   new ArrayList lt Charset gt  Charset availableCharsets   values                public ConfigurableStringHttpMessageConverter String charsetName            super new MediaType  text    plain   Charset forName charsetName    MediaType ALL           defaultCharset   Charset forName charsetName           this availableCharsets   new ArrayList lt Charset gt  Charset availableCharsets   values                           Indicates whether the   code Accept-Charset  should be written to any outgoing request          lt p gt Default is   code true               public void setWriteAcceptCharset boolean writeAcceptCharset            this writeAcceptCharset   writeAcceptCharset              Override     public boolean supports Class lt   gt  clazz            return String class equals clazz               Override     protected String readInternal Class clazz  HttpInputMessage inputMessage  throws IOException           Charset charset   getContentTypeCharset inputMessage getHeaders   getContentType             return FileCopyUtils copyToString new InputStreamReader inputMessage getBody    charset                Override     protected Long getContentLength String s  MediaType contentType            Charset charset   getContentTypeCharset contentType           try               return  long  s getBytes charset name    length                    catch  UnsupportedEncodingException ex                   should not occur             throw new InternalError ex getMessage                           Override     protected void writeInternal String s  HttpOutputMessage outputMessage  throws IOException           if  writeAcceptCharset                outputMessage getHeaders   setAcceptCharset getAcceptedCharsets                       Charset charset   getContentTypeCharset outputMessage getHeaders   getContentType             FileCopyUtils copy s  new OutputStreamWriter outputMessage getBody    charset                          Return the list of supported   link Charset                  lt p gt By default  returns   link Charset availableCharsets     Can be overridden in subclasses                 return the list of accepted charsets             protected List lt Charset gt  getAcceptedCharsets             return this availableCharsets             private Charset getContentTypeCharset MediaType contentType            if  contentType    null  amp  amp  contentType getCharSet      null                return contentType getCharSet                      else               return defaultCharset                      Sample configuration         lt bean class  org springframework web servlet mvc annotation AnnotationMethodHandlerAdapter  gt           lt property name  messageConverters  gt               lt util list gt                   lt bean class  ru dz mvk util ConfigurableStringHttpMessageConverter  gt                       lt constructor-arg index  0  value  UTF-8   gt                   lt  bean gt               lt  util list gt           lt  property gt       lt  bean gt

User · Answer

Just in case you can also set encoding by the following way    RequestMapping value    ajax gethelp   public ResponseEntity lt String gt  handleGetHelp Locale loc  String code  HttpServletResponse response        HttpHeaders responseHeaders   new HttpHeaders        responseHeaders add  Content-Type    text html  charset utf-8         log debug  Getting help for code      code       String help   messageSource getMessage code  null  loc       log debug  Help is      help        return new ResponseEntity lt String gt   returning      help  responseHeaders  HttpStatus CREATED       I think using StringHttpMessageConverter is better than this

User · Answer

you can add produces    text plain charset UTF-8  to RequestMapping   RequestMapping value     rest create document   produces    text plain charset UTF-8    ResponseBody public String create Document document  HttpServletRespone respone  throws UnsupportedEncodingException        Document newDocument   DocumentService create Document        return jsonSerializer serialize newDocument       see this blog for more detail

User · Answer

I set the content-type in the MarshallingView in the ContentNegotiatingViewResolver bean  It works easily  clean and smoothly    lt property name  defaultViews  gt     lt list gt       lt bean class  org springframework web servlet view xml MarshallingView  gt         lt constructor-arg gt           lt bean class  org springframework oxm xstream XStreamMarshaller    gt              lt  constructor-arg gt         lt property name  contentType  value  application xml charset UTF-8    gt       lt  bean gt     lt  list gt   lt  property gt

User · Answer

I found solution for Spring 3 1  with using  ResponseBody annotation  Here is example of controller  using Json output    RequestMapping value     getDealers   method   RequestMethod GET   produces    application json  charset utf-8    ResponseBody public String sendMobileData

[java] Who sets response content-type in Spring MVC (@ResponseBody)

Examples related to java

Examples related to web-applications

Examples related to spring-mvc

Examples related to character-encoding