Servlet 中 CharacterEncodingFilter 失效？

Posted 2020-09-10 Piers

# 问题

 

Spring 提供了CharcterEncodingFilter，专门解决字符串编码的问题。

诡异的是，在类 AbstractAnnotationConfigDispatcherServletInitializer 方法 getFilters 设置了 CharcterEncodingFilter，结果字符集还是乱码。

 

# 排查

 

首先检查是否是上传的值编码错误：通过 Chrome Debug 工具，传出的值经过解码，是正确的。

 

再考虑是否是 request 解码错误。request.getCharacterEncoding() 的返回值为 "utf-8"。解码也是没问题。

  

# 核心

 

契机：我有一天想从 Eclipse 转入 IDEA，便把项目重新导入一遍。导入的过程中我会想起，一开始是没有问题，后来加了一个模块就开始有问题了。后来想想这个模块是 Spring Security。

 

在 Servlet 中，Filter 是一个链，而 Spring Security 是第一个过滤链。字符编码必须在第一个链过滤，因为解码之后就不再解码了（直解码一次，之后就返回第一次解码的内容）。

 

# 解决

 

在 Security 模块注册 CharcterEncodingFilter。

public class TeachingTestSecurityWebApplicationInitializer extends AbstractSecurityWebApplicationInitializer {

    @Override
    protected void beforeSpringSecurityFilterChain(ServletContext servletContext) {
        FilterRegistration.Dynamic characterEncodingFilter = servletContext.addFilter("encodingFilter", new CharacterEncodingFilter());
        characterEncodingFilter.setInitParameter("encoding", "UTF-8");
        characterEncodingFilter.setInitParameter("forceEncoding", "true");
        characterEncodingFilter.addMappingForUrlPatterns(null, false, "/*");
    }   
    
}