【最全, 6种方式】解决Tomcat静态资源(html, js)中文乱码问题

Tomcat响应静态资源中文乱码问题

在SpringBoot/SpringMVC环境下, 动态资源由DispatcherServlet拦截并处理,

一般动态资源的字符编码问题由CharacterEncodingFilter进行处理, xml配置如下:

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

对于静态资源:

如果使用<mvc:default-servlet-handler/>或者其他方式对静态资源放行, 由Tomcat的defaultServlet处理静态资源, 则静态资源的字符编码不受CharacterEncodingFilter过滤修改, 需要由Tomcat配置实现。

整理常用的Tomcat关于字符编码配置如下, 用于在出现中文乱码问题时进行逐一排查:

IDEA配置(优先修改):

修改IDEA配置

File -> Setting -> Editor -> File Encoding

其中Transparent native-to-ascii conversion项表示是否自动将字符转换为ASCII码进行保存, 而默认情况下是以ISO-8859-1编码格式进行保存, 该选项建议项目组同一配置, 默认不勾选。

配置一: web.xml

在Tomcat安装目录/conf/web.xml

增加defaultServlet的初始化参数, fileEncoding=UTF-8, 配置如下

    <servlet>
        <servlet-name>default</servlet-name>
        <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
        <init-param>
            <param-name>debug</param-name>
            <param-value>0</param-value>
        </init-param>
		<!--fileEncoding-->
		<init-param>
        	<param-name>fileEncoding</param-name>
        	<param-value>UTF-8</param-value>
        </init-param>
		<!--fileEncoding-->
        <init-param>
            <param-name>listings</param-name>
            <param-value>false</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

配置二: server.xml(非必须)

配置Connector属性URIEncoding=“UTF-8”

此属性影响到请求报文和响应报文的字符编码, 目前请求报文和响应报文字符编码一般通过代码实现, 暂未验证该配置的实际应用场景, 非必要不配置该属性

	<!--增加URIEncoding-"UTF-8"-->
    <Connector port="8080" protocol="HTTP/1.1" URIEncoding="UTF-8"
               connectionTimeout="20000"
               redirectPort="8443" />

配置三: Tomcat VM options

在Tomcat运行实例中配置VM options: -Dfile.encoding=UTF-8

该配置影响Tomcat中JDK虚拟机的默认文件字符编码, 出现中文乱码问题建议优先修改此配置进行调试。

原因是Windows, Linux, Mac OS系统的默认字符编码均为GBK, 不配置该属性则JDK的运行默认字符编码也是GBK, 可能影响文件的编码。

配置四: Edit Custom VM options…

在IDEA菜单中 Help -> Edit Custom VM options… 配置文件中添加一行 -Dfile.encoding=UTF-8,

该配置的原理同上, 是一个全局配置

配置五: 修改catlina.bat(慎用)

修改Tomcat安装目录/bin/catalina.bat 在@echo off后面添加一行 set JAVA_OPTS=-Dfile.encoding=UTF-8

修改Tomcat启动时的虚拟机配置, 该配置暂未验证应用场景, 建议慎用

衍生问题: IDEA控制台日志输出乱码

配置-Dfile.encoding=UTF-8, 将JVM启动环境的编码集设置为UTF-8后, 可能导致IDEA的控制台输出中文乱码。

原因是IDEA的控制台输出字符编码集默认为GBK编码。

解决方法: 通过修改Tomcat安装目录/conf/logging.properties配置

将java.util.logging.ConsoleHandler.encoding由GBK改为UTF-8

java.util.logging.ConsoleHandler.level = FINE
java.util.logging.ConsoleHandler.formatter = org.apache.juli.OneLineFormatter
java.util.logging.ConsoleHandler.encoding = UTF-8