玩轉SpringBoot之MyBatisplus自動化構建工具

淼淼之森發表於2019-07-12
Spring BootMyBatis

使用MyBatisplus自動化構建專案

為什麼要用這個？

  • 方便
  • 因為之前那種方式讓我用起來不爽了：mybatis逆向工程（MyBatis Generator）
  • 能緊密的貼合mybatis，並且MyBatisplus的很多api用起來也更加方便，能大大提高開發效率

開始使用

0、構建一個普通的Maven工程，這裡就不再贅述了

1、導包：匯入需要使用到的依賴

<dependencies>
    <!-- mybatisplus生成工具需要的依賴 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.0.6</version>
        <scope>compile</scope>
    </dependency>
    <!-- 模板引擎 -->
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity</artifactId>
        <version>1.7</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.0</version>
    </dependency>
    <!-- 模板依賴了日誌，所以需要該包 -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.25</version>
    </dependency>

    <!-- Spring依賴，否則@Service等註解會報錯 -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring</artifactId>
        <version>2.5.6.SEC03</version>
    </dependency>

    <!-- 資料庫連線依賴-->
    <!--新增MySql依賴 -->
    <!--
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.42</version>
    </dependency>
    -->
    <!-- 新增Oracle依賴 -->
    <dependency>
        <groupId>com.oracle</groupId>
        <artifactId>ojdbc6</artifactId>
        <version>11.2.0.3</version>
    </dependency>

    <!-- Mybatis Plus Dependencies -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>3.0.7.1</version>
    </dependency>

</dependencies>

此處要注意的一點就是：因為使用的是MyBatisplus的自動化構建工具，故在引入的依賴中，不再使用mybatis的依賴包：

<!--新增Mybatis依賴 配置mybatis的一些初始化的東西-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>

而是需要使用MyBatisplus的依賴包：

<!-- Mybatis Plus Dependencies -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>3.0.7.1</version>
</dependency>

2、自動化構建工具類

package com.java.mmzsit;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.lang.reflect.Field;

/**
 * @author ：mmzsit
 * @description：MyBatisplus自動化構建工具
 * @date ：2019/6/14 14:45
 */

public class generator {
    public static void main(String[] args) throws Exception {
        AutoGenerator mpg = new AutoGenerator();
        // TODO 此處務必記得修改
        String outputDir = "D:\\WorkspaceGit\\mybatisPlus-generator\\src\\main\\java";

        // 全域性配置
        GlobalConfig gc = new GlobalConfig();
        gc.setOutputDir(outputDir);
        gc.setFileOverride(true);
        gc.setActiveRecord(true);
        // XML 二級快取
//        gc.setEnableCache(true);
        // XML ResultMap
        gc.setBaseResultMap(true);
        // XML columList
        gc.setBaseColumnList(true);
        gc.setAuthor("mmzsit");

        // 自定義檔案命名，注意 %s 會自動填充表實體屬性！
        gc.setMapperName("I%sMapper");
        gc.setXmlName("%sMapper");
        gc.setServiceName("I%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setControllerName("%sController");
        mpg.setGlobalConfig(gc);

        // 資料來源配置mysql
//        DataSourceConfig dsc = new DataSourceConfig();
//        dsc.setDbType(DbType.MYSQL);
//        dsc.setDriverName("com.mysql.jdbc.Driver");
//        dsc.setUrl("jdbc:mysql://localhost:3306/itresources?useUnicode=true&amp;characterEncoding=UTF-8&amp;generateSimpleParameterMetadata=true");
//        dsc.setUsername("root");
//        dsc.setPassword("123456");
//        mpg.setDataSource(dsc);
        // 資料來源配置oracle
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.ORACLE);
        dsc.setDriverName("oracle.jdbc.OracleDriver");
        dsc.setUrl("jdbc:oracle:thin:@localhost:1521/ORCL");
        dsc.setUsername("mmzsit");
        dsc.setPassword("mmzsit");
        mpg.setDataSource(dsc);


        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 表名生成策略
        strategy.setNaming(NamingStrategy.underline_to_camel);
        // 需要生成的表,大小寫一定要正確
        strategy.setInclude(new String[]{"TESTDATAS"});
        // 排除生成的表
//        strategy.setExclude(new String[]{"order"});
        Field field = strategy.getClass().getDeclaredField("logicDeleteFieldName");
        field.setAccessible(true);
        field.set(strategy, "logic_del");
        mpg.setStrategy(strategy);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.java.mmzsit");
//        pc.setModuleName("dc");
        mpg.setPackageInfo(pc);

        // 執行生成
        mpg.execute();
        System.out.println("自動構建完成！");
    }

}

執行上面的java程式碼，即可完成一次自動化構建；

3、值得注意的一點

在.yml配置檔案中，也不再使用：

mybatis:
  # mapper對映檔案
  mapper-locations: classpath:mapper/*Mapper.xml

而是使用的配置寫法：

mybatis-plus:
  # mapper對映檔案
  mapper-locations: classpath:mapper/*Mapper.xml

構建完成後，生成程式碼效果圖

玩轉SpringBoot之MyBatisplus自動化構建工具

總結

相對而言，使用這種方式自動化構建方便快捷；而且後期維護也很簡易。但唯一不舒服的就是生成的實體類還是使用的get、set的方式構建的，而不是使用lombok構建的。


程式碼已經提交github：mybatisPlus-generator


相關文章