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

就是像图中原理一样，哈哈哈~~~~~~~~

watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5rW3wrfmmK_lgJLov4fmnaXnmoTlpKk=,size_20,color_FFFFFF,t_70,g_se,x_16

网关作为微服务中非常重要的一部分，是必须要掌握的；本文记录一下我是如何使用Gateway搭建网关服务及实现动态路由的，帮助大家学习如何快速搭建一个网关服务，了解路由相关配置，鉴权的流程及业务处理，有兴趣的一定看到最后，非常适合没接触过网关服务的同学当作入门教程。

搭建服务

框架

  • SpringBoot 2.1

    1. <parent>
    2.    <groupId>org.springframework.boot</groupId>
    3.    <artifactId>spring-boot-starter-parent</artifactId>
    4.    <version>2.1.0.RELEASE</version>
    5. </parent>

  • Spring-cloud-gateway-core

    1. <dependency>
    2.    <groupId>org.springframework.cloud</groupId>
    3.    <artifactId>spring-cloud-gateway-core</artifactId>
    4. </dependency>

  • common-lang3

    1. <dependency>
    2.    <groupId>org.apache.commons</groupId>
    3.    <artifactId>commons-lang3</artifactId>
    4. </dependency>

路由配置

网关作为请求统一入口，路由就相当于是每个业务系统的入口，通过路由规则则可以匹配到对应微服务的入口，将请求命中到对应的业务系统中

  1. server:
  2.   port: 8080
  3.  
  4. spring:
  5.   cloud:
  6.     gateway:
  7.       enabled: true
  8.       routes:
  9.       - id: demo-server
  10.         uri: http://localhost:8081
  11.         predicates:
  12.         - Path=/demo-server/**
  13.         filters:
  14.           - StripPrefix= 1
  15.

routes

配置项描述
id路由唯一id，使用服务名称即可
uri路由服务的访问地址
predicates路由断言
filters过滤规则

解读配置

  • 现在有一个服务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配置

cb5f0eec68e8bc0703157237c84cbe5b.png

groupId: 使用网关服务名称即可

dataId: routes

配置格式：json

  1. [{
  2.       "id": "xxx-server",
  3.       "order": 1, #优先级
  4.       "predicates": [{ #路由断言
  5.           "args": {
  6.               "pattern": "/xxx-server/**"
  7.           },
  8.           "name": "Path"
  9.       }],
  10.       "filters":[{ #过滤规则
  11.           "args": {
  12.               "parts": 0 #k8s服务内部访问容器为http://xxx-server/xxx-server的话,配置0即可
  13.           },
  14.           "name": "StripPrefix" #截取的开始索引
  15.       }],
  16.       "uri": "http://localhost:8080/xxx-server" #目标地址
  17.   }]
“

json格式配置项与yaml中对应，需要了解配置在json中的写法

比对一下json配置与yaml配置

  1. {
  2.     "id":"demo-server",
  3.     "predicates":[
  4.         {
  5.             "args":{
  6.                 "pattern":"/demo-server/**"
  7.             },
  8.             "name":"Path"
  9.         }
  10.     ],
  11.     "filters":[
  12.         {
  13.             "args":{
  14.                 "parts":1
  15.             },
  16.             "name":"StripPrefix"
  17.         }
  18.     ],
  19.     "uri":"http://localhost:8081"
  20. }
  21.  
  22. spring:
  23.   cloud:
  24.     gateway:
  25.       enabled: true
  26.       routes:
  27.       - id: demo-server
  28.         uri: http://localhost:8081
  29.         predicates:
  30.         - Path=/demo-server/**
  31.         filters:
  32.           - StripPrefix= 1

代码实现

“

Nacos实现动态路由的方式核心就是通过Nacos配置监听，配置发生改变后执行网关相关api创建路由

b75a8bc041a20496006403c43272ad46.png

  1. @Component
  2. public class NacosDynamicRouteService implements ApplicationEventPublisherAware {
  3.  
  4.     private static final Logger LOGGER = LoggerFactory.getLogger(NacosDynamicRouteService.class);
  5.  
  6.     @Autowired
  7.     private RouteDefinitionWriter routeDefinitionWriter;
  8.  
  9.     private ApplicationEventPublisher applicationEventPublisher;
  10.  
  11.     /** 路由id */
  12.     private static List<String> routeIds = Lists.newArrayList();
  13.  
  14.     /**
  15.      * 监听nacos路由配置，动态改变路由
  16.      * @param configInfo
  17.      */
  18.     @NacosConfigListener(dataId = "routes", groupId = "gateway-server")
  19.     public void routeConfigListener(String configInfo) {
  20.         clearRoute();
  21.         try {
  22.             List<RouteDefinition> gatewayRouteDefinitions = JSON.parseArray(configInfo, RouteDefinition.class);
  23.             for (RouteDefinition routeDefinition : gatewayRouteDefinitions) {
  24.                 addRoute(routeDefinition);
  25.             }
  26.             publish();
  27.             LOGGER.info("Dynamic Routing Publish Success");
  28.         } catch (Exception e) {
  29.             LOGGER.error(e.getMessage(), e);
  30.         } 
  31.     }
  32.     /**
  33.      * 清空路由
  34.      */
  35.     private void clearRoute() {
  36.         for (String id : routeIds) {
  37.             routeDefinitionWriter.delete(Mono.just(id)).subscribe();
  38.         }
  39.         routeIds.clear();
  40.     }
  41.  
  42.     @Override
  43.     public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
  44.         this.applicationEventPublisher = applicationEventPublisher;
  45.     }
  46.     /**
  47.      * 添加路由
  48.      * 
  49.      * @param definition
  50.      */
  51.     private void addRoute(RouteDefinition definition) {
  52.         try {
  53.             routeDefinitionWriter.save(Mono.just(definition)).subscribe();
  54.             routeIds.add(definition.getId());
  55.         } catch (Exception e) {
  56.             LOGGER.error(e.getMessage(), e);
  57.         }
  58.     }
  59.     /**
  60.      * 发布路由、使路由生效
  61.      */
  62.     private void publish() {
  63.         this.applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this.routeDefinitionWriter));
  64.     }
  65. }

过滤器

“

gateway提供GlobalFilter及Ordered两个接口用来定义过滤器，我们自定义过滤器只需要实现这个两个接口即可

  • GlobalFilter filter() 实现过滤器业务

  • Ordered getOrder() 定义过滤器执行顺序

通常一个网关服务的过滤主要包含 鉴权（是否登录、是否黑名单、是否免登录接口...） 限流（ip限流等等）功能，我们今天简单介绍鉴权过滤器的流程实现

鉴权过滤器

“

需要实现鉴权过滤器，我们先得了解登录及鉴权流程，如下图所示

8b11d0945f1001a8f0ac029f2d1efd38.png

由图可知，我们鉴权过滤核心就是验证token是否有效，所以我们网关服务需要与业务系统在同一个redis库，先给网关添加redis依赖及配置

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
  4. </dependency>
  5.  
  6. spring:
  7.   redis:
  8.     host: redis-server
  9.     port: 6379
  10.     password:
  11.     database: 0

代码实现

  • 1.定义过滤器AuthFilter

  • 2.获取请求对象 从请求头或参数或cookie中获取token(支持多种方式传token对于客户端更加友好，比如部分web下载请求会新建一个页面，在请求头中传token处理起来比较麻烦)

  • 3.没有token,返回401

  • 4.有token，查询redis是否有效

  • 5.无效则返回401，有效则完成验证放行

  • 6.重置token过期时间、添加内部请求头信息方便业务系统权限处理

  1. @Component
  2. public class AuthFilter implements GlobalFilter, Ordered {
  3.     @Autowired
  4.     private RedisTemplate<String, String> redisTemplate;
  5.     private static final String TOKEN_HEADER_KEY = "auth_token";
  6.     @Override
  7.     public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  8.         // 1.获取请求对象
  9.         ServerHttpRequest request = exchange.getRequest();
  10.         // 2.获取token
  11.         String token = getToken(request);
  12.         ServerHttpResponse response = exchange.getResponse();
  13.         if (StringUtils.isBlank(token)) {
  14.             // 3.token为空 返回401
  15.             response.setStatusCode(HttpStatus.UNAUTHORIZED);
  16.             return response.setComplete();
  17.         }
  18.         // 4.验证token是否有效
  19.         String userId = getUserIdByToken(token);
  20.         if (StringUtils.isBlank(userId)) {
  21.             // 5.token无效 返回401
  22.             response.setStatusCode(HttpStatus.UNAUTHORIZED);
  23.             return response.setComplete();
  24.         }
  25.         // token有效，后续业务处理
  26.         // 从写请求头，方便业务系统从请求头获取用户id进行权限相关处理
  27.         ServerHttpRequest.Builder builder = exchange.getRequest().mutate();
  28.         request = builder.header("user_id", userId).build();
  29.         // 延长缓存过期时间-token缓存用户如果一直在操作就会一直重置过期
  30.         // 这样避免用户操作过程中突然过期影响业务操作及体验，只有用户操作间隔时间大于缓存过期时间才会过期
  31.         resetTokenExpirationTime(token, userId);
  32.         // 完成验证
  33.         return chain.filter(exchange);
  34.     }
  35.  
  36.     @Override
  37.     public int getOrder() {
  38.         // 优先级 越小越优先
  39.         return 0;
  40.     }
  41.  
  42.     /**
  43.      * 从redis中获取用户id
  44.      * 在登录操作时候 登陆成功会生成一个token, redis得key为auth_token:token 值为用户id
  45.      *
  46.      * @param token
  47.      * @return
  48.      */
  49.     private String getUserIdByToken(String token) {
  50.         String redisKey = String.join(":", "auth_token", token);
  51.         return redisTemplate.opsForValue().get(redisKey);
  52.     }
  53.  
  54.     /**
  55.      * 重置token过期时间
  56.      *
  57.      * @param token
  58.      * @param userId
  59.      */
  60.     private void resetTokenExpirationTime(String token, String userId) {
  61.         String redisKey = String.join(":", "auth_token", token);
  62.         redisTemplate.opsForValue().set(redisKey, userId, 2, TimeUnit.HOURS);
  63.     }
  64.  
  65.     /**
  66.      * 获取token
  67.      *
  68.      * @param request
  69.      * @return
  70.      */
  71.     private static String getToken(ServerHttpRequest request) {
  72.         HttpHeaders headers = request.getHeaders();
  73.         // 从请求头获取token
  74.         String token = headers.getFirst(TOKEN_HEADER_KEY);
  75.         if (StringUtils.isBlank(token)) {
  76.             // 请求头无token则从url获取token
  77.             token = request.getQueryParams().getFirst(TOKEN_HEADER_KEY);
  78.         }
  79.         if (StringUtils.isBlank(token)) {
  80.             // 请求头和url都没有token则从cookies获取
  81.             HttpCookie cookie = request.getCookies().getFirst(TOKEN_HEADER_KEY);
  82.             if (cookie != null) {
  83.                 token = cookie.getValue();
  84.             }
  85.         }
  86.         return token;
  87.     }
  88. }

总结

Gateway通过配置项可以实现路由功能，整合Nacos及配置监听可以实现动态路由，实现GlobalFilter, Ordered两个接口可以快速实现一个过滤器，文中也详细的介绍了登录后的请求鉴权流程。

 

来源：https://blog.csdn.net/qq_31587111/article/details/122731977

 

posted @ 2022-11-22 21:51  程序员小明1024  阅读(469)  评论(0)  编辑  收藏  举报