如何让 UTF-8 在 Java webapps 中工作？

U

Unmitigated

回答我自己作为本网站的常见问题解答鼓励它。这对我有用：

大多数字符 äåö 不是问题，因为浏览器使用的默认字符集和 webapps 的 tomcat/java 是 latin1 即。 ISO-8859-1 “理解”这些字符。

要让 UTF-8 在 Java+Tomcat+Linux/Windows+Mysql 下工作，需要以下条件：

配置 Tomcat 的 server.xml

需要配置连接器使用 UTF-8 编码 url（GET 请求）参数：

<Connector port="8080" maxHttpHeaderSize="8192"
 maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
 enableLookups="false" redirectPort="8443" acceptCount="100"
 connectionTimeout="20000" disableUploadTimeout="true" 
 compression="on" 
 compressionMinSize="128" 
 noCompressionUserAgents="gozilla, traviata" 
 compressableMimeType="text/html,text/xml,text/plain,text/css,text/ javascript,application/x-javascript,application/javascript"
 URIEncoding="UTF-8"
/>

上面示例中的关键部分是 URIEncoding="UTF-8"。这保证了 Tomcat 以 UTF-8 编码处理所有传入的 GET 参数。结果，当用户在浏览器的地址栏中写入以下内容时：

 https://localhost:8443/ID/Users?action=search&name=*ж*

字符 ж 被处理为 UTF-8 并被编码为（通常在访问服务器之前由浏览器）为 %D0%B6。

POST 请求不受此影响。

字符集过滤器

然后是时候强制 java webapp 以 UTF-8 编码处理所有请求和响应。这要求我们定义一个字符集过滤器，如下所示：

package fi.foo.filters;

import javax.servlet.*;
import java.io.IOException;

public class CharsetFilter implements Filter {

    private String encoding;

    public void init(FilterConfig config) throws ServletException {
        encoding = config.getInitParameter("requestEncoding");
        if (encoding == null) encoding = "UTF-8";
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain next)
            throws IOException, ServletException {
        // Respect the client-specified character encoding
        // (see HTTP specification section 3.4.1)
        if (null == request.getCharacterEncoding()) {
            request.setCharacterEncoding(encoding);
        }

        // Set the default response content type and encoding
        response.setContentType("text/html; charset=UTF-8");
        response.setCharacterEncoding("UTF-8");

        next.doFilter(request, response);
    }

    public void destroy() {
    }
}

此过滤器确保如果浏览器未设置请求中使用的编码，则将其设置为 UTF-8。

此过滤器完成的另一件事是设置默认响应编码，即。返回的 html/whatever 的编码。另一种方法是在应用程序的每个控制器中设置响应编码等。

必须将此过滤器添加到 web.xml 或 webapp 的部署描述符中：

 <!--CharsetFilter start--> 

  <filter>
    <filter-name>CharsetFilter</filter-name>
    <filter-class>fi.foo.filters.CharsetFilter</filter-class>
      <init-param>
        <param-name>requestEncoding</param-name>
        <param-value>UTF-8</param-value>
      </init-param>
  </filter>

  <filter-mapping>
    <filter-name>CharsetFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

tomcat wiki (http://wiki.apache.org/tomcat/Tomcat/UTF-8 中提供了制作此过滤器的说明）

JSP 页面编码

在您的 web.xml 中，添加以下内容：

<jsp-config>
    <jsp-property-group>
        <url-pattern>*.jsp</url-pattern>
        <page-encoding>UTF-8</page-encoding>
    </jsp-property-group>
</jsp-config>

或者，webapp 的所有 JSP 页面都需要在其顶部具有以下内容：

 <%@page pageEncoding="UTF-8" contentType="text/html; charset=UTF-8"%>

如果使用具有不同 JSP 片段的某种布局，那么所有这些都需要这样做。

HTML 元标记

JSP 页面编码告诉 JVM 以正确的编码处理 JSP 页面中的字符。然后是时候告诉浏览器html页面的编码是什么了：

这是通过 webapp 生成的每个 xhtml 页面顶部的以下内容完成的：

   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fi">
   <head>
   <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
   ...

JDBC 连接

使用 db 时，必须定义连接使用 UTF-8 编码。这是在 context.xml 或任何 JDBC 连接被定义的地方完成的，如下所示：

      <Resource name="jdbc/AppDB" 
        auth="Container"
        type="javax.sql.DataSource"
        maxActive="20" maxIdle="10" maxWait="10000"
        username="foo"
        password="bar"
        driverClassName="com.mysql.jdbc.Driver" url="jdbc:mysql://localhost:3306/      ID_development?useEncoding=true&amp;characterEncoding=UTF-8"
    />

MySQL 数据库和表

使用的数据库必须使用 UTF-8 编码。这是通过使用以下内容创建数据库来实现的：

   CREATE DATABASE `ID_development` 
   /*!40100 DEFAULT CHARACTER SET utf8 COLLATE utf8_swedish_ci */;

然后，所有表也需要采用 UTF-8 格式：

   CREATE TABLE  `Users` (
    `id` int(10) unsigned NOT NULL auto_increment,
    `name` varchar(30) collate utf8_swedish_ci default NULL
    PRIMARY KEY  (`id`)
   ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_swedish_ci ROW_FORMAT=DYNAMIC;

关键部分是 CHARSET=utf8。

MySQL服务器配置

MySQL serveri 也必须配置。这通常在 Windows 中通过修改 my.ini 文件来完成，在 Linux 中通过配置 my.cnf 文件来完成。在这些文件中，应该定义连接到服务器的所有客户端都使用 utf8 作为默认字符集，并且服务器使用的默认字符集也是 utf8。

   [client]
   port=3306
   default-character-set=utf8

   [mysql]
   default-character-set=utf8

Mysql程序和函数

这些也需要定义字符集。例如：

   DELIMITER $$

   DROP FUNCTION IF EXISTS `pathToNode` $$
   CREATE FUNCTION `pathToNode` (ryhma_id INT) RETURNS TEXT CHARACTER SET utf8
   READS SQL DATA
   BEGIN

    DECLARE path VARCHAR(255) CHARACTER SET utf8;

   SET path = NULL;

   ...

   RETURN path;

   END $$

   DELIMITER ;

GET 请求：latin1 和 UTF-8

如果并且当它在 tomcat 的 server.xml 中定义 GET 请求参数以 UTF-8 编码时，则正确处理以下 GET 请求：

   https://localhost:8443/ID/Users?action=search&name=Petteri
   https://localhost:8443/ID/Users?action=search&name=ж

因为 ASCII 字符的编码方式与 latin1 和 UTF-8 相同，所以可以正确处理字符串“Petteri”。

西里尔字母 ж 在 latin1 中根本无法理解。因为 Tomcat 被指示将请求参数作为 UTF-8 处理，所以它将该字符正确编码为 %D0%B6。

如果并且当指示浏览器以 UTF-8 编码（带有请求标头和 html 元标记）读取页面时，至少 Firefox 2/3 和该时期的其他浏览器都将字符本身编码为 %D0%B6。

最终结果是找到了所有名为“Petteri”的用户，也找到了所有名为“ж”的用户。

但是äåö呢？

HTTP 规范定义默认情况下 URL 编码为 latin1。这会导致 firefox2、firefox3 等对以下内容进行编码

    https://localhost:8443/ID/Users?action=search&name=*Päivi*

进入编码版本

    https://localhost:8443/ID/Users?action=search&name=*P%E4ivi*

在 latin1 中，字符 ä 被编码为 %E4。即使页面/请求/一切都被定义为使用 UTF-8。 ä 的 UTF-8 编码版本是 %C3%A4

这样做的结果是 webapp 完全不可能正确处理来自 GET 请求的请求参数，因为有些字符是用 latin1 编码的，而另一些是用 UTF-8 编码的。注意：如果页面被定义为 UTF-8，则 POST 请求确实可以工作，因为浏览器将表单中的所有请求参数完全编码为 UTF-8

需要阅读的东西

非常感谢以下作者为我的问题提供答案：

http://tagunov.tripod.com/i18n/i18n.html

http://wiki.apache.org/tomcat/Tomcat/UTF-8

http://java.sun.com/developer/technicalArticles/Intl/HTTPCharset/

http://dev.mysql.com/doc/refman/5.0/en/charset-syntax.html

http://cagan327.blogspot.com/2006/05/utf-8-encoding-fix-tomcat-jsp-etc.html

http://cagan327.blogspot.com/2006/05/utf-8-encoding-fix-for-mysql-tomcat.html

http://jeppesn.dk/utf-8.html

http://www.nabble.com/request-parameters-mishandle-utf-8-encoding-td18720039.html

http://www.utoronto.ca/webdocs/HTMLdocs/NewHTML/iso_table.html

http://www.utf8-chartable.de/

重要的提示

mysql 支持使用 3 字节 UTF-8 字符的 Basic Multilingual Plane。如果您需要超出此范围（某些字母需要超过 3 字节的 UTF-8），那么您需要使用 VARBINARY 列类型或使用 utf8mb4 character set（这需要 MySQL 5.5.3或以后）。请注意，在 MySQL 中使用 utf8 字符集不会 100% 有效。

Tomcat 与 Apache

另一件事如果您使用的是 Apache + Tomcat + mod_JK 连接器，那么您还需要进行以下更改：

将 URIEncoding="UTF-8" 添加到 8009 连接器的 tomcat server.xml 文件中，供 mod_JK 连接器使用。转到您的 apache 文件夹，即 /etc/httpd/conf 并在 httpd.conf 文件中添加 AddDefaultCharset utf-8 .注意：首先检查它是否存在。如果存在，您可以使用此行更新它。您也可以在底部添加此行。

这些步骤也适用于 Struts/tiles 和 postgres 数据库。

两条评论：1）在 HMTL-meta 标签 中包含了一个 xml 声明。删除它，它只会在怪癖模式下触发浏览器，你不想这样。此外，HTML 元标记实际上已经由 JSP pageEncoding 隐式完成，因此您甚至可以不使用它。 2) 在 MySQL 数据库和表 中，您使用了 utf8_swedish_si，这应该是 utf8_unicode_ci。您甚至可以不使用排序规则，只需 CHARACTER SET utf8 就足够了。

我查阅的有关 HTML 元标记和怪癖模式的文档（例如 ericmeyeroncss.com/bonus/render-mode.html、en.wikipedia.org/wiki/Quirks_mode）都没有表明 <meta http-equiv='Content-Type' 的存在对呈现模式有任何影响。

作为一个有趣的旁注，您可能还想知道，如果您有一个访问请求参数的侦听器，您将需要添加一个设置字符集而不是过滤器的侦听器，因为侦听器在过滤器之前执行。我遵循了所有步骤，但由于这个原因它仍然无法正常工作。只是想我会传递这个信息，以防其他人有类似的问题。

## Tomcat 与 Apache ## 另一件事如果您使用 Apache + Tomcat + mod_JK 连接器，那么您还需要进行以下更改： 1. 将 URIEncoding="UTF-8" 添加到 8009 连接器的 tomcat server.xml 文件中，它由 mod_JK 连接器使用。 <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" URIEncoding="UTF-8"/> 2. 转到您的 apache 文件夹，即 /etc/httpd/conf 并在“httpd.conf”文件中添加 AddDefaultCharset utf-8。 注意：首先检查它是否存在。如果存在，您可以使用此行更新它。您也可以在底部添加此行。

s

stian

我认为您在自己的答案中总结得很好。

在端到端的 UTF-8-ing(?) 过程中，您可能还想确保 java 本身使用 UTF-8。使用 -Dfile.encoding=utf-8 作为 JVM 的参数（可以在 catalina.bat 中配置）。

这对我有帮助，我做了所有提到的事情，但是一旦我更改为 UTF-8，JVM 编码就是 windows-1250，它可以完美地工作。

请问您在 Catalina.bat 文件中的哪个位置添加它？

C

Community

要添加到 kosoant's answer，如果您使用的是 Spring，而不是编写自己的 Servlet 过滤器，您可以使用它们提供的类 org.springframework.web.filter.CharacterEncodingFilter，在 web.xml 中进行如下配置：

 <filter>
    <filter-name>encoding-filter</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>FALSE</param-value>
    </init-param>
 </filter>
 <filter-mapping>
    <filter-name>encoding-filter</filter-name>
    <url-pattern>/*</url-pattern>
 </filter-mapping>

此过滤器必须是 web.xml 中的第一个过滤器

n

n00begon

我还想从 here 添加这部分解决了我的 utf 问题：

runtime.encoding=<encoding>

M

Mike Mountrakis

当我们想使用 Java 访问 MySql 表时，这是针对希腊语编码的：

在您的 JBoss 连接池 (mysql-ds.xml) 中使用以下连接设置

<connection-url>jdbc:mysql://192.168.10.123:3308/mydatabase</connection-url>
<driver-class>com.mysql.jdbc.Driver</driver-class>
<user-name>nts</user-name>
<password>xaxaxa!</password>
<connection-property name="useUnicode">true</connection-property>
<connection-property name="characterEncoding">greek</connection-property>

如果您不想将其放入 JNDI 连接池中，则可以将其配置为 JDBC-url，如下一行所示：

jdbc:mysql://192.168.10.123:3308/mydatabase?characterEncoding=greek

对我和尼克来说，所以我们永远不会忘记它并不再浪费时间......

我仍然更喜欢 UTF-8 而不是希腊语（并将您当前的希腊语数据转换为 UTF-8），以便您的应用程序准备好统治世界。

J

Jay

好详细的答案。只是想再添加一件事，这肯定会帮助其他人看到 URL 上的 UTF-8 编码在起作用。

按照以下步骤在 Firefox 中对 URL 启用 UTF-8 编码。

在地址栏中输入“about:config”。使用过滤器输入类型搜索“network.standard-url.encode-query-utf8”属性。上述属性默认为 false，将其设置为 TRUE。重启浏览器。

URL 上的 UTF-8 编码默认在 IE6/7/8 和 chrome 中有效。

R

Rogelio Triviño

以前的回复不适用于我的问题。它只是在生产中，带有 tomcat 和 apache mod_proxy_ajp。帖子正文丢失了非 ascii 字符？问题最终出在 JVM defaultCharset（默认安装中的 US-ASCII：Charset dfset = Charset.defaultCharset();）所以，解决方案是运行带有修饰符的 tomcat 服务器，以运行 UTF-8 作为默认字符集的 JVM：

JAVA_OPTS="$JAVA_OPTS -Dfile.encoding=UTF-8"

（将此行添加到 catalina.sh 和服务 tomcat 重新启动）

也许您还必须更改 linux 系统变量（编辑 ~/.bashrc 和 ~/.profile 以进行永久更改，请参阅 https://perlgeek.de/en/article/set-up-a-clean-utf8-environment）

导出 LC_ALL=en_US.UTF-8 导出 LANG=en_US.UTF-8 导出 LANGUAGE=en_US.UTF-8

c

caarlos0

我遇到了类似的问题，但是，在我使用 apache commons 压缩的文件的文件名中。所以，我用这个命令解决了它：

convmv --notest -f cp1252 -t utf8 * -r

它对我来说效果很好。希望它可以帮助任何人;）

b

bnguyen82

对于从消息包中显示 Unicode 字符的情况，我不需要应用“JSP 页面编码”部分来在我的 jsp 页面上显示 Unicode。我需要的只是“CharsetFilter”部分。

D

David

尚未提及的另一点与使用 Ajax 的 Java Servlet 有关。我遇到网页从用户那里获取 utf-8 文本并将其发送到 JavaScript 文件的情况，该文件将其包含在发送到 Servlet 的 URI 中。 Servlet 查询数据库，捕获结果并将其作为 XML 返回到 JavaScript 文件，该文件对其进行格式化并将格式化的响应插入到原始网页中。

在一个 Web 应用程序中，我按照早期 Ajax 书籍的说明来包装 JavaScript 以构建 URI。书中的示例使用了 escape() 方法，我发现（困难的方法）是错误的。对于 utf-8，您必须使用 encodeURIComponent()。

这些天似乎很少有人推出自己的 Ajax，但我想我不妨添加这个。

A

Alireza Fattahi

关于@kosoant 回答中提到的CharsetFilter ....

在 tomcat web.xml（位于 conf/web.xml）中的 Filter 中有一个构建。过滤器名为 setCharacterEncodingFilter，默认情况下带有注释。您可以取消注释（请记住也取消注释它的 filter-mapping）

也无需在您的 web.xml 中设置 jsp-config （我已经为 Tomcat 7+ 测试过）

M

MrSalesi

有时您可以通过 MySQL 管理员向导解决问题。在

启动变量 > 高级 >

并设置 Def。字符集：utf8

也许这个配置需要重启 MySQL。

A

Andrei Veshtard

在 Spring MVC 5 + Tomcat 9 + JSP 上面临同样的问题。经过长时间的研究，得出了一个优雅的解决方案（无需过滤器，无需更改Tomcat server.xml（从8.0.0-RC3版本开始））

在 WebMvcConfigurer 实现中为 messageSource 设置默认编码（用于以 UTF-8 编码从消息源文件中读取数据。@Configuration @EnableWebMvc @ComponentScan("{package.with.components}") public class WebApplicationContextConfig implements WebMvcConfigurer { @Bean public MessageSource messageSource() { final ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource(); messageSource.setBasenames("messages"); messageSource.setDefaultEncoding("UTF-8"); return messageSource; } /* 其他 bean 和方法 */ } 在 DispatcherServletInitializer实现 @Override onStartup 方法并在其中设置请求和资源字符编码 public class DispatcherServletInitializer extends AbstractAnnotationConfigDispatcherServletInitializer { @Override public void onStartup(final ServletContext servletContext) throws ServletException { // https://wiki.apache.org/tomcat/FAQ /CharacterEncoding servletContext.setRequestCharacterEncoding("UTF- 8"); servletContext.setResponseCharacterEncoding("UTF-8"); super.onStartup(servletContext); } /* servlet 映射、根和 Web 应用程序配置、其他方法 */ } 以 UTF-8 编码保存所有消息源和视图文件。在每个 *.jsp 文件中添加 <%@ page contentType="text/html;charset=UTF-8" %> 或 <%@ page pageEncoding="UTF-8" %> 或将 jsp-config 描述符添加到 web.xml AppName *.jsp UTF-8

L

LPL

如果您已在连接池 (mysql-ds.xml) 中指定，您可以在 Java 代码中打开连接，如下所示：

DriverManager.registerDriver(new com.mysql.jdbc.Driver());
Connection conn = DriverManager.getConnection(
    "jdbc:mysql://192.168.1.12:3308/mydb?characterEncoding=greek",
    "Myuser", "mypass");

如何让 UTF-8 在 Java webapps 中工作？

关注公众号

想领先一步获取最新的外包任务吗？

相似问题

平台

支持

联系我们