首页 > 技术文章 > Spring Framework 5.0.0 中的 CharacterEncodingFilter

lemon-coke-pudding 2020-04-21 21:32 原文

在使用 SpringMVC 框架的过程中,如果前台有包含中文的请求,或者后台有包含中文的响应,有可能会出现乱码的情况。在以前的 Servlet 中,我们使用 request.setCharacterEncoding("UTF-8");response.setContentType("text/html;charset=UTF-8"); 来设置请求和响应的编码。在 SpringMVC 中,框架直接给我们提供了一个用来解决请求和响应的乱码问题的过滤器 CharacterEncodingFilter注意:请将 CharacterEncodingFilter 配置在其他过滤器之前。

web.xml 中添加 CharacterEncodingFilter 过滤器:

	<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>forceRequestEncoding</param-name>
			<param-value>true</param-value>
		</init-param>
		<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>

CharacterEncodingFilter 中有三个初始化参数:encodingforceRequestEncodingforceResponseEncoding

  • encoding:只有在 isForceRequestEncoding = false 并且 request 中没有设置编码的时候才会将 request 中的编码设置为 encoidng 中指定的编码格式。
  • forceRequestEncoding:强制设置 request 的编码格式。forceRequestEncoding = true 的时候会强制的将 request 中的编码设置为 encoding 中指定的编码格式,如果 request 中已经指定了编码格式,将会强行设置为 encoding 中的编码格式。
  • forceResponseEncoding:强制设置 response 的编码格式。forceResponseEncoding = true 的时候会强制的将 response 中的编码格式设置为 encoding 中指定的编码格式。
        @Override
	protected void doFilterInternal(
			HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
			throws ServletException, IOException {

		String encoding = getEncoding();
		if (encoding != null) {
			if (isForceRequestEncoding() || request.getCharacterEncoding() == null) {
				request.setCharacterEncoding(encoding);
			}
			if (isForceResponseEncoding()) {
				response.setCharacterEncoding(encoding);
			}
		}
		filterChain.doFilter(request, response);
	}

推荐阅读