如何使用Gateway搭建网关服务及实现动态路由

前言 搭建服务 总结 前言 本文记录一下我是如何使用gateway搭建网关服务及实现动态路由的,帮助大家学习如何快速搭建一个网关服务,了解路由相关配置,鉴权的流程及业务处理,有兴趣的一定看到最后,非常适合没接触过网关服务的同学当作入门教程。
基于 spring boot + mybatis plus + vue & element 实现的后台管理系统 + 用户小程序,支持 rbac 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
项目地址:https://gitee.com/zhijiantianya/ruoyi-vue-pro 视频教程:https://doc.iocoder.cn/video/ 搭建服务 框架 springboot 2.1
   org.springframework.boot   spring-boot-starter-parent   2.1.0.release spring-cloud-gateway-core
   org.springframework.cloud   spring-cloud-gateway-core common-lang3
   org.apache.commons   commons-lang3 路由配置 网关作为请求统一入口,路由就相当于是每个业务系统的入口,通过路由规则则可以匹配到对应微服务的入口,将请求命中到对应的业务系统中
server:  port: 8080spring:  cloud:    gateway:      enabled: true      routes:      - id: demo-server        uri: http://localhost:8081        predicates:        - path=/demo-server/**        filters:          - stripprefix= 1 routes
解读配置 现在有一个服务demo-server部署在本机,地址和端口为127.0.0.1:8081,所以路由配置uri为http://localhost:8081 使用网关服务路由到此服务,predicates -path=/demo-server/**,网关服务的端口为8080,启动网关服务,访问localhost:8080/demo-server,路由断言就会将请求路由到demo-server 直接访问demo-server的接口localhost:8081/api/test,通过网关的访问地址则为localhost:8080/demo-server/api/test,predicates配置将请求断言到此路由,filters-stripprefix=1代表将地址中/后的第一个截取,所以demo-server就截取掉了 使用gateway通过配置文件即可完成路由的配置,非常方便,我们只要充分的了解配置项的含义及规则就可以了;但是这些配置如果要修改则需要重启服务,重启网关服务会导致整个系统不可用,这一点是无法接受的,下面介绍如何通过nacos实现动态路由
动态路由 使用nacos结合gateway-server实现动态路由,我们需要先部署一个nacos服务,可以使用docker部署或下载源码在本地启动,具体操作可以参考官方文档即可
nacos配置 groupid: 使用网关服务名称即可
dataid: routes
配置格式:json
[{      id: xxx-server,      order: 1, #优先级      predicates: [{ #路由断言          args: {              pattern: /xxx-server/**          },          name: path      }],      filters:[{ #过滤规则          args: {              parts: 0 #k8s服务内部访问容器为http://xxx-server/xxx-server的话,配置0即可          },          name: stripprefix #截取的开始索引      }],      uri: http://localhost:8080/xxx-server #目标地址  }] json格式配置项与yaml中对应,需要了解配置在json中的写法
比对一下json配置与yaml配置 {    id:demo-server,    predicates:[        {            args:{                pattern:/demo-server/**            },            name:path        }    ],    filters:[        {            args:{                parts:1            },            name:stripprefix        }    ],    uri:http://localhost:8081}spring:  cloud:    gateway:      enabled: true      routes:      - id: demo-server        uri: http://localhost:8081        predicates:        - path=/demo-server/**        filters:          - stripprefix= 1 代码实现 nacos实现动态路由的方式核心就是通过nacos配置监听,配置发生改变后执行网关相关api创建路由
@componentpublic class nacosdynamicrouteservice implements applicationeventpublisheraware {    private static final logger logger = loggerfactory.getlogger(nacosdynamicrouteservice.class);    @autowired    private routedefinitionwriter routedefinitionwriter;    private applicationeventpublisher applicationeventpublisher;    /** 路由id */    private static list routeids = lists.newarraylist();    /**     * 监听nacos路由配置,动态改变路由     * @param configinfo     */    @nacosconfiglistener(dataid = routes, groupid = gateway-server)    public void routeconfiglistener(string configinfo) {        clearroute();        try {            list gatewayroutedefinitions = json.parsearray(configinfo, routedefinition.class);            for (routedefinition routedefinition : gatewayroutedefinitions) {                addroute(routedefinition);            }            publish();            logger.info(dynamic routing publish success);        } catch (exception e) {            logger.error(e.getmessage(), e);        }            }    /**     * 清空路由     */    private void clearroute() {        for (string id : routeids) {            routedefinitionwriter.delete(mono.just(id)).subscribe();        }        routeids.clear();    }    @override    public void setapplicationeventpublisher(applicationeventpublisher applicationeventpublisher) {        this.applicationeventpublisher = applicationeventpublisher;    }    /**     * 添加路由     *      * @param definition     */    private void addroute(routedefinition definition) {        try {            routedefinitionwriter.save(mono.just(definition)).subscribe();            routeids.add(definition.getid());        } catch (exception e) {            logger.error(e.getmessage(), e);        }    }    /**     * 发布路由、使路由生效     */    private void publish() {        this.applicationeventpublisher.publishevent(new refreshroutesevent(this.routedefinitionwriter));    }} 过滤器 gateway提供globalfilter及ordered两个接口用来定义过滤器,我们自定义过滤器只需要实现这个两个接口即可
globalfilter filter() 实现过滤器业务 ordered getorder() 定义过滤器执行顺序 通常一个网关服务的过滤主要包含 鉴权(是否登录、是否黑名单、是否免登录接口...) 限流(ip限流等等)功能,我们今天简单介绍鉴权过滤器的流程实现
鉴权过滤器 需要实现鉴权过滤器,我们先得了解登录及鉴权流程,如下图所示
由图可知,我们鉴权过滤核心就是验证token是否有效,所以我们网关服务需要与业务系统在同一个redis库,先给网关添加redis依赖及配置
    org.springframework.boot    spring-boot-starter-data-redis-reactivespring:  redis:    host: redis-server    port: 6379    password:    database: 0 代码实现 定义过滤器authfilter 获取请求对象 从请求头或参数或cookie中获取token(支持多种方式传token对于客户端更加友好,比如部分web下载请求会新建一个页面,在请求头中传token处理起来比较麻烦) 没有token,返回401 有token,查询redis是否有效 无效则返回401,有效则完成验证放行 重置token过期时间、添加内部请求头信息方便业务系统权限处理 @componentpublic class authfilter implements globalfilter, ordered {    @autowired    private redistemplate redistemplate;    private static final string token_header_key = auth_token;    @override    public mono filter(serverwebexchange exchange, gatewayfilterchain chain) {        // 1.获取请求对象        serverhttprequest request = exchange.getrequest();        // 2.获取token        string token = gettoken(request);        serverhttpresponse response = exchange.getresponse();        if (stringutils.isblank(token)) {            // 3.token为空 返回401            response.setstatuscode(httpstatus.unauthorized);            return response.setcomplete();        }        // 4.验证token是否有效        string userid = getuseridbytoken(token);        if (stringutils.isblank(userid)) {            // 5.token无效 返回401            response.setstatuscode(httpstatus.unauthorized);            return response.setcomplete();        }        // token有效,后续业务处理        // 从写请求头,方便业务系统从请求头获取用户id进行权限相关处理        serverhttprequest.builder builder = exchange.getrequest().mutate();        request = builder.header(user_id, userid).build();        // 延长缓存过期时间-token缓存用户如果一直在操作就会一直重置过期        // 这样避免用户操作过程中突然过期影响业务操作及体验,只有用户操作间隔时间大于缓存过期时间才会过期        resettokenexpirationtime(token, userid);        // 完成验证        return chain.filter(exchange);    }    @override    public int getorder() {        // 优先级 越小越优先        return 0;    }    /**     * 从redis中获取用户id     * 在登录操作时候 登陆成功会生成一个token, redis得key为auth_token:token 值为用户id     *     * @param token     * @return     */    private string getuseridbytoken(string token) {        string rediskey = string.join(:, auth_token, token);        return redistemplate.opsforvalue().get(rediskey);    }    /**     * 重置token过期时间     *     * @param token     * @param userid     */    private void resettokenexpirationtime(string token, string userid) {        string rediskey = string.join(:, auth_token, token);        redistemplate.opsforvalue().set(rediskey, userid, 2, timeunit.hours);    }    /**     * 获取token     *     * @param request     * @return     */    private static string gettoken(serverhttprequest request) {        httpheaders headers = request.getheaders();        // 从请求头获取token        string token = headers.getfirst(token_header_key);        if (stringutils.isblank(token)) {            // 请求头无token则从url获取token            token = request.getqueryparams().getfirst(token_header_key);        }        if (stringutils.isblank(token)) {            // 请求头和url都没有token则从cookies获取            httpcookie cookie = request.getcookies().getfirst(token_header_key);            if (cookie != null) {                token = cookie.getvalue();            }        }        return token;    }} 基于 spring cloud alibaba + gateway + nacos + rocketmq + vue & element 实现的后台管理系统 + 用户小程序,支持 rbac 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
项目地址:https://gitee.com/zhijiantianya/yudao-cloud 视频教程:https://doc.iocoder.cn/video/ 总结 gateway通过配置项可以实现路由功能,整合nacos及配置监听可以实现动态路由,实现globalfilter, ordered两个接口可以快速实现一个过滤器,文中也详细的介绍了登录后的请求鉴权流程,如果有不清楚地方可以评论区见咯。


详解TLB的作用及工作原理
据DCS特性制定对应的运行维护方法
Imagination:看机器人技术中人工智能的未来
4点教你掌握4G-LTE系统中反向Doherty功率放大器设计
台积电被举报,不仅垄断市场还威胁客户
如何使用Gateway搭建网关服务及实现动态路由
中国信科:加速构筑5G精品网络
拆解Apple Silicon MacBook:M1定制芯片庐山真面目
AMD公布第二季度财报:营收53.59亿美元
目前的语音识别和NLP技术仍然不够成熟
三星这二十五年:巨头成长记
MP3技术白皮书:音频格式全解析
安防监控领域高级嵌入式分析系统解析
领跑 AI 时代,开放原子开发者大会——2023 龙蜥操作系统大会圆满举办
AD7879控制器支持电阻式触摸屏上的手势识别
阀门锁的优势是什么,它又是如何充分体现优势的
关于MODBUSRTU通讯协议的提问?
吉时利2200系列再增两款多通道电源供应器
采用差分输入的12 位/14 位ADC LTC2356-1
ChatGPT需要多少算力支持? ChatGPT面临的挑战