支持表级配置

2026-04-17 13:15:49 +08:00
parent ac547d2a57
commit a73e969431
5 changed files with 317 additions and 163 deletions
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # tape-mybatis-generator-plugin
+
 > MyBatis 代码生成插件

 ## 功能特性
@@ -12,17 +13,22 @@
 ## 插件说明

 ### TapeMybatisGeneratorPlugin
+
 扩展 MyBatis Mapper，添加以下功能：
+
 - 在 Mapper 接口中添加 `selectPrimaryKeyByExample` 方法
 - 在 Mapper XML 中生成对应的 SQL 查询语句

 ### TapeRepositoryGeneratorPlugin
+
 为非视图表生成 Repository 层代码：
+
 - **接口位置**: `{facadeRepositoryPackage}.I{TableName}Repository`
 - **实现类位置**: `{domainRepositoryPackage}.{TableName}RepositoryImpl`
 - **视图表过滤**: 根据 `viewKeyWords` 配置自动识别并跳过视图表

 **生成的方法**：
+
 - `trashById(long id)` - 移动到回收站（单个）
 - `trashAll({Example} example)` - 移动到回收站（批量）
 - `deleteById(long id, boolean release)` - 删除（单个，支持物理删除）
@@ -46,20 +52,25 @@
 - `update({Model} record)` - 更新记录（支持乐观锁）

 ### TapeRepoviewGeneratorPlugin
+
 为视图表生成 RepoView 层代码：
+
 - **接口位置**: `{facadeRepoviewPackage}.I{TableName}Repo`
 - **实现类位置**: `{domainRepoviewPackage}.{TableName}RepoImpl`
 - **视图表识别**: 仅处理包含 `viewKeyWords` 关键字的表

 **生成的方法**：
+
 - `findOne({Example} example)` - 查找单条记录
 - `getList({Example} example)` - 获取记录列表（支持分页）
 - `count({Example} example)` - 统计记录数

 ### 其他功能
+
 通过 `TapeMybatisGeneratorPlugin` 为所有 Example 类添加支持：

 **添加的字段**：
+
 - `offset` - 偏移量
 - `rows` - 每页数量
 - `startPageNum` - 最小页码（默认 1）
@@ -68,6 +79,7 @@
 - `withBLOBs` - 是否返回BLOBs列的数据

 **添加的方法**：
+
 - `limit(int rows)` - 设置每页数量
 - `limit(int offset, int rows)` - 设置偏移量和每页数量
 - `usePage(int pageNum, int pageSize)` - 使用页码和每页数量（自动计算 offset）
@@ -79,9 +91,11 @@
 - `getRows()` - 获取当前分页limit的rows

 ## 使用方法
+
 ### 1. 在 `pom.xml` 中配置插件

 ```xml
+
 <build>
    <finalName>application</finalName>
    <plugins>
@@ -162,29 +176,65 @@
 ### 3. 配置参数说明

 | 参数名                            | 说明                            | 默认值                                                     | 必需 |
-|--------------------------------|-------------------------------|---------------------------------------------------------|------|
-| `targetProject`                | 生成代码的目标项目路径                   | `src/main/java`                                         | 否 |
-| `mapperPackage`                | Mapper 接口的包路径                 | `com.iqudoo.platform.application.database.mapper`       | 是 |
-| `modelPackage`                 | Model 类的包路径                   | `com.iqudoo.platform.application.database.model`        | 是 |
-| `facadeRepositoryPackage`      | Repository 接口的包路径             | `com.iqudoo.platform.application.facade.repository`     | 否 |
-| `domainRepositoryPackage`      | Repository 实现类的包路径            | `com.iqudoo.platform.application.domain.repository`     | 否 |
-| `facadeViewRepositoryPackage`  | RepoView 接口的包路径               | `com.iqudoo.platform.application.facade.repoview`       | 否 |
-| `domainViewRepositoryPackage`  | RepoView 实现类的包路径              | `com.iqudoo.platform.application.domain.repoview`       | 否 |
-| `guidGeneratorClass`           | GUID生成工具类                     | `com.iqudoo.framework.tape.modules.utils.SnowflakeUtil` | 否 |
-| `guidGeneratorCode`            | GUID生成方法                      | `SnowflakeUtil.nextId()`                                | 否 |
-| `changeLogContextClassPackage` | 变更日志上下文包路径                    | `com.iqudoo.platform.application.domain.changeLog`      | 否 |
-| `changeLogContextClassName`    | 变更日志上下文类                      | `ChangeLogContext`                                      | 否 |
-| `changeLogEnable`              | 变更日志监听开关                      | `false`                                                 | 否 |
-| `slowQueryLoggerTime`          | 慢查询日志时间阈值                     | `300`                                                   | 否 |
-| `slowQueryLoggerLevel`         | 慢查询日志类型：error，warn，debug，info | `error`                                                 | 否 |
-| `optimisticLockEnable`         | 乐观锁开关                         | `true`                                                  | 否 |
-| `ignorePageSize`               | 忽略分页阈值                        | `10000`                                                 | 否 |
-| `startPageNum`                 | 分页开始页码                        | `1`                                                     | 否 |
-| `maxPageSize`                  | 最大每页数量                        | `100`                                                   | 否 |
+|--------------------------------|-------------------------------|---------------------------------------------------------|----|
+| `targetProject`                | 生成代码的目标项目路径                   | `src/main/java`                                         | 否  |
+| `mapperPackage`                | Mapper 接口的包路径                 | `com.iqudoo.platform.application.database.mapper`       | 是  |
+| `modelPackage`                 | Model 类的包路径                   | `com.iqudoo.platform.application.database.model`        | 是  |
+| `facadeRepositoryPackage`      | Repository 接口的包路径             | `com.iqudoo.platform.application.facade.repository`     | 否  |
+| `domainRepositoryPackage`      | Repository 实现类的包路径            | `com.iqudoo.platform.application.domain.repository`     | 否  |
+| `facadeViewRepositoryPackage`  | RepoView 接口的包路径               | `com.iqudoo.platform.application.facade.repoview`       | 否  |
+| `domainViewRepositoryPackage`  | RepoView 实现类的包路径              | `com.iqudoo.platform.application.domain.repoview`       | 否  |
+| `guidGeneratorClass`           | GUID生成工具类                     | `com.iqudoo.framework.tape.modules.utils.SnowflakeUtil` | 否  |
+| `guidGeneratorCode`            | GUID生成方法                      | `SnowflakeUtil.nextId()`                                | 否  |
+| `changeLogContextClassPackage` | 变更日志上下文包路径                    | `com.iqudoo.platform.application.domain.changeLog`      | 否  |
+| `changeLogContextClassName`    | 变更日志上下文类                      | `ChangeLogContext`                                      | 否  |
+| `changeLogEnable`              | 变更日志监听开关                      | `false`                                                 | 否  |
+| `slowQueryLoggerTime`          | 慢查询日志时间阈值                     | `300`                                                   | 否  |
+| `slowQueryLoggerLevel`         | 慢查询日志类型：error，warn，debug，info | `error`                                                 | 否  |
+| `optimisticLockEnable`         | 乐观锁开关                         | `true`                                                  | 否  |
+| `ignorePageSize`               | 忽略分页阈值                        | `10000`                                                 | 否  |
+| `startPageNum`                 | 分页开始页码                        | `1`                                                     | 否  |
+| `maxPageSize`                  | 最大每页数量                        | `100`                                                   | 否  |
+
+### 3. TABLE级配置，未配置时使用全局配置
+
+| 参数名                    |
+|------------------------|
+| `changeLogEnable`      | 
+| `slowQueryLoggerTime`  |
+| `slowQueryLoggerLevel` |
+| `optimisticLockEnable` |
+| `ignorePageSize`       | 
+| `startPageNum`         |
+| `maxPageSize`          |
+
+```xml
+<!-- your table -->
+<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实现中调用
+
 ```java
 public class ChangeLogContext {

@@ -206,30 +256,33 @@ public class ChangeLogContext {

 ```mysql
 DROP TABLE IF EXISTS `your_table_name`;
-CREATE TABLE `your_table_name`  (
-  `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_delete` int(0) NOT NULL DEFAULT 0 COMMENT '删除标志',
-  `delete_token` varchar(32) NULL DEFAULT '' COMMENT '删除令牌',
-  `data_version` int(0) NOT NULL DEFAULT 0 COMMENT '数据版本',
-  `create_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,
-  -- 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
-) ENGINE = InnoDB COMMENT = '你的表格备注' ROW_FORMAT = Dynamic;
+CREATE TABLE `your_table_name`
+(
+    `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_delete`    int(0)             NOT NULL DEFAULT 0 COMMENT '删除标志',
+    `delete_token` varchar(32)        NULL     DEFAULT '' COMMENT '删除令牌',
+    `data_version` int(0)             NOT NULL DEFAULT 0 COMMENT '数据版本',
+    `create_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,
+    -- 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
+) ENGINE = InnoDB COMMENT = '你的表格备注'
+  ROW_FORMAT = Dynamic;
 ```

 **必需字段说明**：
+
 - `guid` - 主键，类型为 `bigint UNSIGNED`
 - `is_hidden` - 隐藏标志，用于回收站功能
 - `is_delete` - 删除标志，用于软删除功能
@@ -258,31 +311,16 @@ CREATE TABLE `your_table_name`  (
       selectByExampleQueryId="false">
    <property name="useActualColumnNames" value="false"/>
 </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`
-2. **视图表识别**：视图表通过表名中的关键字识别，默认关键字为 `view_` 和 `v_` 不区分大小写
 3. **分页功能**：所有 Example 类都自动包含分页功能，可通过 `usePage()` 方法使用
 4. **乐观锁**：更新操作使用 `data_version` 字段实现乐观锁，更新时需要传入正确的版本号
 5. **软删除**：删除操作默认是软删除（设置 `is_delete` 标志），可通过 `release=true` 参数执行物理删除
 6. **回收站**：通过 `is_hidden` 字段实现回收站功能，`trash` 方法将记录移动到回收站，`recover` 方法恢复记录
-7. **自动字段**：插入记录时，插件会自动设置 `guid`（使用雪花算法）、`is_delete`、`is_hidden`、`delete_token`、`data_version`、`create_time`、`update_time` 等字段
+7. **自动字段**：插入记录时，插件会自动设置 `guid`
+   （使用雪花算法）、`is_delete`、`is_hidden`、`delete_token`、`data_version`、`create_time`、`update_time` 等字段
 8. **BLOB 字段支持**：如果表包含 BLOB 字段，插件会自动使用 `selectByExampleWithBLOBs` 和 `updateByExampleWithBLOBs` 方法
 9. **MyBatis Generator 版本**：本插件基于 MyBatis Generator 1.4.1 开发，建议使用 1.4.0 或更高版本