Getway介绍和使用

Getway

入门简介

网关搭建步骤：

1. 创建项目，引入nacos服务发现和gateway依赖

2. 配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括：

1. 路由id：路由的唯一标示

2. 路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

3. 路由断言（predicates）：判断路由的规则，

4. 路由过滤器（filters）：对请求或响应做处理

引入相关依赖

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

<dependency>
    <groupId>com.alibaba.cloudgroupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>

配置文件

predicates这个一定不能重复，是唯一的！！！

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 192.168.31.140:8848 # nacos 地址
    gateway:
      routes:
        - id: user-service #  路由标识，必须唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**

启动项目

测试下是否正确，将user-sevice和order-service代理成10010端口

路由断言

像这样的断言工厂在SpringCloudGateway还有十几个，我们只需要掌握Path这种路由工程就可以了。

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

示例

After

要想在亚洲/上海，2031-12-06T15:14:47.433之前访问

只需要加上请求头即可

- After=2031-12-06T15:14:47.433+08:00[Asia/Shanghai] # 添加请求头

完善配置

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 192.168.31.140:8848 # nacos 地址
    gateway:
      routes:
        - id: user-service #  路由标识，必须唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**
            - After=2031-12-06T15:14:47.433+08:00[Asia/Shanghai] # 添加请求头

会有404错误

Before

要想在亚洲/上海，2031-12-06T15:14:47.433之后访问

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 192.168.31.140:8848 # nacos 地址
    gateway:
      routes:
        - id: user-service #  路由标识，必须唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**
            - Before=2031-12-06T15:14:47.433+08:00[Asia/Shanghai] # 添加请求头

访问是成功的

过滤器

路由过滤器的种类

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

名称	说明
AddRequestHeader	给当前请求添加一个请求头
RemoveRequestHeader	移除请求中的一个请求头
AddResponseHeader	给响应结果中添加一个响应头
RemoveResponseHeader	从响应结果中移除有一个响应头
RequestRateLimiter	限制请求的流量

请求头过滤器

只需要在配置文件中加上

filters:
  - AddRequestHeader=Truth, Bunny-cli # 添加请求头

完善配置，为所有请求头统一加上

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 192.168.31.140:8848 # nacos 地址
    gateway:
      routes:
        - id: user-service #  路由标识，必须唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**
            - Before=2031-12-06T15:14:47.433+08:00[Asia/Shanghai] # 添加请求头
          filters:
            - AddRequestHeader=Truth, Bunny-cli # 添加请求头

并在order-serve中打印

@GetMapping("{orderId}")
public Order queryOrderByUserId(@PathVariable("orderId") Long orderId,
                                @RequestHeader(value = "Truth",required = false) String truth) {
    log.info("------------truth------------:{}", truth);
    return orderService.queryOrderById(orderId);
}

效果展示

在配置文件中加上过滤器，如果设置中文的话会有乱码。

默认过滤器

为所有配置都加上：

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

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 192.168.31.140:8848 # nacos 地址
    gateway:
      routes:
        - id: user-service #  路由标识，必须唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**
            - Before=2031-12-06T15:14:47.433+08:00[Asia/Shanghai] # 添加请求头
#          filters:
#            - AddRequestHeader=Truth, Bunny-cli # 添加请求头
      default-filters:
        - AddRequestHeader=Truth, Bunny-cli # 添加全局请求头

在所有请求都输出下

过滤器的作用是什么？

1. 对路由的请求或响应做加工处理，比如添加请求头
2. 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么？

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

全局过滤器

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

定义方式是实现GlobalFilter接口。

定义过滤器

在gateway中定义一个过滤器

• 判断当前用户是否为admin如果是的放行
  • 判断请求的params中是否包含admin：params.getFirst("authorization")
    • 通过params中authorization字段判断

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Order(-1)// 值越小权重越高
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1. 获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> params = request.getQueryParams();
        // 2. 获取参数中的 authorization
        String authorization = params.getFirst("authorization");
        // 3. 判断参数是否等于admin
        if ("admin".equals(authorization)) {
            return chain.filter(exchange); // 4. 是，放行
        }
        // 5. 否，放行
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        return exchange.getResponse().setComplete();
    }
}

如果存在，可以正常获取到结果，如果当前不是admin则返回 401

如果当前不是admin，返回401。不通过。

exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED)中HttpStatus枚举

过滤器执行顺序

Order注解

Order：可以使用注解中的Order，数值越小权重越高。或者使用继承Ordered实现同样的效果。

Ordered继承实现

通过返回getOrder数值，效果同样，值越小权重越高

// 也可以使用 Ordered 修改权重
@Override
public int getOrder() {
    return -1;
}

排序的规则是什么呢？

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

跨域问题

跨域问题在服务端是不存在的，就比如之前调用的接口，user访问Order它们之间没有跨域问题，包括在gateway中也没有。

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

解决方式

需要再配置中加上globalcors

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

完善代码

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 192.168.31.140:8848 # nacos 地址
    gateway:
      routes:
        - id: user-service #  路由标识，必须唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**
            - Before=2031-12-06T15:14:47.433+08:00[Asia/Shanghai] # 添加请求头
      default-filters:
        - AddRequestHeader=Truth, Bunny-cli # 添加请求头
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求
              - "http://localhost:5500"
              - "http://127.0.0.1:5500"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

未设置时

设置完成后效果：