SpringCloud——Gateway、Config、Bus的使用

目录

• 七、网关 Spring Cloud Gateway
• 八、配置中心 Spring Cloud Config
• 九、消息总线 Spring Cloud Bus

SpringCloud 总架构图

七、网关 Spring Cloud Gateway

跳转到目录

2.1 简介

Gateway网关是我们服务的守门神，所有微服务的统一入口。Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

在Gateway之前，SpringCloud并不自己开发网关，可能是觉得Netflix公司的Zuul不行吧，然后自己就写了一个，也是替代Netflix Zuul。其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控/指标，和限流。

本身也是一个微服务，需要注册到Eureka

功能特性

• 基于 Spring Framework 5，Project Reactor 和 Spring Boot 2.0
• 动态路由
• Predicates 和 Filters 作用于特定路由
• 集成 Hystrix 断路器
• 集成 Spring Cloud DiscoveryClient
• 简单好用的 Predicates 和 Filters
• 限流
• 路径重写

• 不管是来自客户端的请求，还是服务内部调用。一切对服务的请求都可经过网关。
• 网关实现鉴权、动态路由等等操作。
• Gateway是我们服务的统一入口

术语解释

• Route（路由）：这是网关的基本模块。它由一个 ID，一个目标 URI，一组断言和一组过滤器定义。如果断言为真，则路由匹配。
• Predicate（断言）：这是一个 Java 8 的 Predicate。输入类型是一个 ServerWebExchange。我们可以使用它来匹配来自 HTTP 请求的任何内容，例如 headers 或参数。
• Filter（过滤器）：这是org.springframework.cloud.gateway.filter.GatewayFilter的实例，我们可以使用它修改请求和响应。

2.2 快速入门

搭建网关微服务，实现服务路由分发。

实现步骤：

1. 创建SpringBoot工程gateway_server
2. 勾选starter：网关、Eureka客户端
3. 编写基础配置：端口，应用名称，注册中心地址
4. 编写路由规则：唯一表示id，路由url地址，路由限定规则
5. 启动网关服务进行测试

实现过程：

1. 创建SpringBoot工程gateway_server
   

2. 勾选Starter：网关、Eureka客户端
   

3. 启动引导类开启注册中心Eureka客户端发现

   @SpringBootApplication
   @EnableDiscoveryClient// 开启Eureka客户端发现功能
   public class GatewayApplication {
       public static void main(String[] args) {
           SpringApplication.run(GatewayApplication.class,args);
       }
   }
   

4. 编写基础配置

   • 在gateway_server中创建application.yml文件，配置

     # 端口
     server.port: 10010
     # 应用名
     spring.application.name: api-gateway 
     # 注册中心地址
     eureka.client.service-url.defaultZone: http://127.0.0.1:10086/eureka
     

5. 编写路由规则

   • 需要用网关来路由user_service服务，查看服务ip和端口
     

   • 修改gateway_server的配置文件application.yml，配置网关内容

     spring:
       cloud:
         gateway:
           # 路由si(集合)
           routes:
               # id唯一标识
             - id: user-service-route
               # 路由服务地址
               uri: http://127.0.0.1:9091
               # 断言
               predicates:
                 - Path=/user/**
     

   • 将符合path规则的请求，路由到uri参数指定地址。

   • 举例：http://localhost:10010/user/findById?id=1 路由转发到http://localhost:9091/user/findById?id=1

6. 启动GatewayApplication进行测试

   • 访问路径中，必须包含路由规则的映射路径/user才会被路由
     

2.3 动态路由

刚才路由规则中，我们把路径对应服务地址写死了！如果服务提供者集群的话，这样做不合理。应该是根据服务名称，去Eureka注册中心查找服务对应的所有实例列表，然后进行动态路由！

• 修改映射配置：通过服务名称获取

  • 因为已经配置了Eureka客户端，可以从Eureka获取服务的地址信息，修改application.yml文件如下

    # 注解版
    spring:
      cloud:
        gateway:
          # 路由si(集合)
          routes:
              # id唯一标识
            - id: user-service-route
              # 路由地址
              # uri: http://127.0.0.1:9091
              # 采用lb协议，会从Eureka注册中心获取服务请求地址
              # 路由地址如果通过lb协议加服务名称时，会自动使用负载均衡访问对应服务
              # 规则：lb协议+服务名称
              uri: lb://user-service
              # 路由拦截地址(断言)
              predicates:
                - Path=/user/**
    

  • 路由配置中uri所用的协议为lb时，gateway将把user-service解析为实际的主机和端口，并通过Ribbon进行负载均衡。

• 启动GatewayApplication测试
  

  • 这次gateway进行路由时，会利用Ribbon进行负载均衡访问。日志中可以看到使用了负载均衡器。

2.4 路由前缀

第一：添加前缀：

在gateway中可以通过配置路由的过滤器PrefixPath 实现映射路径中的前缀添加。可以起到隐藏接口地址的作用，避免接口地址暴露。

1. 配置请求地址添加路径前缀过滤器

   spring:
     cloud:
       gateway:
         routes:
           - id: user-service-route # 路由id，可以随意写
             # 代理服务地址；lb表示从Eureka中获取具体服务
             uri: lb://user-service
             # 路由断言，配置映射路径
             predicates:
               - Path=/**
             # 请求地址添加路径前缀过滤器
             filters:
               - PrefixPath=/user
   

2. 重启GatewayApplication

3. 配置完成的效果：

配置	访问地址	路由地址
PrefixPath=/user	localhost:10010/findById?id=1	localhost:9091/user/findById?id=1
PrefixPath=/user/abc	localhost:10010/findById?id=1	localhost:9091/user/abc/findById?id=1

第二：去除前缀：

在gateway中通过配置路由过滤器StripPrefix，实现映射路径中地址的去除。通过StripPrefix=1来指定路由要去掉的前缀个数。如：路径/api/user/1将会被路由到/user/1。

1. 配置去除路径前缀过滤器

   spring:
     cloud:
       gateway:
         routes:
           - id: user-service-route # 路由id，可以随意写
             # 代理服务地址；lb表示从Eureka中获取具体服务
             uri: lb://user-service
             # 路由断言，配置映射路径
             predicates:
               - Path=/**
             # 去除路径前缀过滤器
             filters:
               - StripPrefix=1
   

2. 重启GatewayApplication

3. 访问查看效果

配置	访问地址	路由地址
StripPrefix=1	localhost:10010/api/user/findById?id=1	localhost:9091/user/findById?id=1
StripPrefix=2	localhost:10010/aa/api/user/findById?id=1	localhost:9091/user/findById?id=1

2.5 过滤器

2.5.1 简介

过滤器作为网关的其中一个重要功能，就是实现请求的鉴权。前面的路由前缀章节中的功能也是使用过滤器实现的。

Gateway自带过滤器有几十个，常见自带过滤器有：

过滤器名称	说明
AddRequestHeader	对匹配上的请求加上Header
AddRequestParameters	对匹配上的请求路由
AddResponseHeader	对从网关返回的响应添加Header
StripPrefix	对匹配上的请求路径去除前缀
PrefixPath	对匹配上的请求路径添加前缀

详细说明官方链接

使用场景：

• 请求鉴权：如果没有访问权限，直接进行拦截
• 异常处理：记录异常日志
• 服务调用时长统计

2.5.2 过滤器配置

**过滤器类型：**Gateway有两种过滤器

• 局部过滤器：只作用在当前配置的路由上。
• 全局过滤器：作用在所有路由上。

配置全局过滤器：

对输出的响应设置其头部属性名称为i-love,值为itheima

1. 修改配置文件

   spring:
     cloud:
       gateway:
        # 配置全局默认过滤器
         default-filters:
         # 往响应过滤器中加入信息
           - AddResponseHeader=i-love,itheima
   

2. 查看浏览器响应头信息
   

2.5.3 执行顺序(了解)

Spring Cloud Gateway 的 Filter 的执行顺序有两个：“pre” 和 “post”。“pre”和 “post” 分别会在请求被执行前调用和被执行后调用。

这里的 pre和post可以通过过滤器的 GatewayFilterChain 执行filter方法前后来实现。

2.6 自定义全局过滤器

需求： 模拟登录校验。

实现步骤：

1. 在gateway_server中，全局过滤器类MyGlobalFilter，实现GlobalFilter和 Ordered接口
2. 编写业务逻辑代码判断：
   • 过滤器必须注入SpringIOC容器中
   • 如果请求中有token参数，则认为请求有效，放行，
   • 如果没有则拦截提示未授权。
3. 访问接口测试，加token和不加token。

实现过程：

1. 在gateway_server中，全局过滤器类MyGlobalFilter，实现GlobalFilter和 Ordered接口

2. 编写业务逻辑代码判断：

   1. 如果请求中有token参数，则认为请求有效，放行

   2. 如果没有则拦截提示未授权

      @Component
      public class MyGlobalFilter implements GlobalFilter, Ordered {
      
          @Override
          public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
              System.out.println("-----------------全局过滤器MyGlobalFilter---------------------");
              //1、获取参数中的token，以及token的值
              String token = exchange.getRequest().getQueryParams().getFirst("token");
              //2、如果token的值为空，则拦截
              if (StringUtils.isBlank(token)) {
                  exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
                  return exchange.getResponse().setComplete();
              }
              return chain.filter(exchange);
          }
          /**
           * 定义过滤器执行顺序
           * 返回值越小，越靠前执行
           * @return
           */
          @Override
          public int getOrder() {
              return 0;//
          }
      }
      

3. 访问：http://localhost:10010/api/user/findById?id=1

   

4. 访问：http://localhost:10010/api/user/findById?id=1&token=11

八、配置中心 Spring Cloud Config

跳转到目录

3.0 Config 简介

分布式系统中，由于服务数量非常多，配置文件分散在不同微服务项目中，管理极其不方便。为了方便配置文件集中管理，需要分布式配置中心组件。在Spring Cloud中，提供了Spring Cloud Config，它支持配置文件放在配置服务的本地，也支持配置文件放在远程仓库Git(GitHub、码云)。配置中心本质上是一个微服务，同样需要注册到Eureka服务中心！

一句话概括：统一管理所有微服务配置文件的一个微服务

配置中心，也是一个微服务，需要注册到注册中心

3.1 配置中心整合步骤：

1. 配置文件集中放在码云
2. 配置中心获取码云配置文件
3. 用户服务获取配置中心文件

3.2 Git配置管理

3.2.1 远程Git仓库

• 知名的Git远程仓库有国外的GitHub和国内的码云(gitee)；
• GitHub主服务在外网，访问经常不稳定，如果希望服务稳定，可以使用码云；
• 码云访问地址：http://gitee.com

3.2.2 创建远程仓库

1. 首先使用码云上的git仓库需要先注册账户

2. 账户注册完成，然后使用账户登录码云控制台并创建公开仓库
   

3. 配置仓库 名称和路径
   

3.2.3 创建配置文件

1. 在新建的仓库中创建需要被统一配置管理的配置文件

• 配置文件的命名方式：{application}-{profile}.yml或{application}-{profile}.properties
• application为应用名称
• profile用于区分开发环境dev，测试环境test，生产环境pro等
  • 开发环境 user-dev.yml
  • 测试环境 user-test.yml
  • 生产环境 user-pro.yml

2. 将user-service工程里的配置文件application.yml内容复制作为user-dev.yml文件内容
   

3. 创建完user-dev.yml配置文件之后，gitee中的仓库如下：
   

3.3 搭建配置中心微服务

实现步骤：

1. 创建配置中心SpringBoot项目config_server
2. 勾选Starter：配置中心，Eureka客户端
3. 在启动引导类上加@EnableConfigServer注解
4. 修改配置文件：端口，应用名称，注册中心地址，码云仓库地址
5. 启动测试，测试配置文件实时同步

实现过程：

1. 创建配置中心SpringBoot项目config_server
   

2. 勾选Starter坐标依赖：配置中心starter，Eureka客户端starter
   

3. 启动类：创建配置中心工程config_server的启动类ConfigServerApplication

   • @SpringBootApplication
     @EnableDiscoveryClient//开启Eureka客户端发现功能
     @EnableConfigServer //开启配置服务支持
     public class ConfigServerApplication {
         public static void main(String[] args) {
             SpringApplication.run(ConfigServerApplication.class,args);
         }
     }
     

4. 配置文件：创建配置中心工程config_server的配置文件application.yml

   # 端口
   server.port: 12000
   # 应用名称
   spring.application.name: config-server
   # git仓库地址
   spring.cloud.config.server.git.uri: https://gitee.com/liuyaxiong01/itheima-spring-cloud-config.git
   # 注册中心地址
   eureka.client.service-url.defaultZone: http://127.0.0.1:10086/eureka
   

   • 注意：上述spring.cloud.config.server.git.uri是在码云创建的仓库地址

5. 启动测试：启动eureka注册中心和配置中心；

   • 访问http://localhost:12000/user-dev.yml查看能否输出码云存储管理的user-dev.yml文件
     

   • 并且可以在gitee上修改user-dev.yml，然后刷新上述测试地址也能及时更新数据

3.4 服务去获取配置中心配置

关于application.yml和bootstrap.yml文件的说明：

• bootstrap.yml文件是SpringBoot的默认配置文件，而且其加载时间相比于application.yml更早。
• bootstrap.yml和application.yml都是默认配置文件，但定位不同
  • bootstrap.yml相当于项目启动的引导文件
  • application.yml文件是微服务的常规配置参数，变化比较频繁
• 搭配spring-cloud-config使application.yml的配置可以动态替换。

目标：改造user_service工程，配置文件不再由微服务项目提供，而是从配置中心获取。

实现步骤：

1. 在user_service服务中，添加Config的starter依赖
2. 删除application.yml配置文件，新增bootstrap.yml配置文件
3. 配置bootstrap.yml配置文件：
   • 配置中心相关配置(配置文件前缀、后缀，仓库分支，是否开启配置中心)
   • 注册中心地址
4. 启动服务，测试效果

实现过程：

1. 添加依赖

   
   <dependency>
       <groupId>org.springframework.cloudgroupId>
       <artifactId>spring-cloud-starter-configartifactId>
   dependency>
   

2. 修改配置

   • 删除user_service工程的application.yml文件

   • 创建user_service工程bootstrap.yml配置文件，配置内容如下

     # 注册中心地址
     eureka.client.service-url.defaultZone: http://127.0.0.1:10086/eureka
     
     # 配置中心相关配置
     # 使用配置中心
     spring.cloud.config.discovery.enabled: true
     # 配置中心服务id
     spring.cloud.config.discovery.service-id: config-server
     # 与远程仓库中的配置文件的application和profile保持一致，{application}-{profile}.yml
     spring.cloud.config.name: user
     spring.cloud.config.profile: dev
     # 远程仓库中的分支保持一致
     spring.cloud.config.label: master
     
     

3. 启动测试：

   • 依次启动：注册中心、配置中心、用户中心user_service
     

   • 如果启动没报错，其实已经使用上配置中心内容了

   • 可以在服务中心查看也可以检验user_service的服务
     

3.5 配置中心存在的问题

复现问题步骤：

1. 修改远程Git配置

   • 修改在码云上的user-dev.yml文件，添加一个属性test.name
     

2. 修改UserController

   @RestController
   @RequestMapping("/user")
   public class UserController {
   
       @Value("${server.port}")
       private String port;
   
       @Value("${test.hello}")
       private String name;
   
       @Autowired
       UserService userService;
       //查询所有
       @RequestMapping("/findAll")
       public List<User> findAll() {
           return userService.findAll();
       }
   
       //根据id查询
       @RequestMapping("/findById")
       public User findById(Integer id) {
           System.out.println("服务【"+port+"】被调用");
           User user = userService.findById(id);
           user.setNote("服务【"+port+"】被调用");
           user.setName(name);
           return user;
       }
   
   }
   
   

3. 测试：

   • 依次启动Eureka，配置中心，用户微服务；
   • 访问用户微服务，查看输出内容。我们修改的user-dev.yml并没有发生立即发生变化。但是配置中心的配置文件内容发生了变化。
     

结论：通过浏览器输出结果发现，我们对于Git仓库中的配置文件的修改，并没有及时更新到user-service微服务，只有重启用户微服务才能生效。

SpringCloud Bus，解决上述问题，实现配置自动更新。

九、消息总线 Spring Cloud Bus

跳转到目录

4.1 简介

Bus是用轻量的消息代理将分布式的节点连接起来，可以用于**广播配置文件的更改**或者服务的监控管理。Bus可以为微服务做监控，也可以实现应用程序之间互相通信。Bus可选的消息代理(消息队列)RabbitMQ和Kafka。

广播出去的配置文件服务会进行本地缓存。

注意：SpringCloudBus基于RabbitMQ实现，默认使用本地的消息队列服务，所以需要提前安装并启动RabbitMQ。安装参考./04资料/安装Windows RabbitMQ.pdf

安装注意事项：

所有操作均以管理员权限执行

系统的用户名不能为中文

安装路径也不能含有中文

4.2 整合案例

目标：消息总线整合入微服务系统，实现配置中心的配置自动更新。不需要重启微服务。

4.2.1 改造配置中心

改造步骤：

1. 在config_server中，加入Bus和RabbitMQ的依赖
2. 修改配置文件：RabbitMQ服务地址，触发配置文件更改接口

实现过程：

1. 在config_server项目中加入Bus相关依赖

   
   <dependency>
       <groupId>org.springframework.cloudgroupId>
       <artifactId>spring-cloud-busartifactId>
   dependency>
   
   <dependency>
       <groupId>org.springframework.cloudgroupId>
       <artifactId>spring-cloud-stream-binder-rabbitartifactId>
   dependency>
   

2. 在config_server项目中修改application.yml

   # RabbitMQ的服务地址
   spring.rabbitmq.host: localhost
   spring.rabbitmq.port: 5672
   spring.rabbitmq.username: guest
   spring.rabbitmq.password: guest
   
   # 触发配置文件广播的地址
   management.endpoints.web.exposure.include: bus-refresh
   

4.2.2 改造用户服务

改造步骤：

1. 在user-service中，加入Bus和RabbitMQ的依赖
2. 修改配置文件：RabbitMQ服务地址
3. 在需要刷新配置的类上加@RefreshScope注解
4. 测试效果

实现过程：

1. 在用户微服务user_service项目中加入Bus相关依赖

   
   <dependency>
       <groupId>org.springframework.cloudgroupId>
       <artifactId>spring-cloud-busartifactId>
   dependency>
   
   <dependency>
       <groupId>org.springframework.cloudgroupId>
       <artifactId>spring-cloud-stream-binder-rabbitartifactId>
   dependency>
   

2. 修改user_service项目的bootstrap.yml

   # RabbitMQ的服务地址
   spring.rabbitmq.host: localhost
   spring.rabbitmq.port: 5672
   spring.rabbitmq.username: guest
   spring.rabbitmq.password: guest
   

3. 改造用户微服务user_service项目的UserController

   @RestController
   @RequestMapping("/user")
   @RefreshScope //刷新配置
   public class UserController {
   
       @Value("${server.port}")
       private String port;
   
       @Value("${test.hello}")
       private String name;
       
       @Autowired
       UserService userService;
       //查询所有
       @RequestMapping("/findAll")
       public List<User> findAll() {
           return userService.findAll();
       }
       //根据id查询
       @RequestMapping("/findById")
       public User findById(Integer id) {
           System.out.println("服务【"+port+"】被调用");
           User user = userService.findById(id);
           user.setNote("服务【"+port+"】被调用");
           user.setName(name);
           return user;
       }
   
   }
   
   

4.3 测试

目标：当我们修改Git仓库的配置文件，用户微服务是否能够在不重启的情况下自动更新配置文件信息。

测试步骤：

1. 依次启动Eureka注册中心，配置中心，用户微服务
   

2. 访问用户微服务查看输出结果
   

3. 修改Git仓库中配置文件内容
   

4. 使用Postman工具发送POST请求，地址：http://127.0.0.1:12000/actuator/bus-refresh。刷新配置
   

5. 访问服务接口，浏览器查看输出结果
   

说明：

• Postman或者RESTClient是一个可以模拟浏览器发生各种请求的工具
• 请求地址http://127.0.0.1:12000/actuator/bus-refresh中actuator是固定的，bus-refresh对应的是配置中心的config_server中的application.yml文件的配置项include的内容
• http://127.0.0.1:12000/actuator/bus-refresh

消息总线实现消息分发过程：

• 请求地址访问配置中心的消息总线
• 消息总线接收到请求
• 消息总线向消息队列发送消息
• user-service微服务会监听消息队列
• user-service微服务接到消息队列中消息后
• user-service微服务会重新从配置中心获取最新配置信息