Files
ssw-platform/references/README.md
T
sukyboor 9771fa844d init: 尚数网平台 JNPF 7.0 兼容后端(多应用 + 面 A/面 B 双契约)
- axum 0.8 + pglite:12 张表,多应用按 App-Code 头解析 f_system_id 隔离
- 面 A(ssw/react 形状)+ 面 B(官方 JNPF 形状,Vue-Version: 3)双契约并存
- 业务模块 asset/DataResource;面 B 用户 CRUD 9 条已落地
- 六道闸门 + 两把运行时尺子(perm-smoke 43 / perm-smoke-jnpf 23)
- scripts/:前端接口清单、页面依赖反查、运行时探针
2026-10-30 22:08:31 +08:00

49 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# references/
**用途**:迁 JNPF 时可复用的**通用基础设施源码** — 这些类不在 jnpf-common-all 里,
但 ssw-jnpf-lite-react 的实战用过并验证可工作。稳定期迁业务模块时按需拷贝。
> 自包含:**不**依赖任何本技能外的 `ssw-*` 类。BaseCrudController 不绑死任何权限框架 / 数据范围
> 解析器 / 审计服务 — 这些由子类按需 override 提供。
## 当前收录
| 类 | 用途 |
|---|---|
| `BaseCrudController.java` | 通用 CRUD 骨架(List / Page / Detail / Create / Update / Delete + 关键字 / 过滤 / 数据范围 / 租户 / 可选审计)。业务 Controller `extends BaseCrudController<T>` 即可省去样板。**不是 JNPF 官方类。** |
## 使用方式
迁某个业务模块到 JNPF 时:
1. 把 `BaseCrudController.java` 拷到目标工程的 `ssw.common.controller` 包(**推荐放共享层**,让多个 `-controller` 子模块复用)
2. 业务 Controller `extends BaseCrudController<T>`,覆写方法:
- `service()`、`newEntity()`(必选)
- `keywordColumns()`、`filterColumns()`(可选)
- `beforeSave(entity, create)`(可选,业务校验)
- `requireMenuPermission()`、`applyDataScope()`(可选;权限 / 数据范围由子类按需实现,本基类不绑死任何权限框架)
3. 配套 import:`import jnpf.base.{ActionResult, Pagination, vo.PaginationVO}`;
`import jnpf.util.{RandomUtil, UserProvider, JsonUtil}`。
> 包命名约定见 `../template-boot-jnpf/README.md`「包命名约定」节 — `BaseCrudController` 必须放 `ssw.common.controller`,
> 业务 Controller 放 `ssw.{yourAppCode}.controller`。
## 默认 noop 的扩展钩子
| 钩子 | 默认行为 | 何时 override |
|------|----------|---------------|
| `requireMenuPermission()` | 空实现(不检查) | 需要菜单级权限时(自注 `@PreAuthorize` / Sa-Token `@SaCheckPermission` / 调 jnpf 自带守卫均可) |
| `applyDataScope(wrapper, request)` | 空实现(不过滤) | 需要按用户数据范围过滤时(往 wrapper 拼 SQL) |
| `audit(action, bizId, target)` | 空实现(不记) | 需要审计日志时(写日志表 / 调 MQ / HTTP 第三方) |
> **重要**:本基类**不**自带任何权限 / 数据范围 / 审计服务 — 全部默认 noop,按需覆盖。
> 不要期望拷过来就有这些能力。
## 为什么不放在主目录 / 不集成进 jnpf-common-all
- 这些类属于**业务脚手架**,不是 JNPF 官方提供的公共组件;
- 形态与具体业务耦合(如 `auditBizType()` 默认从实体类名推导);
- JNPF 官方**只承诺**提供底层基元(SuperEntity/SuperMapper/SuperService/SuperServiceImpl/ActionResult),
不提供这种「一键 CRUD」基类。
- 因此稳定期迁每个业务模块都要带一份 `BaseCrudController.java` 过去,本目录即「免去到处找」的
内置副本。