Mybatis-plus 代碼生成器的使用

代碼生成器

MyBatis-Plus（簡稱 MP）是一個 MyBatis 的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。

 

環境參數

 

• 開發工具：IDEA
• 基礎環境：Maven+JDK8
• 所用技術：SpringBoot、mybatis-plus、mysql 
• SpringBoot版本：2.2.6

 

步驟演示

一、添加mybatis plus依賴

       <!--spring-boot web-->
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-web</artifactId>
       </dependency>

      <!--mysql依賴-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.42</version>
            <scope>runtime</scope>
        </dependency>

        <!--生成實體成set set 方法-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!-- mybatisPlus 核心庫 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.0</version>
        </dependency>

        <!-- 引入阿里數據庫連接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.6</version>
        </dependency>

        <!--  mybatis plus 代碼生成器 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.0.6</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.20</version>
        </dependency>

 

二、創建生成器主類

package com.ckf.crm_generator.mapper; import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException; import com.baomidou.mybatisplus.core.toolkit.StringPool; import com.baomidou.mybatisplus.core.toolkit.StringUtils; import com.baomidou.mybatisplus.generator.AutoGenerator; import com.baomidou.mybatisplus.generator.InjectionConfig; import com.baomidou.mybatisplus.generator.config.*; import com.baomidou.mybatisplus.generator.config.po.TableInfo; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine; import java.util.ArrayList; import java.util.List; import java.util.Scanner; /** * 代碼生成器類 * * @author 安詳的苦丁茶 * @version 1.0 * @date 2020/3/23 15:53 */
public class CodeGenerator { /** * <p> * 讀取控制台內容 * </p> */
    public static String scanner(String tip) { Scanner scanner = new Scanner(System.in); StringBuilder help = new StringBuilder(); help.append("請輸入" + tip + "："); System.out.println(help.toString()); if (scanner.hasNext()) { String ipt = scanner.next(); if (StringUtils.isNotEmpty(ipt)) { return ipt; } } throw new MybatisPlusException("請輸入正確的" + tip + "！"); } public static void main(String[] args) { // 代碼生成器
        AutoGenerator mpg = new AutoGenerator(); // 全局配置
        GlobalConfig gc = new GlobalConfig(); final String projectPath = System.getProperty("user.dir"); gc.setOutputDir(projectPath + "/src/main/java"); gc.setAuthor("安詳的苦丁茶"); gc.setBaseResultMap(true); gc.setBaseColumnList(true); // 是否打開輸出目錄 默認為true
        gc.setOpen(false); mpg.setGlobalConfig(gc); // 數據源配置
        DataSourceConfig dsc = new DataSourceConfig(); dsc.setUrl("jdbc:mysql://localhost:3306/ckf_crm?useUnicode=true&useSSL=false&characterEncoding=utf8"); dsc.setDriverName("com.mysql.jdbc.Driver"); dsc.setUsername("root"); dsc.setPassword("root"); mpg.setDataSource(dsc); // 包配置
        final PackageConfig pc = new PackageConfig(); // pc.setModuleName(scanner("模塊名"));
        pc.setParent("com.ckf.crm_generator"); mpg.setPackageInfo(pc); // 自定義配置
        InjectionConfig cfg = new InjectionConfig() { @Override public void initMap() { // to do nothing
 } }; // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl"; // 如果模板引擎是 velocity // String templatePath = "/templates/mapper.xml.vm"; // 自定義輸出配置
        List<FileOutConfig> focList = new ArrayList<FileOutConfig>(); // 自定義配置會被優先輸出
        focList.add(new FileOutConfig(templatePath) { @Override public String outputFile(TableInfo tableInfo) { // 自定義輸出文件名 ， 如果你 Entity 設置了前后綴、此處注意 xml 的名稱會跟着發生變化！！
                return projectPath + "/src/main/resources/mapper/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML; } }); cfg.setFileOutConfigList(focList); mpg.setCfg(cfg); // 配置模板
        TemplateConfig templateConfig = new TemplateConfig(); // 配置自定義輸出模板 // 指定自定義模板路徑，注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別 // templateConfig.setEntity("templates/entity2.java"); // templateConfig.setService(); // templateConfig.setController();
 templateConfig.setXml(null); mpg.setTemplate(templateConfig); // 策略配置
        StrategyConfig strategy = new StrategyConfig(); strategy.setNaming(NamingStrategy.underline_to_camel); strategy.setColumnNaming(NamingStrategy.underline_to_camel); // strategy.setSuperEntityClass("com.fame.common.BaseEntity");
        strategy.setEntityLombokModel(true); strategy.setRestControllerStyle(true); // strategy.setSuperControllerClass("com.fame.common.BaseController");
        strategy.setInclude(scanner("表名，多個英文逗號分割").split(",")); strategy.setSuperEntityColumns("id"); // strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix("sys"); mpg.setStrategy(strategy); mpg.setTemplateEngine(new FreemarkerTemplateEngine()); mpg.execute(); } }

 

這里演示的是springboot項目

dsc.setUrl("jdbc:mysql://localhost:3306/ckf_crm?useUnicode=true&useSSL=false&characterEncoding=utf8"); //數據庫url

gc.setOutputDir(projectPath + "/src/main/java"); //設置文件輸出路徑

pc.setParent("com.ckf.crm_generator");  //父包名


三、接着在生成器類運行main方法，在控制台輸入數據庫表的名稱即可生成三層代碼
效果圖如下

下圖是我項目的路徑（執行代碼生成器之后的項目結構）：

 

然后它是按照mybatis-plus的風格把三層的代碼生成好了
實體類

 

 mapper

 

下面就不截圖那些模塊的代碼了哈，感興趣的可以試一下哈。

 

注意：代碼生成前請確保數據庫中表已經存在。

項目已托管到碼雲
地址：https://gitee.com/ckfeng/crm_generator.git