HttpServletRequest - setCharacterEncoding seems to do nothing

Question

I am trying to read UTF-8 info from the request. I used "request.setCharacterEncoding("UTF-8");", but it seems to do nothing - the info read is non UTF-8.

What am i doing wrong?

Solution 1

If you are using tomcat, you should also set the URIEncoding to UTF-8 in your connectors:

<Server port="8105" shutdown="SHUTDOWN">
...
    <Service name="Catalina">
        <Connector port="8180" URIEncoding="UTF-8" />
        <Engine name="Catalina" defaultHost="localhost">
            <Host name="localhost" appBase="webapps" />
        </Engine>
    </Service>
</Server>

Solution 2

The HttpServletRequest#setCharacterEncoding() has only effect when the request is a POST request and the request body is not processed yet.

So if it doesn't work in your case, then it can have two causes:

1. You're actually firing a GET request. I.e. the request parameters are sent from client to server in the request URL instead of the request body. The request URL is processed by the webserver, not by the Servlet API. So, to fix this, you need to configure the webserver in question to decode the request URL (URI) using the specified character encoding. In case of for example Apache Tomcat, you need to set the URIEncoding attribute of the <Connector> element in server.xml to UTF-8.

2. You're correctly using POST, but you've already (indirectly) processed the request body so that it's too late to change the character encoding. The request body will be fully processed only whenever the first call on a getParameterXXX() method is made. There are several of them. It won't be re-processed on subsequent calls. When nailing down who's calling this method, don't forget to take all declared Filter instances in web.xml into account. Some of them might grab and scan the parameters.

If that still doesn't help anything, then the only possible cause left is that the display console or logger or whatever you're using to print/determine/debug the obtained request parameter does not support UTF-8. You'd like to reconfigure the console/logger/etc to use UTF-8 instead to display the characters. If it's for example the Eclipse console, then you can set it by Window > Preferences > General > Workspace > Text File Encoding.

See also:

• Unicode - How to get characters right? More background info, practical examples and solutions.

Solution 3

this method is really stupid. it shouldn't be there, and you shouldn't use it.

for a body in a POST request, the encoding should have been explicitly defined by the client in the Content-Type header. if not, it's a bad request. [1]

for a GET request URI, the client cannot specify encoding, and the server must have an implicit encoding, and the programmer needs to set the encoding, yet that method does not exist in Servlet API!

however, you servlet container could have a proprietary way of doing that.

the best way is probably set the default encoding of your JVM to UTF-8.

1: http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7.1

The "charset" parameter is used with some media types to define the character set (section 3.4) of the data. When no explicit charset parameter is provided by the sender, media subtypes of the "text" type are defined to have a default charset value of "ISO-8859-1" when received via HTTP. Data in character sets other than "ISO-8859-1" or its subsets MUST be labeled with an appropriate charset value.

Solution 4

The problem is dependent on which application server is used. The best description, which I found in this link.

In some application servers the request.setCharacterEncoding(...) has no effect until you set the application encoding using a descriptor. The most complicated are JBoss, Apache Tomcat, Glassfish. Better is WebLogic, the best is Jetty (UTF-8 is default setting).

In my case I must create a glassfish-web.xml descriptor and put there the parameter-encoding tag. In my case, for GlassFish:

<glassfish-web-app error-url="">
    <!-- request.setCharacterEncoding("UTF-8") not functioning without this setting-->
    <parameter-encoding default-charset="UTF-8" />
</glassfish-web-app>

Solution 5

are you doing it after any request.getParameter call.

request.setCharacterEncoding("UTF-8") must be called prior to any request.getParameter() call.

View more solutions

Comments

[Stephen C]

An for Tomcat (at least) that includes any calls to getParameter() made in any filters, or any valves. (So don't use RequestDumperValve!)

[Sylar]

I think he's trying to read request data and does not know how to decode it right. This flag does not change how request data is encoded, it tells the server how URIs (URLs) are to be encoded.

[Erik Sapir]

I am setting character encoding first thing. As answered below, works fine with POST method, but does not work with GET method

[Muhammad Ahmad Afzal]

Actually, its tells tomcat to use UTF-8 when decoding urls sent by the browser; if you do not specify it, it will use ISO-8859-1. If a URL contains form parameters, they will not be decoded correctly.

[BalusC]

Tell to the clients who are responsible for sending the header and/or to the inventor of the HTTP spec that sending the encoding along the content type header is mandatory.

[fausto]

Updated link to the very useful article mentioned here: oracle.com/technetwork/articles/javase/httpcharset-142283.ht‌​ml

[Jus12]

any non-container specific solution? I have same issue with jetty.

[Muhammad Ahmad Afzal]

sorry, the solution is jetty-specific: wiki.eclipse.org/Jetty/Howto/…

[Panayotis]

Thank you, that worked with glassfish 4.1. Note that the user needs to add request.setCharacterEncoding too - the parameter is not enough.

[hariprasad]

Thank you for clarification.

[A.Alqadomi]

Point 2 was the reason for me , you nailed it! thanks

[valijon]

Docs say that: Overrides the name of the character encoding used in the body of this request.. Does it mean it changes character encoding of the body, or only changes http header for the request