Compare commits

15 Commits
v1 ... main

Author SHA1 Message Date
iqudoo
b827f0e4d0 ini 2026-05-23 21:33:41 +08:00
iqudoo
45f5300e42 fix 2026-05-23 19:39:11 +08:00
iqudoo
c27a2433be fix 2026-05-23 19:34:44 +08:00
iqudoo
88fa1c88dd init 2026-05-23 19:27:01 +08:00
iqudoo
748ebad0c4 优化 2026-04-24 16:07:50 +08:00
iqudoo
4d7e0eab85 日志和变更记录,使用table name 2026-04-21 16:31:56 +08:00
iqudoo
ef0704a45e 插件 2026-04-20 23:27:05 +08:00
iqudoo
908d7333ab 优化 2026-04-17 15:49:30 +08:00
iqudoo
b6e4ab65e7 readme 2026-04-17 13:25:37 +08:00
iqudoo
94360e50b9 readme 2026-04-17 13:23:32 +08:00
iqudoo
ac8bd3c556 readme 2026-04-17 13:22:43 +08:00
iqudoo
6423803562 readme 2026-04-17 13:19:33 +08:00
iqudoo
a73e969431 支持表级配置 2026-04-17 13:15:49 +08:00
iqudoo
ac547d2a57 ifx 2026-04-17 03:57:39 +08:00
iqudoo
e547f645a6 优化:
乐观锁支持配置,数据字段级日志,慢SQL日志
2026-04-17 03:54:01 +08:00
5 changed files with 939 additions and 584 deletions

380
README.md
View File

@@ -1,92 +1,126 @@
# tape-mybatis-generator-plugin # tape-mybatis-generator-plugin
> MyBatis 代码生成插件
> MyBatis 代码生成插件(基于 MyBatis Generator **1.4.1** 开发Maven 插件建议使用 **1.4.0+**
## 功能特性 ## 功能特性
本插件为 MyBatis Generator 提供了以下增强功能: 本插件为 MyBatis Generator 提供了以下增强功能:
1. **TapeMybatisGeneratorPlugin** - 扩展 MyBatis Mapper,添加 `selectPrimaryKeyByExample`, `batchInsert` 方法,拓展查询分页支持 1. **TapeMybatisGeneratorPlugin** 扩展 Mapper`selectPrimaryKeyByExample``batchInsert`)与 Example分页、回收站筛选等
2. **TapeRepositoryGeneratorPlugin** - 为非视图表自动生成 Repository 接口实现,提供完整的 CRUD软删除功能 2. **TapeTableRepositoryGeneratorPlugin** 为非视图表生成 Repository 接口实现,提供 CRUD软删除与回收站
3. **TapeRepoviewGeneratorPlugin** - 为视图表自动生成 RepoView 接口实现,提供查询功能 3. **TapeViewRepositoryGeneratorPlugin** 为视图表生成 View Repository 接口实现,提供只读查询
**视图表识别**:通过 JDBC 元数据 `tableType == "VIEW"` 判断;非视图表与视图表由不同插件分别生成代码。
**运行时依赖**:生成的 Repository 使用 Spring `@Repository``@Resource` 及 SLF4J使用方项目需引入对应依赖。
## 插件说明 ## 插件说明
### TapeMybatisGeneratorPlugin ### TapeMybatisGeneratorPlugin
扩展 MyBatis Mapper添加以下功能
- 在 Mapper 接口中添加 `selectPrimaryKeyByExample` 方法
- 在 Mapper XML 中生成对应的 SQL 查询语句
### TapeRepositoryGeneratorPlugin 扩展 MyBatis Mapper 与 Example 类:
为非视图表生成 Repository 层代码:
- **接口位置**: `{facadeRepositoryPackage}.I{TableName}Repository`
- **实现类位置**: `{domainRepositoryPackage}.{TableName}RepositoryImpl`
- **视图表过滤**: 根据 `viewKeyWords` 配置自动识别并跳过视图表
**生成的方法** **Mapper 接口 / XML**
- `trashById(long id)` - 移动到回收站(单个)
- `trashAll({Example} example)` - 移动到回收站(批量)
- `deleteById(long id, boolean release)` - 删除(单个,支持物理删除)
- `deleteAll({Example} example, boolean release)` - 删除(批量,支持物理删除)
- `recoverById(long id)` - 从回收站恢复(单个)
- `recoverAll({Example} example)` - 从回收站恢复(批量)
- `findAnyById(long id)` - 查找(不区分有效/回收站)
- `findValidById(long id)` - 查找有效记录(单个)
- `findTrashById(long id)` - 查找回收站记录(单个)
- `findValidOne({Example} example)` - 查找有效记录(单个,支持条件)
- `findTrashOne({Example} example)` - 查找回收站记录(单个,支持条件)
- `getValidList({Example} example)` - 获取有效记录列表(支持分页)
- `getTrashList({Example} example)` - 获取回收站记录列表(支持分页)
- `countByValid({Example} example)` - 统计有效记录数
- `countByValidWithPage({Example} example)` - 统计分页有效记录数
- `countByTrash({Example} example)` - 统计回收站记录数
- `countByTrashWithPage({Example} example)` - 统计分页回收站记录数
- `insert({Model} record)` - 插入记录(自动生成 GUID、设置默认值
- `batchInsert(List<{Model}> records)` - 批量插入记录(自动生成 GUID、设置默认值
- `updateByExampleSelective({Model} record, {Example} example)` - 按条件更新记录
- `update({Model} record)` - 更新记录(支持乐观锁)
### TapeRepoviewGeneratorPlugin - `selectPrimaryKeyByExample(Example)` — 按条件查询主键列表(支持 Example 分页 `limit`
为视图表生成 RepoView 层代码: - `batchInsert(List<Model>)` — 批量插入,返回影响行数
- **接口位置**: `{facadeRepoviewPackage}.I{TableName}Repo`
- **实现类位置**: `{domainRepoviewPackage}.{TableName}RepoImpl`
- **视图表识别**: 仅处理包含 `viewKeyWords` 关键字的表
**生成的方法** **Mapper XML 动态 SQL**
- `findOne({Example} example)` - 查找单条记录
- `getList({Example} example)` - 获取记录列表(支持分页)
- `count({Example} example)` - 统计记录数
### 其他功能 -`selectByExample``selectByExampleWithBLOBs``selectAll` 等查询追加 `limit` 片段(`rows` / `offset`
通过 `TapeMybatisGeneratorPlugin` 为所有 Example 类添加支持:
**添加的字段** ### TapeTableRepositoryGeneratorPlugin
- `offset` - 偏移量
- `rows` - 每页数量
- `startPageNum` - 最小页码(默认 1
- `ignorePageSize` - 忽略分页数量(默认 10000每页数量大于10000时忽略分页
- `maxPageSize` - 最大每页数量(默认 100
- `withBLOBs` - 是否返回BLOBs列的数据
**添加的方法** 为非视图表生成 Repository类名后缀由 `domainRepositoryType` 控制,默认 `Repository`
- `limit(int rows)` - 设置每页数量
- `limit(int offset, int rows)` - 设置偏移量和每页数量 - **接口**`{facadeRepositoryPackage}.I{TableName}{domainRepositoryType}`
- `usePage(int pageNum, int pageSize)` - 使用页码和每页数量(自动计算 offset - **实现**`{domainRepositoryPackage}.{TableName}{domainRepositoryType}Impl`
- `setWithBLOBs(boolean withBLOBs)` - 设置是否返回BLOBs列的数据
- `isWithBLOBs()` - 是否返回BLOBs列的数据 示例(默认后缀):`IYourTableNameRepository``YourTableNameRepositoryImpl`
- `getPageNum()` - 获取当前页码
- `getPageSize()` - 获取当前每页数量 **生成的方法**(均声明 `throws Throwable`
- `getOffset()` - 获取当前分页limit的offset
- `getRows()` - 获取当前分页limit的rows | 方法 | 说明 |
|------|------|
| `trashById(long id)``int` | 移入回收站(`is_hidden=1` |
| `trashAll(Example)``int` | 批量移入回收站;自动限定 `is_delete=0``is_hidden=0` |
| `deleteById(long id, boolean release)``int` | `release=false` 软删;`release=true` 物理删除 |
| `deleteAll(Example, boolean release)``int` | `release=false` 仅软删回收站中记录(`is_hidden=1``release=true` 直接 `deleteByExample` |
| `recoverById(long id)``int` | 从回收站恢复 |
| `recoverAll(Example)``int` | 批量恢复;自动限定 `is_delete=0``is_hidden=1` |
| `findAnyById(long id)``Model` | 未删除(`is_delete=0`),不区分是否在回收站 |
| `findValidById(long id)``Model` | 有效数据(`is_hidden=0``is_delete=0` |
| `findTrashById(long id)``Model` | 回收站数据(`is_hidden=1``is_delete=0` |
| `findOne(Example)``Model` | 单条(内部 `usePage(1,1)` |
| `getList(Example)``List<Model>` | 列表;按 `resultType` 过滤;含 BLOB 且分页时先查主键再查详情 |
| `count(Example)``long` | 计数(含 `resultType` 过滤) |
| `countWithPage(Example)``long` | 仅当 `offset``rows` 均已设置时调用 `count`,否则返回 `0` |
| `insert(Model)``Model` | 插入并返回带 GUID 的记录 |
| `batchInsert(List<Model>)``List<Model>` | 批量插入并返回记录列表 |
| `update(Model)``int` | 按主键更新(支持乐观锁) |
| `updateByExampleSelective(Model, Example)``int` | 按条件选择性更新 |
### TapeViewRepositoryGeneratorPlugin
为视图表生成 View Repository类名后缀由 `domainViewRepositoryType` 控制,默认 `Repository`
- **接口**`{facadeViewRepositoryPackage}.I{TableName}{domainViewRepositoryType}`
- **实现**`{domainViewRepositoryPackage}.{TableName}{domainViewRepositoryType}Impl`
示例(默认后缀):`IYourTableNameRepository``YourTableNameRepositoryImpl`
**生成的方法**(均声明 `throws Throwable`
| 方法 | 说明 |
|------|------|
| `findOne(Example)``Model` | 单条 |
| `getList(Example)``List<Model>` | 列表(支持 Example 分页;含 BLOB 时按 `withBLOBs` 选择查询方法) |
| `count(Example)``long` | 计数 |
| `countWithPage(Example)``long` | 行为同表 Repository |
### Example 类增强TapeMybatisGeneratorPlugin
**所有表/视图共有的字段与方法**
| 字段 / 方法 | 说明 |
|------------|------|
| `offset``rows` | 分页偏移与条数 |
| `startPageNum` | 起始页码(默认 `1`,表级可覆盖) |
| `ignorePageSize` | `usePage` 时若 `pageSize >=` 该值则取消分页(默认 `10000` |
| `maxPageSize` | `usePage` 时每页上限(默认 `100` |
| `limit(rows)` / `limit(offset, rows)` | 设置分页 |
| `limitOffset(offset, rows)` | 设置 offset`rows` 置为极大值(仅偏移) |
| `usePage(pageNum, pageSize)` | 按页码计算 offset/rows |
| `getPageNum()` / `getPageSize()` / `getOffset()` / `getRows()` | 读取分页状态;未设 `rows``getPageSize()` 返回 `ignorePageSize` |
| `getLimitString()` / `getWhereString()` | 调试用 limit/where 字符串 |
| `cloneExample()` | 克隆条件与分页状态 |
| `get/setMaxPageSize``get/setIgnorePageSize``get/setStartPageNum` | 分页参数读写 |
**仅非视图表额外支持**
| 字段 / 方法 | 说明 |
|------------|------|
| `resultType` | `null`(默认,等同有效数据)、`any``trash``valid` |
| `setResultType` / `resultAny` / `resultTrash` / `resultValid` | 设置筛选类型 |
| `isResultAny` / `isResultTrash` / `isResultValid` | `isResultValid` 在既非 any 也非 trash 时为 true`resultType==null` |
**仅含 BLOB 列的表/视图**
| 字段 / 方法 | 说明 |
|------------|------|
| `withBLOBs` | 默认 `true` |
| `setWithBLOBs` / `isWithBLOBs` | 是否查询 BLOB 列 |
`getList` / `count` 在表 Repository 中会根据 `resultType` 自动附加 `is_hidden``is_delete` 条件。
## 使用方法 ## 使用方法
### 1. 在 `pom.xml` 中配置插件 ### 1. 在 `pom.xml` 中配置插件
```xml ```xml
<build> <build>
<finalName>application</finalName> <finalName>application</finalName>
<plugins> <plugins>
<!-- your other plugins -->
<!-- add mybatis plugin -->
<plugin> <plugin>
<groupId>org.mybatis.generator</groupId> <groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId> <artifactId>mybatis-generator-maven-plugin</artifactId>
@@ -128,88 +162,145 @@
### 2. 在 `mybatis.generator.xml` 中配置插件 ### 2. 在 `mybatis.generator.xml` 中配置插件
```xml ```xml
<context id="Mysql" targetRuntime="MyBatis3"> <context id="Mysql" targetRuntime="MyBatis3">
<!-- 配置属性 -->
<property name="targetProject" value="src/main/java"/> <property name="targetProject" value="src/main/java"/>
<property name="modelPackage" value="com.iqudoo.platform.application.database.model"/>
<property name="mapperPackage" value="com.iqudoo.platform.application.database.mapper"/> <property name="mapperPackage" value="com.iqudoo.platform.application.database.mapper"/>
<property name="modelPackage" value="com.iqudoo.platform.application.database.model"/>
<property name="facadeRepositoryPackage" value="com.iqudoo.platform.application.facade.repository"/> <property name="facadeRepositoryPackage" value="com.iqudoo.platform.application.facade.repository"/>
<property name="domainRepositoryPackage" value="com.iqudoo.platform.application.domain.repository"/> <property name="domainRepositoryPackage" value="com.iqudoo.platform.application.domain.repository"/>
<property name="domainRepositoryType" value="Repository"/>
<property name="facadeViewRepositoryPackage" value="com.iqudoo.platform.application.facade.repoview"/> <property name="facadeViewRepositoryPackage" value="com.iqudoo.platform.application.facade.repoview"/>
<property name="domainViewRepositoryPackage" value="com.iqudoo.platform.application.domain.repoview"/> <property name="domainViewRepositoryPackage" value="com.iqudoo.platform.application.domain.repoview"/>
<property name="domainViewRepositoryType" value="Repository"/>
<property name="guidGeneratorClass" value="com.iqudoo.framework.tape.modules.utils.SnowflakeUtil"/> <property name="guidGeneratorClass" value="com.iqudoo.framework.tape.modules.utils.SnowflakeUtil"/>
<property name="guidGeneratorCode" value="SnowflakeUtil.nextId()"/> <property name="guidGeneratorCode" value="SnowflakeUtil.nextId()"/>
<property name="changeLogContextClassPackage" value="com.iqudoo.platform.application.domain.changeLog"/> <property name="changeLogContextClassPackage" value="com.iqudoo.platform.application.domain.changeLog"/>
<property name="changeLogContextClassName" value="ChangeLogContext"/> <property name="changeLogContextClassName" value="ChangeLogContext"/>
<property name="changeLogEnable" value="true"/> <property name="changeLogEnable" value="false"/>
<property name="slowQueryLoggerTime" value="300"/> <property name="slowQueryLoggerTime" value="300"/>
<property name="slowQueryLoggerLevel" value="error"/> <property name="slowQueryLoggerLevel" value="error"/>
<property name="priorityPrimaryKeyOffset" value="100"/> <property name="optimisticLockEnable" value="true"/>
<property name="ignorePageSize" value="10000"/> <property name="ignorePageSize" value="10000"/>
<property name="startPageNum" value="1"/> <property name="startPageNum" value="1"/>
<property name="maxPageSize" value="100"/> <property name="maxPageSize" value="100"/>
<!-- 添加插件 -->
<plugin type="com.iqudoo.framework.mybatis.TapeMybatisGeneratorPlugin"/> <plugin type="com.iqudoo.framework.mybatis.TapeMybatisGeneratorPlugin"/>
<plugin type="com.iqudoo.framework.mybatis.TapeRepositoryGeneratorPlugin"/> <plugin type="com.iqudoo.framework.mybatis.TapeTableRepositoryGeneratorPlugin"/>
<plugin type="com.iqudoo.framework.mybatis.TapeRepoviewGeneratorPlugin"/> <plugin type="com.iqudoo.framework.mybatis.TapeViewRepositoryGeneratorPlugin"/>
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
<plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin"/>
<!-- 其他配置... --> <!-- 其他配置... -->
</context> </context>
``` ```
### 3. 配置参数说明 ### 3. 全局配置参数说明
| 参数名 | 说明 | 默认值 | 必需 | | 参数名 | 说明 | 默认值 | 必需 |
|----------------------------|-------------------------------|---------------------------------------------------------|------| |--------|------|--------|------|
| `targetProject` | 生成代码的目标项目路径 | `src/main/java` | 否 | | `targetProject` | 生成代码的目标项目路径 | `src/main/java` | 否 |
| `modelPackage` | Model 类的包路径 | `com.iqudoo.platform.application.database.model` | 是 | | `mapperPackage` | Mapper 接口包路径 | `com.iqudoo.platform.application.database.mapper` | 是 |
| `mapperPackage` | Mapper 接口的包路径 | `com.iqudoo.platform.application.database.mapper` | 是 | | `modelPackage` | Model 类包路径 | `com.iqudoo.platform.application.database.model` | 是 |
| `facadeRepositoryPackage` | Repository 接口包路径 | `com.iqudoo.platform.application.facade.repository` | 否 | | `facadeRepositoryPackage` | Repository 接口包路径 | `com.iqudoo.platform.application.facade.repository` | 否 |
| `domainRepositoryPackage` | Repository 实现类包路径 | `com.iqudoo.platform.application.domain.repository` | 否 | | `domainRepositoryPackage` | Repository 实现类包路径 | `com.iqudoo.platform.application.domain.repository` | 否 |
| `facadeRepoviewPackage` | RepoView 接口的包路径 | `com.iqudoo.platform.application.facade.repoview` | 否 | | `domainRepositoryType` | 表 Repository 类名后缀 | `Repository` | 否 |
| `snowflakeUtilClass` | 雪花算法ID生成工具类 | `com.iqudoo.framework.tape.modules.utils.SnowflakeUtil` | 否 | | `facadeViewRepositoryPackage` | 视图 Repository 接口包路径 | `com.iqudoo.platform.application.facade.repoview` | 否 |
| `snowflakeUtilGenId` | 雪花算法ID生成方法 | `SnowflakeUtil.nextId()` | 否 | | `domainViewRepositoryPackage` | 视图 Repository 实现类包路径 | `com.iqudoo.platform.application.domain.repoview` | 否 |
| `domainViewRepositoryType` | 视图 Repository 类名后缀 | `Repository` | 否 |
| `guidGeneratorClass` | GUID 生成工具类(需 import | `com.iqudoo.framework.tape.modules.utils.SnowflakeUtil` | 否 |
| `guidGeneratorCode` | GUID 生成表达式(写入生成代码) | `SnowflakeUtil.nextId()` | 否 |
| `changeLogContextClassPackage` | 变更日志上下文包路径 | `com.iqudoo.platform.application.domain.changeLog` | 否 | | `changeLogContextClassPackage` | 变更日志上下文包路径 | `com.iqudoo.platform.application.domain.changeLog` | 否 |
| `changeLogContextClassName` | 变更日志上下文类 | `ChangeLogContext` | 否 | | `changeLogContextClassName` | 变更日志上下文类 | `ChangeLogContext` | 否 |
| `changeLogEnable` | 变更日志监听开关 | `false` | 否 | | `changeLogEnable` | 变更日志开关 | `false` | 否 |
| `slowQueryLoggerTime` | 慢查询日志时间阈值 | `300` | 否 | | `slowQueryLoggerTime` | 慢查询阈值(毫秒) | `300` | 否 |
| `slowQueryLoggerLevel` | 慢查询日志类型errorwarndebuginfo | `error` | 否 | | `slowQueryLoggerLevel` | 慢查询日志级别error / warn / debug / info | `error` | 否 |
| `priorityPrimaryKeyOffset` | 优先查询主键偏移阈值 | `0` | 否 | | `optimisticLockEnable` | 乐观锁开关 | `true` | 否 |
| `ignorePageSize` | 忽略分页阈值 | `10000` | 否 | | `ignorePageSize` | `usePage` 取消分页的 pageSize 阈值 | `10000` | 否 |
| `startPageNum` | 分页始页码 | `1` | 否 | | `startPageNum` | 分页始页码 | `1` | 否 |
| `maxPageSize` | 最大每页数量 | `100` | 否 | | `maxPageSize` | 单页最大条数 | `100` | 否 |
### 4. TABLE 级配置
表级 `<property>` 优先于全局 `<property>`,未配置时回退到全局值。
| 参数名 | 说明 |
|--------|------|
| `changeLogEnable` | 变更日志开关 |
| `slowQueryLoggerTime` | 慢查询阈值(毫秒) |
| `slowQueryLoggerLevel` | 慢查询日志级别 |
| `optimisticLockEnable` | 乐观锁开关 |
| `ignorePageSize` | 取消分页阈值 |
| `startPageNum` | 起始页码 |
| `maxPageSize` | 单页最大条数 |
示例:
```xml
<table tableName="your_table_name"
domainObjectName="YourTableName"
enableInsert="true"
enableDeleteByPrimaryKey="true"
enableUpdateByPrimaryKey="true"
enableCountByExample="true"
enableUpdateByExample="true"
enableDeleteByExample="true"
enableSelectByExample="true"
selectByExampleQueryId="false">
<property name="useActualColumnNames" value="false"/>
<property name="changeLogEnable" value="false"/>
<property name="slowQueryLoggerTime" value="200"/>
<property name="slowQueryLoggerLevel" value="warn"/>
<property name="optimisticLockEnable" value="false"/>
<property name="ignorePageSize" value="10000"/>
<property name="startPageNum" value="1"/>
<property name="maxPageSize" value="100"/>
</table>
```
## 变更日志监听 ## 变更日志监听
ChangeLogContext应该提供以下实现的静态方法Repository实现调用 `changeLogEnable=true` 时,Repository 实现调用 `ChangeLogContext.addLog`。使用方需提供如下静态方法:
```java ```java
public class ChangeLogContext { public class ChangeLogContext {
/** public static void addLog(String tableName, String eventType, Long dataGuid,
* 添加一条变更 Map<String, Object[]> fieldChanges) {
*/ // 自行实现
public static void addLog(String tableName, String eventType, Long dataGuid, Map<String, Object[]> fieldChanges) {
// your thing code
} }
} }
``` ```
**eventType 取值**
| eventType | 触发操作 |
|-----------|----------|
| `insert` | `insert` |
| `batchInsert` | `batchInsert` |
| `update` | `update` |
| `updateByExampleSelective` | `updateByExampleSelective` |
| `deleteById` | `deleteById`(软删) |
| `deleteAll` | `deleteAll`(软删) |
| `trashById` | `trashById` |
| `trashAll` | `trashAll` |
| `recoverById` | `recoverById` |
| `recoverAll` | `recoverAll` |
`fieldChanges``Object[]``[旧值, 新值]`;插入/删除类事件通常为空 `Map`
## 数据库表结构要求 ## 数据库表结构要求
### 标准表结构模板 ### 标准表结构模板
为了使用完整 Repository 功能(软删除、回收站等),表结构需要包含以下标准字段: 使用完整 Repository 功能(软删除、回收站、乐观锁)时,表需包含以下标准字段:
```mysql ```mysql
DROP TABLE IF EXISTS `your_table_name`; DROP TABLE IF EXISTS `your_table_name`;
CREATE TABLE `your_table_name` ( CREATE TABLE `your_table_name` (
`guid` bigint(0) UNSIGNED NOT NULL DEFAULT 0 COMMENT 'GUID', `guid` bigint(0) UNSIGNED NOT NULL DEFAULT 0 COMMENT 'GUID',
-- ---------------------------- -- 业务字段
-- add your table other table field
-- ----------------------------
`is_hidden` int(0) NOT NULL DEFAULT 0 COMMENT '隐藏标志', `is_hidden` int(0) NOT NULL DEFAULT 0 COMMENT '隐藏标志',
`is_delete` int(0) NOT NULL DEFAULT 0 COMMENT '删除标志', `is_delete` int(0) NOT NULL DEFAULT 0 COMMENT '删除标志',
`delete_token` varchar(32) NULL DEFAULT '' COMMENT '删除令牌', `delete_token` varchar(32) NULL DEFAULT '' COMMENT '删除令牌',
@@ -217,34 +308,50 @@ CREATE TABLE `your_table_name` (
`create_time` datetime(0) NOT NULL DEFAULT CURRENT_TIMESTAMP(0) COMMENT '创建时间', `create_time` datetime(0) NOT NULL DEFAULT CURRENT_TIMESTAMP(0) COMMENT '创建时间',
`update_time` datetime(0) NOT NULL DEFAULT CURRENT_TIMESTAMP(0) COMMENT '更新时间', `update_time` datetime(0) NOT NULL DEFAULT CURRENT_TIMESTAMP(0) COMMENT '更新时间',
PRIMARY KEY (`guid`) USING BTREE, PRIMARY KEY (`guid`) USING BTREE,
-- UNIQUE KEY `idx_unique_key` (`you unique key`,`delete_token`) USING BTREE,
-- KEY `idx_common_query` (
-- 等值查询字段,
-- `is_hidden`,`is_delete`,
-- 其他参与排序字段,
-- `create_time` desc,
-- `guid`) USING BTREE
KEY `idx_common_query` (`is_hidden`, `is_delete`, `create_time` desc, `guid`) USING BTREE KEY `idx_common_query` (`is_hidden`, `is_delete`, `create_time` desc, `guid`) USING BTREE
) ENGINE = InnoDB COMMENT = '你的表格备注' ROW_FORMAT = Dynamic; ) ENGINE = InnoDB COMMENT = '你的表格备注'
ROW_FORMAT = Dynamic;
``` ```
**必需字段说明** ### 索引优化指南
- `guid` - 主键,类型为 `bigint UNSIGNED`
- `is_hidden` - 隐藏标志,用于回收站功能
- `is_delete` - 删除标志,用于软删除功能
- `delete_token` - 删除令牌,用于标识删除状态
- `data_version` - 数据版本,用于乐观锁
- `create_time` - 创建时间,自动设置
- `update_time` - 更新时间,自动更新
### 视图表结构 唯一键索引(含 `delete_token` 以支持回收站后重建):
视图表不需要上述标准字段,只需要包含业务字段即可。 ```sql
UNIQUE KEY `idx_your_unique_key` (
`your_unique_key`,
`delete_token`
) USING BTREE
```
查询索引:
```sql
KEY `idx_your_query_case` (
`is_hidden`, `is_delete`,
`create_time` desc,
`guid`
) USING BTREE
```
**标准字段说明**
| 字段 | 说明 |
|------|------|
| `guid` | 主键,`bigint UNSIGNED` |
| `is_hidden` | 回收站标志(`1` = 在回收站) |
| `is_delete` | 软删除标志 |
| `delete_token` | 删除令牌(有效数据为 `VALID`,进回收站后变更) |
| `data_version` | 乐观锁版本号 |
| `create_time` / `update_time` | 插入时自动设置 |
### 视图表
视图表无需上述标准字段,仅需业务列;由 `TapeViewRepositoryGeneratorPlugin` 生成只读 Repository。
### 在 `mybatis.generator.xml` 中配置表 ### 在 `mybatis.generator.xml` 中配置表
```xml ```xml
<!-- 标准表配置 -->
<table tableName="your_table_name" <table tableName="your_table_name"
domainObjectName="YourTableName" domainObjectName="YourTableName"
enableInsert="true" enableInsert="true"
@@ -257,31 +364,16 @@ CREATE TABLE `your_table_name` (
selectByExampleQueryId="false"> selectByExampleQueryId="false">
<property name="useActualColumnNames" value="false"/> <property name="useActualColumnNames" value="false"/>
</table> </table>
<!-- 视图表配置(表名包含 VIEW_ 或 V_ 前缀,大小写不敏感) -->
<table tableName="v_your_view_name"
domainObjectName="ViewYourViewName"
enableInsert="false"
enableDeleteByPrimaryKey="false"
enableUpdateByPrimaryKey="false"
enableCountByExample="true"
enableUpdateByExample="false"
enableDeleteByExample="false"
enableSelectByExample="true"
selectByExampleQueryId="false">
<property name="useActualColumnNames" value="false"/>
<generatedKey column="guid" sqlStatement="JDBC" identity="false"/>
</table>
``` ```
## 注意事项 ## 非视图表注意事项
1. **主键要求**必须有一个主键字段,且字段名为 `guid`,类型 `bigint UNSIGNED` 1. **主键**:必须有名为 `guid` 的主键,类型 `bigint UNSIGNED`
2. **视图表识别**视图表通过表名中的关键字识别,默认关键字为 `view_` `v_` 不区分大小写 2. **视图表判定**JDBC `tableType` `VIEW` 时不会生成表 Repository改由视图插件处理。
3. **分页功能**所有 Example 类都自动包含分页功能,可通过 `usePage()` 方法使用 3. **分页**Example 支持 `usePage()` / `limit()``pageSize >= ignorePageSize` 时不加分页。
4. **乐观锁**更新操作使用 `data_version` 字段实现乐观锁,更新时需要传入正确的版本 4. **乐观锁**`update` 使用 `data_version``optimisticLockEnable=false` 时不校验版本
5. **软删除**删除操作默认软删除(设置 `is_delete` 标志),可通过 `release=true` 参数执行物理删除 5. **软删除**`deleteById` / `deleteAll` 默认软删`is_delete=1``release=true` 物理删除
6. **回收站**通过 `is_hidden` 字段实现回收站功能,`trash` 方法将记录移动到回收站,`recover` 方法恢复记录 6. **回收站**`trash*` 设置 `is_hidden=1``recover*` 恢复为 `is_hidden=0``delete_token=VALID`
7. **自动字段**:插入记录时,插件会自动设置 `guid`(使用雪花算法)、`is_delete``is_hidden``delete_token``data_version``create_time``update_time` 等字段 7. **批量删除**`deleteAll(release=false)` 仅作用于已在回收站的记录。
8. **BLOB 字段支持**:如果表包含 BLOB 字段,插件会自动使用 `selectByExampleWithBLOBs``updateByExampleWithBLOBs` 方法 8. **自动字段**`insert` / `batchInsert` 自动设置 `guid``guidGeneratorCode`)、`is_delete=0``is_hidden=0``delete_token=VALID``data_version=1`、时间戳等。
9. **MyBatis Generator 版本**:本插件基于 MyBatis Generator 1.4.1 开发,建议使用 1.4.0 或更高版本 9. **BLOB**:含 BLOB 列时,`getList` 分页查询先 `selectPrimaryKeyByExample` 再按 GUID 拉取详情;可通过 `withBLOBs` 控制是否查询 BLOB 列。

View File

@@ -11,6 +11,7 @@ import org.mybatis.generator.api.dom.xml.Document;
import org.mybatis.generator.api.dom.xml.TextElement; import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement; import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.config.Context; import org.mybatis.generator.config.Context;
import org.mybatis.generator.config.TableConfiguration;
import org.mybatis.generator.internal.util.StringUtility; import org.mybatis.generator.internal.util.StringUtility;
import java.util.List; import java.util.List;
@@ -54,18 +55,79 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
} }
} }
private int getIgnorePageSize(IntrospectedTable introspectedTable) {
return getTableInt(introspectedTable, "ignorePageSize", ignorePageSize);
}
public int getMaxPageSize(IntrospectedTable introspectedTable) {
return getTableInt(introspectedTable, "maxPageSize", maxPageSize);
}
public int getStartPageNum(IntrospectedTable introspectedTable) {
return getTableInt(introspectedTable, "startPageNum", startPageNum);
}
// ====================== 统一 Table 属性获取(你全类都能用) ======================
private String getTableProperty(IntrospectedTable introspectedTable, String propName, String defaultValue) {
try {
TableConfiguration tc = introspectedTable.getTableConfiguration();
String v = tc.getProperty(propName);
if (StringUtility.stringHasValue(v)) {
return v.trim();
}
} catch (Exception ignored) {
}
return defaultValue;
}
private boolean getTableBool(IntrospectedTable introspectedTable, String propName, boolean defaultValue) {
String v = getTableProperty(introspectedTable, propName, String.valueOf(defaultValue));
try {
return Boolean.parseBoolean(v);
} catch (Exception e) {
return defaultValue;
}
}
private int getTableInt(IntrospectedTable introspectedTable, String propName, int defaultValue) {
String v = getTableProperty(introspectedTable, propName, String.valueOf(defaultValue));
try {
return Integer.parseInt(v);
} catch (Exception e) {
return defaultValue;
}
}
@SuppressWarnings("DuplicatedCode") @SuppressWarnings("DuplicatedCode")
@Override @Override
public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) { public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
topLevelClass.addImportedType(new FullyQualifiedJavaType("java.util.Objects"));
FullyQualifiedJavaType integerType = new FullyQualifiedJavaType("java.lang.Integer"); FullyQualifiedJavaType integerType = new FullyQualifiedJavaType("java.lang.Integer");
FullyQualifiedJavaType booleanType = new FullyQualifiedJavaType("java.lang.Boolean"); FullyQualifiedJavaType booleanType = new FullyQualifiedJavaType("java.lang.Boolean");
FullyQualifiedJavaType stringType = new FullyQualifiedJavaType("java.lang.String"); FullyQualifiedJavaType stringType = new FullyQualifiedJavaType("java.lang.String");
String domainObjectName = introspectedTable.getFullyQualifiedTable().getDomainObjectName();
String exampleClassName = domainObjectName + "Example";
if (!ElementTools.isViewTable(introspectedTable)) {
// any, trash, valid
Field resultType = ElementTools.generateField(
"resultType",
JavaVisibility.PROTECTED,
stringType,
"null"
);
topLevelClass.addField(resultType);
}
// 添加 startPageNum、maxPageSize、ignorePageSize 字段 // 添加 startPageNum、maxPageSize、ignorePageSize 字段
Field maxPageSizeField = ElementTools.generateField( Field maxPageSizeField = ElementTools.generateField(
"maxPageSize", "maxPageSize",
JavaVisibility.PROTECTED, JavaVisibility.PROTECTED,
integerType, integerType,
this.maxPageSize + "" getMaxPageSize(introspectedTable) + ""
); );
topLevelClass.addField(maxPageSizeField); topLevelClass.addField(maxPageSizeField);
@@ -73,7 +135,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
"ignorePageSize", "ignorePageSize",
JavaVisibility.PROTECTED, JavaVisibility.PROTECTED,
integerType, integerType,
this.ignorePageSize + "" getIgnorePageSize(introspectedTable) + ""
); );
topLevelClass.addField(ignorePageSizeField); topLevelClass.addField(ignorePageSizeField);
@@ -81,7 +143,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
"startPageNum", "startPageNum",
JavaVisibility.PROTECTED, JavaVisibility.PROTECTED,
integerType, integerType,
startPageNum + "" getStartPageNum(introspectedTable) + ""
); );
topLevelClass.addField(startPageNumField); topLevelClass.addField(startPageNumField);
@@ -140,6 +202,99 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
Method mGetStartPageNum = ElementTools.generateGetterMethod(startPageNumField); Method mGetStartPageNum = ElementTools.generateGetterMethod(startPageNumField);
FormatTools.addMethodWithBestPosition(topLevelClass, mGetStartPageNum); FormatTools.addMethodWithBestPosition(topLevelClass, mGetStartPageNum);
if (!ElementTools.isViewTable(introspectedTable)) {
// setResultType
Method setResultType = ElementTools.generateMethod(
"setResultType",
JavaVisibility.PUBLIC,
topLevelClass.getType(),
new Parameter(stringType, "type")
);
setResultType = ElementTools.generateMethodBody(
setResultType,
"this.resultType = type;",
"return this;"
);
FormatTools.addMethodWithBestPosition(topLevelClass, setResultType);
// resultValid
Method resultValid = ElementTools.generateMethod(
"resultValid",
JavaVisibility.PUBLIC,
topLevelClass.getType()
);
resultValid = ElementTools.generateMethodBody(
resultValid,
"this.resultType = \"valid\";",
"return this;"
);
FormatTools.addMethodWithBestPosition(topLevelClass, resultValid);
// isResultValid
Method isResultValid = ElementTools.generateMethod(
"isResultValid",
JavaVisibility.PUBLIC,
booleanType
);
isResultValid = ElementTools.generateMethodBody(
isResultValid,
"return !this.isResultAny() && !this.isResultTrash();"
);
FormatTools.addMethodWithBestPosition(topLevelClass, isResultValid);
// resultTrash
Method resultTrash = ElementTools.generateMethod(
"resultTrash",
JavaVisibility.PUBLIC,
topLevelClass.getType()
);
resultTrash = ElementTools.generateMethodBody(
resultTrash,
"this.resultType = \"trash\";",
"return this;"
);
FormatTools.addMethodWithBestPosition(topLevelClass, resultTrash);
// isResultTrash
Method isResultTrash = ElementTools.generateMethod(
"isResultTrash",
JavaVisibility.PUBLIC,
booleanType
);
isResultTrash = ElementTools.generateMethodBody(
isResultTrash,
"return Objects.equals(this.resultType, \"trash\");"
);
FormatTools.addMethodWithBestPosition(topLevelClass, isResultTrash);
// resultAny
Method resultAny = ElementTools.generateMethod(
"resultAny",
JavaVisibility.PUBLIC,
topLevelClass.getType()
);
resultAny = ElementTools.generateMethodBody(
resultAny,
"this.resultType = \"any\";",
"return this;"
);
FormatTools.addMethodWithBestPosition(topLevelClass, resultAny);
// isResultAny
Method isResultAny = ElementTools.generateMethod(
"isResultAny",
JavaVisibility.PUBLIC,
booleanType
);
isResultAny = ElementTools.generateMethodBody(
isResultAny,
"return Objects.equals(this.resultType, \"any\");"
);
FormatTools.addMethodWithBestPosition(topLevelClass, isResultAny);
}
// 提供几个快捷方法 // 提供几个快捷方法
Method setLimitByRows = ElementTools.generateMethod( Method setLimitByRows = ElementTools.generateMethod(
"limit", "limit",
@@ -155,6 +310,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, setLimitByRows); FormatTools.addMethodWithBestPosition(topLevelClass, setLimitByRows);
// setLimitByOffsetRows
Method setLimitByOffsetRows = ElementTools.generateMethod( Method setLimitByOffsetRows = ElementTools.generateMethod(
"limit", "limit",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -170,6 +326,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, setLimitByOffsetRows); FormatTools.addMethodWithBestPosition(topLevelClass, setLimitByOffsetRows);
// limitOffset
Method setLimitByOffsetOnly = ElementTools.generateMethod( Method setLimitByOffsetOnly = ElementTools.generateMethod(
"limitOffset", "limitOffset",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -185,6 +342,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, setLimitByOffsetOnly); FormatTools.addMethodWithBestPosition(topLevelClass, setLimitByOffsetOnly);
// usePage
Method usePage = ElementTools.generateMethod( Method usePage = ElementTools.generateMethod(
"usePage", "usePage",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -208,7 +366,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, usePage); FormatTools.addMethodWithBestPosition(topLevelClass, usePage);
// 计算获取当前页码 // getPageNum 计算获取当前页码
Method getPageNum = ElementTools.generateMethod( Method getPageNum = ElementTools.generateMethod(
"getPageNum", "getPageNum",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -222,7 +380,8 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
"return this.offset / this.rows + this.startPageNum;" "return this.offset / this.rows + this.startPageNum;"
); );
FormatTools.addMethodWithBestPosition(topLevelClass, getPageNum); FormatTools.addMethodWithBestPosition(topLevelClass, getPageNum);
// 计算获取当前每页数量
// getPageSize 计算获取当前每页数量
Method getPageSize = ElementTools.generateMethod( Method getPageSize = ElementTools.generateMethod(
"getPageSize", "getPageSize",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -237,6 +396,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, getPageSize); FormatTools.addMethodWithBestPosition(topLevelClass, getPageSize);
// getRows
Method getRows = ElementTools.generateMethod( Method getRows = ElementTools.generateMethod(
"getRows", "getRows",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -248,6 +408,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, getRows); FormatTools.addMethodWithBestPosition(topLevelClass, getRows);
// getOffset
Method getOffset = ElementTools.generateMethod( Method getOffset = ElementTools.generateMethod(
"getOffset", "getOffset",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -259,6 +420,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, getOffset); FormatTools.addMethodWithBestPosition(topLevelClass, getOffset);
// getLimitString
Method getLimitString = ElementTools.generateMethod( Method getLimitString = ElementTools.generateMethod(
"getLimitString", "getLimitString",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -277,6 +439,7 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, getLimitString); FormatTools.addMethodWithBestPosition(topLevelClass, getLimitString);
// getWhereString
Method getWhereString = ElementTools.generateMethod( Method getWhereString = ElementTools.generateMethod(
"getWhereString", "getWhereString",
JavaVisibility.PUBLIC, JavaVisibility.PUBLIC,
@@ -312,6 +475,33 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
); );
FormatTools.addMethodWithBestPosition(topLevelClass, getWhereString); FormatTools.addMethodWithBestPosition(topLevelClass, getWhereString);
// cloneExample
Method cloneExample = ElementTools.generateMethod(
"cloneExample",
JavaVisibility.PUBLIC,
topLevelClass.getType()
);
cloneExample = ElementTools.generateMethodBody(
cloneExample,
exampleClassName + " newExample = new " + exampleClassName + "();",
"newExample.rows = this.rows;",
"newExample.offset = this.offset;",
"newExample.maxPageSize = this.maxPageSize;",
"newExample.ignorePageSize = this.ignorePageSize;",
"newExample.startPageNum = this.startPageNum;",
!ElementTools.isViewTable(introspectedTable) ? "newExample.resultType = this.resultType;" : "",
hasBLOBColumns ? "newExample.withBLOBs = withBLOBs;" : "",
"if (this.getOredCriteria() != null && !this.getOredCriteria().isEmpty()) {",
"for (" + exampleClassName + ".Criteria oldCriteria : this.getOredCriteria()) {",
exampleClassName + ".Criteria newCriteria = newExample.or();",
"newCriteria.getCriteria().addAll(oldCriteria.getCriteria());",
"}",
"}",
"newExample.setOrderByClause(this.getOrderByClause());",
"return newExample;"
);
FormatTools.addMethodWithBestPosition(topLevelClass, cloneExample);
// !!! clear 方法增加 offset 和 rows的清理 // !!! clear 方法增加 offset 和 rows的清理
boolean hasClear = false; boolean hasClear = false;
List<Method> methodList = topLevelClass.getMethods(); List<Method> methodList = topLevelClass.getMethods();
@@ -319,6 +509,9 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
if (method.getName().equals("clear")) { if (method.getName().equals("clear")) {
method.addBodyLine("rows = null;"); method.addBodyLine("rows = null;");
method.addBodyLine("offset = null;"); method.addBodyLine("offset = null;");
if (!ElementTools.isViewTable(introspectedTable)) {
method.addBodyLine("resultType = null;");
}
hasClear = true; hasClear = true;
} }
} }
@@ -331,7 +524,8 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
clear = ElementTools.generateMethodBody( clear = ElementTools.generateMethodBody(
clear, clear,
"rows = null;", "rows = null;",
"offset = null;" "offset = null;",
!ElementTools.isViewTable(introspectedTable) ? "resultType = null;" : ""
); );
FormatTools.addMethodWithBestPosition(topLevelClass, clear); FormatTools.addMethodWithBestPosition(topLevelClass, clear);
} }
@@ -391,9 +585,6 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
batchInsert.setVisibility(JavaVisibility.PUBLIC); batchInsert.setVisibility(JavaVisibility.PUBLIC);
batchInsert.setReturnType(FullyQualifiedJavaType.getIntInstance()); batchInsert.setReturnType(FullyQualifiedJavaType.getIntInstance());
batchInsert.addParameter(recordsParam); batchInsert.addParameter(recordsParam);
interfaceObj.addImportedType(new FullyQualifiedJavaType("java.util.List"));
interfaceObj.addImportedType(new FullyQualifiedJavaType("org.apache.ibatis.annotations.Param"));
interfaceObj.addMethod(batchInsert); interfaceObj.addMethod(batchInsert);
} }
@@ -439,8 +630,12 @@ public class TapeMybatisGeneratorPlugin extends PluginAdapter {
if (introspectedTable.getTargetRuntime() != IntrospectedTable.TargetRuntime.MYBATIS3) { if (introspectedTable.getTargetRuntime() != IntrospectedTable.TargetRuntime.MYBATIS3) {
return super.clientGenerated(interfaceObj, introspectedTable); return super.clientGenerated(interfaceObj, introspectedTable);
} }
interfaceObj.addImportedType(new FullyQualifiedJavaType("java.util.List"));
interfaceObj.addImportedType(new FullyQualifiedJavaType("org.apache.ibatis.annotations.Param"));
addBatchInsertClientMethod(interfaceObj, introspectedTable); addBatchInsertClientMethod(interfaceObj, introspectedTable);
if (introspectedTable.getPrimaryKeyColumns().size() <= 0) {
if (introspectedTable.getPrimaryKeyColumns().isEmpty()) {
return super.clientGenerated(interfaceObj, introspectedTable); return super.clientGenerated(interfaceObj, introspectedTable);
} }
// 获取主键列类型 // 获取主键列类型

View File

@@ -9,6 +9,7 @@ import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.DefaultJavaFormatter; import org.mybatis.generator.api.dom.DefaultJavaFormatter;
import org.mybatis.generator.api.dom.java.*; import org.mybatis.generator.api.dom.java.*;
import org.mybatis.generator.config.Context; import org.mybatis.generator.config.Context;
import org.mybatis.generator.config.TableConfiguration;
import org.mybatis.generator.internal.util.StringUtility; import org.mybatis.generator.internal.util.StringUtility;
import java.io.File; import java.io.File;
@@ -17,7 +18,7 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
@SuppressWarnings({"DuplicatedCode", "SpellCheckingInspection", "ExtractMethodRecommender"}) @SuppressWarnings({"DuplicatedCode", "SpellCheckingInspection", "ExtractMethodRecommender"})
public class TapeRepoviewGeneratorPlugin extends PluginAdapter { public class TapeViewRepositoryGeneratorPlugin extends PluginAdapter {
// 视图Repo包配置可通过配置文件自定义 // 视图Repo包配置可通过配置文件自定义
private String slowQueryLoggerTime = "300"; private String slowQueryLoggerTime = "300";
@@ -26,6 +27,7 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
private String mapperPackage = "com.iqudoo.platform.application.database.mapper"; private String mapperPackage = "com.iqudoo.platform.application.database.mapper";
private String facadeViewRepositoryPackage = "com.iqudoo.platform.application.facade.repoview"; private String facadeViewRepositoryPackage = "com.iqudoo.platform.application.facade.repoview";
private String domainViewRepositoryPackage = "com.iqudoo.platform.application.domain.repoview"; private String domainViewRepositoryPackage = "com.iqudoo.platform.application.domain.repoview";
private String domainViewRepositoryType = "Repository";
private String targetProject = "src/main/java"; private String targetProject = "src/main/java";
// 1.4.1版本专用格式化器 // 1.4.1版本专用格式化器
@@ -45,16 +47,14 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
} }
private void resolveConfiguration() { private void resolveConfiguration() {
targetProject = stringConfig("targetProject", targetProject);
slowQueryLoggerTime = stringConfig("slowQueryLoggerTime", slowQueryLoggerTime); slowQueryLoggerTime = stringConfig("slowQueryLoggerTime", slowQueryLoggerTime);
slowQueryLoggerLevel = stringConfig("slowQueryLoggerLevel", slowQueryLoggerLevel); slowQueryLoggerLevel = stringConfig("slowQueryLoggerLevel", slowQueryLoggerLevel);
if (!UtilTools.inArray(new String[]{"error", "warn", "debug", "info"}, slowQueryLoggerLevel)) { facadeViewRepositoryPackage = stringConfig("facadeViewRepositoryPackage", facadeViewRepositoryPackage);
slowQueryLoggerLevel = "error"; domainViewRepositoryPackage = stringConfig("domainViewRepositoryPackage", domainViewRepositoryPackage);
} domainViewRepositoryType = stringConfig("domainViewRepositoryType", domainViewRepositoryType);
facadeViewRepositoryPackage = stringConfig("facadeRepoviewPackage", facadeViewRepositoryPackage);
domainViewRepositoryPackage = stringConfig("domainRepoviewPackage", domainViewRepositoryPackage);
modelPackage = stringConfig("modelPackage", modelPackage);
mapperPackage = stringConfig("mapperPackage", mapperPackage); mapperPackage = stringConfig("mapperPackage", mapperPackage);
targetProject = stringConfig("targetProject", targetProject); modelPackage = stringConfig("modelPackage", modelPackage);
} }
private String stringConfig(String key, String defaultValue) { private String stringConfig(String key, String defaultValue) {
@@ -71,6 +71,31 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
return defaultValue; return defaultValue;
} }
private String getSlowQueryLoggerLevel(IntrospectedTable introspectedTable) {
String level = getTableProperty(introspectedTable, "slowQueryLoggerLevel", slowQueryLoggerLevel);
if (!UtilTools.inArray(new String[]{"error", "warn", "debug", "info"}, level)) {
return "error";
}
return level;
}
private String getSlowQueryLoggerTime(IntrospectedTable introspectedTable) {
return getTableProperty(introspectedTable, "slowQueryLoggerTime", slowQueryLoggerTime);
}
// ====================== 统一 Table 属性获取你全类都能用 ======================
private String getTableProperty(IntrospectedTable introspectedTable, String propName, String defaultValue) {
try {
TableConfiguration tc = introspectedTable.getTableConfiguration();
String v = tc.getProperty(propName);
if (StringUtility.stringHasValue(v)) {
return v.trim();
}
} catch (Exception ignored) {
}
return defaultValue;
}
/** /**
* 核心方法仅为视图表生成 RepoView 代码 * 核心方法仅为视图表生成 RepoView 代码
*/ */
@@ -85,8 +110,8 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
String domainObjectName = introspectedTable.getFullyQualifiedTable().getDomainObjectName(); String domainObjectName = introspectedTable.getFullyQualifiedTable().getDomainObjectName();
String exampleClassName = domainObjectName + "Example"; String exampleClassName = domainObjectName + "Example";
String mapperClassName = domainObjectName + "Mapper"; String mapperClassName = domainObjectName + "Mapper";
String repoInterfaceName = "I" + domainObjectName + "Repo"; String repoInterfaceName = "I" + domainObjectName + domainViewRepositoryType;
String repoImplName = domainObjectName + "RepoImpl"; String repoImplName = domainObjectName + domainViewRepositoryType + "Impl";
boolean hasBLOBColumns = ElementTools.hasBLOBColumns(introspectedTable); boolean hasBLOBColumns = ElementTools.hasBLOBColumns(introspectedTable);
@@ -102,6 +127,7 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
// 3. 生成视图Repo实现类 // 3. 生成视图Repo实现类
TopLevelClass repoImpl = generateRepoViewImpl( TopLevelClass repoImpl = generateRepoViewImpl(
introspectedTable,
repoImplName, repoImplName,
repoInterfaceName, repoInterfaceName,
domainObjectName, domainObjectName,
@@ -179,6 +205,7 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
* 生成视图Repo实现类逻辑不变仅适配新接口 * 生成视图Repo实现类逻辑不变仅适配新接口
*/ */
private TopLevelClass generateRepoViewImpl( private TopLevelClass generateRepoViewImpl(
IntrospectedTable introspectedTable,
String implClassName, String implClassName,
String interfaceName, String interfaceName,
String modelClassName, String modelClassName,
@@ -187,6 +214,8 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
boolean hasBLOBColumns boolean hasBLOBColumns
) { ) {
String tableName = introspectedTable.getFullyQualifiedTable().getIntrospectedTableName();
TopLevelClass implClass = new TopLevelClass(domainViewRepositoryPackage + "." + implClassName); TopLevelClass implClass = new TopLevelClass(domainViewRepositoryPackage + "." + implClassName);
implClass.setVisibility(JavaVisibility.PUBLIC); implClass.setVisibility(JavaVisibility.PUBLIC);
implClass.addAnnotation("@SuppressWarnings(\"DuplicatedCode\")"); implClass.addAnnotation("@SuppressWarnings(\"DuplicatedCode\")");
@@ -214,10 +243,10 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
mapperField.addAnnotation("@Resource"); mapperField.addAnnotation("@Resource");
implClass.addField(mapperField); implClass.addField(mapperField);
generateFindOneMethod(implClass, modelClassName, exampleClassName); generateFindOneMethod(implClass, tableName, modelClassName, exampleClassName);
generateGetListMethod(implClass, modelClassName, exampleClassName, mapperFieldName, hasBLOBColumns); generateGetListMethod(implClass, tableName, introspectedTable, modelClassName, exampleClassName, mapperFieldName, hasBLOBColumns);
generateCountMethod(implClass, modelClassName, exampleClassName, mapperFieldName); generateCountMethod(implClass, tableName, introspectedTable, modelClassName, exampleClassName, mapperFieldName);
generateCountWithPageMethod(implClass, modelClassName, exampleClassName, mapperFieldName); generateCountWithPageMethod(implClass, tableName, exampleClassName);
return implClass; return implClass;
} }
@@ -245,7 +274,7 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
/** /**
* 生成findOne方法 * 生成findOne方法
*/ */
private void generateFindOneMethod(TopLevelClass implClass, String modelClassName, String exampleClassName) { private void generateFindOneMethod(TopLevelClass implClass, String tableName, String modelClassName, String exampleClassName) {
Method method = new Method("findOne"); Method method = new Method("findOne");
method.addAnnotation("@Override"); method.addAnnotation("@Override");
method.setVisibility(JavaVisibility.PUBLIC); method.setVisibility(JavaVisibility.PUBLIC);
@@ -255,6 +284,8 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
method.addException(new FullyQualifiedJavaType("Throwable")); method.addException(new FullyQualifiedJavaType("Throwable"));
// 方法体 // 方法体
method.addBodyLine("// clone new example");
method.addBodyLine("example = example.cloneExample();");
method.addBodyLine("example.usePage(1, 1);"); method.addBodyLine("example.usePage(1, 1);");
method.addBodyLine("List<" + modelClassName + "> dataList = getList(example);"); method.addBodyLine("List<" + modelClassName + "> dataList = getList(example);");
method.addBodyLine("if (dataList != null && !dataList.isEmpty()) {"); method.addBodyLine("if (dataList != null && !dataList.isEmpty()) {");
@@ -268,7 +299,7 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
/** /**
* 生成getList方法 * 生成getList方法
*/ */
private void generateGetListMethod(TopLevelClass implClass, String modelClassName, String exampleClassName, String mapperFieldName, boolean hasBLOBColumns) { private void generateGetListMethod(TopLevelClass implClass, String tableName, IntrospectedTable introspectedTable, String modelClassName, String exampleClassName, String mapperFieldName, boolean hasBLOBColumns) {
Method method = new Method("getList"); Method method = new Method("getList");
method.addAnnotation("@Override"); method.addAnnotation("@Override");
method.setVisibility(JavaVisibility.PUBLIC); method.setVisibility(JavaVisibility.PUBLIC);
@@ -276,6 +307,9 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
// 参数名匹配示例首字母小写 // 参数名匹配示例首字母小写
method.addParameter(new Parameter(new FullyQualifiedJavaType(exampleClassName), "example")); method.addParameter(new Parameter(new FullyQualifiedJavaType(exampleClassName), "example"));
method.addException(new FullyQualifiedJavaType("Throwable")); method.addException(new FullyQualifiedJavaType("Throwable"));
method.addBodyLine("// clone new example");
method.addBodyLine("example = example.cloneExample();");
method.addBodyLine("List<" + modelClassName + "> result = null;"); method.addBodyLine("List<" + modelClassName + "> result = null;");
method.addBodyLine("long startTime = new Date().getTime();"); method.addBodyLine("long startTime = new Date().getTime();");
if (hasBLOBColumns) { if (hasBLOBColumns) {
@@ -288,7 +322,7 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
method.addBodyLine("result = " + mapperFieldName + ".selectByExample(example);"); method.addBodyLine("result = " + mapperFieldName + ".selectByExample(example);");
} }
method.addBodyLine("long useTime = new Date().getTime() - startTime;"); method.addBodyLine("long useTime = new Date().getTime() - startTime;");
method.addBodyLine("if (useTime > " + slowQueryLoggerTime + ") {"); method.addBodyLine("if (useTime > " + getSlowQueryLoggerTime(introspectedTable) + ") {");
method.addBodyLine("String exampleString = \"\";"); method.addBodyLine("String exampleString = \"\";");
method.addBodyLine("if (example.getWhereString() != null) {"); method.addBodyLine("if (example.getWhereString() != null) {");
method.addBodyLine("exampleString += \"\\n\\t|-> where: \" + example.getWhereString();"); method.addBodyLine("exampleString += \"\\n\\t|-> where: \" + example.getWhereString();");
@@ -296,8 +330,12 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
method.addBodyLine("if (example.getOrderByClause() != null) {"); method.addBodyLine("if (example.getOrderByClause() != null) {");
method.addBodyLine("exampleString += \"\\n\\t|-> order by: \" + example.getOrderByClause();"); method.addBodyLine("exampleString += \"\\n\\t|-> order by: \" + example.getOrderByClause();");
method.addBodyLine("}"); method.addBodyLine("}");
method.addBodyLine("LOGGER." + slowQueryLoggerLevel + "(\"[SQL] select " + modelClassName + " view list use long time\" +"); method.addBodyLine("if (example.getLimitString() != null) {");
method.addBodyLine(" \"\\n\\t|-> use time\" + useTime + \"ms\" +"); method.addBodyLine("exampleString += \"\\n\\t|-> limit: \" + example.getLimitString();");
method.addBodyLine("}");
method.addBodyLine("LOGGER." + getSlowQueryLoggerLevel(introspectedTable) + "(\"[SQL] select " + modelClassName + " view list long time\" +");
method.addBodyLine(" \"\\n\\t|-> table name: " + tableName + "\" +");
method.addBodyLine(" \"\\n\\t|-> use time: \" + useTime + \"ms\" +");
method.addBodyLine(" exampleString +"); method.addBodyLine(" exampleString +");
method.addBodyLine(" \"\\n\\t|-----------------------------------\""); method.addBodyLine(" \"\\n\\t|-----------------------------------\"");
method.addBodyLine(");"); method.addBodyLine(");");
@@ -309,7 +347,7 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
/** /**
* 生成count方法 * 生成count方法
*/ */
private void generateCountMethod(TopLevelClass implClass, String modelClassName, String exampleClassName, String mapperFieldName) { private void generateCountMethod(TopLevelClass implClass, String tableName, IntrospectedTable introspectedTable, String modelClassName, String exampleClassName, String mapperFieldName) {
Method method = new Method("count"); Method method = new Method("count");
method.addAnnotation("@Override"); method.addAnnotation("@Override");
method.setVisibility(JavaVisibility.PUBLIC); method.setVisibility(JavaVisibility.PUBLIC);
@@ -319,10 +357,12 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
method.addException(new FullyQualifiedJavaType("Throwable")); method.addException(new FullyQualifiedJavaType("Throwable"));
// 方法体 // 方法体
method.addBodyLine("// clone new example");
method.addBodyLine("example = example.cloneExample();");
method.addBodyLine("long startTime = new Date().getTime();"); method.addBodyLine("long startTime = new Date().getTime();");
method.addBodyLine("long count = " + mapperFieldName + ".countByExample(example);"); method.addBodyLine("long count = " + mapperFieldName + ".countByExample(example);");
method.addBodyLine("long useTime = new Date().getTime() - startTime;"); method.addBodyLine("long useTime = new Date().getTime() - startTime;");
method.addBodyLine("if (useTime > " + slowQueryLoggerTime + ") {"); method.addBodyLine("if (useTime > " + getSlowQueryLoggerTime(introspectedTable) + ") {");
method.addBodyLine("String exampleString = \"\";"); method.addBodyLine("String exampleString = \"\";");
method.addBodyLine("if (example.getWhereString() != null) {"); method.addBodyLine("if (example.getWhereString() != null) {");
method.addBodyLine("exampleString += \"\\n\\t|-> where: \" + example.getWhereString();"); method.addBodyLine("exampleString += \"\\n\\t|-> where: \" + example.getWhereString();");
@@ -330,8 +370,9 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
method.addBodyLine("if (example.getOrderByClause() != null) {"); method.addBodyLine("if (example.getOrderByClause() != null) {");
method.addBodyLine("exampleString += \"\\n\\t|-> order by: \" + example.getOrderByClause();"); method.addBodyLine("exampleString += \"\\n\\t|-> order by: \" + example.getOrderByClause();");
method.addBodyLine("}"); method.addBodyLine("}");
method.addBodyLine("LOGGER." + slowQueryLoggerLevel + "(\"[SQL] select " + modelClassName + " view count use long time\" +"); method.addBodyLine("LOGGER." + getSlowQueryLoggerLevel(introspectedTable) + "(\"[SQL] select " + modelClassName + " view count long time\" +");
method.addBodyLine(" \"\\n\\t|-> use time\" + useTime + \"ms\" +"); method.addBodyLine(" \"\\n\\t|-> table name: " + tableName + "\" +");
method.addBodyLine(" \"\\n\\t|-> use time: \" + useTime + \"ms\" +");
method.addBodyLine(" exampleString +"); method.addBodyLine(" exampleString +");
method.addBodyLine(" \"\\n\\t|-----------------------------------\""); method.addBodyLine(" \"\\n\\t|-----------------------------------\"");
method.addBodyLine(");"); method.addBodyLine(");");
@@ -344,7 +385,7 @@ public class TapeRepoviewGeneratorPlugin extends PluginAdapter {
/** /**
* 生成count方法 * 生成count方法
*/ */
private void generateCountWithPageMethod(TopLevelClass implClass, String modelClassName, String exampleClassName, String mapperFieldName) { private void generateCountWithPageMethod(TopLevelClass implClass, String tableName, String exampleClassName) {
Method method = new Method("countWithPage"); Method method = new Method("countWithPage");
method.addAnnotation("@Override"); method.addAnnotation("@Override");
method.setVisibility(JavaVisibility.PUBLIC); method.setVisibility(JavaVisibility.PUBLIC);