gateway网关的使用

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6

今天与大家分享gateway网关的使用

1. gateway简介

1.1 是什么

SpringCloud Gateway 作为 Spring Cloud 生态系统中的网关目标是替代 Zuul在Spring Cloud 2.0以上版本中没有对新版本的Zuul 2.0以上最新高性能版本进行集成仍然还是使用的Zuul 2.0之前的非Reactor模式的老版本。而为了提升网关的性能SpringCloud Gateway是基于WebFlux框架实现的而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。

1.2 作用

Spring Cloud Gateway 的目标不仅提供统一的路由方式并且基于 Filter 链的方式提供了网关基本的功能例如安全监控/指标和限流。

1.3 主要特征

  • 基于 Spring Framework 5Project Reactor 和 Spring Boot 2.0
  • 集成 Hystrix 断路器
  • 集成 Spring Cloud DiscoveryClient
  • Predicates 和 Filters 作用于特定路由易于编写的 Predicates 和 Filters
  • 具备一些网关的高级功能动态路由、限流、路径重写

1.4 与zuul的主要区别

Spring Cloud Gateway 底层使用了高性能的通信框架Netty zuul采用的是传统的servlet IO。

1.5 主要组件

  • Filter
    过滤器与zuul中的过滤器作用相同可以用来拦截和修改请求也可以对响应做处理。比如用来进行安全校验等。

  • Route
    路由组件将网关接受到的请求发送给指定的上游服务进行处理。一个Route模块由一个 ID一个目标 URI一组断言和一组过滤器定义。如果断言为真则路由匹配目标URI会被访问

  • Predicate
    断言 这是一个 Java 8 的 Predicate。简单的理解是路由转发的条件满足条件的请求才会被转发。有点像sql中的where子句的作用。

1.6 架构图

官网icon-default.png?t=MBR7https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/

 

对上图的理解
客户端向 Spring Cloud Gateway 发出请求。然后在 Gateway Handler Mapping 中找到与请求相匹配的路由将其发送到 Gateway Web Handler。Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑然后返回。过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前“pre”或之后“post”执行业务逻辑

2. 开发示例

2.1 创建一个gateway模块

1创建一个gateway模块

 

2如上图配置pom文件引入必要的包

    <dependencies>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <!-- 从注册中心进行服务发现 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <!-- 向注册中心进行服务注册 -->
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

    </dependencies>
  1. 项目配置文件application.yml

 

server:
  port: 8090

spring:
  application:
    name: service-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

4创建启动类

 

@SpringBootApplication
public class GatewayApp {

    public static void main(String[] args) {
        SpringApplication.run(GatewayApp.class, args);
    }

}

2.2 与nacos结合使用

2.2.1 默认规则

将gateway注册到nacos注册中心使用默认规则进行路由默认规则使用简单但功能也相当较弱。
默认规则
http://gateway_host:gateway_port/服务名/**

服务名 默认为nacos注册的服务点的大写可以修改

配置文件

server:
  port: 8090

spring:
  application:
    name: service-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

    gateway:
      discovery:
        locator:
          #开启服务发现功能从注册中心获取服务列表nacos->服务管理->服务列表
          #默认服务名称需要为大写可以通过配置lower-case-service-id: true 改变这一规则
          enabled: true
          #配置服务名使用小写
          lower-case-service-id: true

#配置配置
logging:
  level:
    #tracedebuginfo
    org.pringframework.cloud.gateway: trace #便于跟踪调试生产环境最好不用
    org.springframework.http.server.reactive: debug
    org.springframework.web.reactive: debug
    reactor.ipc.netty: debug

2.2.2 通过配置文件配置路由

RouteDefinition中主要有五个属性

  • id路由标识id标识具有唯一性默认为uuid
  • predicatesPredicateDefinition 路由断言定义列表
  • filtersFilterDefinition 过滤器定义列表为一个数组
  • uri目标服务地址uri地址请求转发后的地址
  • order优先级 越小越优先

通过配置文件配置路由的缺点是当增加服务时需要修改配置文件并重启网关。

配置文件

server:
  port: 8090

spring:
  application:
    name: service-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

    gateway:
      discovery:
        locator:
          #开启服务发现功能从注册中心获取服务列表nacos->服务管理->服务列表
          #默认服务名称需要为大写可以通过配置lower-case-service-id: true 改变这一规则
          enabled: false
          #配置服务名使用小写
          lower-case-service-id: true

      routes:
        # http://localhost:5000/usr/hello
        #路由标识id标识具有唯一性
        - id: consumer-service-api
          #目标服务地址uri地址请求转发后的地址会自动从注册中心获得服务的IP不需要手动写死
          uri: lb://service-consumer
          #优先级越小越优先
          #order: 999
          #路由条件predicates断言
          predicates:
          # 路径匹配
          - Path=/consumer/**
          filters:
          #路径前缀删除示例请求/name/bar/fooStripPrefix=2去除掉前面两个前缀之后最后转发到目标服务的路径为/foo
          #前缀过滤请求地址http://localhost:5000/usr/hello
          #此处配置去掉1个路径前缀再配置上面的 Path=/usr/**就将**转发到指定的微服务
          #因为这个api相当于是服务名只是为了方便以后nginx的代码加上去的对于服务提供者service-client来说不需要这段地址所以需要去掉
          - StripPrefix=1

#配置配置
logging:
  level:
    #tracedebuginfo
    org.pringframework.cloud.gateway: trace #便于跟踪调试生产环境最好不用
    org.springframework.http.server.reactive: debug
    org.springframework.web.reactive: debug
    reactor.ipc.netty: debug

2.2.3 动态路由

功能强在新增服务时不需要重启网关

1配置文件

 

# 自定义配置
# 自定义配置
nacos:
  dataId: gateway-config.json
  group: GWC-GROUP

#配置配置
logging:
  level:
    #tracedebuginfo
    #便于跟踪调试生产环境最好不用
    org.springframework.cloud.gateway: trace
    org.springframework.http.server.reactive: debug
    org.springframework.web.reactive: debug
    reactor.ipc.netty: debug

2读取配置文件的中的配置信息

/**
 * 1. 保存Gateway(网关)中与nacos相关的属性
 * 2. 这些信息是自定义配置属性它们保存在配置文件application.yml中
 */
@Configuration
@Data
public class GatewayNacosProperties {

    @Value("${spring.cloud.nacos.discovery.server-addr}")
    private String serverAddr;

    @Value("${nacos.dataId}")
    private String dataId;

    @Value("${nacos.group}")
    private String group;

}

3实现实现动态路由

/**
 * 此类实现了Spring Cloud Gateway + nacos 的动态路由
 * 该类用于监听配置中心中的路由配置的变化当监听到配置变化则发布一个事件
 * 用于更新本地路由信息。
 * 它实现一个Spring提供的事件推送接口ApplicationEventPublisherAware
 */
@Component
public class DynamicRoutingConfig implements ApplicationEventPublisherAware {

    private final Logger logger = LoggerFactory.getLogger(DynamicRoutingConfig.class);

    @Autowired
    private RouteDefinitionWriter routeDefinitionWriter;

    @Autowired
    private GatewayNacosProperties gatewayNacosProperties;

    private ApplicationEventPublisher applicationEventPublisher;


    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        this.applicationEventPublisher = applicationEventPublisher;
    }

    /**
     * 这个方法主要负责监听Nacos的配置变化这里先使用参数构建一个ConfigService再使用ConfigService开启一个监听
     * 并且在监听的方法中刷新路由信息。
     *
     * @throws NacosException
     */
    @Bean
    public void refreshRouting() throws NacosException {
        Properties properties = new Properties();
        properties.put(PropertyKeyConst.SERVER_ADDR, gatewayNacosProperties.getServerAddr());
        ConfigService configService = NacosFactory.createConfigService(properties);

        //获得nacos中已有的路由配置
        String json = configService.getConfig(gatewayNacosProperties.getDataId(), gatewayNacosProperties.getGroup(), 8090);
        this.parseJson(json);

        //添加监听器监听nacos中的数据修改事件
        configService.addListener(gatewayNacosProperties.getDataId(), gatewayNacosProperties.getGroup(), new Listener() {
            @Override
            public Executor getExecutor() {
                return null;
            }

            @Override
            public void receiveConfigInfo(String configInfo) {
                logger.info(configInfo);
                parseJson(configInfo);
            }
        });
    }


    /**
     * 解析从nacos读取的路由配置信息(json格式)
     *
     * @param json
     */
    public void parseJson(String json) {
        logger.info("从Nacos返回的路由配置(JSON格式)" + json);
        List<RouteDefinition> routeArr = JSON.parseArray(json).toJavaList(RouteDefinition.class);
        for (RouteDefinition route : routeArr) {
            update(route);
        }
    }


    /**
     * 路由更新
     * 1先将原来的路由信息删除
     * 2保存新的路由信息
     * @param routeDefinition
     * @return
     */
    public void update(RouteDefinition routeDefinition) {

        try {
            this.routeDefinitionWriter.delete(Mono.just(routeDefinition.getId()));
            logger.info("删除原来的路由信息");
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }

        try {
            routeDefinitionWriter.save(Mono.just(routeDefinition)).subscribe();
            this.applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this));
            logger.info("路由更新成功");
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
    }

}

4在配置中心中配置路由信息

 

路由配置采用json格式参考配置如下

[
  {
    "id": "service-consumer",
    "predicates": [
      {
        "name": "Path",
        "args": {
        "_genkey_0": "/consumer/**"
        }
      }
    ],
    "filters": [
      {
        "name": "StripPrefix",
        "args": {
          "_genkey_0": "1"
        }
      }
    ],
    "uri": "lb://service-consumer",
    "order": 0
  }
]

需要根据自己的项目的具体情况配置。

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6
返回列表

上一篇：【论文阅读 CIKM2014】Extending Faceted Search to the General Web

下一篇：如何使用 Python比较两张图像并获得准确度？

“gateway网关的使用” 的相关文章

AcWing1074. 二叉苹果树（树形DP +分组背包）1年前 (2023-02-02)
【Java|golang】2325. 解密消息1年前 (2023-02-02)
【数学建模】常用算法-主成分分析PCA的Python实现1年前 (2023-02-02)
函数1年前 (2023-02-02)
读函数式编程思维笔记05_现实应用1年前 (2023-02-02)
【第24天】SQL进阶-查询优化- performance1年前 (2023-02-02)
计算机网络原理（谢希仁第八版）第四章课后习题答案_计算机网络第八版谢希仁课后答案1年前 (2023-02-02)
AHP层次分析法与python代码讲解（处理论文、建模）1年前 (2023-02-02)
发布并部署NCF站点的那些事1年前 (2023-02-02)
Windows-》CMD命令1年前 (2023-02-02)

阿里云国际版