Oracle 12C + Mybatis-Plus實現代碼生成

前言

最近在寫一個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()方法中的表名一定要大寫，否則無法查詢到目標表。

更多配置請參考：https://mp.baomidou.com/config/generator-config.html#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE

3. 運行程序，生成代碼及文件