记录一个关于 GBK 编码的问题

背景

区分 UTF-8 和 GBK

GBK 是在国家标准 GB2312 基础上扩容后兼容 GB2312 的标准,专门用来解决中文编码的,是双字节的,不论中英文都是双字节的。

UTF-8 是一种国际化的编码方式,包含了世界上大部分的语种文字(简体中文字、繁体中文字、英文、日文、韩文等语言),也兼容 ASCII 码。

虽然 GBK 比 UTF-8 少节省两个字节,但是 GBK 只包含中文,UTF-8 则包含全世界所有国家需要用到的字符,所以现在很多系统或者框架处理都默认使用 UTF-8 。

不过业务开发对接系统接口的时候,经常会碰到一些老系统使用 GBK 编码,特别是国内支付,这个时候需要兼容 GBK 和 UTF-8 编码。

如何让项目兼容 UTF-8 和 GBK

我们使用 spring boot 2.7 版本。我们默认API使用 UTF-8 ,特别的 API 使用 GBK。在 spring boot 中,当收到请求解析前会通过 CharacterEncodingFilter 进行内容编码格式指定。

    @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);
    }

通过以下方式可以修改项目全局的编码方式

server:
  servlet:
    encoding:
      charset: UTF-8
      force-request: false
      force-response: false

看下默认情况下,编码格式 UTF-8 并且每次都强制转换,什么意思?也就是就算你请求头 application/json;charset=GBK 这样也不会按照头的编码解析,会强制给你转成 UTF-8,如果是 GBK 过来的内容,你就等着吃乱码吧!


    @Bean
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));
        return filter;
    }

public boolean shouldForce(Type type) {
        Boolean force = (type != Type.REQUEST) ? this.forceResponse : this.forceRequest;
        if (force == null) {
            force = this.force;
        }
        if (force == null) {
            force = (type == Type.REQUEST);
        }
        return force;
    }

现在有一个支付系统,它请求的内容是 GBK 编码,并且有 GET 和 POST 两种方式过来,我们系统接口默认是 UTF-8,所以只有针对特定的 GBK 接口进行处理。需要支持下面几种请求情况。

  1. POST 对方的请求内容 GBK 编码并且请求头里指定了编码方式 application/json;charset=GBK
  2. POST 对方的请求内容 GBK 编码并且请求头里未指定编码方式 application/json
  3. GET 对方的请求内容 GBK 编码。

第一种情况,我们只需要关闭强制转换,带了charset=gbk,就会使用 gbk 编码进行解析,默认不带则使用 utf-8 解析。

server:
  servlet:
    encoding:
            force: false

第二种和第三种情况,我们需要先关闭强制转换,然后添加一个优先级很高的过滤器将指定的请求设置为 GBK 编码格式(也就是在进入spring 解析前就要处理),如果使用 tomcat 容器的话如下处理。

@Slf4j
@Configuration
public class GBKFilterConfig {
    @Bean
    public FilterRegistrationBean gbkFilter() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setDispatcherTypes(DispatcherType.REQUEST);
        registration.setFilter(new Filter() {
            @Override
            public void init(javax.servlet.FilterConfig filterConfig) throws ServletException {
            }

            @Override
            public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
                    throws IOException, ServletException {
                RequestFacade req = (RequestFacade) request;
                Class clazz = req.getClass();
                log.info("GBK Filter...");
                try {
                    Field field = clazz.getDeclaredField("request");
                    field.setAccessible(true);
                    Request r = (Request) field.get(req);
                    org.apache.coyote.Request p = r.getCoyoteRequest();
                    // GET 请求参数强使用 GBK 编码。
                    p.getParameters().setQueryStringCharset(Charset.forName("GBK"));
                    // POST 请求带头未指定编码,强制使用 GBK
                    p.getParameters().setCharset(Charset.forName("GBK"));
                    p.setCharset(Charset.forName("GBK"));
                    chain.doFilter(request, response);
                } catch (Exception e) {
                   log.error("error", e)
                }
            }

            @Override
            public void destroy() {
            }
        });
        registration.addUrlPatterns("/api/gbk/**");
        registration.setName("gbkFilter");
        registration.setOrder(Integer.MIN_VALUE);
        return registration;
    }
}

多年编程老菜鸟👨‍💻🦍

445 声望
1.4k 粉丝
0 条评论
推荐阅读
Spring事务传播行为详解
Spring在TransactionDefinition接口中规定了7种类型的事务传播行为。事务传播行为是Spring框架独有的事务增强特性,他不属于的事务实际提供方数据库行为。这是Spring为我们提供的强大的工具箱,使用事务传播行可...

JerryTse238阅读 121.1k评论 94

刨根问底 Redis, 面试过程真好使
充满寒气的互联网如何在面试中脱颖而出,平时积累很重要,八股文更不能少!下面带来的这篇 Redis 问答希望能够在你的 offer 上增添一把🔥。

菜农曰17阅读 973

封面图
PHP转Go实践:xjson解析神器「开源工具集」
我和劲仔都是PHP转Go,身边越来越多做PHP的朋友也逐渐在用Go进行重构,重构过程中,会发现php的json解析操作(系列化与反序列化)是真的香,弱类型语言的各种隐式类型转换,很大程度的减低了程序的复杂度。

王中阳Go10阅读 2k评论 3

封面图
万字详解,吃透 MongoDB!
MongoDB 是一个基于 分布式文件存储 的开源 NoSQL 数据库系统,由 C++ 编写的。MongoDB 提供了 面向文档 的存储方式,操作起来比较简单和容易,支持“无模式”的数据建模,可以存储比较复杂的数据类型,是一款非常...

JavaGuide5阅读 847

封面图
计算机网络连环炮40问
本文已经收录到Github仓库,该仓库包含计算机基础、Java基础、多线程、JVM、数据库、Redis、Spring、Mybatis、SpringMVC、SpringBoot、分布式、微服务、设计模式、架构、校招社招分享等核心知识点,欢迎star~

程序员大彬8阅读 1.1k

与RabbitMQ有关的一些知识
工作中用过一段时间的Kafka,不过主要还是RabbitMQ用的多一些。今天主要来讲讲与RabbitMQ相关的一些知识。一些基本概念,以及实际使用场景及一些注意事项。

lpe2348阅读 1.9k

封面图
Git操作不规范,战友提刀来相见!
年终奖都没了,还要扣我绩效,门都没有,哈哈。这波骚Git操作我也是第一次用,担心闪了腰,所以不仅做了备份,也做了笔记,分享给大家。问题描述小A和我在同时开发一个功能模块,他在优化之前的代码逻辑,我在开...

王中阳Go5阅读 2.3k评论 2

封面图

多年编程老菜鸟👨‍💻🦍

445 声望
1.4k 粉丝
宣传栏