Spring Cloud Gateway 啟動報錯（因為web依賴）

報錯信息：

Spring Cloud Gateway啟動一直報錯 詳細錯誤信息

Parameter 0 of method modifyRequestBodyGatewayFilterFactory in org.springframework.cloud.gateway.config.GatewayAutoConfiguration required a bean of type 'org.springframework.http.codec.ServerCodecConfigurer' that could not be found.

Action:

Consider defining a bean of type 'org.springframework.http.codec.ServerCodecConfigurer' in your configuration.

查看源碼：

1、GatewayClassPathWarningAutoConfiguration.java

spring cloud Gateway網關本身是一個Spring Boot項目，在網關微服務啟動時他會自動加載它的配置，其中其中有一個叫做GatewayClassPathWarningAutoConfiguration的配置類, 如下：

看到@ConditionalOnMissingClass({"org.springframework.web.reactive.DispatcherHandler"})

在沒有DispatcherHandler的情況下提示添加 spring-boot-starter-webflux 依賴。

在有DispatcherHandler的情況下提示移除 spring-boot-starter-web 依賴。

@Configuration(
    proxyBeanMethods = false
)
@AutoConfigureBefore({GatewayAutoConfiguration.class})
public class GatewayClassPathWarningAutoConfiguration {
    private static final Log log = LogFactory.getLog(GatewayClassPathWarningAutoConfiguration.class);
    private static final String BORDER = "\n\n**********************************************************\n\n";

    public GatewayClassPathWarningAutoConfiguration() {
    }

    @Configuration(
        proxyBeanMethods = false
    )
    @ConditionalOnMissingClass({"org.springframework.web.reactive.DispatcherHandler"}) //重點注解
    protected static class WebfluxMissingFromClasspathConfiguration {
        public WebfluxMissingFromClasspathConfiguration() {
            GatewayClassPathWarningAutoConfiguration.log.warn("\n\n**********************************************************\n\nSpring Webflux is missing from the classpath, which is required for Spring Cloud Gateway at this time. Please add spring-boot-starter-webflux dependency.\n\n**********************************************************\n\n");
        }
    }

    @Configuration(
        proxyBeanMethods = false
    )
    @ConditionalOnClass(
        name = {"org.springframework.web.servlet.DispatcherServlet"}
    )
    protected static class SpringMvcFoundOnClasspathConfiguration {
        public SpringMvcFoundOnClasspathConfiguration() {
            GatewayClassPathWarningAutoConfiguration.log.warn("\n\n**********************************************************\n\nSpring MVC found on classpath, which is incompatible with Spring Cloud Gateway at this time. Please remove spring-boot-starter-web dependency.\n\n**********************************************************\n\n");
        }
    }
}

如果pom文件中添加了spring-boot-starter-web 依賴，項目中就會存在 org.springframework.web.servlet.DispatcherServlet過濾器，這樣與Spring Cloud Gateway沖突不兼容。

2、GatewayAutoConfiguration.java

打開網關自動配置類中GatewayAutoConfiguration 這個類，看到如下幾個方法中需要org.springframework.http.codec.ServerCodecConfigurer這個bean

@Bean
public ModifyRequestBodyGatewayFilterFactory modifyRequestBodyGatewayFilterFactory(ServerCodecConfigurer codecConfigurer) {
    return new ModifyRequestBodyGatewayFilterFactory(codecConfigurer.getReaders());
}

@Bean
public DedupeResponseHeaderGatewayFilterFactory dedupeResponseHeaderGatewayFilterFactory() {
    return new DedupeResponseHeaderGatewayFilterFactory();
}

@Bean
public ModifyResponseBodyGatewayFilterFactory modifyResponseBodyGatewayFilterFactory(ServerCodecConfigurer codecConfigurer, Set<MessageBodyDecoder> bodyDecoders, Set<MessageBodyEncoder> bodyEncoders) {
    return new ModifyResponseBodyGatewayFilterFactory(codecConfigurer.getReaders(), bodyDecoders, bodyEncoders);
}

解決辦法：

spring cloud gateway是基於webflux的，所以直接移除spring-boot-start-web依賴，如果需要web服務，添加spring-boot-starter-webflux依賴。