[Java知识库]Tomcat 访问静态资源html、txt等出现中文乱码及获取Request域中数据乱码解决方案

注意: 非本人阅读请跳转到问题分析与解决一栏
分类分析:

• 非Spring MVC项目
• Spirng MVC项目

本文章所使用 Tomcat 版本分别为7.0.100和8.5.54

注意: 本文的 html 文件均带了<meta charset="utf-8">标签如果没带此标签，解析html和解析txt效果一样！！

非Spring MVC项目

在非spring mvc项目中出现访问静态资源乱码，如 txt 文本等，一般都是文件编码为非BOM的UTF-8，将文件编码改为UTF-8 BOM格式即可。具体信息查看下面表格:

Spirng MVC项目

如果配置了CharacterEncodingFilter且初始化了参数forceResponseEncoding或forceEncoding为true，此时每次请求静态资源时，CharacterEncodingFilter都会在响应头加上charset=UTF-8。参数为false，或未设置时，情况和上面非Spring MVC情况一致。

<filter>
        <filter-name>characterEncodingFilter</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>
        <!--初始化forceResponseEncoding为true-->
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

当设置了forceResponseEncoding或forceEncoding为true时，具体显示信息如下:

问题分析与解决

解决乱码只需加入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>
        <init-param>
            <param-name>listings</param-name>
            <param-value>false</param-value>
        </init-param>
        <!--fileEncoding  
        Encoding to be used to read static resources 
        [platform default]-->
        <!--增加下面初始化参数-->
        <init-param>
        	<param-name>fileEncoding</param-name>
        	<param-value>UTF-8</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

影响DefaultServlet解析静态资源编码主要有两个重要的参数fileEncoding和useBomIfPresent

	/**
     * File encoding to be used when reading static files. If none is specified
     * the platform default is used.
     */
     //读取静态文件时要使用的文件编码,如果未指定，则使用平台默认值。
    protected String fileEncoding = null;
    private transient Charset fileEncodingCharset = null;

    /**
     * If a file has a BOM, should that be used in preference to fileEncoding?
     * Will default to {@code BomConfig.TRUE} in {@link #init()}.
     */
     //如果文件有BOM，是否应该优先使用BOM而不是fileEncoding？将在init()中默认设置为BomConfig.TRUE。
    private BomConfig useBomIfPresent = null;

init()源码:

		//获取初始化参数fileEncoding,若没有则返回null
        fileEncoding = getServletConfig().getInitParameter("fileEncoding");
        if (fileEncoding == null) {
        	//尝试输出fileEncoding得到结果为GBK----用命令行运行测试Charset.defaultCharset()
        	//IDEA或者Eclipse运行出来的结果可能是UTF-8
            fileEncodingCharset = Charset.defaultCharset();
            fileEncoding = fileEncodingCharset.name();
        } else {
            ……
        }
		//获取初始化参数useBomIfPresent,若没有则返回null
        String useBomIfPresent = getServletConfig().getInitParameter("useBomIfPresent");
        if (useBomIfPresent == null) {
            // Use default
            //使用默认值BomConfig.TRUE
            this.useBomIfPresent = BomConfig.TRUE;
        } else {
            ……
            }
           

枚举类BomConfig源码:

static enum BomConfig {
        /**
         * BoM is stripped if present and any BoM found used to determine the
         * encoding used to read the resource.
         */
         //如果存在BOM，则会将其剥离，并使用找到的BOM来确定用于读取资源的编码。
        TRUE("true", true, true),
        /**
         * BoM is stripped if present but the configured file encoding is used
         * to read the resource.
         */
         //BOM(如果存在)将被剥离，但配置的文件编码(fileEncoding)用于读取资源。
        FALSE("false", true, false),
……

综上，如果未指定fileEncoding初始化参数，Tomcat将使用平台默认编码解析静态资源，而Windows默认编码为GBK，所以解码UTF-8的文件出现乱码。为什么带BOM的文件Tomcat能正常解析，那是因为参数useBomIfPresent的默认值为BomConfig.TRUE，此情况下Tomcat解析到带有BOM的文件时BOM推断出的编码优先级高于fileEncoding属性，比如前三个字节为EF BB BF，Tomcat便知道这个静态资源是UTF-8编码，于是使用UTF-8解码(即使fileEncoding = GBK)。至于为什么html能普遍解析成功，个人猜测是因为<meta charset="utf-8">标签告诉Tomcat此文件是UTF-8编码，所以Tomcat能解析成功。

关于获取Request域中数据乱码问题

public void init() {
        messageGET = "GET-----你好";
        messagePOST = "POST-----你好";
    }
 public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
        //request
        //默认request.getCharacterEncoding()返回null
        if (null == request.getCharacterEncoding()) {
            System.out.println("charset == null");
        }
        //tomcat7 ---解码url用ISO-8859-1  ----解决方法->使用tomcat8+或者修改server.xml
        //<Connector connectionTimeout="20000"  (URIEncoding="UTF-8") port="8080" protocol="HTTP/1.1" redirectPort="8443"/>
        //tomcat8 ---解码url用UTF-8
        //GET请求无法提供以下方法修改获取url参数的编码方式
//        request.setCharacterEncoding("UTF-8");
        String s = request.getParameter("s");
        System.out.println("GET-----s: " + new String(s.getBytes(StandardCharsets.ISO_8859_1), StandardCharsets.UTF_8));
        //response
        //tomcat响应默认用ISO-8859-1
        //response.getCharacterEncoding()默认返回ISO-8859-1
        System.out.println("response: " + response.getCharacterEncoding());
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html");
        PrintWriter out = response.getWriter();
        out.println("<html><body>");
        out.println("<h1>" + messageGET + "</h1>");
        out.println("</body></html>");
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //request
        //默认request.getCharacterEncoding()返回null
        if (null == req.getCharacterEncoding()) {
            System.out.println("charset == null");
        }
        //POST请求通过以下方法修改读取请求体数据的编码
        req.setCharacterEncoding("UTF-8");
        if (null != req.getCharacterEncoding()) {
            System.out.println("charset == " + req.getCharacterEncoding());
        }
        //POST读取参数默认用ISO-8859-1
        String s = req.getParameter("s");
        System.out.println("POST------s: " + s);
        //response
        //响应默认用ISO-8859-1
        //response.getCharacterEncoding()默认返回ISO-8859-1
        System.out.println("response: " + resp.getCharacterEncoding());
        resp.setCharacterEncoding("UTF-8");
        resp.setContentType("text/html");
        PrintWriter out = resp.getWriter();
        out.println("<html><body>");
        out.println("<h1>" + messagePOST + "</h1>");
        out.println("</body></html>");
    }

本文章仅个人学习记载，包含主观想法，并不确保正确性。如若有误，恳请指正！