HM-SpringCloud微服务系列2.3【Gateway服务网关】

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

1 为什么需要网关

  1. Gateway网关是我们服务的守门神，所有微服务的统一入口。
  2. 在SpringCloud中网关的实现包括两种：
    • zuul：基于Servlet的实现，属于阻塞式编程
    • gateway: 基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能
  3. image
    权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。
    路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。
    限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。
  4. image

2 gateway快速入门

2.1 步骤

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

2.2 搭建网关服务

  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>

image
image
image
image
image

  1. 编写启动类
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);
	}
}

image
image

  1. 编写路由配置及nacos地址
    创建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就是loadBalance负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**

我们将符合Path 规则的一切请求，都代理到 uri参数指定的地址。
本例中，我们将 /user/**开头的请求，代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

image

注意：这里我们将nacos地址端口改为80，与前面集群的nacos端口保持一致；否则下面测试时访问不到

  1. 启动服务测试
    首先启动GatewayApplication服务
    image
    其次，在保证nacos集群（参考2.1https://www.cnblogs.com/yppah/p/15791141.html）启动好状态下，启动OrderApplication & UserApplication & UserApplication2
    image
    最后，访问http://localhost:10010/user/1和http://localhost:10010/order/101测试
    image
    image
    可以看出，网关中本身是没有业务的，通过访问网关，可以路由到具体的微服务执行业务代码

  2. 网关路由的流程图
    整个访问的流程如下：
    image

2.3 小结

网关搭建步骤：

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

路由配置包括：

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

3 断言工厂

3.1 路由断言工厂Route Predicate Factory

image
image
image

3.2 测试

- After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
image
image
image
访问user正常；无法访问order
2.
- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
image
image
image
访问user & order 都正常

3.3 小结

image

4 过滤器工厂

4.1 路由过滤器

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

4.2 路由过滤器工厂种类

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

4.3 案例(以AddRequestHeader为例)

  1. 请求头过滤器
    需求：给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!
    实现：在gateway中修改application.yml文件，给userservice的路由添加过滤器
    注意：当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效
spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

image
修改gateway后重启服务
image
修改user后重启服务，清空控制台启动日志
访问http://localhost:10010/user/2测试
image
image

  1. 默认过滤器

如果想让当前所有服务（order和user）都实现4.3案例(user)中的效果，可以在gateway中修改application.yml为如下：

spring:
  cloud:
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是loadBalance负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
          filters: # 过滤器
            - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头(键固定，值自定义)
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
            - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
          filters: # 过滤器
            - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头(键固定，值自定义)

以上方式是在每个网关路由中单独设置filters过滤器，虽然可以实现需求，但太麻烦；spring提供了如下的默认过滤器也可以实现此需求（推荐）
2.
如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

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

image
image
修改完gateway后，清空user控制台日志，访问测试
image
image
可以看到，user中可以拿到Header信息；实际上order也可以拿到（需要修改order的controller，此处不再演示）

4.4 小结

image

5 全局过滤器

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

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中编写自定义逻辑，可以实现下列功能：

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

5.2 自定义全局过滤器

案例：拦截并判断用户身份
需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件，如果同时满足则放行，否则拦截

  • 参数中是否有authorization，
  • authorization参数值是否为admin
package cn.itcast.gateway;

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;

/**
 * 自定义过滤执行顺序的方法(两种方法效果相同，二选一即可)
 *      方法1：注解@Order(xxx)
 *      方法2：实现Ordered接口，并重写方法getOrder()
 */
//@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 auth = params.getFirst("authorization"); // getFirst()表示取第一个匹配给定键的值
        // 3 判断参数值是否等于admin
        if ("admin".equals(auth)){
            // 4 是：放行
            return chain.filter(exchange);
        }else {
            // 5 否：拦截
            // 5.1 设置状态码
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); //401表示未登录未认证
            // 5.2 拦截请求
            return exchange.getResponse().setComplete();
        }
    }

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

image
访问测试
image
image
image

5.3 过滤器执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器：
image
排序的规则是什么呢？

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

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

  • org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。
  • org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

5.4 小结

image
image

6 跨域问题

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

6.2 模拟跨域问题

image

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

image
使用VSCODE打开该文件夹，但是VSCODE的live server插件并不能通过命令指定端口启动（实测），只能默认端口5050

现用npm在本地全局安装live-server
发现一个问题：npm全局安装的包老是默认自己安装到C盘，现设置为自定义的包安装路径

https://blog.csdn.net/weixin_40726805/article/details/100920603
https://blog.csdn.net/breal/article/details/92841673
image
image
image
image

npm本地全局安装live-server：npm install -g live-server
指定端口启动live-server：live-server --port=xxxx

image
image
image

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

image
image
image

6.4 小结

image

7 网关的限流过滤器（未讲内容）

image
image
image
image
image

posted @ 2022-01-16 15:10  yub4by  阅读(114)  评论(0)    收藏  举报