Spring MVC UTF-8 Encoding

Question

At the moment I m trying to get started with Spring MVC  While trying things out I ran into an encoding issue    I want to display UTF-8 characters on my JSP-Pages so I added a String with UTF-8 characters to my ModelAndView  It looks like this    Controller public class HomeController        private static final Logger logger   LoggerFactory getLogger HomeController class         RequestMapping value      method RequestMethod GET      public ModelAndView home             logger info  Welcome home             return new ModelAndView  home    utftest      lm               On the JSP page I just want to display the String with UTF-8 characters like this    lt    page language  java  pageEncoding  UTF-8   gt   lt    page contentType  text html charset UTF-8    gt   lt    taglib uri  http   java sun com jsp jstl core  prefix  c    gt   lt    page session  false    gt   lt html gt   lt head gt       lt meta http-equiv  Content-Type  content  text html  charset utf-8  gt       lt title gt Home lt  title gt   lt  head gt   lt body gt       lt h1 gt Hello world  lt  h1 gt       lt p gt  lt c out value        gt  lt  p gt       lt p gt  lt c out value    utftest   gt  lt  c out gt  lt  p gt   lt  body gt   lt  html gt    As result I get following   Hello world       v lm   Note that following code  lt c out value        gt  was displayed without encoding error  I also set the default encoding to UTF-8 in Springsource Tool Suite but I m still getting wrong characters   Edit   Maybe I should have mentioned that I m using a Mac with OS X 10 6  For Spring development I use the Springsource Tool Suite from Spring  http   www springsource com developer sts   Hope this helps to find out what is wrong with my setting   Edit 2   Thanks to McDwell  I just tried out using   u00f6lm  instead of    lm  in my controller and the encoding issue on the JSP page is gone    Does that mean my  java files are encoded with wrong character set  Where can I change this in Eclipse   Thank you

User · Answer

Depending on how you render your view  you may also need    Bean public StringHttpMessageConverter stringHttpMessageConverter         return new StringHttpMessageConverter Charset forName  UTF-8

User · Answer

Worked for me like here Spring MVC Java config  by added to web initializer     Override       protected Filter   getServletFilters              CharacterEncodingFilter characterEncodingFilter   new CharacterEncodingFilter            characterEncodingFilter setEncoding  UTF-8            return new Filter     characterEncodingFilter

User · Answer

Easiest solution to force UTF-8 encoding in Spring MVC returning String   In  RequestMapping  use   produces   MediaType APPLICATION JSON VALUE      charset utf-8

User · Answer

In addition to Benjamin s answer  which I ve only skimmed   you need to make sure that your files are actually stored using the proper encoding  that would be UTF-8 for source code  JSPs etc   but note that Java Properties files must be encoded as ISO 8859-1 by definition    The problem with this is that it s not possible to tell what encoding has been used to store a file  Your only option is to open the file using a specific encoding  and checking whether or not the content makes sense  You can also try to convert the file from the assumed encoding to the desired encoding using iconv - if that produces an error  your assumption was incorrect  So if you assume that hello jsp is encoded as UTF-8  run  iconv -f UTF-16 -t UTF-8 hello jsp  and check for errors   If you should find out that your files are not properly encoded  you need to find out why  It s probably the editor or IDE you used to create the file  In case of Eclipse  and STS   make sure the Text File Encoding  Preferences   General   Workspace  is set to UTF-8  it unfortunately defaults to your system s platform encoding    What makes encoding problems so difficult to debug is that there s so many components involved  text editor  borwser  plus each and every software component in between  in some cases including a database   and each of them has the potential to introduce an error

User · Answer

To solve this issue you need below three steps    Set page encoding to UTF-8 like below    lt    page language  java  pageEncoding  UTF-8   gt   lt    page contentType  text html charset UTF-8    gt   Set filter in web xml file as below    lt filter gt       lt filter-name gt encodingFilter 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 forceEncoding lt  param-name gt           lt param-value gt true lt  param-value gt       lt  init-param 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  filter gt   lt filter-mapping gt       lt filter-name gt encodingFilter lt  filter-name gt       lt url-pattern gt    lt  url-pattern gt   lt  filter-mapping gt   Set resource encoding to UTF-8  in case if you are writing any UTF-8 characters in Java code or JSP directly

User · Answer

Make sure you register Spring s CharacterEncodingFilter in your web xml  must be the first filter in that file     lt filter gt         lt filter-name gt encodingFilter 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     lt filter-mapping gt         lt filter-name gt encodingFilter lt  filter-name gt         lt url-pattern gt    lt  url-pattern gt     lt  filter-mapping gt     If you are on Tomcat you might not have set the URIEncoding in your server xml  If you don t set it to UTF-8 it won t work  Definitely keep the CharacterEncodingFilter  Nevertheless  here s a concise checklist to follow  It will definitely guide you to make this work

User · Answer

Ok guys I found the reason for my encoding issue   The fault was in my build process  I didn t tell Maven in my pom xml file to build the project with the UTF-8 encoding  Therefor Maven just took the default encoding from my system which is MacRoman and build it with the MacRoman encoding    Luckily Maven is warning you about this when building your project  BUT there is a good chance that the warning disappears to fast from your screen because of all the other messages    Here is the property you need to set in the pom xml file    lt properties gt       lt project build sourceEncoding gt UTF-8 lt  project build sourceEncoding gt           lt  properties gt    Thank you guys for all your help  Without you guys I wouldn t be able to figure this out

User · Answer

right-click to your controller java then properties and check if your text file is encoded with utf-8  if not this is your mistake

User · Answer

In addition to Benjamin s answer - in case if you are using Spring Security  placing the CharacterEncodingFilter in web xml might not always work  In this case you need to create a custom filter and add it to the filter chain as the first filter  To make sure it s the first filter in the chain  you need to add it before ChannelProcessingFilter  using addFilterBefore in your WebSecurityConfigurerAdapter    Configuration  EnableWebSecurity  public class SecurityConfig extends WebSecurityConfigurerAdapter          Override     protected void configure HttpSecurity http  throws Exception              add your custom encoding filter as the first filter in the chain         http addFilterBefore new EncodingFilter    ChannelProcessingFilter class            http authorizeRequests                and                  your code here               The ordering of all filters in Spring Security is available here  HttpSecurityBuilder - addFilter    Your custom UTF-8 encoding filter can look like following   public class EncodingFilter extends GenericFilterBean         Override     public void doFilter              ServletRequest request               ServletResponse response              FilterChain chain  throws IOException  ServletException            request setCharacterEncoding  UTF-8            response setCharacterEncoding  UTF-8             chain doFilter request  response             Don t forget to add in your jsp files    lt    page pageEncoding  UTF-8  contentType  text html  charset UTF-8    gt    And remove the CharacterEncodingFilter from web xml if it s there

[java] Spring MVC UTF-8 Encoding

Examples related to java

Examples related to spring-mvc

Examples related to utf-8

Examples related to character-encoding