如何使用Gateway搭建网关服务及实现动态路由？
前言
本文记录一下我是如何使用Gateway搭建网关服务及实现动态路由的，帮助大家学习如何快速搭建一个网关服务，了解路由相关配置，鉴权的流程及业务处理，有兴趣的一定看到最后，非常适合没接触过网关服务的同学当作入门教程。
基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
- 项目地址：https://github.com/YunaiV/ruoyi-vue-pro
- 视频教程：https://doc.iocoder.cn/video/
搭建服务
框架
SpringBoot 2.1
<parent>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-parentartifactId>
<version>2.1.0.RELEASEversion>
parent>
Spring-cloud-gateway-core
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-gateway-coreartifactId>
dependency>
common-lang3
<dependency>
<groupId>org.apache.commonsgroupId>
<artifactId>commons-lang3artifactId>
dependency>
路由配置
网关作为请求统一入口，路由就相当于是每个业务系统的入口，通过路由规则则可以匹配到对应微服务的入口，将请求命中到对应的业务系统中
server:
port:8080
spring:
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创建路由
@Component
publicclassNacosDynamicRouteServiceimplementsApplicationEventPublisherAware{
privatestaticfinalLoggerLOGGER=LoggerFactory.getLogger(NacosDynamicRouteService.class);
@Autowired
privateRouteDefinitionWriterrouteDefinitionWriter;
privateApplicationEventPublisherapplicationEventPublisher;
/**路由id*/
privatestaticListrouteIds=Lists.newArrayList();
/**
*监听nacos路由配置，动态改变路由
*@paramconfigInfo
*/
@NacosConfigListener(dataId="routes",groupId="gateway-server")
publicvoidrouteConfigListener(StringconfigInfo){
clearRoute();
try{
ListgatewayRouteDefinitions=JSON.parseArray(configInfo,RouteDefinition.class);
for(RouteDefinitionrouteDefinition:gatewayRouteDefinitions){
addRoute(routeDefinition);
}
publish();
LOGGER.info("DynamicRoutingPublishSuccess");
}catch(Exceptione){
LOGGER.error(e.getMessage(),e);
}
}
/**
*清空路由
*/
privatevoidclearRoute(){
for(Stringid:routeIds){
routeDefinitionWriter.delete(Mono.just(id)).subscribe();
}
routeIds.clear();
}
@Override
publicvoidsetApplicationEventPublisher(ApplicationEventPublisherapplicationEventPublisher){
this.applicationEventPublisher=applicationEventPublisher;
}
/**
*添加路由
*
*@paramdefinition
*/
privatevoidaddRoute(RouteDefinitiondefinition){
try{
routeDefinitionWriter.save(Mono.just(definition)).subscribe();
routeIds.add(definition.getId());
}catch(Exceptione){
LOGGER.error(e.getMessage(),e);
}
}
/**
*发布路由、使路由生效
*/
privatevoidpublish(){
this.applicationEventPublisher.publishEvent(newRefreshRoutesEvent(this.routeDefinitionWriter));
}
}
过滤器
gateway提供GlobalFilter及Ordered两个接口用来定义过滤器，我们自定义过滤器只需要实现这个两个接口即可
-
GlobalFilter filter()实现过滤器业务 -
Ordered getOrder()定义过滤器执行顺序
通常一个网关服务的过滤主要包含 鉴权（是否登录、是否黑名单、是否免登录接口...） 限流（ip限流等等）功能，我们今天简单介绍鉴权过滤器的流程实现
鉴权过滤器
需要实现鉴权过滤器，我们先得了解登录及鉴权流程，如下图所示
由图可知，我们鉴权过滤核心就是验证token是否有效，所以我们网关服务需要与业务系统在同一个redis库，先给网关添加redis依赖及配置
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-data-redis-reactiveartifactId>
dependency>
spring:
redis:
host:redis-server
port:6379
password:
database:0
代码实现
- 定义过滤器AuthFilter
- 获取请求对象 从请求头或参数或cookie中获取token(支持多种方式传token对于客户端更加友好，比如部分web下载请求会新建一个页面，在请求头中传token处理起来比较麻烦)
- 没有token,返回401
- 有token，查询redis是否有效
- 无效则返回401，有效则完成验证放行
- 重置token过期时间、添加内部请求头信息方便业务系统权限处理
@Component
publicclassAuthFilterimplementsGlobalFilter,Ordered{
@Autowired
privateRedisTemplateredisTemplate;
privatestaticfinalStringTOKEN_HEADER_KEY="auth_token";
@Override
publicMonofilter(ServerWebExchangeexchange,GatewayFilterChainchain) {
//1.获取请求对象
ServerHttpRequestrequest=exchange.getRequest();
//2.获取token
Stringtoken=getToken(request);
ServerHttpResponseresponse=exchange.getResponse();
if(StringUtils.isBlank(token)){
//3.token为空返回401
response.setStatusCode(HttpStatus.UNAUTHORIZED);
returnresponse.setComplete();
}
//4.验证token是否有效
StringuserId=getUserIdByToken(token);
if(StringUtils.isBlank(userId)){
//5.token无效返回401
response.setStatusCode(HttpStatus.UNAUTHORIZED);
returnresponse.setComplete();
}
//token有效，后续业务处理
//从写请求头，方便业务系统从请求头获取用户id进行权限相关处理
ServerHttpRequest.Builderbuilder=exchange.getRequest().mutate();
request=builder.header("user_id",userId).build();
//延长缓存过期时间-token缓存用户如果一直在操作就会一直重置过期
//这样避免用户操作过程中突然过期影响业务操作及体验，只有用户操作间隔时间大于缓存过期时间才会过期
resetTokenExpirationTime(token,userId);
//完成验证
returnchain.filter(exchange);
}
@Override
publicintgetOrder(){
//优先级越小越优先
return0;
}
/**
*从redis中获取用户id
*在登录操作时候登陆成功会生成一个token,redis得key为auth_token:token值为用户id
*
*@paramtoken
*@return
*/
privateStringgetUserIdByToken(Stringtoken){
StringredisKey=String.join(":","auth_token",token);
returnredisTemplate.opsForValue().get(redisKey);
}
/**
*重置token过期时间
*
*@paramtoken
*@paramuserId
*/
privatevoidresetTokenExpirationTime(Stringtoken,StringuserId){
StringredisKey=String.join(":","auth_token",token);
redisTemplate.opsForValue().set(redisKey,userId,2,TimeUnit.HOURS);
}
/**
*获取token
*
*@paramrequest
*@return
*/
privatestaticStringgetToken(ServerHttpRequestrequest){
HttpHeadersheaders=request.getHeaders();
//从请求头获取token
Stringtoken=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获取
HttpCookiecookie=request.getCookies().getFirst(TOKEN_HEADER_KEY);
if(cookie!=null){
token=cookie.getValue();
}
}
returntoken;
}
}
基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能
- 项目地址：https://github.com/YunaiV/yudao-cloud
- 视频教程：https://doc.iocoder.cn/video/
总结
Gateway通过配置项可以实现路由功能，整合Nacos及配置监听可以实现动态路由，实现GlobalFilter, Ordered两个接口可以快速实现一个过滤器，文中也详细的介绍了登录后的请求鉴权流程，如果有不清楚地方可以评论区见咯。
审核编辑 ：李倩
声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表德赢Vwin官网
网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。
举报投诉
-
网关
+关注
关注
9文章
4444浏览量
51053 -
路由
+关注
关注
0文章
278浏览量
41834 -
Gateway
+关注
关注
1文章
16浏览量
7894
原文标题：如何使用 Gateway 搭建网关服务及实现动态路由？
文章出处：【微信号：芋道源码，微信公众号：芋道源码】欢迎添加关注！文章转载请注明出处。
发布评论请先 登录
相关推荐
虚拟主机为什么不适合搭建网站？
不推荐使用虚拟主机搭建网站的原因主要包括以下几点: 1、资源受限: 虚拟主机由于共享服务器资源，主机商会对每个用户进行资源限制，包括流量、软件等。这意味着在某些功能上，用户不能随意安装软件，可能会
路由器无法连接网关怎么解决
路由器无法连接网关通常意味着路由器无法与互联网服务提供商（ISP）的服务器建立通信。这可能导致无法访问互联网、无法访问特定的在线资源或无法访
网关和路由器的对比分析
网关和路由器作为计算机网络中的关键设备，各自承担着不同的角色和功能。下面将从定义、功能、应用场景、性能等多个方面对网关和路由器进行对比分析。
Spring Cloud Gateway网关框架
推出的第二代网关框架，取代Zuul网关。网关作为流量的，在微服务系统中有着非常作用，网关常见的功能有路由
如何通过ESP8266上的命令将此网关添加到路由器?
我已经成功地将ESP8266编程为热点或 wifi 扩展器，手机可以在其中登录并通过它连接到互联网。为了做到这一点，我必须在我的路由器（ESP8266连接到的路由器）中安装一个网关，以便可以将来
发表于 07-16 07:41
请问如何强制DHCP服务器以空网关和DNS地址进行响应？
表指标，以便首先选择正确的路由。但是，用户或应用程序必须具有提升的权限才能执行此操作。
我可以使用 AT 命令强制 DHCP 服务器使用空网关和 dns 地址进行响应吗？如果没有 - 是否计划在将来的某个版本中添加此功能？我在
发表于 07-16 07:19
网关是路由器吗？网关和路由器的区别
网关和路由器是两个不同的概念，虽然网关和路由器都用于连接不同的网络，但它们是不同的设备，具有不同的功能和用途。 路由器是一种网络设备，用于在
中兴通讯和泰雷兹携手打造了一款无线网关路由器（Gateway Router）
中兴通讯和泰雷兹携手打造了一款无线网关路由器（Gateway Router）。这款FWA设备能够帮助移动网络运营商（MNO）更容易地进入快速增长的消费级物联网市场。
EtherCAT FP介绍系列文章—UDP gateway
Mailbox Gateway功能，可以用于将EtherCAT mailbox相关协议从外部设备的工具通过邮箱网关路由到EtherCAT从站设备。
蓝牙网关是什么？具有哪些功能？
：
扫描和连接周边蓝牙设备：蓝牙网关可以扫描周边的蓝牙设备，并将获得的信息通过WiFi或者以太网发送到服务器。同时，蓝牙网关也可以连接周边的蓝牙设备，实现远程管理，例如远程控制蓝牙设备
发表于 01-19 15:05
网关和路由器的区别 用网关的wifi好还是路由器的好
网关和路由器是网络中常见的两种设备，它们在网络架构中发挥不同的功能。虽然它们都是用于连接网络设备并进行数据传输的，但是它们之间存在一些关键的区别。在这篇文章中，我们将详细介绍网关和路由
I.MX6ULL-ElfBoard ELF1板卡- route路由配置命令
route路由配置命令
命令：route
功能：添加，删除或查看网关参数
参数：route
Destination
目标网段或者主机
Gateway
网关地址，”*” 表示目标是本主机
发表于 01-12 14:33
嵌入式学习-ElfBoard ELF 1板卡 - route路由配置命令你清楚吗？学起来吧
route路由配置命令
命令：route
功能：添加，删除或查看网关参数
参数：route
Destination
目标网段或者主机
Gateway
网关地址，”*” 表示目标是本主机
发表于 01-12 14:29
Kubernetes Gateway API攻略教程
Kubernetes Gateway API 刚刚 GA，旨在改进将集群服务暴露给外部的过程。这其中包括一套更标准、更强大的 API资源，用于管理已暴露的服务。在这篇文章中，我将介绍 Gate
PLC通过智能网关，与OPCUA服务端通讯，实现标签数据读写
在工业自动化领域，越来越多的碰到支持OPCUA接口的设备，如工业机器人、智能焊接设备等。而PLC一般不具备OPCUA客户端接口，如果要跟这些设备通讯，可以通过IGT-DSER智能网关来实现。本文
发表于 01-02 16:41
工商网监
评论