乐趣区

关于springboot:如何解决springboot参数传中文乱码

jiezi

前言

本文案例来自业务部门的一个业务场景。他们的业务场景是他们部门研发了一个微服务上下文透传组件，其透传原理也挺简略的，就是通过 springboot 拦截器把申请参数塞进 threadlocal，而后上游通过 threadlocal 取到值，服务之间进行 feign 调用时，再把 threadlocal 的参数塞到 header 头外面。这个组件始终用得好好的，忽然有一天因为传的参数值是中文，导致乱码。他们通过尝试上面的各种计划，都无奈解决。最初就让咱们部门排查解决。

业务部门的实现思路

他们一开始的思路方向是参数编码不统一导致中文乱码。于是他们就朝这个方向致力着，于是就有了如下计划

计划一：

String value = new String("我是中文乱码".getBytes("ISO-8859-1"),"UTF-8");

这个是罕用解决字符串中文乱码的办法之一

计划二：编写字符编码过滤器

@WebFilter(urlPatterns = "/*",filterName = "CharacterEncodingFilter")
public class CharacterEncodingFilter implements Filter{
    @Override
    public void init(FilterConfig filterConfig) throws ServletException { }
 
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
 
        filterChain.doFilter(request , response);
    }
    @Override
    public void destroy() {}
}

而后启动类上加上 @ServletComponentScan。@WebFilter 是 servlet3.0 才有的注解。当然这个过滤器你还能够这么写

public class CharacterEncodingFilter implements Filter{
    @Override
    public void init(FilterConfig filterConfig) throws ServletException { }
 
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
 
        filterChain.doFilter(request , response);
    }
    @Override
    public void destroy() {}
}

写个 bean 配置类，如下

    @Bean
    public FilterRegistrationBean registerAuthFilter() {FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new CharacterEncodingFilter();
        registration.addUrlPatterns("/*");
        registration.setName("CharacterEncodingFilter");
        registration.setOrder(1); 
        return registration;
    }

计划三：在 application.yml 指定编码格局为 utf-8

spring:
  http:
    encoding:
      charset: utf-8
      enabled: true
      force: true

server:
  tomcat:
    uri-encoding: UTF-8

计划四：写个 StringHttpMessageConverter


百度来的基本上都是长这样。不过在 spring5 版本 WebMvcConfigurerAdapter 这个类曾经过期。其代替形式是实现 WebMvcConfigurer 接口或者继承 WebMvcConfigurationSupport。不过如果应用 WebMvcConfigurationSupport，则会使 springboot 的 mvc 主动拆卸生效。生效的起因是

拓展一点小常识，加上 @EnableWebMvc 同样也会 springboot 的 mvc 主动拆卸生效。其起因是

org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration 这个配置类继承 WebMvcConfigurationSupport

介绍那么多种计划，并没有解决按例的问题。那问题点出在哪里？前边案例咱们提到过，在 feign 调用时，会把 threadlocal 的参数塞到 header 外面。真正乱码的问题点就在这里，header 是不反对中文传输的，如果你硬要传输，基本上接管方接到就是??? 这种看似乱码的符号

破题要害

在把 threadlocal 的值塞到 header 外面时，先做下 URLEncoder 编码，形如

URLEncoder.encode(“我是中文乱码”,"UTF-8")

在接管 header 参数时，做下 URLDecoder. 解码，形如下

URLDecoder.decode(header 中待解码的参数值, "UTF-8")

总结

方向错了，尽管再怎么致力看似也啥没卵用，不过至多可能会播种其余意想不到的货色

退出移动版