利用Mybatis-Plus代碼生成器快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各個模塊的代碼

時間 2019-11-18

標籤利用 mybatis 代碼成器快速生成 entity mapper xml service controller 各個模塊欄目 MyBatis 简体版

原文原文鏈接

一、添加依賴

1>添加代碼生成器依賴html

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.2.0</version>
</dependency>

2>添加模板引擎依賴，MyBatis-Plus 支持 Velocity（默認）、Freemarker、Beetl，用戶能夠選擇本身熟悉的模板引擎，若是都不知足您的要求，能夠採用自定義模板引擎。java

Velocity（默認）：mysql

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.1</version>
</dependency>

Freemarker：sql

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.29</version>
</dependency>

Beetl：數據庫

<dependency>
    <groupId>com.ibeetl</groupId>
    <artifactId>beetl</artifactId>
    <version>3.0.13.RELEASE</version>
</dependency>

二、話很少說，直接上代碼

  1 package com.example.shiro.generator;
  2 
  3 import com.baomidou.mybatisplus.annotation.DbType;
  4 import com.baomidou.mybatisplus.generator.AutoGenerator;
  5 import com.baomidou.mybatisplus.generator.config.*;
  6 import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  7 import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
  8 import org.junit.Test;
  9 
 10 /**
 11  *  運行此方法生成mybatis代碼
 12  *  生成代碼自動放入對應目錄
 13  * @author wangshu
 14  * @create 2019/10/18
 15  */
 16 public class MyBatisGeneratorRun {
 17     //數據庫類型
 18     private final DbType dbType = DbType.MYSQL;
 19     //數據庫連結信息
 20     private final String dbUrl = "jdbc:mysql://***:3306/***?useUnicode=true&characterEncoding=UTF8&serverTimezone=Asia/Shanghai&useSSL=false&autoReconnect=true&autoReconnectForPools=true&allowMultiQueries=true";
 21     private final String driver = "com.mysql.cj.jdbc.Driver";
 22     private final String userName = "***";
 23     private final String password = "***";
 24 
 25     //項目名
 26     private final String projectName = "***";
 27     //指定包名
 28     private final String packageName = "***";
 29     //controller基礎類
 30     private final String superControllerClass = packageName + ".common.BaseController";
 31     //entity基礎類
 32     private final String superEntityClass = packageName + ".common.BaseEntity";
 33     //模塊名 若是有模塊名，則需在模塊名前加. 例：.log
 34     private final String moduleName = "";
 35     //做者名
 36     private final String author = "wangshu";
 37     //指定生成的表名
 38     private final String[] tableNames = new String[]{"log", "demo"};
 39 
 40 
 41     @Test
 42     public void generateCode() {
 43         //serviceNameStartWithI：user -> UserService, 設置成true: user -> IUserService
 44         generateByTables(false, packageName, tableNames);
 45     }
 46     /**
 47      * 根據表自動生成
 48      * @param serviceNameStartWithI 默認爲false
 49      * @param packageName      包名
 50      * @param tableNames      表名
 51      * @author Terry
 52      */
 53     private void generateByTables(boolean serviceNameStartWithI, String packageName, String... tableNames) {
 54         //配置數據源
 55         DataSourceConfig dataSourceConfig = getDataSourceConfig();
 56         // 策略配置
 57         StrategyConfig strategyConfig = getStrategyConfig(tableNames);
 58         //全局變量配置
 59         GlobalConfig globalConfig = getGlobalConfig(serviceNameStartWithI);
 60         //包名配置
 61         PackageConfig packageConfig = getPackageConfig(packageName);
 62         //自動生成
 63         atuoGenerator(dataSourceConfig, strategyConfig, globalConfig, packageConfig);
 64     }
 65     /**
 66      * 集成
 67      * @param dataSourceConfig 配置數據源
 68      * @param strategyConfig  策略配置
 69      * @param config      全局變量配置
 70      * @param packageConfig  包名配置
 71      * @author Terry
 72      */
 73     private void atuoGenerator(DataSourceConfig dataSourceConfig, StrategyConfig strategyConfig, GlobalConfig config, PackageConfig packageConfig) {
 74         new AutoGenerator()
 75                 .setGlobalConfig(config)
 76                 .setDataSource(dataSourceConfig)
 77                 .setStrategy(strategyConfig)
 78                 .setPackageInfo(packageConfig)
 79                 .setTemplateEngine(new FreemarkerTemplateEngine())
 80                 .execute();
 81     }
 82     /**
 83      * 設置包名
 84      * @param packageName 父路徑包名
 85      * @param packageName 模塊名
 86      * @return PackageConfig 包名配置
 87      * @author Terry
 88      */
 89     private PackageConfig getPackageConfig(String packageName) {
 90         return new PackageConfig()
 91                 .setParent(packageName)
 92                 .setXml("mapper.xml" + moduleName)
 93                 .setMapper("mapper." + moduleName)
 94                 .setController("controller." + moduleName)
 95                 .setEntity("entity." + moduleName);
 96     }
 97     /**
 98      * 全局配置
 99      * @param serviceNameStartWithI false
100      * @return GlobalConfig
101      * @author Terry
102      */
103     private GlobalConfig getGlobalConfig(boolean serviceNameStartWithI) {
104         GlobalConfig globalConfig = new GlobalConfig();
105         globalConfig
106                 .setBaseColumnList(true)
107                 .setBaseResultMap(true)
108                 .setActiveRecord(false)
109                 //做者
110                 .setAuthor(author)
111                 //設置輸出路徑
112                 .setOutputDir(getOutputDir(projectName))
113                 .setFileOverride(true);
114         if (!serviceNameStartWithI) {
115             //設置service名
116             globalConfig.setServiceName("%sService");
117         }
118         return globalConfig;
119     }
120     /**
121      * 返回項目路徑
122      * @param projectName 項目名
123      * @return 項目路徑
124      * @author Terry
125      */
126     private String getOutputDir(String projectName) {
127 //        String path = this.getClass().getClassLoader().getResource("").getPath();
128 //        int index = path.indexOf(projectName);
129         return "D:/IntelliJ IDEA 2019.2/workSpace/" + projectName + "/src/main/java/";
130     }
131     /**
132      * 策略配置
133      * @param tableNames 表名
134      * @return StrategyConfig
135      * @author Terry
136      */
137     private StrategyConfig getStrategyConfig(String... tableNames) {
138         return new StrategyConfig()
139                 // 全局大寫命名 ORACLE 注意
140                 .setCapitalMode(true)
141                 //從數據庫表到文件的命名策略
142                 .setNaming(NamingStrategy.underline_to_camel)
143                 //須要生成的的表名，多個表名傳數組
144                 .setInclude(tableNames)
145                 //公共父類
146                 .setSuperControllerClass(superControllerClass)
147                 .setSuperEntityClass(superEntityClass)
148                 // 寫於父類中的公共字段
149                 .setSuperEntityColumns("id")
150                 //使用lombok
151                 .setEntityLombokModel(true)
152                 //rest風格
153                 .setRestControllerStyle(true);
154     }
155     /**
156      * 配置數據源
157      * @return 數據源配置 DataSourceConfig
158      * @author Terry
159      */
160     private DataSourceConfig getDataSourceConfig() {
161         return new DataSourceConfig().setDbType(dbType)
162                 .setUrl(dbUrl)
163                 .setUsername(userName)
164                 .setPassword(password)
165                 .setDriverName(driver);
166     }
167     /**
168      * 根據表自動生成
169      * @param packageName 包名
170      * @param tableNames 表名
171      * @author Terry
172      */
173     @SuppressWarnings("unused")
174     private void generateByTables(String packageName, String... tableNames) {
175         generateByTables(true, packageName, tableNames);
176     }
177 }