代码生成器的取舍
从 jeepay 的 codegen 看 DB-first 的收益与代价
读 jeepay(Java 支付系统)源码时,最先撞上的是它那 22 个风格高度统一的实体类——每个字段都要写三样东西:
/** 服务商号 */ // javadoc
@Schema(title = "isvNo", description = "服务商号") // 文档注解
private String isvNo; // 字段声明这种"一眼看出是机器产出"的风格,来自仓库里一个叫 jeepay-z-codegen 的独立工程:连上数据库,把表反向生成 Entity / Mapper / XML / Service。它的取舍相当典型,值得单独记一笔。
先分清方向
这是 DB-first(数据库优先):先写 DDL,再由工具生成 Java 类型。与之相反的是 Code-first:先写实体,由框架推导或管理表结构。方向一旦定下,优缺点基本就被锁死了。
它的好处
1. 机械劳动的量确实够大。 22 张表、数百个字段,而每个字段要写 javadoc、@Schema 文案、字段声明三样,其中文案还高度重复("服务商号"要写两遍)。手写必然漏字段、错字。
2. 把隐式错误消灭在生成阶段。 MyBatis 的列名是字符串,写错既不报编译错、运行也不一定报错,只是那个字段恒为 null,排查成本极高。生成器用统一的命名规则(下划线转驼峰)+ 只在主键处显式写列名,从源头消除这类问题。
3. 团队约定一次配置、全局生效。 这是最容易被低估的一点。那些"反常规"的写法,全部来自生成器里的几行配置:
| 约定 | 配置项 |
|---|---|
时间类型一律 java.util.Date,不用 LocalDateTime | setDateType(DateType.ONLY_DATE) |
tinyint 一律映射成 Byte | 自定义 TypeConvert |
Service 实现类直接叫 XxxService,不带 Impl | setServiceImplName("%sService") |
| 不生成 Service 接口、不生成 Controller | setService(null) / setController(null) |
约定写进生成器,就等于写进了所有实体——人不用记,也记不歪。
4. 多模块共用同一份类型。 支付网关、商户端、运营端依赖同一批实体,"生成 + 搬运"保证它们是同一份产物,而不是各自维护后慢慢漂移。
5. 只自动化没有业务差异的那一层。 生成器刻意不产出 Controller,业务 Service 也只是一个空壳。真正有逻辑的地方全部手写——它只该吃掉"表结构 → Java 类型"的翻译工作。
6. 工具本身零成本。 做成独立工程、不继承父 POM、没有任何模块依赖它,于是它拖进来的那堆依赖(模板引擎、数据库驱动、生成器框架)永远不会进生产包。
它的代价
| 短板 | 表现 |
|---|---|
| 一次性 | 生成完就与生成器脱钩。后续 DDL 变更不会自动同步到实体,只能靠人记得重跑 → "DB 与实体漂移" |
| 工作流粗糙 | 产物落在生成器模块内部,要手工搬到业务模块 |
| 可复现性差 | 自定义模板没进仓库,换个人重跑,产物未必与现有代码一致 |
| 产物有噪音 | 空转注解、无意义注释、硬编码的 serialVersionUID |
| 工具会老化 | 旧驱动类名、旧版生成器 API,重跑前往往得先修一下 |
| 能力边界 | 生成器永远产不出业务逻辑,省的是体力活,不是核心工作 |
其他实现方式
两个轴:方向(DB 优先 / 代码优先)与时机(开发期生成 / 编译期生成 / 运行时托管)。
| 方案 | 类型 | 产出 | 差异 |
|---|---|---|---|
| 手写 | DB 优先 | 无 | 字段少时最快最可控;表多时不现实 |
| MyBatis Generator | DB 优先·开发期 | 实体 + Example 条件类 + Mapper | 官方老牌工具,配置与插件体系更重 |
| MyBatisX 插件 | DB 优先·开发期 | 同生成器 | 图形化,可直接输出到目标模块,补掉"手工搬运"短板 |
| jOOQ | DB 优先·开发期 | 类型安全 SQL DSL | 连 SQL 也编译期校验;代价是学习曲线与授权成本 |
| Hibernate Tools | DB 优先·开发期 | JPA 实体 | 面向 JPA 生态 |
| Spring Data JPA | 代码优先 | 只需一个接口 | 连 Mapper 都不用生成,但要接受 ORM 的隐性成本(懒加载、N+1) |
| Lombok / MapStruct | 编译期生成(APT) | getter、映射代码 | 不往源码树落文件,从根上没有"生成物漂移" |
| Flyway / Liquibase | 正交工具 | DDL 版本化与迁移 | 方向相反,管的是表结构演进,可与生成器并用 |
看得再透一点
为什么这类生成器可以做得这么薄?因为 MyBatis-Plus 的 BaseMapper<T> 已经把单表 CRUD 自动化了,实体对应的 Mapper 接口几乎是空的。没有这层兜底,生成器就得吐出成百上千行 CRUD 语句;有了它,生成器只需解决"表结构 → Java 类型"这一件事。
选型结论
- 表多、结构稳定、团队约定强 → 用生成器,但要把模板提交进仓库,并用 MyBatisX 之类的插件省掉手工搬运
- 表少或字段少 → 手写
- 复杂查询多、希望 SQL 也类型安全 → jOOQ
- 想写最少的代码 → Spring Data JPA,前提是接受 ORM 的隐性成本
- 无论选哪种,都建议用 Flyway / Liquibase 管 DDL 演进——这才是"生成物与数据库漂移"的根治办法
最后编辑于