文章目錄
- mybatis-plus優勢
-
- 引入逆向工程依賴
- 逆向工程配置
- 逆向工程模闆
- 運作逆向工程
- 逆向工程結構
mybatis-plus優勢
官網:https://mp.baomidou.com/
官網介紹的特點:
- 主要宗旨:隻做增強,不做改變。引入它不會對現有工程産生影響。
- 提高效率:隻需要簡單配置,即可快速進行CRUD操作,進而節省大量時間。
- 功能豐富:熱加載、代碼生成、分頁、性能分析等功能一應俱全。
引入逆向工程依賴
- mybatis-plus逆向工程相關依賴
<!--mybatis-plus 核心依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<!--mybatis-plus generator 逆向工程-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.1</version>
<scope>test</scope>
</dependency>
<!--freemarker引擎-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
- 其他依賴
<!--基礎工具包-->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.10</version>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.20</version>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
-
要使用mybatis-plus還需要加上其他依賴,參考
一起入門mybatis-plus之增删改查
逆向工程配置
/**
* @author hugo0129
* @description Mybatis-Plus代碼生成器
*/
public class MyBatisPlusGenerator {
/**
* <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") + "/spring-mybatis-plus";
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("hugo0129");
gc.setOpen(false);
gc.setDateType(ONLY_DATE);
gc.setServiceImplName("%sRepository");
// 實體屬性 Swagger2 注解
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
// 資料源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/資料庫名稱?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root使用者名");
dsc.setPassword("root密碼");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// pc.setModuleName(scanner("子產品名"));
pc.setParent("com.hugo.talk.ssm");
pc.setEntity("model.entity");
pc.setMapper("repository.mapper");
pc.setServiceImpl("repository");
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/" + 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();
templateConfig.setServiceImpl("template/repository.java");
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 政策配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// strategy.setSuperEntityClass("你自己的父類實體,沒有就不用設定!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父類
// strategy.setSuperControllerClass("你自己的父類控制器,沒有就不用設定!");
// 寫于父類中的公共字段
// strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名,多個英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix("t_");
strategy.setEntityBooleanColumnRemoveIsPrefix(true);
strategy.setEntityColumnConstant(true);
strategy.setEntityTableFieldAnnotationEnable(true);
strategy.setLogicDeleteFieldName("deleted");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
- 上述按需配置,一定要注意各個屬性代表的意思,正确配置
- setOutputDir 這個屬性一定要注意,正确的項目路徑
-
pc.setParent(“com.hugo.talk.ssm”); //設定項目父包名
pc.setEntity(“model.entity”);//設定實體類包名
pc.setMapper(“repository.mapper”);//設定mapper包名
pc.setServiceImpl(“repository”);//設定service Impl包名
mpg.setPackageInfo(pc);
- 以上逆向工程如果配置錯誤,可以操作多次,類似于debug,發現問題再做相應更正
逆向工程模闆
上述筆者逆向工程生成了一個repository,作為service impl的替代,作為資料操作中間層,與業務service脫離。
需要配置的模闆如下:
- repository.java.btl
package ${package.ServiceImpl};
import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Repository;
/**
* <p>
* ${table.comment!} 服務實作類
* </p>
*
* @author ${author}
* @since ${date}
*/
@Repository
<% if(kotlin){ %>
open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>() {
}
<% }else{ %>
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> {
}
<% } %>
- repository.java.ftl
package ${package.ServiceImpl};
import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Repository;
/**
* <p>
* ${table.comment!} 服務實作類
* </p>
*
* @author ${author}
* @since ${date}
*/
@Repository
<#if kotlin>
open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>(){
}
<#else>
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}>{
}
</#if>
- repository.java.vm
package ${package.ServiceImpl};
import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Repository;
/**
* <p>
* $!{table.comment} 服務實作類
* </p>
*
* @author ${author}
* @since ${date}
*/
@Repository
#if(${kotlin})
open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>(){
}
#else
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> {
}
#end
運作逆向工程
上述配置好之後,直接執行MyBatisPlusGenerator類,輸入需要生成的mysql表名稱,即可生成表對應的實體類、mapper、mybatis xml、repository類等。
逆向工程結構
![](https://img.laitimes.com/img/_0nNw4CM6IyYiwiM6ICdiwiIwczX0xiRGZkRGZ0Xy9GbvNGL2EzXlpXazxyMJRlT6NGRNNTR6hFMG1mYw50MMBjVtJWd0ckW65UbM5WOHJWa5kHT20ESjBjUIF2X0hXZ0xCMx81dvRWYoNHLrdEZwZ1Rh5WNXp1bwNjW1ZUba9VZwlHdssmch1mclRXY39CXldWYtlWPzNXZj9mcw1ycz9WL49zZuBnLzIDNxQTO0AjM3ETNwAjMwIzLc52YucWbp5GZzNmLn9Gbi1yZtl2Lc9CX6MHc0RHaiojIsJye.png)