引言

最近在學習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

說明：mybatis plus的xml路徑和實體類包名，是要和你項目中一致的，包括datasourse信息，賦值粘貼請記得修改！

?

四、代碼生成器

?

數據庫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 引擎，默認 Velocitympg.setTemplateEngine(new FreemarkerTemplateEngine());// 全局配置GlobalConfig gc = new GlobalConfig();gc.setAuthor("Mht");gc.setOutputDir("D://workspace/spring-boot-mybatis-plus/src/main/java");gc.setFileOverride(false);// 是否覆蓋同名文件，默認是falsegc.setActiveRecord(true);// 不需要ActiveRecord特性的請改為falsegc.setEnableCache(false);// XML 二級緩存gc.setBaseResultMap(true);// XML ResultMapgc.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() {// 自定義數據庫表字段類型轉換【可選】@Overridepublic 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"));} }

代碼生成器請參考：《Mybatis Plus————代碼生成器》

注意事項：

需要更改的地方有：文件輸出路徑（根據項目需要定制），數據源（此類是單獨的數據庫反向生成代碼執行文件，因此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 {@Autowiredprivate 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操作。

六、測試

結果如圖：

總結

通讀全文，我們輕松實現了自己的mybatis持久層整合操作。不得不說mybatis-plus真的非常不錯，本文的對應項目在我的GitHub上，地址是：https://github.com/DragonWatcher/spring-boot-mybatis-plus

簡單，高效，使用起來清晰易懂。不過在整合過程中，依然走了不少彎路，網上的大多解釋都不盡如人意，另外，本項目并未整合Druid（因為還沒接觸過）。

基本流程大概就是這樣，如果在按照上述步驟搭建和部署的過程中出現任何問題，都可以在文末留言和我討論。

?

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的双剑合璧————Spring Boot + Mybatis Plus的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。