# xly（小羚羊）ERP — 框架 Wiki

面向 **xly** 印刷行业 ERP 框架的开发者指南。

## 这个 Wiki 是什么，不是什么

**本 Wiki 讲的是框架本身**，不是构建在框架之上的业务模块。xly 是一个数据驱动、低代码的 ERP 平台：PM（非开发人员）通过**元数据表中的行**（`gdsmodule`、`gdsconfigformmaster` 等）定义表单、数据表、工作流和报表。运行时（Spring Boot + MyBatis + 大量存储过程层）解释这些行，并把它们渲染成可用的应用。

本 Wiki 解释**这个闭环如何工作**：**后台**中的配置动作如何修改元数据，运行时如何读取元数据、分发到存储过程并写入业务数据，以及客户如何在**前台**中使用结果。

业务模块（财务、生产、报价、销售）只作为**贯穿示例**出现，用来证明框架概念确实产生了行为；它们不会成为独立章节的主体。

## 阅读路径

本 Wiki 用同一套结构服务两类读者：

- **配置人员路径**（你是使用 xly 定义模块的 PM / 实施）：→ [心智模型](concepts/index.md) → [垂直切片](slices/index.md) → [参考（配置人员）](reference/builder/index.md) → 需要具体表或存储过程时查 [自动目录](auto-catalog/index.md)。
- **维护人员路径**（你是维护框架本身的 Java 开发）：→ [心智模型](concepts/index.md) → [垂直切片](slices/index.md) → [参考（维护人员）](reference/maintainer/index.md) → 其他细节查 [自动目录](auto-catalog/index.md)。

两条路径共享同一套心智模型和切片章节，区别只是深入阅读哪个参考章节。

## 不覆盖的范围

- B2B 印刷平台层（`plat_*` 表、`xlyPlat*` 模块）。
- AI / LLM 功能（`ai_*` 表、`AiController`），太新且仍在变化。
- 人脸识别（`xlyFace`），范围较窄。
- `xlyweberp_*` 数据库之间的租户级 schema 漂移；本 Wiki 针对一个 schema。
- 备份表（`*_bak`、`*0302` 等）。
- MongoDB 文档存储（yaml profile 中的 `spring.data.mongodb.uri`，以及 `xlyEntity/.../mongo/` 下的文档类）。每个 `@Document` 类都是 `PLAT_*` 命名，每个 `MongoTemplate` 调用方都位于 `xlyPlat*` 模块中，因此 MongoDB 属于上面的 plat 层。本 Wiki 覆盖的框架层只讨论 MySQL。

## 如何修正这个 Wiki

编辑 Markdown 文件即可，这些文件就是 Wiki 的源。MkDocs Material 会从这些 `.md` 文件生成静态 HTML。重新生成命令和 pre-commit hook 见 [参与维护](contributing/index.md)。