微服务学习笔记--(Gateway网关)_gateway网关配置

统一网关Gateway

• 为什么需要网关
• gateway快速入门
• 断言工厂
• 过滤器工厂
• 全局过滤器
• 跨域问题

Gateway网关-网关作用介绍

为什么需要网关

网关功能：

• 身份认证和权限校验
• 服务路由、负载均衡
• 请求限流

网关的技术实现

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

• gateway
• zuul

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

小结：

网关的作用：

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

Gateway网关-快速入门

搭建网关服务

搭建网关服务的步骤：

1.创建新的module，引入SpringCloudGateway的依赖和nacos的服务发现依赖：

<!--网关依赖-->
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服务发现依赖-->
<dependency>
	<groupId>com.alibaba.cloud</groupId>
	<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
1
2
3
4
5
6
7
8
9
10

2.编写路由配置及nacos地址

server:
  port: 10010 # 网关端口
spring:
  application: 
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # url: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          url: lb//userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/usr/** # 这个是按照路径匹配，只要以/user/开头就符合要求
        - id: order-service 
          url: lb//orderservice
          predicates:
            - Path=/order/** 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

小结：

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

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

Gateway网关-路由断言工厂

路由断言工厂Route Predicate Factory

网关路由可以配置的内容包括：

• 路由id：路由的唯一标识
• url：路由目的地，支持lb和http两种
• predicates：路由断言，判断请求是否符合要求，符合则转发到路由目的地
• 路由过滤器(filters)：对请求或响应做处理

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

例如Path=/usr/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRouteRoutePredicateFactory类来处理的

像这样的断言工厂在SpringCloudGateway还有十几个

Spring提供了11种基本的Predicate工厂：

小结：

PredicateFactory的作用是什么？

• 读取用户定义的断言条件，对请求做判断

Path=/user/**是什么含义？

• 路径是以/user开头的就认为是符合的

Gateway网关-路由的过滤器配置

路由过滤器GatewayFilter

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

请求–>路由–>过滤器–>过滤器–>过滤器–>微服务

其中路由、过滤器属于网关Gateway

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

案例：给所有进入userservice请求添加一个请求头

给所有进入userservice的请求添加一个请求头：Truth=luxifa is following her dream

实现方式：在gateway中修改application.yml，给userservice的路由添加过滤器：

server:
  cloud:
    gateway:
      routes: 
        - id: user-service 
          url: lb//userservice 
          predicates: 
            - Path=/usr/** 
          filters: # 过滤器
          	- AddRequestHeader=Truth,luxifa is  following her dream # 添加请求头
1
2
3
4
5
6
7
8
9
10

默认过滤器

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

server:
  port: 10010 # 网关端口
spring:
  application: 
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # url: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          url: lb//userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/usr/** # 这个是按照路径匹配，只要以/user/开头就符合要求
        - id: order-service 
          url: lb//orderservice
          predicates:
            - Path=/order/** 
       default-filters: # 默认过滤器，会对所有的路由请求都生效
         - AddRequestHeader=Truth,luxifa is  following her dream # 添加请求头
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Gateway网关-全局过滤器

全局过滤器 GlobalFilter

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

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

案例 定义全局过滤器，拦截并判断用户身份

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

• 参数中是否有authorization
• authorization参数值是否为admin

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

步骤 步骤1：自定义过滤器

@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".equal(auth)) {
		// 放行
		return chain.filter(exchange);
	}
	// 4.拦截
	// 4.1.禁止访问
	exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
	// 4.2.结束处理
	return exchange.getResponse().setComplete();
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

小结：

全局过滤器的作用是什么？
对所有路由都生效的过滤器，并且可以自定义处理逻辑

实现全局过滤器的步骤？

1. 实现GlobalFilter接口
2. 添加@Order注解或实现Ordered接口
3. 编写处理逻辑

Gateway网关-过滤器链执行顺序

过滤器执行顺序

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

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

请求–>路由–>默认过滤器–>路由过滤器–>全局过滤器–>微服务

过滤器执行顺序

每一个过滤器都必须指定一个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排序，组织过滤器链
1
2
3

Gateway网关-网关的cors跨域配置

跨域问题处理

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

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

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

解决方案：CORS

网关处理跨域采用的同样是CORS方案，并且只需要简单配置即可实现：

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]': # 拦截所有请求
            allowedOrgins:  # 允许哪些网站的跨域请求
              - "http://localhost:8090"
              - "http://www.leyou.com"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求头携带的信息 * 代表允许所有请求头
            allowCredentials: true #是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

小结:

CROS跨域要配置的参数包括哪几个？

• 允许哪些域名跨域？
• 允许哪些请求头？
• 允许哪些请求方法？
• 是否允许使用cookie？
• 有效期是多久？