43 lines
1.7 KiB
Markdown
43 lines
1.7 KiB
Markdown
# 6.22 示例模块（example）
|
||
|
||
:::tip 概述
|
||
`gin_example` 是全项目的**规约参考实现**：标准 CRUD + 单图转正 + 字典回填 + 导入导出 + 状态更新，一个模块覆盖 ModuleSpec 常用能力组合。第 3 章以其贯穿讲解。
|
||
:::
|
||
|
||
## 功能清单
|
||
|
||
| 接口 | 权限码 | 说明 |
|
||
|---|---|---|
|
||
| Page / List / Detail | sys:example:* | 标准查询 |
|
||
| Add / Update | sys:example:* | 维护（avatar 转正） |
|
||
| Status | sys:example:status | 单列状态更新（手写） |
|
||
| Delete / BatchDelete | sys:example:* | 软删除 |
|
||
| Import | sys:example:import | Excel 导入（UnmarshalBody + 逐行校验） |
|
||
| Export | sys:example:export | Excel 导出（applyFilters 复用 + 字典翻译） |
|
||
|
||
## 能力示范对照
|
||
|
||
| 能力 | 声明/实现 |
|
||
|---|---|
|
||
| 模糊 + 等值过滤 | LikeFields(name) / EqFields(type,status) |
|
||
| 字典显示名 | SerializeMaps: status → example_status |
|
||
| 单图转正 + 读侧补域名 | FileFields(avatar) + FileSaveDir |
|
||
| 全量表单语义 | exampleToData + 全局钩子 |
|
||
| 手写逻辑 | Status / Import / Export |
|
||
| 逃生舱接口 | ImportReq.UnmarshalBody（multipart） |
|
||
| 提示语定制 | ImportRes.ResMsg（MsgProvider） |
|
||
|
||
## 非租户级说明
|
||
|
||
gin_example 无 tenant_id 列、不在租户白名单——它是平台级示例表。做租户级模块开发时对照 [6.1 用户管理](/zh/modules/user.html) 等租户级模块。
|
||
|
||
## 学习路径
|
||
|
||
1. [3.1–3.11 模块开发实战](/zh/guide/overview.html) 逐文件精读
|
||
2. 对照 [3.11 完整代码清单](/zh/guide/code-list.html) 自检
|
||
3. 用生成器重新生成一遍比对产物
|
||
|
||
## 管理界面
|
||
|
||
`tool/example`：列表 + 编辑 + 导入导出（页面本身也是生成器模板的产物示范）。
|