最近看到不少人在用mybatis plus,代碼生成工具更好用。想起之前用mybatis 自己花了很大的功夫去實現這個代碼生成工具,生成的代碼只有dao層(即,那個mapper)層。我們今天就來搭建一個spring boot + mybatis plus 項目,實現一個代碼生成器。
1.準備
先來看看我們的數據庫表,這裏有一個student表,只有3個字段,如下圖:
2. 搭建
2.1 先搭建一個基礎springboot
(1)點擊IDEA左上角的File | new Project 到下面界面
(2)點擊Next,填寫座標等基本設置,如下圖:
(3)點擊Next,添加lombok,MySQL,web相關依賴,如下圖:
(4)點擊Next設置項目存放路徑,如下圖:
到這裏我們一個基礎的spring boot就有了,接下來在該項目上做修改。
2.2 修改pom文件
首先在pom文件中把springboot的版本修改爲2.2.0,接着添加下面的依賴:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
</dependency>
<!--mybatis-plus依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.2.0</version>
</dependency>
<!--mybatis-plus代碼生成器依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.2.0</version>
</dependency>
<!--引入freemarker,自動生成代碼的時候會用到-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
整個pom文件內容如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.0.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.cdd</groupId>
<artifactId>mybatis-plus-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>mybatis-plus-demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
</dependency>
<!--mybatis-plus依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.2.0</version>
</dependency>
<!--mybatis-plus代碼生成器依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.2.0</version>
</dependency>
<!--引入freemarker,自動生成代碼的時候會用到-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
<!--工具-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2.3 修改配置文件
新建一個application.yml文件,配置如下:
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/spring-frame-db?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true
username: root
password: root
mybatis-plus:
mapper-locations: classpath*:/mybatis/mapper/**Mapper.xml
2.4 配置maper接口掃描包
啓動類上打上@MapperScan註解
2.5 編寫代碼生成器
(1)新建一個util包,編寫代碼生成的類CodeGeneratorUtil,放在該包下,內容如下:
package com.cdd.demo.util;
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 代碼生成器工具類
* 詳細可參考官方文檔:https://mp.baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B
* @Author cdd
* @Date 2020/6/4
* @Vesrion v1.0
**/
public class CodeGeneratorUtil {
public static final String DB_URL = "jdbc:mysql://localhost:3306/spring-frame-db?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=UTC";
public static final String DB_DRIVER_NAME = "com.mysql.cj.jdbc.Driver";
public static final String BASE_PACKAGE_PATH = "com.cdd.demo";
/**
* Description: 窗口獲取信息
* @Author: cdd
* @Param: [tip]
* @Return: java.lang.String
*/
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 + "!");
}
/**
* Description: 執行生成代碼
* @Author: cdd
* @Param: []
* @Return: void
*/
public static void execute() {
// 代碼生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir"); // 獲取當前項目路徑
gc.setOutputDir(projectPath + "/src/main/java"); // 設置基礎包路徑
gc.setAuthor("cdd"); // Mapper,Service等類註解中顯示創建人信息
gc.setOpen(false); // 文件生成完畢後,是否需要打開所在路徑
// gc.setSwagger2(true); // 實體屬性 Swagger2 註解
// gc.setBaseColumnList(true); // 在Mapper.xml文件中是否生成公用SQL代碼段
// gc.setBaseResultMap(true); // 在Mapper.xml文件中是否生成公用返回集合ResultMap
mpg.setGlobalConfig(gc);
// 數據源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl(CodeGeneratorUtil.DB_URL);
// dsc.setSchemaName("public");
dsc.setDriverName(CodeGeneratorUtil.DB_DRIVER_NAME);
dsc.setUsername("root");
dsc.setPassword("root");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// pc.setModuleName(scanner("模塊名")); // 模塊名稱
pc.setParent(CodeGeneratorUtil.BASE_PACKAGE_PATH); // 基礎包路徑
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/mybatis/mapper/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
/*
cfg.setFileCreate(new IFileCreate() {
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
// 判斷自定義文件夾是否需要創建
checkDir("調用默認方法創建的目錄,自定義目錄用");
if (fileType == FileType.MAPPER) {
// 已經生成 mapper 文件判斷存在,不想重新生成返回 false
return !new File(filePath).exists();
}
// 允許生成模板文件
return true;
}
});
*/
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
mpg.setTemplate(new TemplateConfig().setXml(null));
// 策略配置,具體配置可查看官方文檔:
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel); // Entity文件名稱命名規範
strategy.setColumnNaming(NamingStrategy.underline_to_camel); // Entity字段名稱
strategy.setRestControllerStyle(true); // Controller註解使用是否RestController標註,否則是否開啓使用Controller標註
// strategy.setSuperEntityClass("你自己的父類實體,沒有就不用設置!"); // Entity的公共父類
strategy.setEntityLombokModel(true); // 是否使用lombok完成Entity實體標註Getting Setting ToString 方法
strategy.setControllerMappingHyphenStyle(true); // Controller註解名稱,不使用駝峯,使用連字符
// strategy.setSuperControllerClass("你自己的父類控制器,沒有就不用設置!"); // controller公共父類
strategy.setInclude(scanner("表名,多個英文逗號分割").split(","));
// strategy.setTablePrefix(pc.getModuleName() + "_"); // 表前綴,添加該表示,則生成的實體,不會有表前綴,比如sys_dept 生成就是Dept
// strategy.setFieldPrefix("sys_"); // 字段前綴
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine()); // 用的是freeemarker模板引擎
mpg.execute();
}
public static void main(String[] args) {
execute();
}
}
(2)運行該類的main方法,再輸入表名,如下圖:
(3)再來看看我們的項目結構,
3 測試
(1)在StudentController裏面,我們來寫一個接口測試下,StudentController類內容如下:
package com.cdd.demo.controller;
import com.cdd.demo.service.IStudentService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
/**
* <p>
* 學生表 前端控制器
* </p>
*
* @author cdd
* @since 2020-06-04
*/
@RestController
@RequestMapping("/student")
public class StudentController {
@Resource
IStudentService studentService;
@GetMapping("/test")
public Object test(){
return studentService.getById(1L);
}
}
(2)啓動該項目,啓動成功後,在瀏覽器地址欄輸入:http://localhost:8080/student/test ,響應如下: