springboot Spring Cloud Gateway 彻底解决Exceeded limit on max bytes to buffer : 262144报错问题

一、问题描述

使用Spring Cloud Gateway开发内部API网关时，当业务的Http请求体大小超过256K时，会出现如下报错：Exceeded limit on max bytes to buffer : 262144。

Spring Boot框架给了两种方式来修改这个大小的方式： 方式一：使用修改配置参数值，spring.max-in-memory-size: 1024 * 1024 的方式

spring:

application:

name: gateway

codec:

max-in-memory-size: 1024 * 1024

方式二：使用WebFluxConfigurer，通过set方法设置max-in-memory-size

@Override

public void configureHttpMessageCodecs(ServerCodecConfigurer configurer) {

configurer.defaultCodecs().maxInMemorySize((int) maxInMemorySize.toBytes());

}

但在实际上线以后发现并为解决256K的限制，这是为什么呢？

二、问题定位

首先排查了SpringBoot是如何使用spring.max-in-memory-size这个参数的，当业务在启动时候设置的参数到底是怎么执行的。

第一步：SpringBoot首先会自动加载autoconfigure包下面的CodecsAutoConfiguration类：

这个类主要是加载Encoders和Decoders，如果我们使用的application/json的请求格式，并且项目里面也存在jackson2的包，则SpringBoot会加载，Jackson2JsonDecoder 和Jackson2JsonEncoder：

org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration

@Configuration(proxyBeanMethods = false)

@ConditionalOnClass(ObjectMapper.class)

static class JacksonCodecConfiguration {

@Bean

@Order(0)

@ConditionalOnBean(ObjectMapper.class)

CodecCustomizer jacksonCodecCustomizer(ObjectMapper objectMapper) {

return (configurer) -> {

CodecConfigurer.DefaultCodecs defaults = configurer.defaultCodecs();

// 这里会new一个Jackson2JsonDecoder

defaults.jackson2JsonDecoder(new Jackson2JsonDecoder(objectMapper, EMPTY_MIME_TYPES));

defaults.jackson2JsonEncoder(new Jackson2JsonEncoder(objectMapper, EMPTY_MIME_TYPES));

};

}

}

第二步：将设置的Jackson2JsonDecoder交给org.springframework.http.codec.support.BaseDefaultCodecs类去做初始化的工作：

通过追踪到这里，我们可以看出来是执行了setMaxInMemorySize方法的，那么我们只需要知道这个set之前的值是从哪里来的。

第三步：setMaxInMemorySize修改参数

如果通过上述的两个方式来修改setMaxInMemorySize，会调用BaseDefaultCodecs的maxInMemorySize方法来设置的：

org.springframework.http.codec.support.BaseDefaultCodecs

@Override

public void maxInMemorySize(int byteCount) {

if (!ObjectUtils.nullSafeEquals(this.maxInMemorySize, byteCount)) {

this.maxInMemorySize = byteCount;

initReaders();

}

}

到这里可以确定的逻辑是，不管是通过哪种set maxInMemorySize的方式，都会执行Jackson2JsonDecoder父类AbstractJackson2Decoder的setMaxInMemorySize方法来修改maxInMemorySize这个私有属性： 而这个maxInMemorySize默认的256 * 1024 就是控制256K请求体的大小。具体可以查看org.springframework.http.codec.json.AbstractJackson2Decoder的decodeToMono方法，这个方法负责将http请求的body转换成json格式：

@Override

public Mono