前言
最近在写一个Spring Boot + Oracle 12C的项目。为了提高开发效率,就使用到了Mybatis Plus的代码生成器。但在使用过程中碰到了不少坑,因此记录一下。
1. 引入依赖
mybatis-plus代码生成器支持配置swagger注解自动生成,如果没有使用swagger,就不需要添加springfox-swagger2和springfox-swagger-ui依赖。
<!-- mybatis-plus代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!-- 代码生成器需要借助模板引擎-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.1</version>
</dependency>
<!--swagger2-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
2. 编写CodeGenerator.java
mybatis-plus代码生成器采用的是运行java程序的方式生成代码,因此我们需要在CodeGenerator.java中编写生成时的配置。
以下是代码模板:
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.OracleTypeConvert;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
/**
* @author: OnlyOne
* @create: 2021-02-06 22:23
* @description: mybatis-plus代码生成器
**/
public class CodeGenerator {
public static void main(String[] args) {
// 1.创建代码生成器
AutoGenerator mpg = new AutoGenerator();
// 2.全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("XXX");
gc.setOpen(false); //生成后是否打开资源管理器
gc.setFileOverride(false); //重新生成时文件是否覆盖
/**
* mp生成service层代码,默认接口名称第一个字母有 I
*
*/
gc.setServiceName("%sService");//去掉Service接口的首字母I
gc.setIdType(IdType.AUTO);//主键策略,IdType.AUTO对应的策略为主键自增
gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
// gc.setSwagger2(true); // 实体属性 Swagger2 注解
mpg.setGlobalConfig(gc);
//3. 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:oracle:thin:@localhost:1521:orcl");
dsc.setDbType(DbType.ORACLE);
dsc.setTypeConvert(new OracleTypeConvert());
dsc.setDriverName("oracle.jdbc.driver.OracleDriver");
dsc.setUsername("XXXX");
dsc.setPassword("XXXX");
mpg.setDataSource(dsc);
// 4.包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("XXXX");
pc.setParent("com.XXXX");
pc.setController("controller");
pc.setEntity("entity");
pc.setService("service");
pc.setMapper("mapper");
mpg.setPackageInfo(pc);
// 5.策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude(new String[]{"USER", "POINT"}); // 表名字,注意一定要大写!大写!否则识别不出来!
strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀
strategy.setColumnNaming(NamingStrategy.underline_to_camel);;//数据库表字段映射到实体的命名策略
strategy.setEntityLombokModel(true);// lombok 模型 @Accessors(chain true) setter链式操作
strategy.setRestControllerStyle(true); //restful api风格控制器
strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符
mpg.setStrategy(strategy);
mpg.execute();
}
}
一定注意,dsc.setDbType(DbType.ORACLE)千万不要写成dsc.setDbType(DbType.ORACLE_12C)。如果参数是DbType.ORACLE,那么将使用OracleQuery类的对象实现对目标用户表的查询。但如果参数为DbType.ORACLE_12C,那么实际上是使用MySqlQuery类的对象对目标用户表进行查询(应该是官方的一个Bug)。
另一点需要注意的就是 strategy.setIncludeI()方法中的表名一定要大写,否则无法查询到目标表。