Spring Cloud-Gateway网关

前置文章:
一、Spring Cloud-Erueka服务注册&发现
二、Spring Cloud-Nacos服务注册&发现
三、Spring Cloud-Nacos配置管理
四、Spring Cloud-Feign Http客户端
本文与前置文章关联性不是很强,如果仅需了解Gateway相关内容,阅读本文即可。

零、本文纲要

  • 一、认识网关
  • 二、Gateway快速入门
  • 三、网关路由配置
  • 四、路由过滤器
  • 五、路由过滤器链
  • 六、跨域访问问题

tips:Ctrl + F快速定位到所需内容进行阅读吧。

一、认识网关

  • 1、网关功能
    ①身份认证、权限校验;
    ②服务路由、负载均衡;
    ③请求限流;
  • 2、Spring Cloud网关
    ①Zuul
    基于Servlet实现,属于阻塞式编程;
    ②Gateway
    基于WebFlux实现,属于响应式编程,性能更优。

二、Gateway快速入门

  • 1、基础依赖
    ①spring-cloud-starter-gateway——Gateway网关
    ②spring-cloud-starter-alibaba-nacos-discovery——Nacos服务发现
    ③spring-cloud-starter-loadbalancer——负载均衡
        <!--网关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--nacos服务发现依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--负载均衡相关依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>
  • 2、application.yml配置
    ①网关端口
    ②应用名称
    ③Nacos地址
    ④网关路由配置:路由ID(自定义)、路由目标地址、路由断言
server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id,自定义,只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求

此时启动项目,即可开启网关功能了。

三、网关路由配置

  • 1、路由ID
    随机命名即可,要求唯一;
  • 2、uri
    路由地址,支持lb和http两种;
# 推荐使用 uri: lb//service
uri: http://127.0.0.1:8081
uri: lb://userservice
# lb是loadbalance的缩写
  • 3、predicates
    路由断言,判断请求是否符合要求,符合则转发至相应路由;
    Spring Cloud Gateway有11种类型的路由断言工厂,具体可访问官方文档:Route Predicate Factory
spring:
  cloud:
    gateway:
      routes:
      - id: user_service
        uri: lb://userservice
        predicates:
        - Path=/user/**

四、路由过滤器

  • 1、GatewayFilter
    网关过滤器,Spring Cloud Gateway官方提供了31种过滤器,具体可访问官方文档:GatewayFilter
    以AddRequestHeader为例,如下:
spring:
  cloud:
    gateway:
      routes:
      - id: user_service
        uri: lb://userservice
        filters:
        - AddRequestHeader=color, blue
# 方法参数中,使用如下形式即可获取对应请求头
@RequestHeader(value = "color",required = false) String color
  • 2、Default Filters
    default filters是31种官方提供的一种特殊的配置,配置default filters会对全局路由请求生效,不限于单种路由请求。如下配置,我们设置的过滤器都会生效。
spring:
  cloud:
    gateway:
      routes:
      - id: user_service
        uri: lb://userservice
        filters:
        - AddRequestHeader=color, blue
      default-filters:
      - AddResponseHeader=color, green
      - PrefixPath=/httpbin
  • 3、GlobalFilter
    The GlobalFilter interface has the same signature as GatewayFilter. These are special filters that are conditionally applied to all routes.官方文档:GlobalFilter

GlobalFilter 作用与GatewayFilter 一样,处理一切进入网关的请求与响应,GlobalFilter 的逻辑需要我们编写代码实现。
如下过滤器是判断请求参数authorization的内容是否等于admin,代码:

//@Order(-1)
@Component
public class AuthorizationFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //1.获取请求参数
        MultiValueMap<String, String> queryParams = exchange.getRequest().getQueryParams();
        //2.获取authorization参数
        String authorization = queryParams.getFirst("authorization");
        //3.校验
        if("admin".equals(authorization)){
            //3.1.校验通过放行
            return chain.filter(exchange);
        }
        //4.拦截
        //4.1.设置401状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        //4.2.结束处理
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

五、路由过滤器链

  • 1、过滤器执行顺序
    ①每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前
    ②GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
    路由过滤器defaultFilter的order由Spring指定,默认是按照声明顺序从1递增
    ④当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
  • 2、源码

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。

    private List<GatewayFilter> getFilters(RouteDefinition routeDefinition) {
        List<GatewayFilter> filters = new ArrayList();
        if (!this.gatewayProperties.getDefaultFilters().isEmpty()) {
            filters.addAll(this.loadGatewayFilters(routeDefinition.getId(), new ArrayList(this.gatewayProperties.getDefaultFilters())));
        }

        if (!routeDefinition.getFilters().isEmpty()) {
            filters.addAll(this.loadGatewayFilters(routeDefinition.getId(), new ArrayList(routeDefinition.getFilters())));
        }

        AnnotationAwareOrderComparator.sort(filters);
        return filters;
    }

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链。

    @Override
    public Mono<Void> handle(ServerWebExchange exchange) {
        return this.chain.filter(exchange);
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange) {
        return Mono.defer(() ->
                this.currentFilter != null && this.chain != null ?
                        invokeFilter(this.currentFilter, this.chain, exchange) :
                        this.handler.handle(exchange));
    }

    private Mono<Void> invokeFilter(WebFilter current, DefaultWebFilterChain chain, ServerWebExchange exchange) {
        String currentName = current.getClass().getName();
        return current.filter(exchange, chain).checkpoint(currentName + " [DefaultWebFilterChain]");
    }

    @Override
    public Mono<Void> handle(ServerWebExchange exchange) {
        Route route = exchange.getRequiredAttribute(GATEWAY_ROUTE_ATTR);
        List<GatewayFilter> gatewayFilters = route.getFilters();

        List<GatewayFilter> combined = new ArrayList<>(this.globalFilters);
        combined.addAll(gatewayFilters);
        // TODO: needed or cached?
        AnnotationAwareOrderComparator.sort(combined);

        if (logger.isDebugEnabled()) {
            logger.debug("Sorted gatewayFilterFactories: " + combined);
        }

        return new DefaultGatewayFilterChain(combined).filter(exchange);
    }

六、跨域访问问题

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        cors-configurations:
          '[/**]':
            allowCredentials: true # 是否允许携带cookie
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://127.0.0.1:8090"
            allowedMethods: "*" # 允许的跨域ajax的请求方式
            allowedHeaders: "*" # 允许在请求中携带的头信息
            maxAge: 360000 # 这次跨域检测的有效期

七、结尾

以上即为Spring Cloud Gateway基础内容,感谢阅读。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容