微服务系列（8）- Gateway服务网关

最新推荐文章于 2024-06-25 15:58:55 发布

兀坐晴窗独饮茶

最新推荐文章于 2024-06-25 15:58:55 发布

阅读量3.1k

点赞数

分类专栏： Java系列微服务文章标签： Gateway服务网关微服务

本文链接：https://blog.csdn.net/weixin_40040107/article/details/124392552

版权

Java系列同时被 2 个专栏收录

104 篇文章 4 订阅

订阅专栏

微服务

13 篇文章 0 订阅

订阅专栏

1. Gateway服务网关

1.1 网关的作用

Gateway网关是我们服务的守门神，所有微服务的统一入口, 有些微服务是企业内部使用的, 不能让所有的微服务都可以互相访问到, 所以我们需要一个特殊的 “门” 来拦截请求, 并决定是否放行

Gateway的核心功能 :

请求路由
权限控制
限流

权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大

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

Zuul是基于Servlet的实现，属于阻塞式编程。
SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

1.2 网关的使用

1.2.1 创建网关

如下图所示, 新建一个名为 gateway 的 maven 项目

新建完成以后, 在 pom 文件里面添加 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>

添加完成依赖后, 创建启动类

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

1.2.2 添加配置

创建 application.yml 文件, 添加网关配置 :

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway-server
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 服务地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由的id, 可以自己定义, 但是要唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/**

配置文件介绍 :

uri: lb://user-service 一般是这样设置即可 lb 表示负载均衡, 当然也可以设置成

uri: http://127.0.0.1:8081

predicates 相当于是匹配路径的, 比如 Path=/user/** 这个是按照路径匹配的, 只要是 /user 开头的请求就表示复合要求

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

配置完成以后, 我们启动 gateway 微服务即可, 然后测试直接访问 http://localhost:10010/user/1

如上图可以看到, 可以成功的通过网关转发请求获取数据

1.3 网关路由

网关路由的访问流程如下图所示 :

用户访问链接, 浏览器发送请求到服务器
服务器接收到请求, 先由网关拦截请求, 然后对其路由规则进行判断
根据路由规则找到到路由的id, 进而找到路由的uri, 然后从Nacos中来取对应的微服务实例列表
然后由负载均衡负责处理具体是请求那一台服务器

1.4 路由断言

我们在配置文件中写的断言规则只是字符串，这些字符串会被PredicateFactory读取并处理，转变为路由判断的条件例如Path=/user/**是按照路径匹配，这个规则是由下面这个工厂类来处理的

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory

像这样的断言工厂在SpringCloudGateway还有很多, 不过一般用的很少, 会用 Path 就可以了 :

After : 是某个时间点后的请求

- After=2037-01-20T17:42:47.789-07:00[America/Denver]

Before : 是某个时间点之前的请求

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

我们只需要掌握Path这种路由工程就可以了

1.5 路由过滤器

1.5.1 过滤器工厂

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

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

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

1.5.2 过滤器使用

以 AddRequestHeader 为例来讲解如何使用这些已经定义好的过滤器 :

  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 服务地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由的id, 可以自己定义, 但是要唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/**
          filters: # 过滤器
            - AddRequestHeader=Truth,AddRequestHeader success!

我们可以直接在配置文件中添加, 需要注意的是, AddRequestHeader=key,value 如果想要获取添加的请求头

可以通过 request.getHeader("truth") 获取请求头信息, 请求头的key是不区分大小写的!


    public User queryById(@PathVariable("id") Long id, HttpServletRequest request) {

        log.info(request.getHeader("truth"));
        return userService.queryById(id);
    }

简单总结 :

过滤器的作用是什么？

对路由的请求或响应做加工处理，比如添加请求头
配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么？

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

1.5.3 全局过滤器

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

第一步 : 定义方式是实现 GlobalFilter 接口。特别注意 : GlobalFilter 是springcloud提供的

package cn.itcast.gateway.filters;

import lombok.extern.slf4j.Slf4j;
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.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * @author 王天赐
 * @title: AuthorizationFilter
 * @projectName cloud-demo
 * @description:
 * @website http://knightzz.cn/
 * @github https://github.com/knightzz1998
 * @date 2022/4/24 16:45
 */
@Slf4j
@Order(0)
@Component
public class AuthorizationFilter implements GlobalFilter {
}

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

参数中是否有authorization
authorization参数值是否为admin

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


package cn.itcast.gateway.filters;

import lombok.extern.slf4j.Slf4j;
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.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * @author 王天赐
 * @title: AuthorizationFilter
 * @projectName cloud-demo
 * @description:
 * @website http://knightzz.cn/
 * @github https://github.com/knightzz1998
 * @date 2022/4/24 16:45
 */
@Slf4j
@Order(0)
@Component
public class AuthorizationFilter implements GlobalFilter {

    /**
     * @param exchange 请求上下文，里面可以获取Request、Response等信息
     * @param chain    用来把请求委托给下一个过滤器
     * @return
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        // 判断 :
        // 参数中是否有authorization
        // authorization参数值是否为admin
        // 获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        String auth = params.getFirst("authorization");
        if ("admin".equals(auth)) {
            // 满足条件直接放行
            return chain.filter(exchange);
        }

        // 不满足条件, 设置响应状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 结束处理
        return exchange.getResponse().setComplete();
    }
}

@Order 注解的作用是定义过滤器的执行顺序, 可以通过注解也可以通过实现 Ordered 接口方式去定义接口的执行顺序, 值越小越先执行

1.5.4 过滤器执行顺序

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

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

排序的规则是 :

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

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

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator #getFilters()

方法是先加载defaultFilters，然后再加载某个route的 filters，然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler #handle()

handle() 方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

1.6 跨域问题

1.6.1 跨域问题介绍

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

域名不同：

www.taobao.com 和 www.taobao.org 和
www.jd.com 和 miaosha.jd.com

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

参考 : https://www.ruanyifeng.com/blog/2016/04/cors.html

1.6.2 跨域问题解决

在 gateway 服务的 application.yml文件中的spring.cloud.gateway，添加下面的配置

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

完整的配置

spring:
  application:
    name: gateway-service
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 服务地址
    gateway:
      routes: # 网关路由配置
        - id: nacos-user-service # 路由的id, 可以自己定义, 但是要唯一
          uri: lb://user-service # 路由的目标地址
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/**
          filters:
            - AddRequestHeader=Truth,AddRequestHeader success!
        - id: nacos-order-service # order-service 的路由
          uri: lb://order-service # 路由的目标地址
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/order/**
      globalcors: #  全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被 拦截问题
        cors-configurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

兀坐晴窗独饮茶

关注

0
点赞
踩
13

收藏

觉得还不错? 一键收藏
打赏
1
评论
微服务系列（8）- Gateway服务网关

1. Gateway服务网关1.1 网关的作用Gateway网关是我们服务的守门神，所有微服务的统一入口, 有些微服务是企业内部使用的, 不能让所有的微服务都可以互相访问到, 所以我们需要一个特殊的 “门” 来拦截请求, 并决定是否放行Gateway的核心功能 :请求路由权限控制限流权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路
复制链接

扫一扫