碼上歡樂
相關內容    簡體    繁體

Mybatis-Plus 代碼生成器基本使用

本文轉載自   查看原文   2019-10-30 08:55   287    MyBatis/ SpringBoot-SpringCloud

Mybatis-Plus 代碼生成器基本使用

參考

https://mp.baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B

依賴

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.1.0</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.2.0</version>
</dependency>
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.29</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

代碼生成類

package com.mozq.boot.mpsand02.mp;

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;

/**
 * @description:
 * @author: changzhou.xie@yuantiaokj.com
 * @date: 2019/10/30 8:20
 */
// 演示例子，執行 main 方法控制台輸入模塊表名回車自動生成對應項目目錄中
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();
        //        String projectPath = System.getProperty("user.dir") + "mp-sand-02";
        //E:\mozq\demo_project\shiromp-sand-02

        String projectPath = System.getProperty("user.dir") + "/mp-sand-02";
        //E:\mozq\demo_project\shiromp-sand-02

        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("mozq");//作者
        gc.setOpen(false);
        // gc.setSwagger2(true); 實體屬性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        //        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        //        // dsc.setSchemaName("public");
        //        dsc.setDriverName("com.mysql.jdbc.Driver");
        //        dsc.setUsername("root");
        //        dsc.setPassword("密碼");
        /*=========== 設置自己的數據庫路徑 ==========*/
        dsc.setUrl("jdbc:mysql://114.215.104.72:3306/smart_sand_sit?serverTimezone=GMT%2B8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("zichen");
        dsc.setPassword("62672000");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //        pc.setModuleName(scanner("模塊名"));
        //        pc.setParent("com.baomidou.ant");
        //        pc.setModuleName("mpsand02");
        /*=========== 設置 Mapper Entity Service ServiceImpl Controller 所在包 ==========*/
        pc.setParent("com.mozq.boot");
        pc.setEntity(scanner("實體包"));
        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<>();
        // 自定義配置會被優先輸出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸出文件名 ， 如果你 Entity 設置了前后綴、此處注意 xml 的名稱會跟着發生變化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                    + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判斷自定義文件夾是否需要創建
                checkDir("調用默認方法創建的目錄");
                return false;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定義輸出模板
        //指定自定義模板路徑，注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        /*=========== 設置為null表示不生成相應的文件 ==========*/
        templateConfig.setService(null);
        templateConfig.setServiceImpl(null);
        templateConfig.setController(null);
        templateConfig.setXml(null);
        templateConfig.setMapper(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //        strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
        strategy.setEntityLombokModel(true);
        //        strategy.setRestControllerStyle(true);
        // 公共父類
        //        strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
        // 寫於父類中的公共字段
        //        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));
        //        strategy.setControllerMappingHyphenStyle(true);
        //        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

命令行運行

請輸入實體包：
mpsand02.pojo.user
請輸入表名，多個英文逗號分割：
sys_user,sys_role,sys_permission
08:46:35.345 [main] DEBUG com.baomidou.mybatisplus.generator.AutoGenerator - ==========================准備生成文件...==========================
08:46:36.245 [main] DEBUG com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine - 創建目錄： [E:\mozq\demo_project\shiro/mp-sand-02/src/main/java\com\mozq\boot\mpsand02\pojo\user]
08:46:36.434 [main] DEBUG com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine - 模板:/templates/entity.java.ftl;  文件:E:\mozq\demo_project\shiro/mp-sand-02/src/main/java\com\mozq\boot\mpsand02\pojo\user\SysPermission.java
08:46:36.436 [main] DEBUG com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine - 模板:/templates/entity.java.ftl;  文件:E:\mozq\demo_project\shiro/mp-sand-02/src/main/java\com\mozq\boot\mpsand02\pojo\user\SysRole.java
08:46:36.439 [main] DEBUG com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine - 模板:/templates/entity.java.ftl;  文件:E:\mozq\demo_project\shiro/mp-sand-02/src/main/java\com\mozq\boot\mpsand02\pojo\user\SysUser.java
08:46:36.439 [main] DEBUG com.baomidou.mybatisplus.generator.AutoGenerator - ==========================文件生成完成！！！==========================

實際生成文件：
com.mozq.boot.mpsand02.pojo.user.SysUser
com.mozq.boot.mpsand02.pojo.user.SysRole
com.mozq.boot.mpsand02.pojo.user.SysPermission

package com.mozq.boot.mpsand02.pojo.user;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import java.time.LocalDateTime;
import java.io.Serializable;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

/**
 * <p>
 * 
 * </p>
 *
 * @author mozq
 * @since 2019-10-30
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class SysUser implements Serializable {

    private static final long serialVersionUID = 1L;

    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    /**
     * 砂廠id
     */
    private Integer companyId;

    /**
     * 用戶名
     */
    private String username;

    /**
     * 密碼
     */
    private String password;

    /**
     * 真實姓名
     */
    private String realName;

    /**
     * 電話號碼
     */
    private String telephone;

    /**
     * 用戶狀態  0-禁用 1-啟用
     */
    private Integer status;

    /**
     * 創建時間
     */
    private LocalDateTime createTime;
    
    /**
     * 系統時間
     */
    private LocalDateTime updateTime;
    
    /**
     * 登錄時間
     */
    private LocalDateTime loginTime;
    
    /**
     * 微信openId
     */
    private String openId;
}

示例2

package com.ytkj.mozq_excel_server.mp;

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;

/**
 * @description:
 * @author: changzhou.xie@yuantiaokj.com
 * @date: 2019/10/30 13:40
 */
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();
        /*=========== 項目路徑+模塊路徑 ==========*/
        String projectPath = System.getProperty("user.dir") + "/mozq_excel_server";
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("mozq");
        gc.setOpen(false);
        // gc.setSwagger2(true); 實體屬性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://114.215.104.72:3306/smart_sand_sit?serverTimezone=GMT%2B8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("zichen");
        dsc.setPassword("62672000");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //            pc.setModuleName(scanner("模塊名"));
        pc.setParent("com.ytkj.mozq_excel_server");
        pc.setEntity(scanner("實體包"));
        pc.setMapper(scanner("Mapper包"));
        pc.setService(scanner("Service包"));
        pc.setServiceImpl(scanner("ServiceImpl包"));
        pc.setController(scanner("Controller包"));
        /*=========== xml文件所在包，默認值為mapper.xml,不需要可以在模板引擎中取消 ==========*/
        pc.setXml("");
        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<>();

        /*=========== 自定義xml文件生成位置 ==========*/
        String mapperxml = scanner("xml位置");

        // 自定義配置會被優先輸出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸出文件名 ， 如果你 Entity 設置了前后綴、此處注意 xml 的名稱會跟着發生變化！！
                return projectPath + "/src/main/resources/static/mybatis" + mapperxml
                    + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判斷自定義文件夾是否需要創建
                checkDir("調用默認方法創建的目錄");
                return false;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定義輸出模板
        //指定自定義模板路徑，注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();
        /*=========== 不生成xml文件包 ==========*/
        templateConfig.setXml(null);//不生成xml包
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //            strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父類
        //            strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
        // 寫於父類中的公共字段
        //            strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多個英文逗號分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        //            strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

請輸入實體包：
pojo.car
請輸入Mapper包：
dao.car
請輸入Service包：
service.car
請輸入ServiceImpl包：
service.impl.car
請輸入Controller包：
controller.car
請輸入xml位置：
/mapper/car
請輸入表名，多個英文逗號分割：
car,car_record

package com.ytkj.mozq_excel_server.pojo.car;

import java.math.BigDecimal;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import java.time.LocalDateTime;
import com.baomidou.mybatisplus.annotation.TableField;
import java.io.Serializable;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

/**
 * <p>
 * 
 * </p>
 *
 * @author mozq
 * @since 2019-10-30
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class CarRecord implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 主鍵
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    /**
     * 車牌號
     */
    @TableField("carLicense")
    private String carLicense;
}

記憶點

項目下有子模塊

//如果項目下有子模塊，則要添加子模塊的路徑，要以斜杠開頭。
String projectPath = System.getProperty("user.dir") + "mp-sand-02";
//E:\mozq\demo_project\shiromp-sand-02

String projectPath = System.getProperty("user.dir") + "/mp-sand-02";
//E:\mozq\demo_project\shiro/mp-sand-02

TemplateConfig控制是否生成相應文件

// 配置模板,可以控制生成哪些
TemplateConfig templateConfig = new TemplateConfig();

// 配置自定義輸出模板
//指定自定義模板路徑，注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();

/*=========== 設置為null表示不生成相應的文件 ==========*/
templateConfig.setService(null);
templateConfig.setServiceImpl(null);
templateConfig.setController(null);
templateConfig.setXml(null);//不生成xml包，和xml配置文件不是一回事。
templateConfig.setMapper(null);
mpg.setTemplate(templateConfig);

控制xml文件生成位置

// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/mapper.xml.vm";

// 自定義輸出配置
List<FileOutConfig> focList = new ArrayList<>();

/*=========== 自定義xml文件生成位置 ==========*/
String mapperxml = scanner("xml位置");

// 自定義配置會被優先輸出
focList.add(new FileOutConfig(templatePath) {
    @Override
    public String outputFile(TableInfo tableInfo) {
        // 自定義輸出文件名 ， 如果你 Entity 設置了前后綴、此處注意 xml 的名稱會跟着發生變化！！
        return projectPath + "/src/main/resources/static/mybatis" + mapperxml
            + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
    }
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 Mybatis-plus 代碼生成器的使用 Mybatis-plus 代碼生成器的使用 六、mybatis-plus的代碼生成器 mybatis-plus代碼生成器 mybatis-plus代碼生成器 mybatis-plus的代碼生成器 Mybatis-plus代碼生成器 mybatis-plus代碼生成器及配置 mybatis-plus 代碼生成器 MyBatis-Plus 代碼生成器模板
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM