b11081f4b2feabf26c5de64f84cea512406da545
code-gen.md
| ... | ... | @@ -67,3 +67,71 @@ FastAutoGenerator.create(ConfigUtils.load("pg.properties")) |
| 67 | 67 | |
| 68 | 68 | |
| 69 | 69 | |
| 70 | +# |
|
| 71 | +## 数据库配置 \(DataSourceConfig\) {#数据库配置-datasourceconfig} |
|
| 72 | + |
|
| 73 | +#### 基础配置 {#基础配置} |
|
| 74 | + |
|
| 75 | +| 属性 | 说明 | 示例 | |
|
| 76 | +| :--- | :--- | :--- | |
|
| 77 | +| url | jdbc 路径 | jdbc:mysql://127.0.0.1:3306/mybatis-plus | |
|
| 78 | +| username | 数据库账号 | root | |
|
| 79 | +| password | 数据库密码 | 123456 | |
|
| 80 | + |
|
| 81 | +#### {#可选配置} |
|
| 82 | + |
|
| 83 | +```java |
|
| 84 | +DataSourceConfig dataSourceConfig = new DataSourceConfig.Builder("jdbc:mysql://127.0.0.1:3306/mybatis-plus", "root", "123456").build(); |
|
| 85 | +``` |
|
| 86 | + |
|
| 87 | +#### {#可选配置} |
|
| 88 | + |
|
| 89 | +#### 可选配置 {#可选配置} |
|
| 90 | + |
|
| 91 | +| 方法 | 说明 | 示例 | |
|
| 92 | +| :--- | :--- | :--- | |
|
| 93 | +| dbQuery\(IDbQuery\) | 数据库查询 | new MySqlQuery\(\),只在SQLQuery下生效 | |
|
| 94 | +| schema\(String\) | 数据库 schema\(部分数据库适用\) | mybatis-plus | |
|
| 95 | +| | | | |
|
| 96 | +| | | | |
|
| 97 | +| databaseQueryClass\(AbstractDatabaseQuery\) | 数据库查询方式 | 默认DefaultQuery.class\(通用元数据\), SQLQuery.class\(SQL查询\) | |
|
| 98 | + |
|
| 99 | +```java |
|
| 100 | +// 使用SQL查询的方式生成代码,属于旧的代码生成方式,通用性不是好,老的代码可以继续使用,适配数据库需要完成dbQuery和typeConvert的扩展,后期不再维护这种方式 |
|
| 101 | +DataSourceConfig dataSourceConfig = new DataSourceConfig.Builder("jdbc:mysql://127.0.0.1:3306/mybatis-plus", "root", "123456") |
|
| 102 | +.dbQuery(new MySqlQuery()) |
|
| 103 | +.schema("mybatis-plus") |
|
| 104 | +.databaseQueryClass(SQLQuery.class) |
|
| 105 | +.build(); |
|
| 106 | +``` |
|
| 107 | + |
|
| 108 | + |
|
| 109 | + |
|
| 110 | + |
|
| 111 | + |
|
| 112 | +# |
|
| 113 | +# 策略配置 \(StrategyConfig\) {#策略配置-strategyconfig} |
|
| 114 | + |
|
| 115 | +策略配置是 MyBatis-Plus 代码生成器的核心部分,它允许开发者根据项目需求定制代码生成的规则,包括命名模式、表和字段的过滤、以及各个代码模块的生成策略。 |
|
| 116 | + |
|
| 117 | +### 方法说明 {#方法说明-4} |
|
| 118 | + |
|
| 119 | +| 方法 | 说明 | 示例 | |
|
| 120 | +| :--- | :--- | :--- | |
|
| 121 | +| enableCapitalMode | 开启大写命名 | 默认值:`false` | |
|
| 122 | +| enableSkipView | 开启跳过视图 | 默认值:`false` | |
|
| 123 | +| disableSqlFilter | 禁用 SQL 过滤 | 默认值:`true`,如果 SQL 过滤不支持,可以关闭此选项 | |
|
| 124 | +| enableSchema | 启用 schema | 默认值:`false`,多 schema 场景时启用 | |
|
| 125 | +| likeTable\(LikeTable\) | 模糊表匹配\(SQL 过滤\) | 与`notLikeTable`互斥,只能配置一项 | |
|
| 126 | +| notLikeTable\(LikeTable\) | 模糊表排除\(SQL 过滤\) | 与`likeTable`互斥,只能配置一项 | |
|
| 127 | +| addInclude\(String…\) | 增加表匹配\(内存过滤\) | 与`addExclude`互斥,只能配置一项,支持正则匹配,如`^t_.*`匹配所有以`t_`开头的表名 | |
|
| 128 | +| addExclude\(String…\) | 增加表排除匹配\(内存过滤\) | 与`addInclude`互斥,只能配置一项,支持正则匹配,如`.*st$`匹配所有以`st`结尾的表名 | |
|
| 129 | +| addTablePrefix\(String…\) | 增加过滤表前缀 | | |
|
| 130 | +| addTableSuffix\(String…\) | 增加过滤表后缀 | | |
|
| 131 | +| addFieldPrefix\(String…\) | 增加过滤字段前缀 | | |
|
| 132 | + |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + |
|
| 136 | + |
|
| 137 | + |