雙劍合璧————Spring Boot + Mybatis Plus
阿新 • • 發佈：2019-01-30
引言
最近在學習Mybatis Plus的使用，希望通過spring boot快速將mybatis plus整合進來。
對於springboot專案，mybatis plus團隊也有自己的啟動器 ：mybatis-plus-boot-starter。這個依賴內部已經整合了mybatis-spring，也包括非快速啟動的mybatis-plus（這個依賴需要額外的配置資料來源等資訊），所以如果您在網上看到引入兩個和mybatis-plus有關的依賴的話完全是多餘的。
操作步驟
一、建立spring boot
首先建立一個spring boot專案（參考：《SpringBoot————快速搭建springboot專案
二、新增必需依賴
接著再去引一下阿里的fastjson，以及模板生成需要的freemarker（mybatis-plus預設使用velocity，無需糾結於此，兩者任選其一）。最重要的，我們需要引入mybatis-plus-boot-starter依賴（可以從maven庫找到：maven中央庫）
此處選用2.2.0版本的mp啟動器：
<!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>2.2.0</version> </dependency>
說明：mybatis plus 2.3版本引入後會出現莫名其妙的異常，但是同樣的應用環境下，2.2.0就完全沒有問題，我在查詢使用者列表的時候使用2.2.0版本的依賴是完全OK的，但是把版本號改為2.3後就會在查詢時報錯，但未糾結於此，有碰到同樣問題的朋友歡迎文末留言。
至此，我們的pom依賴全部完畢（是不是很驚喜？！），完整pom.xml如下：
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.mht</groupId> <artifactId>spring-boot-mybatis-plus</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>spring-boot-mybatis-plus</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.3.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <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> <!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>2.2.0</version> </dependency> <!-- freemarker --> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> </dependency> <!-- fastjson --> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.15</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
說明：可以看到，包括web依賴和mysql驅動依賴，總共就添加了五個依賴。當然，此處也只是一個Demo樣例，並未新增阿里的Druid連線池，但是完全不會影響我們實現大量而基本的持久層操作。
三、spring boot資料來源配置
這個不說廢話，直接上完整application.properties檔案：
server.port=8080
#mysql
spring.datasource.url=jdbc:mysql://localhost:3306/ease-run?useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#mybatis-plus
mybatis-plus.mapper-locations=classpath:com/mht/springbootmybatisplus/mapper/xml/*.xml
mybatis-plus.type-aliases-package=com.mht.springbootmybatisplus.entity
四、程式碼生成器
資料庫user表：
生成器：
package com.mht.springbootmybatisplus.generate;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.DbType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
/**
* <p>
* 程式碼生成器演示
* </p>
*/
public class MpGenerator {
public static void main(String[] args) {
// assert (false) : "程式碼生成屬於危險操作，請確定配置後取消斷言執行程式碼生成！";
AutoGenerator mpg = new AutoGenerator();
// 選擇 freemarker 引擎，預設 Velocity
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
// 全域性配置
GlobalConfig gc = new GlobalConfig();
gc.setAuthor("Mht");
gc.setOutputDir("D://workspace/spring-boot-mybatis-plus/src/main/java");
gc.setFileOverride(false);// 是否覆蓋同名檔案，預設是false
gc.setActiveRecord(true);// 不需要ActiveRecord特性的請改為false
gc.setEnableCache(false);// XML 二級快取
gc.setBaseResultMap(true);// XML ResultMap
gc.setBaseColumnList(false);// XML columList
/* 自定義檔案命名，注意 %s 會自動填充表實體屬性！ */
// gc.setMapperName("%sDao");
// gc.setXmlName("%sDao");
// gc.setServiceName("MP%sService");
// gc.setServiceImplName("%sServiceDiy");
// gc.setControllerName("%sAction");
mpg.setGlobalConfig(gc);
// 資料來源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL);
dsc.setTypeConvert(new MySqlTypeConvert() {
// 自定義資料庫表字段型別轉換【可選】
@Override
public DbColumnType processTypeConvert(String fieldType) {
System.out.println("轉換型別：" + fieldType);
// 注意！！processTypeConvert 存在預設型別轉換，如果不是你要的效果請自定義返回、非如下直接返回。
return super.processTypeConvert(fieldType);
}
});
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setUrl("jdbc:mysql://localhost:3306/ease-run?useUnicode=true&characterEncoding=utf8");
mpg.setDataSource(dsc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
// strategy.setCapitalMode(true);// 全域性大寫命名 ORACLE 注意
strategy.setTablePrefix(new String[] { "user_" });// 此處可以修改為您的表字首
strategy.setNaming(NamingStrategy.nochange);// 表名生成策略
strategy.setInclude(new String[] { "user" }); // 需要生成的表
// strategy.setExclude(new String[]{"test"}); // 排除生成的表
// 自定義實體父類
// strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
// 自定義實體，公共欄位
// strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
// 自定義 mapper 父類
// strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
// 自定義 service 父類
// strategy.setSuperServiceClass("com.baomidou.demo.TestService");
// 自定義 service 實現類父類
// strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
// 自定義 controller 父類
// strategy.setSuperControllerClass("com.baomidou.demo.TestController");
// 【實體】是否生成欄位常量（預設 false）
// public static final String ID = "test_id";
// strategy.setEntityColumnConstant(true);
// 【實體】是否為構建者模型（預設 false）
// public User setName(String name) {this.name = name; return this;}
// strategy.setEntityBuilderModel(true);
mpg.setStrategy(strategy);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.mht.springbootmybatisplus");
// pc.setModuleName("test");
mpg.setPackageInfo(pc);
// 注入自定義配置，可以在 VM 中使用 cfg.abc 【可無】
// InjectionConfig cfg = new InjectionConfig() {
// @Override
// public void initMap() {
// Map<String, Object> map = new HashMap<String, Object>();
// map.put("abc", this.getConfig().getGlobalConfig().getAuthor() +
// "-mp");
// this.setMap(map);
// }
// };
//
// // 自定義 xxList.jsp 生成
// List<FileOutConfig> focList = new ArrayList<>();
// focList.add(new FileOutConfig("/template/list.jsp.vm") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// // 自定義輸入檔名稱
// return "D://my_" + tableInfo.getEntityName() + ".jsp";
// }
// });
// cfg.setFileOutConfigList(focList);
// mpg.setCfg(cfg);
//
// // 調整 xml 生成目錄演示
// focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// return "/develop/code/xml/" + tableInfo.getEntityName() + ".xml";
// }
// });
// cfg.setFileOutConfigList(focList);
// mpg.setCfg(cfg);
//
// // 關閉預設 xml 生成，調整生成 至 根目錄
// TemplateConfig tc = new TemplateConfig();
// tc.setXml(null);
// mpg.setTemplate(tc);
// 自定義模板配置，可以 copy 原始碼 mybatis-plus/src/main/resources/templates 下面內容修改，
// 放置自己專案的 src/main/resources/templates 目錄下, 預設名稱一下可以不配置，也可以自定義模板名稱
// TemplateConfig tc = new TemplateConfig();
// tc.setController("...");
// tc.setEntity("...");
// tc.setMapper("...");
// tc.setXml("...");
// tc.setService("...");
// tc.setServiceImpl("...");
// 如上任何一個模組如果設定 空 OR Null 將不生成該模組。
// mpg.setTemplate(tc);
// 執行生成
mpg.execute();
// 列印注入設定【可無】
// System.err.println(mpg.getCfg().getMap().get("abc"));
}
}
注意事項：
需要更改的地方有：檔案輸出路徑（根據專案需要定製），資料來源（此類是單獨的資料庫反向生成程式碼執行檔案，因此springboot的資料來源不起作用），包配置，以及一些基本的生成策略...總之還是參考一下我的另一篇文章吧，謝謝！
執行，重新整理，獲得自動生成的業務程式碼，不再贅述。
注意！！！生成後一定記得在spring boot專案中新增mybatis的包掃描路徑，或@Mapper註解：
@SpringBootApplication
@MapperScan("com.mht.springbootmybatisplus.mapper")
public class SpringBootMybatisPlusApplication {
private static final Logger logger = LoggerFactory.getLogger(SpringBootMybatisPlusApplication.class);
public static void main(String[] args) {
SpringApplication.run(SpringBootMybatisPlusApplication.class, args);
logger.info("========================啟動完畢========================");
}
}或：
@Mapper
public interface UserMapper extends BaseMapper<User> {
}否則會報：Error creating bean with name 'xxxServiceImpl': Unsatisfied dependency expressed through field 'baseMapper';
至此，我們的底層增刪改查操作全部完畢！下面來編寫簡單的controller來測試效果。
五、緊張有序的測試準備工作
controller：
package com.mht.springbootmybatisplus.web;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.alibaba.fastjson.JSONObject;
import com.baomidou.mybatisplus.plugins.Page;
import com.mht.springbootmybatisplus.entity.User;
import com.mht.springbootmybatisplus.service.IUserService;
/**
* <p>
* 前端控制器
* </p>
*
* @author Mht
* @since 2018-06-23
*/
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private IUserService userSvc;
@GetMapping(value = "/show")
public JSONObject testEnum() {
Page<User> users = userSvc.selectPage(new Page<>(1, 10));
JSONObject result = new JSONObject();
result.put("users", users);
return result;
}
}
資料庫中的資料：
說明：mybatis-plus已經為我們將基本的crud操作封裝以待，在程式碼生成的過程中我們也已經看到UserMapper介面自動繼承了BaseMapper介面，它裡面有豐富的介面方法且已經按照常規的開發習慣實現完畢，雖然我們的Mapper介面中一個方法都沒有，卻可以實現大部分crud操作。
六、測試
結果如圖：
總結
簡單，高效，使用起來清晰易懂。不過在整合過程中，依然走了不少彎路，網上的大多解釋都不盡如人意，另外，本專案並未整合Druid（因為還沒接觸過）。
基本流程大概就是這樣，如果在按照上述步驟搭建和部署的過程中出現任何問題，都可以在文末留言和我討論。