# openNexus **Repository Path**: xylve/open-nexus ## Basic Information - **Project Name**: openNexus - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-07 - **Last Updated**: 2026-11-07 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # openNexus - API 开放平台 一个基于 Spring Boot + Spring Cloud Gateway + Dubbo 的企业级 API 开放平台,提供接口管理、客户端 SDK、签名认证、网关统一鉴权、调用次数统计等完整能力。 ## 项目简介 openNexus 是一个仿「阿里云 API 市场 / 聚合数据」的 API 开放平台,核心目标是让第三方开发者能够安全、可控地调用平台提供的接口。平台实现了从接口发布、签名认证、流量转发到调用计费的完整链路。 ### 核心特性 - 🔐 **API 签名认证**:基于 AK/SK + SHA256 签名 + 时间戳 + 随机数的防篡改、防重放机制 - 🛡️ **网关统一鉴权**:Spring Cloud Gateway 全局过滤器,所有请求在网关层完成鉴权与转发 - 📦 **客户端 SDK**:Spring Boot Starter 机制,第三方引入 jar 即可调用,无需关心签名细节 - 📊 **调用次数统计**:网关层通过响应装饰器在调用成功后统一计费(剩余次数 -1、总次数 +1) - 🔌 **Dubbo RPC 分布式**:网关通过 Nacos 注册中心远程调用主后端的内部服务,实现服务解耦 - 📈 **接口数据分析**:提供调用量 Top 接口统计接口 - 🧩 **接口生命周期管理**:增删改查 + 上下线(上线前自动真实调用验证可用性) ## 技术栈 | 分类 | 技术 | |------|------| | 后端框架 | Spring Boot 2.7.x | | 网关 | Spring Cloud Gateway 2021.0.x | | RPC 框架 | Apache Dubbo 3.0.x | | 注册中心 | Nacos 2.1.x | | 持久层 | MyBatis-Plus 3.5.x | | 数据库 | MySQL | | 缓存 / Session | Redis | | 工具库 | Hutool、Gson、Commons-Lang3 | | 文档 | Knife4j(Swagger) | | 构建工具 | Maven | ## 项目结构 ``` openNexus/ ├── openNexus/ # 主后端服务(端口 7529) │ ├── controller/ # 接口管理、用户、分析等 REST 接口 │ ├── service/ # 业务逻辑 + Dubbo 内部服务实现 │ ├── mapper/ # MyBatis-Plus Mapper │ ├── aop/ # 权限校验、日志切面 │ └── config/ # 跨域、MyBatis-Plus、Knife4j 配置 │ ├── api-gateway/ # API 网关(端口 8090) │ └── CustomGlobalFilter.java # 全局过滤器:鉴权、路由、计费 │ ├── api-interface/ # 模拟接口服务(端口 8123) │ └── NameController.java # 被调用的业务接口示例 │ ├── api-client-sdk/ # 客户端 SDK │ ├── client/ApiClient.java # 封装 HTTP 调用 + 签名头 │ ├── utils/SignUtils.java # SHA256 签名工具 │ └── ApiClientConfig.java # Spring Boot Starter 自动装配 │ ├── api-common/ # 公共模块(契约层) │ ├── model/entity/ # User、InterfaceInfo、UserInterfaceInfo │ └── service/ # Dubbo 内部服务接口定义 │ └── doc/sql/ # 数据库建表脚本 ``` ## 模块职责 | 模块 | 端口 | 职责 | |------|------|------| | openNexus(主后端) | 7529 | 接口 CRUD、上下线管理、用户管理、数据分析;作为 Dubbo 服务提供者暴露内部服务 | | api-gateway | 8090 | 统一入口,完成请求日志、黑白名单、AK/SK 鉴权、签名校验、接口存在性校验、转发、调用统计 | | api-interface | 8123 | 真实业务接口实现(示例:名称接口) | | api-client-sdk | - | 第三方客户端 SDK,封装签名与调用逻辑 | | api-common | - | 公共实体 + Dubbo 服务接口契约,被网关和主后端共同依赖 | ## 架构与调用流程 ### 一次完整的接口调用链路 ``` 第三方 / 前端 │ │ 1. 创建接口、发布(online)、测试调用 ▼ 主后端 openNexus:7529 │ InterfaceInfoController │ - 发布时用 ApiClient 真实调试验证接口可用性 │ │ 2. 构造签名请求头(accessKey / nonce / timestamp / body / sign) ▼ api-client-sdk │ │ 3. HTTP 请求发往网关 ▼ api-gateway:8090 ──────── Dubbo RPC ────────► 主后端提供的内部服务 CustomGlobalFilter: (InnerUserService / ① 请求日志 InnerInterfaceInfoService / ② IP 黑白名单 InnerUserInterfaceInfoService) ③ AK/SK 鉴权(getInvokeUser) ④ 签名校验(SignUtils.genSign) ⑤ 接口存在性校验(getInterfaceInfo) ⑥ 转发到 api-interface:8123 ⑦ 响应装饰器:调用成功后 invokeCount │ ▼ api-interface:8123 NameController 执行业务逻辑 ``` ### 签名认证机制 签名算法(`SignUtils`): ``` sign = SHA256(body + "." + secretKey) ``` 请求头包含以下字段: | Header | 说明 | |--------|------| | accessKey | 用户标识(公开,用于查库获取用户) | | nonce | 4 位随机数,防重放 | | timestamp | 秒级时间戳,超时 5 分钟拒绝 | | body | 请求体原文,参与签名 | | sign | 签名值,secretKey 永不传输 | 服务端校验流程: 1. 通过 `accessKey` 查库获取用户的 `secretKey` 2. 用相同算法对 `body` 重新签名,与请求 `sign` 比对(防篡改) 3. 校验 `timestamp` 是否在 5 分钟内(防重放) 4. 校验 `nonce`(防重放) ### 网关调用统计 网关使用 `ServerHttpResponseDecorator` 装饰响应对象,重写 `writeWith` 方法,在业务接口成功响应后通过 Dubbo 调用 `InnerUserInterfaceInfoService.invokeCount`,将该用户对该接口的 `leftNum - 1`、`totalNum + 1`,实现统一计费且不侵入业务代码。 ## 快速开始 ### 环境要求 - JDK 1.8 - Maven 3.6+ - MySQL 5.7+ - Redis - Nacos 2.x ### 1. 初始化数据库 执行建表脚本: ```bash mysql -u root -p < doc/sql/create_table.sql ``` 脚本会创建 `api` 库及 `user`、`interface_info`、`user_interface_info` 三张表。 ### 2. 启动 Nacos ```bash # 下载 nacos 后进入 bin 目录 sh startup.sh -m standalone # Linux / macOS startup.cmd -m standalone # Windows ``` 默认地址:`http://localhost:8848/nacos`,账号密码均为 `nacos`。 ### 3. 修改配置 根据你的环境修改各模块的 `application.yml`: **主后端** `openNexus/src/main/resources/application.yml`: ```yaml spring: datasource: url: jdbc:mysql://你的MySQL地址:3306/api username: root password: 你的密码 redis: host: 你的Redis地址 port: 6379 dubbo: registry: address: nacos://你的Nacos地址:8848 ``` **网关** `api-gateway/src/main/resources/application.yml`: ```yaml dubbo: registry: address: nacos://你的Nacos地址:8848 ``` ### 4. 编译安装公共模块 由于 `api-client-sdk` 和 `api-common` 被其他模块依赖,需先安装到本地仓库: ```bash cd openNexus mvn clean install -pl api-common,api-client-sdk -am ``` ### 5. 启动服务 按以下顺序启动三个服务: 1. **主后端** `openNexus` → 运行 `MyApplication` 2. **接口服务** `api-interface` → 运行 `ApiInterfaceApplication` 3. **网关** `api-gateway` → 运行 `ApiGatewayApplication` 启动成功后,访问 Knife4j 接口文档:`http://localhost:7529/api/doc.html` ## 客户端 SDK 使用 ### 引入依赖 将 `api-client-sdk` 安装到本地仓库后,在使用方项目中引入: ```xml com.zy api-client-sdk 1.0-SNAPSHOT ``` ### 配置 AK/SK 在 `application.yml` 中配置: ```yaml api: client: access-key: 你的accessKey secret-key: 你的secretKey ``` SDK 采用 Spring Boot Starter 自动装配,配置后即可直接注入 `ApiClient`。 ### 调用示例 ```java @Resource private ApiClient apiClient; // GET 方式 String result1 = apiClient.getNameByGet("张三"); // POST 方式 String result2 = apiClient.getNameByPost("张三"); // POST JSON 方式 User user = new User(); user.setUsername("张三"); String result3 = apiClient.getUsernameByPost(user); ``` ## 核心 API 接口 | 接口 | 方法 | 说明 | 权限 | |------|------|------|------| | /api/interfaceInfo/add | POST | 创建接口 | 登录 | | /api/interfaceInfo/delete | POST | 删除接口 | 本人/管理员 | | /api/interfaceInfo/update | POST | 更新接口 | 本人/管理员 | | /api/interfaceInfo/get | GET | 根据 id 查询 | - | | /api/interfaceInfo/list | GET | 获取列表 | 管理员 | | /api/interfaceInfo/list/page | GET | 分页查询 | - | | /api/interfaceInfo/online | POST | 发布接口 | 管理员 | | /api/interfaceInfo/offline | POST | 下线接口 | 管理员 | | /api/interfaceInfo/invoke | POST | 测试调用接口 | 登录 | | /api/analysis/top/interface/invoke | GET | 调用量 Top3 接口 | 管理员 | ## 数据库表设计 ### user(用户表) | 字段 | 类型 | 说明 | |------|------|------| | id | bigint | 主键 | | userAccount | varchar | 账号(唯一) | | userPassword | varchar | 密码 | | userName | varchar | 昵称 | | userRole | varchar | 角色:user / admin | | accessKey | varchar | 签名 accessKey | | secretKey | varchar | 签名 secretKey | ### interface_info(接口信息表) | 字段 | 类型 | 说明 | |------|------|------| | id | bigint | 主键 | | name | varchar | 接口名称 | | description | varchar | 描述 | | url | varchar | 接口地址 | | requestParams | text | 请求参数 | | method | varchar | 请求方法 | | status | int | 状态:0-关闭,1-开启 | | userId | bigint | 创建人 | ### user_interface_info(用户调用接口关系表) | 字段 | 类型 | 说明 | |------|------|------| | id | bigint | 主键 | | userId | bigint | 调用用户 id | | interfaceInfoId | bigint | 接口 id | | totalNum | int | 总调用次数 | | leftNum | int | 剩余调用次数 | | status | int | 0-正常,1-禁用 | ## 设计亮点 1. **管理面与数据面分离**:主后端负责接口管理,网关负责流量转发,职责清晰 2. **网关统一收口**:鉴权、签名校验、调用统计全部在网关层完成,业务接口无需关心 3. **响应装饰器计费**:利用 `ServerHttpResponseDecorator` 在响应写出时统计调用次数,只在调用成功时计费 4. **Dubbo 契约解耦**:`api-common` 定义服务接口,网关与主后端通过 RPC 通信,互不依赖实现 5. **上线前验证**:接口发布时通过 SDK 真实调用一次,确保接口可用后才变更状态 ## 注意事项 - 网关中 `IP_WHITE_LIST` 默认仅允许 `127.0.0.1`,生产环境需根据实际情况调整 - `nonce` 防重放目前为简化实现(>10000 拒绝),生产环境应使用 Redis 存储已用 nonce 并设置过期时间 - `ApiClient` 中 `GATEWAY_HOST` 硬编码为 `http://localhost:8090`,对外分发 SDK 前应改为可配置 - 接口发布时的真实调用使用配置文件中的默认 AK/SK,实际应使用发布人自己的密钥 ## License 本项目仅用于学习交流。