OJ在线评测系统微服务高级 Gateway网关接口路由和聚合文档引入knife4j库集中查看管理并且调试网关项目

Gateway微服务网关接口路由

各个服务之间已经能相互调用了

为什么需要网关

因为我们的不同服务是放在不同的端口上面的

如果前端调用服务需要不同的端口 8101 8102 8103 8104

我们最好提供一个唯一的给前端去调用的路径

我们学习技术的时候必须要去思考

1.为什么要用？

2.是什么？

所有的服务端口不同增大了前端调用成本同时我们的所有服务是分散的你可能需要进行集中管理操作

比如说集中解决跨域鉴权接口文档服务的路由接口安全性流量染色

Gateway 想自定义一些功能

需要对这个技术有比较深的理解

接口路由

统一的接收前端请求

然后转发请求到对应的服务

Gateway 是应用层网关想要自定义一些功能需要对这个技术有较深的理解

Nginx 是接入层网关比如说每个请求的日志通常没有业务逻辑

如何找到路由

可以编写一套路由配置通过API地址前缀来找到服务

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      routes:
        - id: yuoj-backend-user-service
          uri: lb://yuoj-backend-user-service
          predicates:
            - Path=/api/user/**
        - id: yuoj-backend-question-service
          uri: lb://yuoj-backend-question-service
          predicates:
            - Path=/api/question/**
        - id: yuoj-backend-judge-service
          uri: lb://yuoj-backend-judge-service
          predicates:
            - Path=/api/judge/**
  application:
    name: yuoj-backend-gateway
  main:
    web-application-type: reactive
server:
  port: 8101
knife4j:
  gateway:
    # ① 第一个配置，开启gateway聚合组件
    enabled: true
    # ② 第二行配置，设置聚合模式采用discover服务发现的模式
    strategy: discover
    discover:
      # ③ 第三行配置，开启discover模式
      enabled: true
      # ④ 第四行配置，聚合子服务全部为Swagger2规范的文档
      version: swagger2

解释一下配置

#         ------------------------------------
#         服务id 地址所对应的服务
        - id: yuoj-backend-user-service
#         地址 请求到哪个地址
          uri: lb://yuoj-backend-user-service
#         规则 哪些服务请求到地址
          predicates:
            - Path=/api/user/**
#         ------------------------------------

兼容问题

解决找不到数据库的问题

Gateway微服务网关聚合文档

如果想调试网关项目

可以使用接口文档工具比如说postman

以一个全局的视角集中查看和管理所有的接口文档

可以用 knife4j 这个库

先要给所有的服务引入依赖同时开启接口文档的配置

给网关配置集中管理文档

快速开始 | Knife4j (xiaominfo.com)

先引入依赖

只给需要的模块引入

		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>knife4j-gateway-spring-boot-starter</artifactId>
			<version>4.3.0</version>
		</dependency>

进行配置

knife4j:
  gateway:
    # ① 第一个配置，开启gateway聚合组件
    enabled: true
    # ② 第二行配置，设置聚合模式采用discover服务发现的模式
    strategy: discover
    discover:
      # ③ 第三行配置，开启discover模式
      enabled: true
      # ④ 第四行配置，聚合子服务全部为Swagger2规范的文档
      version: swagger2

我都写代码了还让我写那么多繁杂的配置是对程序员的不尊重

这样就能聚合文档文档里面有接口文档工具

可以很方便的调试

分布式session登录

注意的是一定要在总体项目的pom.xml文件加入redis的依赖

<!-- redis -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-data-redis</artifactId>
</dependency>

访问地址 /doc.html 可查看接口文档

Session 是一种用于在用户与应用程序之间保持状态的机制。它允许在用户访问不同页面时存储和管理用户信息，如登录状态、购物车内容等。Session 通常在服务器端存储，并通过唯一的会话 ID 来识别用户。

Session 的管理通常包括以下几个方面：

创建与初始化：当用户首次访问应用时，服务器为其创建一个新的 Session，并生成一个唯一的 Session ID。
存储数据：开发者可以在 Session 中存储各种数据，如用户信息、应用状态等，这些数据在用户的多个请求中保持可用。
过期管理：Session 会设定一个过期时间，超过这个时间后，Session 将失效，存储的数据也会被清除。这可以帮助节省资源和提升安全性。
安全性：为了保护 Session 数据，常用的方法包括加密 Session ID、使用 HTTPS 等。
结束与销毁：用户登出时或 Session 过期时，服务器会销毁该 Session，以释放资源。

server:
  address: 0.0.0.0
  port: 8104
  servlet:
    context-path: /api/judge
    # cookie 30 天过期
    session:
      cookie:
        max-age: 2592000
        path: /api

OJ在线评测系统 微服务高级 Gateway网关接口路由和聚合文档 引入knife4j库集中查看管理并且调试网关项目