【Spring Cloud-Gateway网关】

目标：
一、认识网关
二、Gateway快速入门
三、网关路由配置
四、路由过滤器
五、路由过滤器链
六、跨域访问问题

一、认识网关

1、网关功能
①身份认证、权限校验；
②服务路由、负载均衡；
③请求限流；
2、Spring Cloud网关
①Zuul
基于Servlet实现，属于阻塞式编程；
②Gateway
基于WebFlux实现，属于响应式编程，性能更优。

二、Gateway快速入门

1、基础依赖
①spring-cloud-starter-gateway——Gateway网关
②spring-cloud-starter-alibaba-nacos-discovery——Nacos服务发现
③spring-cloud-starter-loadbalancer——负载均衡

<!--网关-->
<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>
<!--负载均衡相关依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>

2、application.yml配置
①网关端口
②应用名称
③Nacos地址
④网关路由配置：路由ID(自定义)、路由目标地址、路由断言

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/开头就符合要求

此时启动项目，即可开启网关功能了。

三、网关路由配置

1、路由ID
随机命名即可，要求唯一；
2、uri
路由地址，支持lb和http两种；

# 推荐使用 uri: lb//service
uri: http://127.0.0.1:8081
uri: lb://userservice
# lb是loadbalance的缩写

3、predicates
路由断言，判断请求是否符合要求，符合则转发至相应路由；
Spring Cloud Gateway有11种类型的路由断言工厂，具体可访问官方文档。

spring:
cloud:
gateway:
routes:
- id: user_service
uri: lb://userservice
predicates:
- Path=/user/**

四、路由过滤器

1、GatewayFilter
网关过滤器，Spring Cloud Gateway官方提供了31种过滤器，具体可访问官方文档。以AddRequestHeader为例，如下：

spring:
cloud:
gateway:
routes:
- id: user_service
uri: lb://userservice
filters:
- AddRequestHeader=color, blue
# 方法参数中，使用如下形式即可获取对应请求头
@RequestHeader(value = "color",required = false) String color

2、Default Filters
default filters是31种官方提供的一种特殊的配置，配置default filters会对全局路由请求生效，不限于单种路由请求。如下配置，我们设置的过滤器都会生效。

spring:
cloud:
gateway:
routes:
- id: user_service
uri: lb://userservice
filters:
- AddRequestHeader=color, blue
default-filters:
- AddResponseHeader=color, green
- PrefixPath=/httpbin

3、GlobalFilter
The GlobalFilter interface has the same signature as GatewayFilter. These are special filters that are conditionally applied to all routes.

GlobalFilter 作用与GatewayFilter 一样，处理一切进入网关的请求与响应，GlobalFilter 的逻辑需要我们编写代码实现。
如下过滤器是判断请求参数authorization的内容是否等于admin，代码：

//@Order(-1)
@Component
public class AuthorizationFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//1.获取请求参数
MultiValueMap<String, String> queryParams = exchange.getRequest().getQueryParams();
//2.获取authorization参数
String authorization = queryParams.getFirst("authorization");
//3.校验
if("admin".equals(authorization)){
//3.1.校验通过放行
return chain.filter(exchange);
        }
//4.拦截
//4.1.设置401状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
//4.2.结束处理
return exchange.getResponse().setComplete();
    }

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

五、路由过滤器链

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

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

private List<GatewayFilter> getFilters(RouteDefinition routeDefinition) {
List<GatewayFilter> filters = new ArrayList();
if (!this.gatewayProperties.getDefaultFilters().isEmpty()) {
filters.addAll(this.loadGatewayFilters(routeDefinition.getId(), new ArrayList(this.gatewayProperties.getDefaultFilters())));
        }

if (!routeDefinition.getFilters().isEmpty()) {
filters.addAll(this.loadGatewayFilters(routeDefinition.getId(), new ArrayList(routeDefinition.getFilters())));
        }

AnnotationAwareOrderComparator.sort(filters);
return filters;
    }

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

@Override
public Mono<Void> handle(ServerWebExchange exchange) {
return this.chain.filter(exchange);
    }

@Override
public Mono<Void> filter(ServerWebExchange exchange) {
return Mono.defer(() ->
this.currentFilter != null && this.chain != null ?
invokeFilter(this.currentFilter, this.chain, exchange) :
this.handler.handle(exchange));
    }

private Mono<Void> invokeFilter(WebFilter current, DefaultWebFilterChain chain, ServerWebExchange exchange) {
String currentName = current.getClass().getName();
return current.filter(exchange, chain).checkpoint(currentName + " [DefaultWebFilterChain]");
    }

@Override
public Mono<Void> handle(ServerWebExchange exchange) {
Route route = exchange.getRequiredAttribute(GATEWAY_ROUTE_ATTR);
List<GatewayFilter> gatewayFilters = route.getFilters();

List<GatewayFilter> combined = new ArrayList<>(this.globalFilters);
combined.addAll(gatewayFilters);
// TODO: needed or cached?
AnnotationAwareOrderComparator.sort(combined);

if (logger.isDebugEnabled()) {
logger.debug("Sorted gatewayFilterFactories: " + combined);
        }

return new DefaultGatewayFilterChain(combined).filter(exchange);
    }

六、跨域访问问题

1、跨域
跨域：域名不一致就是跨域，主要包括：
1.域名相同，端口不同：127.0.0.1:8080和127.0.0.1:8081
2、跨域问题
Access to XMLHttpRequest at ' from origin 'http://127.0.0.1:8090' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.
跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求的响应会被浏览器拦截的问题。
3、跨域问题处理

【Spring Cloud-Gateway网关】

七、结尾

以上即为Spring Cloud Gateway基础内容

秒客网

【Spring Cloud-Gateway网关】

一、认识网关

二、Gateway快速入门

三、网关路由配置

四、路由过滤器

五、路由过滤器链

六、跨域访问问题

七、结尾

相关文章