SpringCloud学习笔记02——Nacos配置管理和 Gateway网关

た入场券 2024-03-30 10:50 44阅读 0赞

## SpringCloud02 ##

## 0.学习目标 ##

## 1.Nacos配置管理 ##

Nacos除了可以做注册中心，同样可以做配置管理来使用。

### 1.1.统一配置管理 ###

当微服务部署的实例越来越多，达到数十、数百时，逐个修改微服务配置就会让人抓狂，而且很容易出错。我们需要一种统一配置管理方案，可以集中管理所有实例的配置。

![在这里插入图片描述][bf1a8f5c974f42879dc260ffdea19f5b.png]

Nacos一方面可以将配置集中管理，另一方可以在配置变更时，及时通知微服务，实现配置的热更新。

#### 1.1.1.在nacos中添加配置文件 ####

如何在nacos中管理配置呢？

![在这里插入图片描述][5a65b333513342ddab751b028f21fdbc.png]

然后在弹出的表单中，填写配置信息：

![在这里插入图片描述][cdcd62cc28bf410d9b3adfb194a01d2b.png]

> 注意：项目的核心配置，需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

#### 1.1.2.从微服务拉取配置 ####

微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。

但如果尚未读取application.yml，又如何得知nacos地址呢？

因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前被读取，流程如下：

![在这里插入图片描述][dcec16f43f8c4276998393fac516459e.png]

1）引入nacos-config依赖

首先，在user-service服务中，引入nacos-config的客户端依赖：

<dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>

2）添加bootstrap.yaml

然后，在user-service中添加一个bootstrap.yaml文件，内容如下：

spring:
      application:
        name: userservice # 服务名称
      profiles:
        active: dev #开发环境，这里是dev 
      cloud:
        nacos:
          server-addr: localhost:8848 # Nacos地址
          config:
            file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址，再根据

`${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}`作为文件id，来读取配置。

本例中，就是去读取`userservice-dev.yaml`：

![在这里插入图片描述][b0efedecbb964005a1a832333246fb7c.png]

3）读取nacos配置

在user-service中的UserController中添加业务逻辑，读取pattern.dateformat配置：

![在这里插入图片描述][2a6fb34315814aa0b79b7f4b95af6d6a.png]

完整代码：

package cn.itcast.user.web;
    
    import cn.itcast.user.pojo.User;
    import cn.itcast.user.service.UserService;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.web.bind.annotation.*;
    
    import java.time.LocalDateTime;
    import java.time.format.DateTimeFormatter;
    
    @Slf4j
    @RestController
    @RequestMapping("/user")
    public class UserController {
        
    
        @Autowired
        private UserService userService;
    
        @Value("${pattern.dateformat}")
        private String dateformat;
        
        @GetMapping("now")
        public String now(){
        
            return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
        }
        // ...略
    }

在页面访问，可以看到效果：

![在这里插入图片描述][6be41865bf2641f28bd9a2b53c872b90.png]

### 1.2.配置热更新 ###

我们最终的目的，是修改nacos中的配置后，微服务中无需重启即可让配置生效，也就是**配置热更新**。

要实现配置热更新，可以使用两种方式：

#### 1.2.1.方式一 ####

在@Value注入的变量所在类上添加注解@RefreshScope：

![在这里插入图片描述][1ba4aa6e6cc04097a64f13ff0dcce54d.png]

#### 1.2.2.方式二 ####

使用@ConfigurationProperties注解代替@Value注解。

在user-service服务中，添加一个类，读取patterrn.dateformat属性：

package cn.itcast.user.config;
    
    import lombok.Data;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    @Component
    @Data
    @ConfigurationProperties(prefix = "pattern")
    public class PatternProperties {
        
        private String dateformat;
    }

在UserController中使用这个类代替@Value：

![在这里插入图片描述][8fcb303a1cff4fd88d842587f6aca0ac.png]

完整代码：

package cn.itcast.user.web;
    
    import cn.itcast.user.config.PatternProperties;
    import cn.itcast.user.pojo.User;
    import cn.itcast.user.service.UserService;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.time.LocalDateTime;
    import java.time.format.DateTimeFormatter;
    
    @Slf4j
    @RestController
    @RequestMapping("/user")
    public class UserController {
        
    
        @Autowired
        private UserService userService;
    
        @Autowired
        private PatternProperties patternProperties;
    
        @GetMapping("now")
        public String now(){
        
            return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
        }
    
        // 略
    }

### 1.3.配置共享 ###

其实微服务启动时，会去nacos读取多个配置文件，例如：

*  `[spring.application.name]-[spring.profiles.active].yaml`，例如：userservice-dev.yaml
 *  `[spring.application.name].yaml`，例如：userservice.yaml

而`[spring.application.name].yaml`不包含环境，因此可以被多个环境共享。

下面我们通过案例来测试配置共享

#### 1）添加一个环境共享配置 ####

我们在nacos中添加一个userservice.yaml文件：

![在这里插入图片描述][66c2d528a0f146439047d3694c546e48.png]

#### 2）在user-service中读取共享配置 ####

在user-service服务中，修改PatternProperties类，读取新添加的属性：

![在这里插入图片描述][fd9da06fd3524a7b93f9b7f90e1f2dc4.png]

在user-service服务中，修改UserController，添加一个方法：

![在这里插入图片描述][aaf96c53bf6548a49ce1d94a481df63a.png]

#### 3）运行两个UserApplication，使用不同的profile ####

修改UserApplication2这个启动项，改变其profile值：

![在这里插入图片描述][8bb84c7b880d479199b6fd22c52bd407.png]

![在这里插入图片描述][95602b417ed942988bdefc14bebdea26.png]

这样，UserApplication(8081)使用的profile是dev，UserApplication2(8082)使用的profile是test。

启动UserApplication和UserApplication2

访问http://localhost:8081/user/prop，结果：

![在这里插入图片描述][9895fb5240ed45a39204e17804526389.png]

访问http://localhost:8082/user/prop，结果：

![在这里插入图片描述][5b299b64daf54021abe0869c38ebb563.png]

可以看出来，不管是dev，还是test环境，都读取到了envSharedValue这个属性的值。

#### 4）配置共享的优先级 ####

当nacos、服务本地同时出现相同属性时，优先级有高低之分：

![在这里插入图片描述][42510fd5239841f39f77f72735a10b9c.png]

### 1.4.搭建Nacos集群 ###

Nacos生产环境下一定要部署为集群状态，部署方式参考[Nacos安装 和 集群搭建][Nacos_ _]：

!\[在这里插入图片描述\](https://img-blog.csdnimg.cn/71885d97fc7247bb8682192dd3dffe17.png

## 2.Feign远程调用 ##

先来看我们以前利用RestTemplate发起远程调用的代码：

![在这里插入图片描述][a51af18b9cc84c0f913f9d7a5412cda1.png]

存在下面的问题：

•代码可读性差，编程体验不统一

•参数复杂URL难以维护

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

![在这里插入图片描述][9a1267a71be64d18a139c529fc2fb0be.png]

### 2.1.Feign替代RestTemplate ###

Fegin的使用步骤如下：

#### 1）引入依赖 ####

我们在order-service服务的pom文件中引入feign的依赖：

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

#### 2）添加注解 ####

在order-service的启动类添加注解开启Feign的功能：

![在这里插入图片描述][eb8b4acbbc1647a0979719c95b903773.png]

#### 3）编写Feign的客户端 ####

在order-service中新建一个接口，内容如下：

package cn.itcast.order.client;
    
    import cn.itcast.order.pojo.User;
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    
    @FeignClient("userservice")
    public interface UserClient {
        
        @GetMapping("/user/{id}")
        User findById(@PathVariable("id") Long id);
    }

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：

*  服务名称：userservice
 *  请求方式：GET
 *  请求路径：/user/\{id\}
 *  请求参数：Long id
 *  返回值类型：User

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。

#### 4）测试 ####

修改order-service中的OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate：

![在这里插入图片描述][505b8ccf294a45249cecc4c252456290.png]

是不是看起来优雅多了。

#### 5）总结 ####

使用Feign的步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

④ 使用FeignClient中定义的方法代替RestTemplate

### 2.2.自定义配置 ###

Feign可以支持很多的自定义配置，如下表所示：

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>作用</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong>feign.Logger.Level</strong></td> 
   <td>修改日志级别</td> 
   <td>包含四种不同的级别：NONE、BASIC、HEADERS、FULL</td> 
  </tr> 
  <tr> 
   <td>feign.codec.Decoder</td> 
   <td>响应结果的解析器</td> 
   <td>http远程调用的结果做解析，例如解析json字符串为java对象</td> 
  </tr> 
  <tr> 
   <td>feign.codec.Encoder</td> 
   <td>请求参数编码</td> 
   <td>将请求参数编码，便于通过http请求发送</td> 
  </tr> 
  <tr> 
   <td>feign. Contract</td> 
   <td>支持的注解格式</td> 
   <td>默认是SpringMVC的注解</td> 
  </tr> 
  <tr> 
   <td>feign. Retryer</td> 
   <td>失败重试机制</td> 
   <td>请求失败的重试机制，默认是没有，不过会使用Ribbon的重试</td> 
  </tr> 
 </tbody> 
</table>

一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置。

#### 2.2.1.配置文件方式 ####

基于配置文件修改feign的日志级别可以针对单个服务：

feign:  
      client:
        config: 
          userservice: # 针对某个微服务的配置
            loggerLevel: FULL #  日志级别

也可以针对所有服务：

feign:  
      client:
        config: 
          default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
            loggerLevel: FULL #  日志级别

而日志的级别分为四种：

*  NONE：不记录任何日志信息，这是默认值。
 *  BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
 *  HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
 *  FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

#### 2.2.2.Java代码方式 ####

也可以基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：

public class DefaultFeignConfiguration  {
        
        @Bean
        public Logger.Level feignLogLevel(){
        
            return Logger.Level.BASIC; // 日志级别为BASIC
        }
    }

如果要**全局生效**，将其放到启动类的@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果是**局部生效**，则把它放到对应的@FeignClient这个注解中：

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)

### 2.3.Feign使用优化 ###

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

•URLConnection：默认实现，不支持连接池

•Apache HttpClient ：支持连接池

•OKHttp：支持连接池

因此提高Feign的性能主要手段就是使用**连接池**代替默认的URLConnection。

这里我们用Apache的HttpClient来演示。

1）引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖：

<dependency>
        <groupId>io.github.openfeign</groupId>
        <artifactId>feign-httpclient</artifactId>
    </dependency>

2）配置连接池

在order-service的application.yml中添加配置：

feign:
      client:
        config:
          default: # default全局的配置
            loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息
      httpclient:
        enabled: true # 开启feign对HttpClient的支持
        max-connections: 200 # 最大的连接数
        max-connections-per-route: 50 # 每个路径的最大连接数

接下来，在FeignClientFactoryBean中的loadBalance方法中打断点：

![在这里插入图片描述][69b075ced7d74d53b2c8f11bc23f990c.png]

Debug方式启动order-service服务，可以看到这里的client，底层就是Apache HttpClient：

![在这里插入图片描述][4685bd54c8eb4de38ea631243317e373.png]

总结，Feign的优化：

1.日志级别尽量用basic

2.使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

② 配置文件开启httpClient功能，设置连接池参数

### 2.4.最佳实践 ###

所谓最近实践，就是使用过程中总结的经验，最好的一种使用方式。

自习观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：

feign客户端：

![在这里插入图片描述][26703c1097fb44bb9de7f632659f4e02.png]

UserController：

![在这里插入图片描述][3673af5e90154c9b9b80d8f645273dfb.png]

有没有一种办法简化这种重复的代码编写呢？

#### 2.4.1.继承方式 ####

一样的代码可以通过继承来共享：

1）定义一个API接口，利用定义方法，并基于SpringMVC注解做声明。

2）Feign客户端和Controller都集成改接口

![在这里插入图片描述][59c75b2f251140f790633deecbe7f546.png]

优点：

*  简单
 *  实现了代码共享

缺点：

*  服务提供方、服务消费方紧耦合
 *  参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

#### 2.4.2.抽取方式 ####

将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。

例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。

![在这里插入图片描述][ef6b566bed9546a4ae46cd35395b3d25.png]

#### 2.4.3.实现基于抽取的最佳实践 ####

##### 1）抽取 #####

首先创建一个module，命名为feign-api：

![在这里插入图片描述][0f5e2aa344e84d45ad8c5466750ed9e8.png]

项目结构：

![在这里插入图片描述][7ae1721de17e4adcab67a7f3855d33d7.png]

在feign-api中然后引入feign的starter依赖

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

然后，order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

![在这里插入图片描述][32e80010a39140e599279b401ec2b29d.png]

##### 2）在order-service中使用feign-api #####

首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。

在order-service的pom文件中中引入feign-api的依赖：

<dependency>
        <groupId>cn.itcast.demo</groupId>
        <artifactId>feign-api</artifactId>
        <version>1.0</version>
    </dependency>

修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包

##### 3）重启测试 #####

重启后，发现服务报错了：

![在这里插入图片描述][32671837b3894c40ae88b64e88931bb4.png]

这是因为UserClient现在在cn.itcast.feign.clients包下，

而order-service的@EnableFeignClients注解是在cn.itcast.order包下，不在同一个包，无法扫描到UserClient。

##### 4）解决扫描包问题 #####

方式一：

指定Feign应该扫描的包：

@EnableFeignClients(basePackages = "cn.itcast.feign.clients")

方式二：

指定需要加载的Client接口：

@EnableFeignClients(clients = {
        UserClient.class})

## 3.Gateway服务网关 ##

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

### 3.1.为什么需要网关 ###

Gateway网关是我们服务的守门神，所有微服务的统一入口。

网关的**核心功能特性**：

*  请求路由
 *  权限控制
 *  限流

架构图：

![在这里插入图片描述][effc8c39af5e4ae59507c45a5692ee74.png]

**权限控制**：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

**路由和负载均衡**：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

**限流**：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。

在SpringCloud中网关的实现包括两种：

*  gateway
 *  zuul

Zuul是基于Servlet的实现，属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

### 3.2.gateway快速入门 ###

下面，我们就演示下网关的基本路由功能。基本步骤如下：

1.  创建SpringBoot工程gateway，引入网关依赖
2.  编写启动类
3.  编写基础配置和路由规则
4.  启动网关服务进行测试

#### 1）创建gateway服务，引入依赖 ####

创建服务：

![在这里插入图片描述][451fc06d570f4a31b1dde924f5e597fb.png]

引入依赖：

<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>

#### 2）编写启动类 ####

package cn.itcast.gateway;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class GatewayApplication {
        
    
    	public static void main(String[] args) {
        
    		SpringApplication.run(GatewayApplication.class, args);
    	}
    }

#### 3）编写基础配置和路由规则 ####

创建application.yml文件，内容如下：

server:
      port: 10010 # 网关端口
    spring:
      application:
        name: gateway # 服务名称
      cloud:
        nacos:
          server-addr: localhost:8848 # nacos地址
        gateway:
          routes: # 网关路由配置
            - id: user-service # 路由id，自定义，只要唯一即可
              # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
              uri: lb://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
              predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
                - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

我们将符合`Path` 规则的一切请求，都代理到 `uri`参数指定的地址。

本例中，我们将 `/user/**`开头的请求，代理到`lb://userservice`，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

#### 4）重启测试 ####

重启网关，访问http://localhost:10010/user/1时，符合`/user/**`规则，请求转发到uri：http://userservice/user/1，得到了结果：

![在这里插入图片描述][aa6935fe1b5341e3980b4c1acbc1f4a8.png]

#### 5）网关路由的流程图 ####

整个访问的流程如下：

![在这里插入图片描述][981200af5fbb46229161fadfd7f86093.png]

总结：

网关搭建步骤：

1.  创建项目，引入nacos服务发现和gateway依赖
2.  配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括：

1.  路由id：路由的唯一标示
2.  路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
3.  路由断言（predicates）：判断路由的规则，
4.  路由过滤器（filters）：对请求或响应做处理

接下来，就重点来学习路由断言和路由过滤器的详细知识

### 3.3.断言工厂 ###

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件

例如Path=/user/\*\*是按照路径匹配，这个规则是由

`org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory`类来

处理的，像这样的断言工厂在SpringCloudGateway还有十几个:

<table> 
 <thead> 
  <tr> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
   <th><strong>示例</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>After</td> 
   <td>是某个时间点后的请求</td> 
   <td>- After=2037-01-20T17:42:47.789-07:00[America/Denver]</td> 
  </tr> 
  <tr> 
   <td>Before</td> 
   <td>是某个时间点之前的请求</td> 
   <td>- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]</td> 
  </tr> 
  <tr> 
   <td>Between</td> 
   <td>是某两个时间点之前的请求</td> 
   <td>- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]</td> 
  </tr> 
  <tr> 
   <td>Cookie</td> 
   <td>请求必须包含某些cookie</td> 
   <td>- Cookie=chocolate, ch.p</td> 
  </tr> 
  <tr> 
   <td>Header</td> 
   <td>请求必须包含某些header</td> 
   <td>- Header=X-Request-Id, \d+</td> 
  </tr> 
  <tr> 
   <td>Host</td> 
   <td>请求必须是访问某个host（域名）</td> 
   <td>- Host=<strong>.somehost.org,</strong>.anotherhost.org</td> 
  </tr> 
  <tr> 
   <td>Method</td> 
   <td>请求方式必须是指定方式</td> 
   <td>- Method=GET,POST</td> 
  </tr> 
  <tr> 
   <td>Path</td> 
   <td>请求路径必须符合指定规则</td> 
   <td>- Path=/red/{segment},/blue/**</td> 
  </tr> 
  <tr> 
   <td>Query</td> 
   <td>请求参数必须包含指定参数</td> 
   <td>- Query=name, Jack或者- Query=name</td> 
  </tr> 
  <tr> 
   <td>RemoteAddr</td> 
   <td>请求者的ip必须是指定范围</td> 
   <td>- RemoteAddr=192.168.1.1/24</td> 
  </tr> 
  <tr> 
   <td>Weight</td> 
   <td>权重处理</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

我们只需要掌握Path这种路由工程就可以了。

### 3.4.过滤器工厂 ###

GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：

![在这里插入图片描述][86156ef540a544a791feae635b46e5f5.png]

#### 3.4.1.路由过滤器的种类 ####

Spring提供了31种不同的路由过滤器工厂。例如：

<table> 
 <thead> 
  <tr> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>AddRequestHeader</td> 
   <td>给当前请求添加一个请求头</td> 
  </tr> 
  <tr> 
   <td>RemoveRequestHeader</td> 
   <td>移除请求中的一个请求头</td> 
  </tr> 
  <tr> 
   <td>AddResponseHeader</td> 
   <td>给响应结果中添加一个响应头</td> 
  </tr> 
  <tr> 
   <td>RemoveResponseHeader</td> 
   <td>从响应结果中移除有一个响应头</td> 
  </tr> 
  <tr> 
   <td>RequestRateLimiter</td> 
   <td>限制请求的流量</td> 
  </tr> 
 </tbody> 
</table>

#### 3.4.2.请求头过滤器 ####

下面我们以AddRequestHeader 为例来讲解。

> **需求**：给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!

只需要修改gateway服务的application.yml文件，添加路由过滤即可：

spring:
      cloud:
        gateway:
          routes:
          - id: user-service 
            uri: lb://userservice 
            predicates: 
            - Path=/user/** 
            filters: # 过滤器
            - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。

#### 3.4.3.默认过滤器 ####

如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

spring:
      cloud:
        gateway:
          routes:
          - id: user-service 
            uri: lb://userservice 
            predicates: 
            - Path=/user/**
          default-filters: # 默认过滤项
          - AddRequestHeader=Truth, Itcast is freaking awesome!

#### 3.4.4.总结 ####

过滤器的作用是什么？

① 对路由的请求或响应做加工处理，比如添加请求头

② 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么？

① 对所有路由都生效的过滤器

### 3.5.全局过滤器 ###

上一节学习的过滤器，网关提供了31种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求，做自己的业务逻辑则没办法实现。

#### 3.5.1.全局过滤器作用 ####

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

public interface GlobalFilter {
        
        /**
         *  处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
         *
         * @param exchange 请求上下文，里面可以获取Request、Response等信息
         * @param chain 用来把请求委托给下一个过滤器 
         * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
         */
        Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
    }

在filter中编写自定义逻辑，可以实现下列功能：

*  登录状态判断
 *  权限校验
 *  请求限流等

#### 3.5.2.自定义全局过滤器 ####

需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

*  参数中是否有authorization，
 *  authorization参数值是否为admin

如果同时满足则放行，否则拦截

实现：

在gateway中定义一个过滤器：

package cn.itcast.gateway.filters;
    
    import org.springframework.cloud.gateway.filter.GatewayFilterChain;
    import org.springframework.cloud.gateway.filter.GlobalFilter;
    import org.springframework.core.annotation.Order;
    import org.springframework.http.HttpStatus;
    import org.springframework.stereotype.Component;
    import org.springframework.web.server.ServerWebExchange;
    import reactor.core.publisher.Mono;
    
    @Order(-1)
    @Component
    public class AuthorizeFilter implements GlobalFilter {
        
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        
            // 1.获取请求参数
            MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
            // 2.获取authorization参数
            String auth = params.getFirst("authorization");
            // 3.校验
            if ("admin".equals(auth)) {
        
                // 放行
                return chain.filter(exchange);
            }
            // 4.拦截
            // 4.1.禁止访问，设置状态码
            exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
            // 4.2.结束处理
            return exchange.getResponse().setComplete();
        }
    }

#### 3.5.3.过滤器执行顺序 ####

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器：

![在这里插入图片描述][dde4bdd01f894a32acdc2250aabc0f46.png]

排序的规则是什么呢？

*  每一个过滤器都必须指定一个int类型的order值，**order值越小，优先级越高，执行顺序越靠前**。
 *  GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
 *  路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
 *  当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

详细内容，可以查看源码：

`org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()`方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

`org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()`方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

### 3.6.跨域问题 ###

#### 3.6.1.什么是跨域问题 ####

跨域：域名不一致就是跨域，主要包括：

*  域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
 *  域名相同，端口不同：localhost:8080和localhost8081

跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

解决方案：CORS，这个以前应该学习过，这里不再赘述了。不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html

#### 3.6.2.模拟跨域问题 ####

使用新的 index.html 替换原来版本

<!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <meta http-equiv="X-UA-Compatible" content="ie=edge">
        <title>Document</title>
    </head>
    <body>
    <pre>
    spring:
      cloud:
        gateway:
          globalcors: # 全局的跨域处理
            add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
            corsConfigurations:
              '[/**]':
                allowedOrigins: # 允许哪些网站的跨域请求
                  - "http://localhost:8090"
                  - "http://www.leyou.com"
                allowedMethods: # 允许的跨域ajax的请求方式
                  - "GET"
                  - "POST"
                  - "DELETE"
                  - "PUT"
                  - "OPTIONS"
                allowedHeaders: "*" # 允许在请求中携带的头信息
                allowCredentials: true # 是否允许携带cookie
                maxAge: 360000 # 这次跨域检测的有效期
    </pre>
    </body>
    <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
    <script>
      axios.get("http://localhost:10010/user/1?authorization=admin")
      .then(resp => console.log(resp.data))
      .catch(err => console.log(err))
    </script>
    </html>

放入tomcat或者nginx这样的web服务器中，启动并访问。

可以在浏览器控制台看到下面的错误：

![在这里插入图片描述][ff50598ff4c64d81b962107163523336.png]

从localhost:8090访问localhost:10010，端口不同，显然是跨域的请求。

#### 3.6.3.解决跨域问题 ####

在gateway服务的application.yml文件中，添加下面的配置：

spring:
      cloud:
        gateway:
          # 。。。
          globalcors: # 全局的跨域处理
            add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
            corsConfigurations:
              '[/**]':
                allowedOrigins: # 允许哪些网站的跨域请求 
                  - "http://localhost:8090"
                allowedMethods: # 允许的跨域ajax的请求方式
                  - "GET"
                  - "POST"
                  - "DELETE"
                  - "PUT"
                  - "OPTIONS"
                allowedHeaders: "*" # 允许在请求中携带的头信息
                allowCredentials: true # 是否允许携带cookie
                maxAge: 360000 # 这次跨域检测的有效期

[bf1a8f5c974f42879dc260ffdea19f5b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/605fec970e9c434da7868aa53e16a3b3.png
[5a65b333513342ddab751b028f21fdbc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/1063536d5b924a06815514ac4b97f9a8.png
[cdcd62cc28bf410d9b3adfb194a01d2b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/688035fdfa9f4e00893cae2a811f1ed8.png
[dcec16f43f8c4276998393fac516459e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/4c66eabcc5b44f88a8d8edccdd6b2b9a.png
[b0efedecbb964005a1a832333246fb7c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/d8740525f9dd47359112f6250fa12f6b.png
[2a6fb34315814aa0b79b7f4b95af6d6a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/dcf1eee7ee664e6ea5dafdd4ee395eb2.png
[6be41865bf2641f28bd9a2b53c872b90.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/71d4108b9ebd40cab912e8fb3462e13b.png
[1ba4aa6e6cc04097a64f13ff0dcce54d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/4e971ea30815455294ada34288a15f44.png
[8fcb303a1cff4fd88d842587f6aca0ac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/0e7d803ad11f41ffaebca8b6f0a7fc51.png
[66c2d528a0f146439047d3694c546e48.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/94f96874295d4348a50010ffe6913372.png
[fd9da06fd3524a7b93f9b7f90e1f2dc4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/80c7218bd97f4a8bab382f0c90b7bea4.png
[aaf96c53bf6548a49ce1d94a481df63a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/5198f280966647698b6a02d9c3f3a455.png
[8bb84c7b880d479199b6fd22c52bd407.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/910e5d1eead14984971c88ef574b552e.png
[95602b417ed942988bdefc14bebdea26.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/ec7791791ce848beb2d89958c6ebcf1e.png
[9895fb5240ed45a39204e17804526389.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/05540cdb4f394953968fb7055456ebe8.png
[5b299b64daf54021abe0869c38ebb563.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/0c07e28ae8d24501a707c97a833a048e.png
[42510fd5239841f39f77f72735a10b9c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/6a46902478db4f50ac042ede482efe66.png
[Nacos_ _]: https://blog.csdn.net/qq_46371399/article/details/128378358?spm=1001.2014.3001.5501
[a51af18b9cc84c0f913f9d7a5412cda1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/bc70b1ec2a0f406095d9d6b30aa3058b.png
[9a1267a71be64d18a139c529fc2fb0be.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/787db19e783044fea7249a19b5c133ee.png
[eb8b4acbbc1647a0979719c95b903773.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/82a9596cb7784886b1b7f17aad45faaa.png
[505b8ccf294a45249cecc4c252456290.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/d5e89424c8684d8f9661e51a6cd91ec0.png
[69b075ced7d74d53b2c8f11bc23f990c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/f2df67f3fd504815bb67a89dd97202e7.png
[4685bd54c8eb4de38ea631243317e373.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/f2da7ee6b9a948a681d93a5e7cadbd73.png
[26703c1097fb44bb9de7f632659f4e02.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/6d618dd349ba4d31bab10bc38b6fa95c.png
[3673af5e90154c9b9b80d8f645273dfb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/564b990729b7489cbc47abdafe77f07a.png
[59c75b2f251140f790633deecbe7f546.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/4c17acf211d04ede8d28b6f6b7ef4476.png
[ef6b566bed9546a4ae46cd35395b3d25.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/4d7ecaad572f45aea1916a2e2437b8ae.png
[0f5e2aa344e84d45ad8c5466750ed9e8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/40e21660d7104a3da9ebe5d0ae3bc9cc.png
[7ae1721de17e4adcab67a7f3855d33d7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/cd3b33b23bb34597b916ffd5b0d5797e.png
[32e80010a39140e599279b401ec2b29d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/0ad39ba671054db7955c1075ad01a1fb.png
[32671837b3894c40ae88b64e88931bb4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/b27a02a8e9cd4b94a7e37fe34c707aca.png
[effc8c39af5e4ae59507c45a5692ee74.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/789b211557574ae2b50e61fd039810e5.png
[451fc06d570f4a31b1dde924f5e597fb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/3028c8ff46df459bbbbf47ff32264411.png
[aa6935fe1b5341e3980b4c1acbc1f4a8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/9c928e6cf5fd49768f17e945961ca89d.png
[981200af5fbb46229161fadfd7f86093.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/1399fca402ad48a3b999c9c765fbe857.png
[86156ef540a544a791feae635b46e5f5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/ef0adf95ed8b4fdf98bf6bf18afed2dd.png
[dde4bdd01f894a32acdc2250aabc0f46.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/0020e1cf406b4d739f4bf0214f8d310f.png
[ff50598ff4c64d81b962107163523336.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/df2bd2de32de47c4a4ff218f236c5ec0.png