使用 MyBatis-Plus 代碼生成器

MyBatis-Plus（簡稱 MP）是一個 MyBatis 的加強工具，在 MyBatis 的基礎上只作加強不作改變，爲簡化開發、提升效率而生

MyBatis-Plus 的目的是加強 MyBatis 的功能和操做，內置代碼生成器能夠爲咱們減小很多的工做量了，這裏主要介紹 MyBatis-Plus 代碼生成器的使用

代碼生成器也是稱做 MyBatis 的逆向工程，主要是用來生成 model、mapper 等層的代碼，mybatis 官方也有一個 mybatis-generator 的逆向工程，功能很是強大，但生成的代碼比較臃腫，生成的 Example 類用於構造複雜的篩選條件，使用起來不友好。相比起來 mybatis-plus 生成的代碼簡潔優雅，配合 CRUD 接口和條件構造器，使用起來也方便

代碼生成器

添加依賴

代碼生成器的依賴

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>最新版本</version>
</dependency>

MyBatis-Plus 3.0.3 以後移除了自動模板引擎依賴，須要手動添加對應引擎的依賴座標

<!-- velocity 模板引擎, 默認 -->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>最新版本</version>
</dependency>

<!-- freemarker 模板引擎 -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>最新版本</version>
</dependency>

<!-- beetl 模板引擎 -->
<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>最新版本</version>
</dependency>

生成代碼

AutoGenerator 是 MyBatis-Plus 的代碼生成器，經過 AutoGenerator 能夠快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各個模塊的代碼，極大的提高了開發效率

public class Generator {

    /**
     * <p>
     * 讀取控制檯內容
     * </p>
     */
    private static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        System.out.println("請輸入" + tip + "：");
        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");
        gc.setOutputDir(projectPath + "/src/main/java"); // 生成文件的輸出目錄,默認D根目錄
        gc.setFileOverride(true); // 是否覆蓋已有文件
        gc.setAuthor("zou");
        gc.setOpen(false); // 是否打開輸出目錄,默認true
        gc.setEnableCache(true); // 是否在xml中添加二級緩存配置,默認false
        gc.setSwagger2(true); // 開啓 swagger2 模式,默認false

        gc.setEntityName("%sModel");
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setServiceName("I%sService");
        gc.setServiceImplName("%sServiceImpl");
        gc.setControllerName("%sController");
        mpg.setGlobalConfig(gc);

        // 數據源配置
        DataSourceConfig dsc = new DataSourceConfig();
        Properties properties = new Properties();
        try {
            properties.load(new FileInputStream("src/main/resources/generator.properties"));
            dsc.setUrl(properties.getProperty("generator.jdbc.url"));
            // dsc.setSchemaName("public");
            dsc.setDriverName(properties.getProperty("generator.jdbc.driver"));
            dsc.setUsername(properties.getProperty("generator.jdbc.username"));
            dsc.setPassword(properties.getProperty("generator.jdbc.password"));
            mpg.setDataSource(dsc);
        } catch (IOException e) {
            throw new RuntimeException("數據源配置錯誤", e);
        }

        // 包名配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模塊名"));
        pc.setParent("com.shiyu");
        pc.setEntity("model");
        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) {
                // 自定義輸出文件名
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName() + "/"
                    + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        // 配置自定義輸出模板
        // templateConfig.setEntity();
        // 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); // 數據庫表字段映射到實體的命名策略, 未指定按照 naming 執行
        // strategy.setSuperEntityClass("com.shiyu.BaseEntity"); //自定義繼承的Entity類全稱，帶包名
        // strategy.setSuperEntityColumns(new String[] {"id","gmtCreate","gmtModified"});// 自定義基礎的Entity類，公共字段
        strategy.setEntityLombokModel(true); // 是否爲lombok模型
        strategy.setEntityBooleanColumnRemoveIsPrefix(true); // Boolean類型字段是否移除is前綴
        strategy.setRestControllerStyle(true); // 生成 @RestController 控制器
        // strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
        // strategy.setInclude("upms_user"); //包含的表名
        strategy.setExclude("upms_role"); // 排除的表名

        strategy.setControllerMappingHyphenStyle(true); // 駝峯轉連字符 如 umps_user 變爲 upms/user
        strategy.setTablePrefix(pc.getModuleName() + "_"); // 表前綴

        mpg.setStrategy(strategy);
        // mpg.setTemplateEngine(new FreemarkerTemplateEngine()); //設置模板引擎類型，默認爲 velocity
        // mpg.setTemplateEngine(new FreemarkerTemplateEngine()); // 切換爲 freemarker 模板引擎
        // mpg.setTemplateEngine(new BeetlTemplateEngine()); //切換爲 beetl 模板引擎
        mpg.execute();
    }

}