引言
最近在学习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启动器:
com.baomidou
mybatis-plus-boot-starter
2.2.0
说明:mybatis plus 2.3版本引入后会出现莫名其妙的异常,但是同样的应用环境下,2.2.0就完全没有问题,我在查询用户列表的时候使用2.2.0版本的依赖是完全OK的,但是把版本号改为2.3后就会在查询时报错,但未纠结于此,有碰到同样问题的朋友欢迎文末留言。
至此,我们的pom依赖全部完毕(是不是很惊喜?!),完整pom.xml如下:
4.0.0
<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>
说明:可以看到,包括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;
/**
- 代码生成器演示
*/
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"));
}
}
代码生成器请参考:《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 {
}
否则会报: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;
/**
- 前端控制器
*- @author Mht
- @since 2018-06-23
*/
@RestController
@RequestMapping(“/user”)
public class UserController {
@Autowired
private IUserService userSvc; @GetMapping(value = “/show”)
public JSONObject testEnum() {
Page 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(因为还没接触过)。
基本流程大概就是这样,如果在按照上述步骤搭建和部署的过程中出现任何问题,都可以在文末留言和我讨论。
作者:圣斗士Morty
来源:CSDN
原文:https://blog.csdn.net/u014745069/article/details/80783122
版权声明:本文为博主原创文章,转载请附上博文链接!