教你如何使用Gateway搭建网关服务及实现动态路由_海·是倒过来的天的博客-程序员宅基地_gateway搭建

技术标签: 微服务  网络  gateway  

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

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

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

搭建服务

框架

  • SpringBoot 2.1

    <parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>2.1.0.RELEASE</version>
    </parent>
    
  • Spring-cloud-gateway-core

    <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-gateway-core</artifactId>
    </dependency>
    
  • common-lang3

    <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-lang3</artifactId>
    </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

配置项 描述
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

[{
      "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创建路由

b75a8bc041a20496006403c43272ad46.png

@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<String> routeIds = Lists.newArrayList();

    /**
     * 监听nacos路由配置,动态改变路由
     * @param configInfo
     */
    @NacosConfigListener(dataId = "routes", groupId = "gateway-server")
    public void routeConfigListener(String configInfo) {
        clearRoute();
        try {
            List<RouteDefinition> 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);
        }
    }
    /**
     * 发布路由、使路由生效
     */
    private void publish() {
        this.applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this.routeDefinitionWriter));
    }
}

过滤器

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

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

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

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

鉴权过滤器

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

8b11d0945f1001a8f0ac029f2d1efd38.png

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

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</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
public class AuthFilter implements GlobalFilter, Ordered {
    @Autowired
    private RedisTemplate<String, String> redisTemplate;
    private static final String TOKEN_HEADER_KEY = "auth_token";
    @Override
    public Mono<Void> 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有效,后续业务处理
        // 从写请求头,方便业务系统从请求头获取用户id进行权限相关处理
        ServerHttpRequest.Builder builder = exchange.getRequest().mutate();
        request = builder.header("user_id", userId).build();
        // 延长缓存过期时间-token缓存用户如果一直在操作就会一直重置过期
        // 这样避免用户操作过程中突然过期影响业务操作及体验,只有用户操作间隔时间大于缓存过期时间才会过期
        resetTokenExpirationTime(token, userId);
        // 完成验证
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        // 优先级 越小越优先
        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;
    }
}

总结

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

 

 

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/qq_31587111/article/details/122731977

智能推荐

spring framework test3种方式_牛麦康纳的博客-程序员宅基地

微服务中Spring boot的分布数以百计,这么多的服务结点如果依赖人工测试将会是一场灾难,所以单个的boot服务必须具有单元测试甚至更负责的集成测试的能力。毕竟在微服务框架中,我们更多的精力会花费在服务架构上,而不是单个的服务能力上。    Spring boot提供了1种单元测试和2种web应用测试。

MFC界面编程基础(16):文档、视图、框架_半个月儿上来的博客-程序员宅基地

MFC应用程序模型历经多年以有了相当大的发展。有一个时期,它只是个使用应用程序对象和主窗口对象的简单模型。在这个模型中,应用程序的数据作为成员变量保持在框架窗口类中,在框架窗口的客户区中,该数据被提交显示器。随着MFC2.0的问世,一种应用程序结构的新方式----MFC文档/视结构出现了。在文档/视图结构中,CFrameWnd繁重的任务被委派给几个不同类,实现了数据存储和显示的分离。文档/视图应...

操作系统实验五文件系统-16281141_qq_41936609的博客-程序员宅基地

文件系统实验报告16281141实验简介本实验要求在模拟的I/O系统之上开发一个简单的文件系统。用户通过create, open, read等命令与文件系统交互。文件系统把磁盘视为顺序编号的逻辑块序列,逻辑块的编号为0至L − 1。I/O系统利用内存中的数组模拟磁盘。I/O系统实际物理磁盘的结构是多维的:有柱面、磁头、扇区等概念。I/O系统的任务是隐藏磁盘的结构细节,把磁盘以逻辑块的面目...

阿里云怎样设置基础设施DDoS防护呢?_qq_38465263的博客-程序员宅基地

DDoS高防实例的流量黑白名单用于封禁或者放行来自指定源IP的四层访问流量。根据业务需要为DDoS高防实例单独配置流量黑名单、白名单,例如添加、移除IP。流量黑名单中也包含DDoS高防智能防御算法标记的恶意IP。同时,流量黑白名单支持导出到本地。本文分享流量黑白名单的具体操作方法。 更多参阅官方文档 操作步骤 登录云盾DDoS高防...

海明码_nicholas199109的博客-程序员宅基地

海明码  1.海明码的概念  海明码是一种可以纠正一位差错的编码。它是利用在信息位为k位,增加r位冗余位,构成一个n=k+r位的码字,然后用r个监督关系式产生的r个校正因子来区分无错和在码字中的n个不同位置的一位错。它必需满足以下关系式:  2^r>=n+1 或2^r>=k+r+1  海明码的编码效率为:  R=k/(k+r)  式中 k为信息位位数  r为增加冗余位位

随便推点

最经典的Linux内核学习方法论_蓝色的音乐的博客-程序员宅基地

最经典的Linux内核学习方法论原文转自:http://tech.it168.com/a2010/0510/884/000000884174_all.shtml Makefile不是Make Love  从前在学校,混了四年,没有学到任何东西,每天就是逃课,上网,玩游戏,睡觉。毕业的时候,人家跟我说Makefile我完全不知,但是一说Make Love我就来劲了,现在想来依然觉得丢

CF 556D Case of Fugitive 根据岛屿选择桥(贪心)_我的指针和我一样已找到对象的博客-程序员宅基地

http://codeforces.com/contest/556/problem/D题意:给你n个岛屿 m个桥,岛屿在一条线上            给岛屿的左坐标与又坐标(L,R).从左到右按顺序给每个岛的L,R           再给你每个桥的长度,每个桥只能用一次           让你用桥把岛屿连接起来,能连则输出yes,并且输出每两个岛屿之间的桥的编号 

BZOJ1119: [POI2009]SLO_L_0_Forever_LF的博客-程序员宅基地

建一个n个点的图,若ax在b中的位置是y,就连一条x->y的边,每次可以交换两个出度,代价是wx+wy,问让所有边连成自环的最小花费每个环显然选出最小的wx顺着环换,也可以额外花费一些,和其他环并在一起,用其他环的wx换 判一下就行了code:#include<set>#include<map>#include<deque>#include<queue>#include<stack>#i

金融风控TASK5_m0_49190544的博客-程序员宅基地

金融风控TASK5:模型融合5.1 平均法5.1.1 简单平均5.1.2 加权平均法5.2投票5.3 综合法5.4 stacking5.5 blending5.6 代码示例模型融合是指将一组不同的模型以合适的方法组合在一起,进而能够让组合模型获得更好的表现。5.1 平均法对于一个回归问题而言,假如存在三种不同的模型,各自有着不同的预测结果。一种朴素的思路是将折三个不同的模型的进行简单平均,得到一个新的预测值。进一步,可以尝试调整各个模型的的权重来获得不同的线性组合。将不同模型通过线性组合的方式组合

小程序获取各种数据值跟设置数据值_只吃小白兔孜孜的博客-程序员宅基地

修改设置data数组中的某个值://小程序接收后台数据若为数组时,下标最好为默认索引数组,从0开始排序 var articleId ='1'//对应数组中的索引值 var thisArticle = &quot;articleList[&quot; + articleId + &quot;].iscollection&quot; console.log(thisArticle); th...

HLJUOJ1003(预处理)_编码之夜的博客-程序员宅基地

1003: TimeTime Limit: 1 Sec  Memory Limit: 128 MBSubmit: 27  Solved: 13[Submit][Status][Web Board]DescriptionDigital clock use 4 digits to express time, each digit is described by 3*3

推荐文章

热门文章

相关标签