统一网关Gateway 快速入门

最新推荐文章于 2024-09-30 10:47:27 发布

高老庄小呆子

最新推荐文章于 2024-09-30 10:47:27 发布

阅读量128

点赞数

文章标签： gateway spring cloud 微服务分布式

本文链接：https://blog.csdn.net/qq_41915280/article/details/130694720

版权

一网关的作用

身份认证和权限校验

服务路由、负载均衡

请求限流

二网关快速入门

1 搭建网关服务的步骤

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

        <!--nacos服务注册发现依赖-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--网关gateway依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

1.2 编写路由配置及nacos地址

server:
  port: 10010
logging:
  level:
    cn.itcast: debug
  pattern:
    dateformat: MM-dd HH:mm:ss:SSS
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: nacos:8848 # nacos地址
    gateway:
      routes:
        - id: user-service # 路由标示，必须唯一
          uri: lb://userservice # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言，判断路径是否是以/user开头，如果是则符合

网关搭建步骤：

创建项目，引入nacos服务发现和gateway依赖

配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括：

路由id：路由的唯一标示

路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

路由断言（predicates）：判断路由的规则，

路由过滤器（filters）：对请求或响应做处理

三路由断言工厂Route Predicate Factory

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

路由id：路由唯一标示

uri：路由目的地，支持lb和http两种

predicates：路由断言，判断请求是否符合要求，符合则转发到路由目的地

filters：路由过滤器，处理请求或响应

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

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

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

名称	说明	示例
After	是某个时间点后的请求	- After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before	是某个时间点之前的请求	- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between	是某两个时间点之前的请求	-Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie	请求必须包含某些cookie	- Cookie=chocolate, ch.p
Header	请求必须包含某些header	- Header=X-Request-Id, \d+
Host	请求必须是访问某个host（域名）	- Host=.somehost.org,.anotherhost.org
Method	请求方式必须是指定方式	- Method=GET,POST
Path	请求路径必须符合指定规则	- Path=/red/{segment},/blue/**
Query	请求参数必须包含指定参数	- Query=name, Jack或者- Query=name
RemoteAddr	请求者的ip必须是指定范围	- RemoteAddr=192.168.1.1/24
Weight	权重处理

predicates:
   - Path=/order/**  #路径断言，判断路径是否是以/user开头，如果是则符合
   - After= 2037-01-20T17:42:47.789-07:00[America/Denver] #是某个时间点后的请求

四过滤器工厂

4.1 路由过滤器 GatewayFilter

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

4.2 过滤器工厂 GatewayFilterFactory

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

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

gatewayFiterFacton 官网

4.3 例子: 给所有进入userservice的请求添加一个请求头 Truth=test test!

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

spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: nacos:8848 # nacos地址
    gateway:
      routes:
        - id: user-service # 路由标示，必须唯一
          uri: lb://userservice # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言，判断路径是否是以/user开头，如果是则符合
      filters: # 过滤器
        - AddRequestHeader=Truth,test test!  # 添加请求头

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

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

spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: nacos:8848 # nacos地址
    gateway:
      routes:
        - id: user-service # 路由标示，必须唯一
          uri: lb://userservice # 路由的目标地址
          predicates: # 路由断言，判断请求是否符合规则
            - Path=/user/** # 路径断言，判断路径是否是以/user开头，如果是则符合
      default-filters:
        - AddRequestHeader=Truth,test test! # 添加请求头

五全局过滤器 GlobalFilter

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

例子:

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

参数中是否有authorization，

authorization参数值是否为admin

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

// @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");
        // 3.判断参数值是否等于 admin
        if ("admin".equals(auth)) {
            // 4.是，放行
            return chain.filter(exchange);
        }
        // 5.否，拦截
        // 5.1.设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 5.2.拦截请求
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() { //优先级 数字越小 优先级越高
        return -1;
    }
}

总结:

全局过滤器的作用:

        对所有路由都生效的过滤器，并且可以自定义处理逻辑

实现全局过滤器的步骤:

        实现GlobalFilter接口

        添加@Order注解或实现Ordered接口  (数字越小优先级越高)

        编写处理逻辑

六过滤器执行顺序

请求进入网关会碰到三类过滤器：当前filter(路由的过滤器)、DefaultFilter(默认过滤器)、GlobalFilter(全局过滤器)

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

1.每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。

2.GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定

3.路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。

4.当过滤器的order值一样时，会按照 DefaultFilter(默认过滤器)> filter(路由的过滤器) > GlobalFilter(全局过滤器) 的顺序执行。

七跨域问题

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

域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

域名相同，端口不同：localhost:8080和localhost8081

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

3，解决方案：CORS（浏览器询问服务器是否允许跨域 CORS询问请求是 options 默认是会被拦截的）

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

CORS跨域要配置的参数包括哪些

1.允许哪些域名跨域

2.允许哪些请求头

3.允许哪些请求方式

4.是否允许使用cookie

5.有效期是多久

spring:  
    cloud:    
        gateway:      
        # 。。。      
            globalcors: # 全局的跨域处理        
                add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 CORS询问请求是 options 默认是会被拦截的
                corsConfigurations:          
                   '[/**]':   # 拦截一切请求           
                allowedOrigins: # 允许哪些网站的跨域请求 
                      - "http://localhost:8090"            
                      - "http://www.leyou.com"          
                allowedMethods: # 允许的跨域ajax的请求方式           
                      - "GET"             
                      - "POST"            
                      - "DELETE"            
                      - "PUT"             
                      - "OPTIONS"           
                allowedHeaders: "*" # 允许在请求中携带的头信息            
                    allowCredentials: true # 是否允许携带cookie            
                maxAge: 360000 # 这次跨域检测的有效期