GlobalFilter 竟然比不上 RequestMapping？Spring Cloud Gateway 初体验

GlobalFilter 竟然比不上 RequestMapping？Spring Cloud Gateway 初体验

请求网关层项目中的 Controller 且 ”请求路径“ 与 @RequestMapping 一致时，GlobalFilter 不生效

本文结论：
基于 org.springframework.web.server.WebFilter 实现的过滤器能够覆盖包括 Spring-Cloud-Gateway 的所有请求
因此需要在网关层编写逻辑，使用 WebFilter 实现就可以了。

1 前言

之前的项目网关层都是使用 Feign 并复制上游的接口定义粘贴到网关层项目中，
然后编写 Controller 调用下游。即大部分接口都要在网关层复制一份，部分接口在网关做一些简单的逻辑。
这种方式非常繁琐，一旦上游修改接口或者 DTO，网关层都要同步修改。当一份接口复制到多个网关层，修改起来存在一定工作量，且容易出错。也不知道是谁想出来这么做的🌚🌚

最近使用 Spring Cloud Gateway 作为应用网关。在网关层，只需进行一定配置，发送到网关的请求会根据一定的规则路由到对应的服务，省去了以前复制接口的工作，减少了网关层的工作量。

虽然大部分接口都是可以直接转发到对应服务，还有少部分接口需要在网关层做一些逻辑，例如生成打印图片返回给App端。
这部分逻辑不适合直接做在后端服务中，前端做起来也有难度，因此，这部分逻辑可以放到网关层实现。

目前遇到一个问题，即本文探讨的问题： 网关层的操作需要鉴权，因此存在一个用于鉴权的 GlobalFilter，
前端的请求只有带有有效的登录信息才会被转发到后端对应的服务。
现在在网关层中编写了一个逻辑简单但必要的 Controller，这个 Controller 中的接口同样需要鉴权。
但经过测试，对应 Controller 的 RequestMapping 的请求不会经过 GlobalFilter，直接发到了 Controller 中，即未被鉴权。

2 实践

此处直接在开源版本的xxl-sso上创建一个基于 Spring-Cloud-Gateway 的 Client
并通过 GlobalFilter 实现鉴权过滤器

2.1 编写Controller

import com.xxl.sso.core.conf.Conf;
import com.xxl.sso.core.entity.ReturnT;
import com.xxl.sso.core.user.XxlSsoUser;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@RestController
@RequestMapping("/demo")
public class IndexController {
   
   

    @GetMapping("/user")
    public Mono<ReturnT<XxlSsoUser>> index(ServerWebExchange exchange) {
   
   
        XxlSsoUser xxlUser = exchange.getAttribute(Conf.SSO_USER);
        return Mono.just(new ReturnT<>(xxlUser));
    }
}

2.2 编写GlobalFilter

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

@Component
public class XxlSsoTokenGatewayFilter implements GlobalFilter, Ordered {
   
   

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
   
   
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();
        // 省略过滤逻辑
    }

    @Override
    public int getOrder() {
   
   
        return HIGHEST_PRECEDENCE;
    }
}

2.3 路由配置

spring.cloud.gateway.routes[0].id=default
spring.cloud.gateway.routes[0].uri=forward:/
spring.cloud.gateway.routes[0].predicates[0]=Path=/demo/user
spring.cloud.gateway.routes[0].filters[0]=SetPath=/demo/user
spring.cloud.gateway.routes[1].id=internal
spring.cloud.gateway.routes[1].uri=forward:/
spring.cloud.gateway.routes[1].predicates[0]=Path=/internal/user
spring.cloud.gateway.routes[1].filters[0]=SetPath=/demo/user
spring.cloud.gateway.routes[2].id=github
spring.cloud.gateway.routes[2].uri=https://github.com
spring.cloud.gateway.routes[2].predicates[0]=Path=/TeslaCN/**

配置了3条路由：

1. 内部转发 /demo/user 到