前言
本文記錄一下我是如何使用Gateway搭建網(wǎng)關(guān)服務(wù)及實(shí)現(xiàn)動(dòng)態(tài)路由的,幫助大家學(xué)習(xí)如何快速搭建一個(gè)網(wǎng)關(guān)服務(wù),了解路由相關(guān)配置,鑒權(quán)的流程及業(yè)務(wù)處理,有興趣的一定看到最后,非常適合沒接觸過(guò)網(wǎng)關(guān)服務(wù)的同學(xué)當(dāng)作入門教程。
基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶小程序,支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能
- 項(xiàng)目地址:https://github.com/YunaiV/ruoyi-vue-pro
- 視頻教程:https://doc.iocoder.cn/video/
搭建服務(wù)
框架
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>
路由配置
網(wǎng)關(guān)作為請(qǐng)求統(tǒng)一入口,路由就相當(dāng)于是每個(gè)業(yè)務(wù)系統(tǒng)的入口,通過(guò)路由規(guī)則則可以匹配到對(duì)應(yīng)微服務(wù)的入口,將請(qǐng)求命中到對(duì)應(yīng)的業(yè)務(wù)系統(tǒng)中
server:
port:8080
spring:
cloud:
gateway:
enabled:true
routes:
-id:demo-server
uri:http://localhost:8081
predicates:
-Path=/demo-server/**
filters:
-StripPrefix=1
routes
解讀配置
-
現(xiàn)在有一個(gè)服務(wù)demo-server部署在本機(jī),地址和端口為
127.0.0.1:8081
,所以路由配置uri為http://localhost:8081
-
使用網(wǎng)關(guān)服務(wù)路由到此服務(wù),
predicates -Path=/demo-server/**
,網(wǎng)關(guān)服務(wù)的端口為8080,啟動(dòng)網(wǎng)關(guān)服務(wù),訪問(wèn)localhost:8080/demo-server
,路由斷言就會(huì)將請(qǐng)求路由到demo-server -
直接訪問(wèn)demo-server的接口
localhost:8081/api/test
,通過(guò)網(wǎng)關(guān)的訪問(wèn)地址則為localhost:8080/demo-server/api/test,predicates
配置將請(qǐng)求斷言到此路由,filters-StripPrefix=1
代表將地址中/后的第一個(gè)截取,所以demo-server就截取掉了
使用gateway通過(guò)配置文件即可完成路由的配置,非常方便,我們只要充分的了解配置項(xiàng)的含義及規(guī)則就可以了;但是這些配置如果要修改則需要重啟服務(wù),重啟網(wǎng)關(guān)服務(wù)會(huì)導(dǎo)致整個(gè)系統(tǒng)不可用,這一點(diǎn)是無(wú)法接受的,下面介紹如何通過(guò)Nacos實(shí)現(xiàn)動(dòng)態(tài)路由
動(dòng)態(tài)路由
使用nacos結(jié)合gateway-server實(shí)現(xiàn)動(dòng)態(tài)路由,我們需要先部署一個(gè)nacos服務(wù),可以使用docker部署或下載源碼在本地啟動(dòng),具體操作可以參考官方文檔即可
Nacos配置
groupId: 使用網(wǎng)關(guān)服務(wù)名稱即可
dataId: routes
配置格式:json
[{
"id":"xxx-server",
"order":1,#優(yōu)先級(jí)
"predicates":[{#路由斷言
"args":{
"pattern":"/xxx-server/**"
},
"name":"Path"
}],
"filters":[{#過(guò)濾規(guī)則
"args":{
"parts":0#k8s服務(wù)內(nèi)部訪問(wèn)容器為http://xxx-server/xxx-server的話,配置0即可
},
"name":"StripPrefix"#截取的開始索引
}],
"uri":"http://localhost:8080/xxx-server"#目標(biāo)地址
}]
json格式配置項(xiàng)與yaml中對(duì)應(yīng),需要了解配置在json中的寫法
比對(duì)一下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
代碼實(shí)現(xiàn)
Nacos實(shí)現(xiàn)動(dòng)態(tài)路由的方式核心就是通過(guò)Nacos配置監(jiān)聽,配置發(fā)生改變后執(zhí)行網(wǎng)關(guān)相關(guān)api創(chuàng)建路由
@Component
publicclassNacosDynamicRouteServiceimplementsApplicationEventPublisherAware{
privatestaticfinalLoggerLOGGER=LoggerFactory.getLogger(NacosDynamicRouteService.class);
@Autowired
privateRouteDefinitionWriterrouteDefinitionWriter;
privateApplicationEventPublisherapplicationEventPublisher;
/**路由id*/
privatestaticListrouteIds=Lists.newArrayList();
/**
*監(jiān)聽nacos路由配置,動(dòng)態(tài)改變路由
*@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);
}
}
/**
*發(fā)布路由、使路由生效
*/
privatevoidpublish(){
this.applicationEventPublisher.publishEvent(newRefreshRoutesEvent(this.routeDefinitionWriter));
}
}
過(guò)濾器
gateway提供GlobalFilter及Ordered兩個(gè)接口用來(lái)定義過(guò)濾器,我們自定義過(guò)濾器只需要實(shí)現(xiàn)這個(gè)兩個(gè)接口即可
-
GlobalFilter filter()
實(shí)現(xiàn)過(guò)濾器業(yè)務(wù) -
Ordered getOrder()
定義過(guò)濾器執(zhí)行順序
通常一個(gè)網(wǎng)關(guān)服務(wù)的過(guò)濾主要包含 鑒權(quán)(是否登錄、是否黑名單、是否免登錄接口...) 限流(ip限流等等)功能,我們今天簡(jiǎn)單介紹鑒權(quán)過(guò)濾器的流程實(shí)現(xiàn)
鑒權(quán)過(guò)濾器
需要實(shí)現(xiàn)鑒權(quán)過(guò)濾器,我們先得了解登錄及鑒權(quán)流程,如下圖所示
由圖可知,我們鑒權(quán)過(guò)濾核心就是驗(yàn)證token是否有效,所以我們網(wǎng)關(guān)服務(wù)需要與業(yè)務(wù)系統(tǒng)在同一個(gè)redis庫(kù),先給網(wǎng)關(guān)添加redis依賴及配置
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-data-redis-reactiveartifactId>
dependency>
spring:
redis:
host:redis-server
port:6379
password:
database:0
代碼實(shí)現(xiàn)
- 定義過(guò)濾器AuthFilter
- 獲取請(qǐng)求對(duì)象 從請(qǐng)求頭或參數(shù)或cookie中獲取token(支持多種方式傳token對(duì)于客戶端更加友好,比如部分web下載請(qǐng)求會(huì)新建一個(gè)頁(yè)面,在請(qǐng)求頭中傳token處理起來(lái)比較麻煩)
- 沒有token,返回401
- 有token,查詢r(jià)edis是否有效
- 無(wú)效則返回401,有效則完成驗(yàn)證放行
- 重置token過(guò)期時(shí)間、添加內(nèi)部請(qǐng)求頭信息方便業(yè)務(wù)系統(tǒng)權(quán)限處理
@Component
publicclassAuthFilterimplementsGlobalFilter,Ordered{
@Autowired
privateRedisTemplateredisTemplate;
privatestaticfinalStringTOKEN_HEADER_KEY="auth_token";
@Override
publicMonofilter(ServerWebExchangeexchange,GatewayFilterChainchain) {
//1.獲取請(qǐng)求對(duì)象
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.驗(yàn)證token是否有效
StringuserId=getUserIdByToken(token);
if(StringUtils.isBlank(userId)){
//5.token無(wú)效返回401
response.setStatusCode(HttpStatus.UNAUTHORIZED);
returnresponse.setComplete();
}
//token有效,后續(xù)業(yè)務(wù)處理
//從寫請(qǐng)求頭,方便業(yè)務(wù)系統(tǒng)從請(qǐng)求頭獲取用戶id進(jìn)行權(quán)限相關(guān)處理
ServerHttpRequest.Builderbuilder=exchange.getRequest().mutate();
request=builder.header("user_id",userId).build();
//延長(zhǎng)緩存過(guò)期時(shí)間-token緩存用戶如果一直在操作就會(huì)一直重置過(guò)期
//這樣避免用戶操作過(guò)程中突然過(guò)期影響業(yè)務(wù)操作及體驗(yàn),只有用戶操作間隔時(shí)間大于緩存過(guò)期時(shí)間才會(huì)過(guò)期
resetTokenExpirationTime(token,userId);
//完成驗(yàn)證
returnchain.filter(exchange);
}
@Override
publicintgetOrder(){
//優(yōu)先級(jí)越小越優(yōu)先
return0;
}
/**
*從redis中獲取用戶id
*在登錄操作時(shí)候登陸成功會(huì)生成一個(gè)token,redis得key為auth_token:token值為用戶id
*
*@paramtoken
*@return
*/
privateStringgetUserIdByToken(Stringtoken){
StringredisKey=String.join(":","auth_token",token);
returnredisTemplate.opsForValue().get(redisKey);
}
/**
*重置token過(guò)期時(shí)間
*
*@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();
//從請(qǐng)求頭獲取token
Stringtoken=headers.getFirst(TOKEN_HEADER_KEY);
if(StringUtils.isBlank(token)){
//請(qǐng)求頭無(wú)token則從url獲取token
token=request.getQueryParams().getFirst(TOKEN_HEADER_KEY);
}
if(StringUtils.isBlank(token)){
//請(qǐng)求頭和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 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶小程序,支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能
- 項(xiàng)目地址:https://github.com/YunaiV/yudao-cloud
- 視頻教程:https://doc.iocoder.cn/video/
總結(jié)
Gateway通過(guò)配置項(xiàng)可以實(shí)現(xiàn)路由功能,整合Nacos及配置監(jiān)聽可以實(shí)現(xiàn)動(dòng)態(tài)路由,實(shí)現(xiàn)GlobalFilter, Ordered兩個(gè)接口可以快速實(shí)現(xiàn)一個(gè)過(guò)濾器,文中也詳細(xì)的介紹了登錄后的請(qǐng)求鑒權(quán)流程,如果有不清楚地方可以評(píng)論區(qū)見咯。
-
網(wǎng)關(guān)
+關(guān)注
關(guān)注
9文章
4196瀏覽量
50774 -
路由
+關(guān)注
關(guān)注
0文章
274瀏覽量
41706 -
Gateway
+關(guān)注
關(guān)注
1文章
16瀏覽量
7876
原文標(biāo)題:如何使用 Gateway 搭建網(wǎng)關(guān)服務(wù)及實(shí)現(xiàn)動(dòng)態(tài)路由?
文章出處:【微信號(hào):芋道源碼,微信公眾號(hào):芋道源碼】歡迎添加關(guān)注!文章轉(zhuǎn)載請(qǐng)注明出處。
發(fā)布評(píng)論請(qǐng)先 登錄
相關(guān)推薦
評(píng)論