• 前言
• 搭建服務
• 總結

前言

本文記錄一下我是如何使用Gateway搭建網關服務及實現動態路由的，幫助大家學習如何快速搭建一個網關服務，了解路由相關配置，鑒權的流程及業務處理，有興趣的一定看到最后，非常適合沒接觸過網關服務的同學當作入門教程。

基于 Spring Boot + MyBatis Plus + Vue & Element 實現的后臺管理系統 + 用戶小程序，支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能

• 項目地址：https://gitee.com/zhijiantianya/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

代碼實現

1. 定義過濾器AuthFilter
2. 獲取請求對象 從請求頭或參數或cookie中獲取token(支持多種方式傳token對于客戶端更加友好，比如部分web下載請求會新建一個頁面，在請求頭中傳token處理起來比較麻煩)
3. 沒有token,返回401
4. 有token，查詢redis是否有效
5. 無效則返回401，有效則完成驗證放行
6. 重置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://gitee.com/zhijiantianya/yudao-cloud
• 視頻教程：https://doc.iocoder.cn/video/

總結

Gateway通過配置項可以實現路由功能，整合Nacos及配置監聽可以實現動態路由，實現GlobalFilter, Ordered兩個接口可以快速實現一個過濾器，文中也詳細的介紹了登錄后的請求鑒權流程，如果有不清楚地方可以評論區見咯。

審核編輯：湯梓紅