Spring MVC中的CharacterEncodingFilter介绍以及源码分析

一、场景

CharacterEncodingFilter是Spring MVC很简单很实用的一个过滤器,当前台JSP页面和JAVA代码中使用了不同的字符集进行编码的时候就会出现表单提交的数据或者上传/下载中文名称文件出现乱码的问题,那这个类就可以出场了。

二、配置

从名字就可以看出来它是个过滤器了,所以就要想配置普通过滤器那样配置到web.xml中去了,配置方式如下:
 <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>
        <init-param>
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
  </filter>
  <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern> </filter-mapping>

为了加深印象从源码来分析一下这个参数的变化。

三、源码分析

package org.springframework.web.filter;

import java.io.IOException;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;


public class CharacterEncodingFilter extends OncePerRequestFilter {

    private String encoding; //要使用的字符集,一般我们使用UTF-8(保险起见UTF-8最好)
    private boolean forceRequestEncoding = false; //是否强制设置request的编码为encoding
    private boolean forceResponseEncoding = false; //是否强制设置response的编码为encoding
    private boolean forceEncoding = false;//相当于forceRequestEncoding 和 forceResponseEncoding 


    /** * Set the encoding to use for requests. */
    public void setEncoding(String encoding) {
        this.encoding = encoding;
    }


    public void setForceEncoding(boolean forceEncoding) {
        this.forceEncoding = forceEncoding;
    }


   @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {

        String encoding = getEncoding();
        if (encoding != null) { //如果设置了encoding的值,则根据情况设置request和response的编码
            //若设置request强制编码或request本身就没有设置编码
            //则设置编码为encoding表示的值
            if (isForceRequestEncoding() || request.getCharacterEncoding() == null) { 
                request.setCharacterEncoding(encoding);
            }
            //若设置response强制编码,则设置编码为encoding表示的值
            if (isForceResponseEncoding()) { //请注意这行代码,下面有额外提醒
                response.setCharacterEncoding(encoding);
            }
        }
        filterChain.doFilter(request, response);
    }

这个filter可能与我们自己写的Filter不太相同,它继承的是OncePerRequestFilter,看看OncePerRequestFilter的源码,可以发现,OncePerRequestFilter的过滤器会负责调用doFilterInternal()方法,因此,我们只关注这个方法即可。

这个方法很简单,就是看看是否设置了encoding,如果设置了encoding,且请求中没有设置characterEncoding的话,它会负责设置characterEncoding,并且如果forceEncoding设置为true的话,在responce中也会设置characterEncoding。
我觉得这个作用就是更改HTTP报头中charset的内容,仅此而已,不会更改HTTPbody中的编码格式。所以我想到使用setContentType()来显式的设置输出的报文信息
也就是说:Spring里的字符过滤器CharacterEncodingFilter是针对请求的,forceEncoding=true是意思是指无论客户端请求是否包含了编码,都用过滤器里的编码来解析请求

setContentType("text/json";charst=utf-8);

最后调用filterChain.doFilter(request, response);
doFilter的作用是将请求转发给过滤器链上下一个对象。这里的下一个指的是下一个filter,如果没有filter那就是你请求的资源。 一般filter都是一个链,web.xml 里面配置了几个就有几个。一个一个的连在一起
request -> filter1 -> filter2 ->filter3 -> …. -> request resource.

    原文作者:Spring MVC
    原文地址: https://blog.csdn.net/github_38687585/article/details/81867024
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞