refactor(platform): 移除旧版开放平台模块并迁移至独立仓库
- 删除api返回结果封装(ApiResult)、业务异常(BusinessException)、系统常量(Constants)等基础模块代码 - 移除开放平台上下文(OpenCaller)、租户上下文(OpenTenantContext)及相关拦截器等实现 - 删除开放平台安全配置、安全异常处理、JWT校验配置和相关测试用例 - 调整 MybatisPlusConfig 中对 OpenTenantContext 包路径的引用 - 将开放平台controller、参数、视图、配置、拦截器等迁移至新的独立仓库包名 com.gxwebsoft.platform.openapi - 开放接口controller添加 @OpenApi 注解用于异常处理匹配 - 更新文档,补充开放平台模块移除和迁移说明,指导后续开发维护 - 保持包名兼容,确保遗留代码引用不变,无需做import改动
This commit is contained in:
@@ -59,7 +59,19 @@
|
||||
## 3. 代码结构
|
||||
|
||||
```
|
||||
本服务的业务侧(留在本仓库)
|
||||
com.gxwebsoft.openplatform
|
||||
├─ constant/OpenScopes.java scope 常量
|
||||
├─ param/OpenOrderPageParam.java 入参白名单(刻意不含 tenantId)
|
||||
├─ param/OpenUserPageParam.java 用户查询入参白名单
|
||||
├─ vo/OpenOrderVO.java 出参裁剪 + 手机号脱敏
|
||||
├─ vo/OpenUserVO.java 出参裁剪 + 手机号/邮箱脱敏,不含密码字段
|
||||
├─ controller/OpenOrderController.java /api/open/v1/order/page
|
||||
└─ controller/OpenUserController.java /api/open/v1/user/page
|
||||
|
||||
平台层(已迁出到独立仓库 websoft-platform,作为构件依赖引入)
|
||||
com.gxwebsoft.platform.openapi
|
||||
├─ OpenApi 标记注解,异常处理器按它匹配
|
||||
├─ config/OpenPlatformProperties.java 配置:JWKS / iss / aud / 前缀 / 脱敏
|
||||
├─ config/OpenPlatformJwtConfig.java JwtDecoder + iss/aud 校验器
|
||||
├─ config/OpenPlatformSecurityConfig.java @Order(1),只匹配 /api/open/**
|
||||
@@ -71,15 +83,20 @@ com.gxwebsoft.openplatform
|
||||
├─ web/OpenPlatformAccessDeniedHandler.java 无权限响应(不含 error 字段)
|
||||
├─ web/OpenPlatformExceptionAdvice.java 开放接口专用异常处理,不外泄内部信息
|
||||
├─ web/OpenPageResult.java 对外分页结构 {list,total,page,limit}
|
||||
├─ constant/OpenScopes.java scope 常量
|
||||
├─ param/OpenOrderPageParam.java 入参白名单(刻意不含 tenantId)
|
||||
├─ param/OpenUserPageParam.java 用户查询入参白名单
|
||||
├─ vo/OpenOrderVO.java 出参裁剪 + 手机号脱敏
|
||||
├─ vo/OpenUserVO.java 出参裁剪 + 手机号/邮箱脱敏,不含密码字段
|
||||
├─ controller/OpenOrderController.java /api/open/v1/order/page
|
||||
└─ controller/OpenUserController.java /api/open/v1/user/page
|
||||
└─ web/JsonResponseWriter.java 响应写出(不依赖业务侧 CommonUtil)
|
||||
```
|
||||
|
||||
> **迁移说明(2026-09-22)**:上述平台层文件原先以源码形式放在本仓库的
|
||||
> `com.gxwebsoft.openplatform.{config,context,web}` 下,现已抽到独立仓库
|
||||
> `websoft-platform` 并作为 `websoft-platform-openapi` 构件依赖引入。
|
||||
> 内核 `Constants` / `ApiResult` / `PageResult` / `BusinessException` 同样已迁移,
|
||||
> 但**包名保持不变**,所以本服务其余代码一行 import 都不用改。
|
||||
>
|
||||
> 对外开放的 controller 必须加 `@OpenApi` 注解——平台层的异常处理器按注解匹配,
|
||||
> 漏加会导致第三方收到带 `error` 字段(内部异常信息)的响应。
|
||||
>
|
||||
> 详见 `websoft-platform/docs/PLATFORM_LAYER.md`。
|
||||
|
||||
既有文件改动:
|
||||
|
||||
| 文件 | 改动 |
|
||||
|
||||
Reference in New Issue
Block a user