主题
术语表
这里收录 78 个在本仓反复出现的术语。一个术语只给一句话,解释到「能继续读下一页」为止;想深挖就点最后一列的落点。
1. 怎么用这张表
- 读文档卡住时,先按
Ctrl+F搜术语,不要从头读。 - 第 4 列是「本仓落点」:能点的是页面,不能点的是类名或表名,复制到 IDE 里搜。
- 同一概念在不同层有不同叫法(如「功能权限」≈「权限点」),第 5 节专门列了易混组。
- 本表只解释本仓实际存在的东西;标了「未使用」「未建模」的,就是现状,不要按上游项目假设。
2. 产品与项目管理
组内按拼音排序;拉丁缩写排在组末。
| 术语 | 英文 / 缩写 | 一句话解释 | 本仓落点 |
|---|---|---|---|
| 场景 | Scenario | 角色在特定目标下的一段业务活动 | 角色与场景 |
| 功能点 | Feature | 知识库里的最小业务单元,用 ID 对齐产品与代码 | 能力地图 |
| 功能卡 | Feature Card | 一个功能点的接口、表、权限点与代码定位单页 | 功能卡索引 |
| 关键流程 | Key Flow | 跨模块的端到端业务链路,如开通租户 | 关键流程 |
| 规划中 | Planned | 只有需求与决策、尚无代码的能力状态 🚧 | 路线图与决策 |
| 领域模型 | Domain Model | 实体、关系与边界,如用户-角色-菜单 | 领域模型 |
| 路线图 | Roadmap | 能力按版本投放的顺序与依赖 | 路线图与决策 |
| 里程碑 | Milestone | 阶段交付节点,用于对齐范围与验收 | 项目管理知识框架 |
| 能力地图 | Capability Map | 113 项能力按已实现 / 预留 / 规划分层 | 能力地图 |
| 业务角色 | Business Role | 使用系统的人,如管理员、运营,不是权限角色 | 角色与场景 |
| 验收标准 | Acceptance Criteria | 可自检的完成定义,写清输入、输出与边界 | 练习与自测 |
| 预留模块 | Reserved Module | 源码在库但 pom 注释、不参与构建的 13 个模块 | 预留模块概览 |
| PRD | Product Requirements Document | 立项需求原件,知识库只引用不改写 | PRD 产品概述 |
| WBS | Work Breakdown Structure | 工作分解结构,对应任务树 / 计划能力 | 项目管理知识框架 |
3. 平台与权限
| 术语 | 英文 / 缩写 | 一句话解释 | 本仓落点 |
|---|---|---|---|
| 按钮权限 | Button Permission | system_menu 中 type=3 的记录,只挂权限点与按钮 | MenuTypeEnum.BUTTON |
| 部门 | Dept | 组织树节点,也是数据权限的默认维度 | DeptDO(system_dept) |
| 超管 | Super Admin | 角色码 super_admin,权限判断直接放行 | RoleServiceImpl#L241 |
| 菜单 | Menu | 目录 / 菜单 / 按钮三级,permission 字段挂权限点 | MenuDO(system_menu) |
| 短信渠道 | SMS Channel | 短信服务商账号与签名配置,发送时按渠道取 | SmsChannelDO(system_sms_channel) |
| 岗位 | Post | 用户的任职标记,参与展示、导出与筛选 | PostDO(system_post) |
| 岗位职级 | Post Level | 本仓未单独建模,仅用岗位的 sort 表达顺序 | PostDO(无 level 字段) |
| 公告 | Notice | 面向全员的通知发布,可置顶与定时 | NoticeDO(system_notice) |
| 角色 | Role | 权限集合的载体,用户通过角色获得菜单与权限点 | RoleDO(system_role) |
| 邮件模版 | Mail Template | 邮件正文模板,变量占位后由发送服务渲染 | MailTemplateDO(system_mail_template) |
| 权限点 | Permission | 形如 system:user:create 的最小校验单位 | MenuDO.permission |
| 社交登录 | Social Login | 微信、钉钉等第三方身份换取本系统令牌 | SocialUserDO(system_social_user) |
| 套餐 | Tenant Package | 租户可用的菜单集合,开通时裁剪 | TenantPackageDO(system_tenant_package) |
| 数据权限 | Data Permission | 按部门 / 自定义范围过滤行,区别于功能权限 | DeptDataPermissionRule |
| 刷新令牌 | Refresh Token | 短期访问令牌过期后换取新令牌的长期凭证 | AuthController#L85-L91 |
| 令牌 | Token / JWT | 请求头携带的登录凭证,服务端校验后建上下文 | OAuth2AccessTokenDO、TokenAuthenticationFilter |
| 租户 | Tenant | 一套独立数据空间的客户单位,业务表带 tenant_id | TenantBaseDO、TenantContextHolder |
| 租户忽略 | @TenantIgnore | 标记全局表 / 方法,SQL 不拼 tenant_id | TenantDatabaseInterceptor#L46 |
| 站内信 | Notify Message | 站内通知,模板与消息分表存储 | NotifyMessageDO(system_notify_message) |
| 字典 | Dict | 枚举型下拉的库内配置,按类型分组 | DictTypeDO / DictDataDO |
| OAuth2 | OAuth 2.0 | 授权码等模式的令牌协议,本仓作客户端 | OAuth2ClientDO(system_oauth2_client) |
| SSO | Single Sign-On | 本仓无独立 SSO 服务端,靠 OAuth2 客户端对接 | OAuth2ClientDO、AuthController#L66 |
| 验证码 | Captcha | 滑块 / 点选验证,答案存 Redis,默认 blockPuzzle | application.yaml#L103-L118 |
4. 数据与持久化
| 术语 | 英文 / 缩写 | 一句话解释 | 本仓落点 |
|---|---|---|---|
| 代码生成 | Codegen | 由表结构生成 CRUD 代码、页面与 SQL 片段 | CodegenEngine |
| 读写分离 | Read-Write Splitting | 主库写、从库读,用 @DS("slave") 切换 | application-local.yaml#L70-L74 |
| 多数据源 | Dynamic DataSource | 运行时可增删的数据库连接,按 @DS 切换 | DataSourceConfigDO(infra_data_source_config) |
| 分页 | Pagination | 页码 / 页大小 + total,插件自动拼 limit | PageParam、PageResult |
| 类型处理器 | TypeHandler | Java 集合 / 对象与 JSON 列互转 | JacksonTypeHandler(AdminUserDO#L61) |
| 逻辑删除 | Logical Delete | deleted 标记,查询自动过滤、删除只改标记 | BaseDO#deleted |
| 审计字段 | Audit Fields | creator / create_time / updater / update_time 四件套 | BaseDO |
| 事务 | Transaction | 多表写入同成功或同回滚 | AdminUserServiceImpl#L96 |
| 数据源 | Data Source | 业务库或从库的连接配置,含主从与租户库 | DataSourceConfigDO |
| 树表 | Tree Table | parent_id 自关联的层级表,代码生成类型 2 | CodegenTemplateTypeEnum.TREE |
| 雪花 ID | Snowflake ID | 全局唯一 long 主键,避免分库分表冲突 | IdTypeEnvironmentPostProcessor |
| 主子表 | Master-Detail | 一张主表带明细表,模板类型 10 / 11 / 12 | CodegenTemplateTypeEnum |
| DDL | Data Definition Language | 建表 / 改表语句,本仓集中在一个 SQL 文件 | sql/mysql/pmforge.sql#L5021 |
| DO | Data Object | 与表一一对应的持久化对象 | AdminUserDO |
| Mapper | MyBatis Mapper | 数据访问接口,继承 BaseMapperX 获得通用 CRUD | AdminUserMapper |
| VO | View Object | 接口入参 / 出参对象,承载校验与展示字段 | UserSaveReqVO |
5. 中间件与运维
| 术语 | 英文 / 缩写 | 一句话解释 | 本仓落点 |
|---|---|---|---|
| 错误码 | Error Code | 10 位数字,类型 + 系统 + 模块 + 序号,按段分配 | GlobalErrorCodeConstants、ServiceErrorCodeRange |
| 定时任务 | Scheduled Job | Quartz 调度 + 业务 JobHandler,日志落 infra_job_log | SchedulerManager |
| 分布式锁 | Distributed Lock | 多实例互斥,基于 Redis,注解 @Lock4j | PmforgeLock4jConfiguration |
| 加密传输 | API Encrypt | 请求 / 响应体加解密,注解 @ApiEncrypt 开启 | ApiEncryptFilter |
| 幂等 | Idempotency | 同一请求重复执行只生效一次,注解 @Idempotent | IdempotentAspect |
| 限流 | Rate Limit | 按用户 / IP / 表达式限制单位时间调用次数 | RateLimiterAspect |
| 验签 | Signature Verification | 开放接口按密钥与时序签名,防篡改与重放 | ApiSignatureAspect |
| 自动配置 | Auto-configuration | 通过 imports 文件按条件装配 Bean | AutoConfiguration.imports |
| Actuator | Spring Boot Actuator | 生产就绪端点,本仓挂在 /actuator 下 | application-local.yaml#L148-L159 |
| API 日志 | API Access Log | 记录请求、响应、耗时与异常,异步落库 | ApiAccessLogFilter |
| BOM | Bill of Materials | 统一管理依赖版本的父 pom | pmforge-dependencies |
| Cron | Cron Expression | 6 段调度表达式,秒级,非法时拒绝保存 | CronUtils |
| Flyway / Liquibase | DB Migration Tool | 本仓未使用,DDL 由 sql/ 手工执行 | sql/mysql/pmforge.sql |
| JobHandler | Job Handler | 任务执行接口,Bean 名即 handler_name | JobHandler(starter-job#L31) |
| OpenTelemetry | OTel | 链路追踪 API / SDK,生成 traceId 与 span | PmforgeTracerAutoConfiguration#L36 |
| Profile | Spring Profile | 环境配置开关,默认 local | application.yaml#L6 |
| Prometheus / Metrics | Metrics | Micrometer 指标,暴露给 Prometheus 抓取 | PmforgeMetricsAutoConfiguration |
| Pub/Sub | Publish / Subscribe | Redis 频道广播,在线即收、不持久化 | AbstractRedisChannelMessage |
| RabbitMQ | RabbitMQ | 可选消息中间件,生产端自动透传租户 | TenantRabbitMQMessagePostProcessor |
| Redis | Redis | 缓存、会话、验证码、限流与消息的共用底座 | PmforgeRedisAutoConfiguration |
| Starter | Spring Boot Starter | 可插拔能力包,含 core 与 config 两部分 | pmforge-framework/* |
| Stream | Redis Stream | 带消费组与 ACK 的持久化消息队列 | AbstractRedisStreamMessage |
| Trace | Trace ID | 一次请求的全局标识,写在响应头并入库 | TraceFilter#L28 |
| WebSocket | WebSocket | 长连接推送,路径 /infra/ws,五种 sender | WebSocketSessionManagerImpl |
| XSS | Cross-Site Scripting | 跨站脚本过滤,默认开启,可配开关 | XssFilter |
6. 最容易混的 10 组
- 业务角色 vs 权限角色:前者是「谁在用」(产品层),后者是「能访问什么」(
RoleDO);同一业务角色可以对应多个权限角色。 - 功能权限 vs 数据权限:功能权限决定「能不能调这个接口」,数据权限决定「这次查询能返回哪些行」。
- 权限点 vs 菜单:权限点只是字符串,必须登记在
system_menu.permission才可被反查;没登记就是 403。 - 租户 vs 部门:租户是数据隔离的第一层(
tenant_id),部门是租户内部的第二层(数据权限)。 - 租户忽略 vs 数据权限关闭:
@TenantIgnore关掉租户条件;@DataPermission(enable = false)关掉部门条件,两者互不替代。 - 逻辑删除 vs 物理删除:本仓默认逻辑删除(
deleted),DDL 里的deleted bit(1)不是备份字段。 - DTO vs VO vs DO:DO 对表、VO 对接口、DTO 跨模块传输;功能卡里的「接口」用的是 VO。
- Starter vs 模块:Starter 是框架能力(
pmforge-framework),模块是业务能力(pmforge-module-*)。 - BOM vs parent:BOM 只管版本(
dependencyManagement),parent 还管构建插件与聚合。 - Stream vs Pub/Sub:要可靠、可重放、有消费组用 Stream;只要在线广播、允许丢用 Pub/Sub。
7. 按场景速查
| 我想…… | 先看 |
|---|---|
| 判断一个需求有没有现成能力 | 能力地图 |
| 知道一个功能对应哪些接口和表 | 功能卡索引 |
| 搞清登录后菜单是怎么算出来的 | AuthController#L93-L118 |
| 加一个新权限点 | 鉴权与权限点 |
| 搞清一次请求经过哪些 Filter | 请求处理链路 |
解释为什么查询自动带 tenant_id | 多租户 |
| 让不同部门看到不同数据 | 数据权限 |
| 新建一张表并生成 CRUD | 代码生成闭环 |
| 任务在 local 不执行 | 常见问题 |
| 多实例下消息送不到 | 消息与实时推送 |
| 查一个错误码属于哪个模块 | 错误码段 |
| 看某个配置项的默认值 | 配置项速查 |
8. 相关页面
- 想按角色系统读:阅读路径
- 术语会了但环境起不来:常见问题
- 想看术语怎么落在一条真实链路上:SYS-USER-01