快速搭建一個網(wǎng)關服務,動態(tài)路由、鑒權看完就會(含流程圖)
前言
搭建服務
框架
<parent>
???<groupId>org.springframework.bootgroupId>
???<artifactId>spring-boot-starter-parentartifactId>
???<version>2.1.0.RELEASEversion>
parent>
<dependency>
???<groupId>org.springframework.cloudgroupId>
???<artifactId>spring-cloud-gateway-coreartifactId>
dependency>
<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

解讀配置
現(xiàn)在有一個服務demo-server部署在本機,地址和端口為 127.0.0.1:8081,所以路由配置uri為http://localhost:8081使用網(wǎng)關服務路由到此服務, predicates -Path=/demo-server/**,網(wǎng)關服務的端口為8080,啟動網(wǎng)關服務,訪問localhost:8080/demo-server,路由斷言就會將請求路由到demo-server直接訪問demo-server的接口 localhost:8081/api/test,通過網(wǎng)關的訪問地址則為localhost:8080/demo-server/api/test,predicates配置將請求斷言到此路由,filters-StripPrefix=1代表將地址中/后的第一個截取,所以demo-server就截取掉了
動態(tài)路由
Nacos配置

[{
??????"id":?"xxx-server",
??????"order":?1,?#優(yōu)先級
??????"predicates":?[{?#路由斷言
??????????"args":?{
??????????????"pattern":?"/xxx-server/**"
??????????},
??????????"name":?"Path"
??????}],
??????"filters":[{?#過濾規(guī)則
??????????"args":?{
??????????????"parts":?0?#k8s服務內(nèi)部訪問容器為http://xxx-server/xxx-server的話,配置0即可
??????????},
??????????"name":?"StripPrefix"?#截取的開始索引
??????}],
??????"uri":?"http://localhost:8080/xxx-server"?#目標地址
??}]
比對一下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
代碼實現(xiàn)

@Component
public?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();
????/**
?????*?監(jiān)聽nacos路由配置,動態(tài)改變路由
?????*?@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);
????????}
????}
????/**
?????*?發(fā)布路由、使路由生效
?????*/
????private?void?publish()?{
????????this.applicationEventPublisher.publishEvent(new?RefreshRoutesEvent(this.routeDefinitionWriter));
????}
}
過濾器
GlobalFilter filter()?實現(xiàn)過濾器業(yè)務Ordered getOrder()?定義過濾器執(zhí)行順序
鑒權過濾器

<dependency>
????<groupId>org.springframework.bootgroupId>
????<artifactId>spring-boot-starter-data-redis-reactiveartifactId>
dependency>
spring:
??redis:
????host:?redis-server
????port:?6379
????password:
????database:?0
代碼實現(xiàn)
定義過濾器AuthFilter 獲取請求對象 從請求頭或參數(shù)或cookie中獲取token(支持多種方式傳token對于客戶端更加友好,比如部分web下載請求會新建一個頁面,在請求頭中傳token處理起來比較麻煩) 沒有token,返回401 有token,查詢redis是否有效 無效則返回401,有效則完成驗證放行 重置token過期時間、添加內(nèi)部請求頭信息方便業(yè)務系統(tǒng)權限處理
@Component
public?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有效,后續(xù)業(yè)務處理
????????//?從寫請求頭,方便業(yè)務系統(tǒng)從請求頭獲取用戶id進行權限相關處理
????????ServerHttpRequest.Builder?builder?=?exchange.getRequest().mutate();
????????request?=?builder.header("user_id",?userId).build();
????????//?延長緩存過期時間-token緩存用戶如果一直在操作就會一直重置過期
????????//?這樣避免用戶操作過程中突然過期影響業(yè)務操作及體驗,只有用戶操作間隔時間大于緩存過期時間才會過期
????????resetTokenExpirationTime(token,?userId);
????????//?完成驗證
????????return?chain.filter(exchange);
????}
????@Override
????public?int?getOrder()?{
????????//?優(yōu)先級?越小越優(yōu)先
????????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;
????}
}
總結
評論
圖片
表情
