【微服务】6、一篇文章学会使用 SpringCloud 的网关

简介: 【微服务】6、一篇文章学会使用 SpringCloud 的网关


一、网关作用

📗 身份认证、权限校验

📗 服务路由、负载均衡

📗 请求限流

二、网关的技术实现

📝 在 SpringCloud 中有两种网关的技术实现

✏️ gateway(比 zuul 新)

✏️ zuul

✒️ Zuul 是基于 Servlet 实现的,属于阻塞式编程

✒️ Gateway 是基于 Spring5 中提供的 WebFlux 实现的。属于响应式编程,具有更好的性能

三、简单使用

✏️ 网关是一个新的微服务

✏️ 需要通过 nacos 进行服务注册和发现

🎄 (1) 创建新的模块(module),引入 SpringCloudGateway 和 Nacos 服务发现依赖

<dependencies>
      <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-gateway</artifactId>
      </dependency>
      <dependency>
          <groupId>com.alibaba.cloud</groupId>
          <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
      </dependency>
  </dependencies>

🎄 (2)把网关服务注册到 nacos 中,并编写路由配置

server:
  port: 10010 # 网关服务的端口号
spring:
  application:
    name: gateway # 服务名
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 服务发现地址
    gateway: # 网关相关配置
      routes: # 网关的路由配置
        - id: userservice # 路由编号(自定义), 保持唯一
          uri: lb://userservice # 路由的目标地址【lb: load balance】
          # uri: http://127.0.01:8081 # 路由的目标地址(直接写死)
          predicates: # 判断(断言)怎样的请求会被路由
            - Path=/users/** # 若请求路径是【/users/】开头的就路由到此
        - id: orderservice
          uri: lb://orderservice
          predicates:
            - Path=/orders/**

四、predicates

(1) 网关路由可配置的内容

✒️ id: 路由的唯一标识

✒️ uri:路由目的地【① lb: load balance;② http(不推荐)】

✒️ predicates:路由断言(判断请求是否符合要求,符合则路由转发到对应的 uri 的服务器)

✒️ filters:路由过滤器(处理请求响应

(2) 路由断言工厂(Route Predicate Factory)

📝 在配置文件中写的断言规则只是字符串(它会被 Predicate Factory 读取和处理,并转变为路由判断的条件)


✏️ Path=/user/** 是按照路径进行匹配

✏️ 是通过 PathRoutePredicateFactory 类来处理的


✏️ SpringCloudGateway 中的断言工厂:

五、filters

(1) GatewayFilter

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

官方提供了三十多种过滤器工厂:

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

(2) 给全部进入 userservice 的请求添加请求头

spring:
  application:
    name: gateway # 服务名
  cloud:
    gateway: # 网关相关配置
      routes: # 网关的路由配置
        - id: userservice # 路由编号(自定义), 保持唯一
          uri: lb://userservice # 路由的目标地址【lb: load balance】
          # uri: http://127.0.01:8081 # 路由的目标地址(直接写死)
          predicates: # 判断(断言)怎样的请求会被路由
            - Path=/users/** # 若请求路径是【/users/】开头的就路由到此
          filters: # 过滤器
            - AddRequestHeader=color, skyblue
        - id: orderservice
          uri: lb://orderservice
          predicates:
            - Path=/orders/**
@GetMapping("getUserById/{id}")
 public User getUserById(@PathVariable Long id,
                         @RequestHeader(value = "color", required = false) String color) {
     log.info("请求头: {}", color);
     return userService.getUserById(id);
 }

默认过滤器 default-filters 会对全部的路由请求都生效

spring:
  application:
    name: gateway # 服务名
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 服务发现地址
    gateway: # 网关相关配置
      routes: # 网关的路由配置
        - id: userservice # 路由编号(自定义), 保持唯一
          uri: lb://userservice # 路由的目标地址【lb: load balance】
          # uri: http://127.0.01:8081 # 路由的目标地址(直接写死)
          predicates: # 判断(断言)怎样的请求会被路由
            - Path=/users/** # 若请求路径是【/users/】开头的就路由到此
#          filters: # 过滤器
#            - AddRequestHeader=color, skyblue
        - id: orderservice
          uri: lb://orderservice
          predicates:
            - Path=/orders/**
      default-filters: # 默认过滤器
        - AddRequestHeader=color, green

(3) 全局过滤器 —— GlobalFilter

📝 全局过滤器的作用: 处理一切进入网关的请求微服务响应,与GatewayFilter 的作用一样

📝 区别:GatewayFilter 通过配置定义,处理逻辑是固定的

📝 GlobalFilter 的逻辑需要自己写代码实现


📚 需求:定义全局过滤器,拦截并判断用户身份

定义全局过滤器,拦截请求。判断请求参数是否满足以下条件:

① 参数中是否有 authorization

② authorization 的参数值是否是 admin

若 ① 和 ② 同时满足,则放行;否则拦截

// @Order(value = 6) // 过滤器执行顺序(值越小,优先级越高)
@Component // 放入 IoC
public class GlobalGatewayFilter implements GlobalFilter , Ordered {
    /**
     * 拦截并处理全部的请求,处理成功后通过 chain 进入下一个过滤器
     *
     * @param exchange 请求上下文(可获取 Request、Response 等信息)
     * @param chain    放行该请求,进入下一过滤器
     * @return 返回,标识当前过滤器结束
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 获取请求参数
        // 该请求是 WebFlux 中的(与 HttpServletRequest 不同)
        ServerHttpRequest request = exchange.getRequest();
        // 获取请求参数(键值对)
        MultiValueMap<String, String> paramMap = request.getQueryParams();
        String paramVal = paramMap.getFirst("authorization");
        if (paramVal == null || !paramVal.equals("admin")) {
            // 拦截(返回)
            ServerHttpResponse response = exchange.getResponse();
            // 未登录状态码
            response.setStatusCode(HttpStatus.UNAUTHORIZED);
            return response.setComplete(); // 返回
        }
        // 放行
        return chain.filter(exchange);
    }
    @Override
    public int getOrder() {
        return 6;
    }
}

(4) 过滤器的执行顺序

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

📚 请求路由后,会将当前路由过滤器、DefaultFilter、GlobalFilter 合并为一个过滤器链(集合)中,然后进行排序。排序之后,依次执行每个过滤器。


📚 每个过滤器都必须指定一个 int 类型的 order 值【order 值越小,优先级越高,执行顺序越靠前】

📚 GlobalFilter 通过实现 Ordered 接口或添加 @Order 注解来指定 order 值

📚 路由过滤器和 DefaultFilter 的 order 值由 Spring 指定【在各自过滤器内部按照声明顺序 从1 递增】

📚 当过滤器的 order 值一样时,优先级是:DefaultFilter > 路由过滤器 > GlobalFilter

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: localhost:8848
    gateway:
      routes:
        - id: userservice
          uri: lb://userservice
          predicates:
            - Path=/users/**
          filters: # 路由过滤器
            - AddRequestHeader=color, red # order = 1
            - AddRequestHeader=color, blue # order = 2
            - AddRequestHeader=color, green # order = 3
      default-filters: # 默认过滤器
        - AddRequestHeader=name, zgq # order = 1
        - AddRequestHeader=name, ytr # order = 2
        - AddRequestHeader=name, zhn # order = 3

  • org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters(): ① 加载 DefaultFilter;② 加载路由过滤器;③ 合并 DefaultFilter 和路由过滤器
  • org.springframework.cloud.gateway.handler.FilteringWebHandler#handle(): ① 加载全局过滤器;② 与 DefaultFilter 和路由过滤器合并;③ 根据合并后的 order 值排序;④ 组织过滤器链

六、网关跨域

(1) 跨域

浏览器有个同源策略(Same-Origin Policy):默认情况下,AJAX 请求只能发送给同源的 URL

📚 AJAX:Asynchronous Javascript And XML【异步 JavaScript 和 XML】

  • 同源指 ① 协议、② 域名(IP)、③ 端口 相同
  • img、script、link、iframe、video、audio 等标签不受同源策略约束


跨域问题: 浏览器要求发送请求的来源和接收请求的接口的协议、域名和端口必须相同,否则该请求会被浏览器拦截


📚 CORS(Cross-Origin Resource Sharing):跨域资源共享

(2) 网关跨域处理

  • 要访问 http://localhost:10010/orders/getOrderById/101?authorization=admin 地址的资源
  • 发送请求的来源是 http://localhost:8082/#/pages/index/index

❌ 端口不相同(不符合浏览器的同源策略)

📚 跨域访问检查发送的是 OPTIONS 请求

📚 跨域访问检查有效期要合理

spring:
  cloud:
    gateway: # 网关相关配置
      globalcors: # 全局跨域处理
        add-to-simple-url-handler-mapping: true # 防止 options 请求被拦截
        cors-configurations:
          '[/**]': # 拦截全部路径
            allowedOrigins: # 允许跨域访问的来源
              - "http://localhost:8082"
            allowedMethods: # 允许跨域访问的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许跨域访问携带请求头信息
            allowCredentials: true # 允许跨域访问携带 cookie
            maxAge: 360000 # 本次跨域访问检查的有效期
相关实践学习
部署高可用架构
本场景主要介绍如何使用云服务器ECS、负载均衡SLB、云数据库RDS和数据传输服务产品来部署多可用区高可用架构。
负载均衡入门与产品使用指南
负载均衡(Server Load Balancer)是对多台云服务器进行流量分发的负载均衡服务,可以通过流量分发扩展应用系统对外的服务能力,通过消除单点故障提升应用系统的可用性。 本课程主要介绍负载均衡的相关技术以及阿里云负载均衡产品的使用方法。
相关文章
|
1月前
|
SpringCloudAlibaba Java 持续交付
【构建一套Spring Cloud项目的大概步骤】&【Springcloud Alibaba微服务分布式架构学习资料】
【构建一套Spring Cloud项目的大概步骤】&【Springcloud Alibaba微服务分布式架构学习资料】
142 0
|
7天前
|
负载均衡 Java 开发者
细解微服务架构实践:如何使用Spring Cloud进行Java微服务治理
【4月更文挑战第17天】Spring Cloud是Java微服务治理的首选框架,整合了Eureka(服务发现)、Ribbon(客户端负载均衡)、Hystrix(熔断器)、Zuul(API网关)和Config Server(配置中心)。通过Eureka实现服务注册与发现,Ribbon提供负载均衡,Hystrix实现熔断保护,Zuul作为API网关,Config Server集中管理配置。理解并运用Spring Cloud进行微服务治理是现代Java开发者的关键技能。
|
7天前
|
API
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态。
|
8天前
|
监控 JavaScript 安全
构建微服务架构下的API网关
【4月更文挑战第15天】在微服务架构中,API网关扮演着至关重要的角色。它作为系统的唯一入口,不仅负责请求的路由、负载均衡和认证授权,还涉及到监控、日志记录和服务熔断等关键功能。本文将探讨如何构建一个高效且可靠的API网关,涵盖其设计原则、核心组件以及实现策略,旨在为后端开发人员提供一套实用的指导方案。
22 4
|
15天前
|
SpringCloudAlibaba 监控 Java
SpringCloud Alibaba微服务-- Sentinel的使用(保姆级)
SpringCloud Alibaba微服务-- Sentinel的使用(保姆级)
|
15天前
|
SpringCloudAlibaba Java API
SpringCloud Alibaba微服务工程搭建(保姆级)
SpringCloud Alibaba微服务工程搭建(保姆级)
|
15天前
|
SpringCloudAlibaba Java Nacos
SpringCloud Alibaba微服务 -- Nacos使用以及注册中心和配置中心的应用(保姆级)
SpringCloud Alibaba微服务 -- Nacos使用以及注册中心和配置中心的应用(保姆级)
|
22天前
|
负载均衡 网络协议 Java
构建高效可扩展的微服务架构:利用Spring Cloud实现服务发现与负载均衡
本文将探讨如何利用Spring Cloud技术实现微服务架构中的服务发现与负载均衡,通过注册中心来管理服务的注册与发现,并通过负载均衡策略实现请求的分发,从而构建高效可扩展的微服务系统。
|
30天前
|
消息中间件 缓存 API
微服务架构下的API网关性能优化实践
在现代的软件开发中,微服务架构因其灵活性和可扩展性被广泛采用。随着服务的细分与增多,API网关作为微服务架构中的关键组件,承担着请求路由、负载均衡、权限校验等重要职责。然而,随着流量的增长和业务复杂度的提升,API网关很容易成为性能瓶颈。本文将深入探讨API网关在微服务环境中的性能优化策略,包括缓存机制、连接池管理、异步处理等方面的具体实现,旨在为开发者提供实用的性能提升指导。
|
1月前
|
缓存 负载均衡 监控
构建高效微服务架构:API网关的作用与实践
【2月更文挑战第31天】 在当今的软件开发领域,微服务架构已成为实现系统高度模块化和易于扩展的首选方法。然而,随着微服务数量的增加,确保通信效率和管理一致性变得尤为重要。本文将探讨API网关在微服务架构中的核心角色,包括其在请求路由、安全性、负载均衡以及聚合功能方面的重要性。我们将通过具体案例分析,展示如何利用API网关优化后端服务,并讨论实施过程中的最佳实践和常见挑战。