Gateway网关初步使用

Gateway简介

Gateway是Spring Cloud中的网关组件,Spring Cloud Gateway旨在提供一种简单而有效的方式来路由到API。Spring Cloud 在1.x版本中都是使用Zuul网关,但在2.x版本中使用Gateway替代了Zuul。Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。

网关的功能

• 对用户请求做身份认证、权限校验
• 将用户请求路由到微服务,并实现负载均衡
• 对用户请求做限流

搭建Gateway网关

一、创建Spring Boot项目

二、导入gateway和nacos依赖

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

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

三、编写路由配置及nacos地址

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

四、启动
五、测试

路由断言工厂

在gateway配置文件中的predicates中填写的路由断言会被Predicate Factory读取并处理,然后转变为路由判断的条件。Spring Cloud为我们提供了十二个断言工厂

每一种断言工厂官方文档都提供了案例

名称	说明	示例
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	权重处理	- Weight=group1, 2

路由过滤器

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

Spring提供了31种不同的路由过滤器工厂（文档地址）

spring:
  cloud:
    gateway:
      routes:
      - id: lb://userservice
        uri: https://example.org
        predicates:
        - Path=/user/**
        filters: #过滤器（与id同级）
        - AddRequestHeader=X-Request-red, blue#添加请求头

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

spring:
  cloud:
    gateway:
      routes:
        #路由1
        #路由2
        #... 
      default-filters: #与routes同级
      - AddResponseHeader=X-Response-Default-Red, Default-Blue
      - PrefixPath=/httpbin

全局过滤器

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

【案例】

定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件：
1、参数中是否有authorization,
2、authorization参数值是否为admin。如果同时满足则放行,否则拦截

//指定Order值得第一种方式使用注解
//指定Order值得第二种方式实现Ordered接口重写getOrder方法
//@Order(-1)//值越小优先执行
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {
    /**
     * @param exchange:请求上下文,里面可以获取Request、Response等信息
     * @param chain:用来把请求委托给下一个过滤器
     * @return {@code Mono} 返回标示当前过滤器业务结束
     */
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> queryParams = request.getQueryParams();
        //获取参数中的authorization参数
        String auth = queryParams.getFirst("authorization");
        //校验参数值是否等于admin
        if ("admin".equals(auth)){
            //是,放行
            return chain.filter(exchange);
        }
        //否,拦截
        //设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);//401未登录
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

测试

过滤器执行顺序

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

跨域问题处理

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

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 # 这次跨域检测的有效期