Gateway统一网关

Venus688

已于 2024-05-08 17:01:29 修改

阅读量663

点赞数 8

文章标签： gateway

于 2024-05-08 16:59:30 首次发布

本文链接：https://blog.csdn.net/Kint_Arthur/article/details/138542366

版权

微服务相关专栏收录该内容

3 篇文章 0 订阅

订阅专栏

一、引入：

网关功能：

身份认证和权限校验
- 网关作为微服务入口，需要校验用户是否有请求资格，如果没有则进行拦截。
服务路由、负载均衡
- 一切请求都必须先经过gateway网关，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务同时部署多个时，还需要做负载均衡，也就是根据规则具体转发到某个服务。
请求限流
- 当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。
处理跨域
- 我们可以在网关中统一处理跨域问题，而不必单独在每个项目中处理。

网关的具体实现：SpringCloudGateway

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

gateway
- 基于Spring5中提供的WebFlux，属于响应式编程的实现，吞吐能力更强，具备更好的性能。
zuul
- 基于Servlet的实现，属于阻塞式编程。

二、使用：

gateway网关是一个独立的服务,需要创建一个新的模块gateway

创建gateway服务（项目版本jdk是8，要选择8的），引入依赖

<!--gateway网关-->
<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>

编写启动类

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);
	}
}

编写基础配置和路由规则:
创建application.yml文件，内容如下：

	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: baidu-demo
	          uri: https://www.baidu.com  # 第二种写法：路由的目标地址 http就是固定地址
	          predicates:
	           - Path=/baidu/** # 注意使用本服务测试需要开启下面截取path，不然拼接的路径无效
	#         filters: 
	# path断言路由的请求格式默认为uri+path,如果不需要携带path可以截取掉
	#           - StripPrefix=1    # 截取掉- Path中的第一级路径/baidu
	
	# 初学期间为了方便调试与快速定位错误，可以将gateway打印日志级别调低
	logging:
	  level:
	    org:
	      springframework:
	        cloud:
	          gateway: trace

路由的配置包括：
- 路由（id）：路由的唯一标识
- 路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
- 路由断言（predicates）：判断路由的规则
- 路由过滤器（filters）：对请求或响应做处理
  我们将符合Path 规则的一切请求，都代理到 uri参数指定的地址。

本例中，我们将 /user/** 开头的请求，代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。进行更多丰富配置可查阅官方文档~
3. 测试：
- 启动nacos
- 重启网关，访问http://localhost:10010/user/1时，符合/user/**规则，请求转发到uri：http://userservice/user/1，得到了结果
- 访问http://localhost:10010/order/101时，不符合/user/**规则，请求被拦截
说明：
网关路由的流程图在这里插入图片描述

三、路由断言工厂：

工厂作用：读取用户配置的断言规则，解析成对应的判断条件

官网示例：判断规则

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件
例如Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的

四、路由过滤器

作用：对路由的请求或响应做加工处理，比如添加请求头

GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：在这里插入图片描述
Spring提供了31种不同的路由过滤器工厂。例如：

名称	说明
AddRequestHeader	给当前请求添加一个请求头
RemoveRequestHeader	移除请求中的一个请求头
AddResponseHeader	给响应结果中添加一个响应头
RemoveResponseHeader	从响应结果中移除有一个响应头
RequestRateLimiter	限制请求的流量

官网其他过滤器工厂：GatewayFilter Factories

a).当前路由过滤器

配置在路由下的过滤器只对当前路由的请求生效

给所有进入userservice的请求添加一个请求头，注意等号不要有空格
在这里插入图片描述

controlle层请求参数加上*@RequestHeader（required = false）String header*来获取传递参数上的请求头
- 其中required参数是指，这个请求头可以有也可以没有

b).默认过滤器

对所有路由都生效的过滤器

在这里插入图片描述

c).全局过滤器 GlobalFilter

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与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中编写自定义逻辑，可以实现下列功能：

登录状态判断
权限校验
请求限流等
自定义全局过滤器,拦截请求，判断请求的参数是否满足下面条件：
参数中是否有authorization，
authorization参数值是否为admin
如果同时满足则放行，否则拦截

package cn.itcast.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@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".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.拦截
        // 4.1.禁止访问，设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.结束处理
        return exchange.getResponse().setComplete();
    }
}

d).过滤器执行顺序

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

请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器
在这里插入图片描述

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

五、网关的跨域问题

跨域：域名不一致或端口不一致，主要包括：
域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
域名相同，端口不同：localhost:8080和localhost:8081
跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

解决方案：CROS
添加如下配置：

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