Spring boot 入门教程-集成Mybatis-Plus
简介
MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
愿景
我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。
#特性
- 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
- 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
- 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
- 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
- 支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库
- 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
- 支持 XML 热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML 启动
- 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
- 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
- 支持关键词自动转义：支持数据库关键词（order、key......）自动转义，还可自定义关键词
- 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
- 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
- 内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
- 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
- 内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击
#框架结构
以上内容来自Mybatis-Plus官网，内容非常详细，既然提供了很多遍历那就学习一下,以下是我学习过程的记录。
先贴一下maven依赖：
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.46</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.7</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.28</version>
</dependency>
<!-- 模板引擎 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.0.9</version>
</dependency>
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-mapper-asl</artifactId>
<version>1.5.0</version>
</dependency>这里是我把后续要用到的依赖一起加上了，包含swagger,fastjson,jackson,freemarker,velocity，lombok等，当然最主要的是mybatis-plus-boot-starter，这里用的3.0.3 的版本算是比较新的了。引入它之后就不需要在添加mybatis 依赖了。
配置数据源 application.properties 中添加
spring.datasource.url=jdbc:mysql://localhost:3306/exchange?useUnicode=true&characterEncoding=gbk&useSSL=false&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
添加数据源配置类：
@Configuration
public class MybatisConfig {
@Bean
@ConfigurationProperties(prefix = "spring.datasource")
public DataSource druidDataSource() {
return new DruidDataSource();
}
/**
* 分页拦截器
* @return
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}使用一下MP 的代码生成功能：
创建代码生成器类：
package com.elens.data.rbces.mybatis;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
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.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.apache.commons.lang3.StringUtils;
import java.util.ArrayList;
import java.util.List;
import java.util.ResourceBundle;
/**
* @BelongsProject: rbc-es
* @BelongsPackage: com.elens.data.rbces.mybatis
* @Author: xuweichao
* @CreateTime: 2019-04-10 17:08
* @Description: 代码生成
*/
public class MysqlGenerator {
private static String projectPath = System.getProperty("user.dir");
//父包路径
private static String parentPackageName = "com.elens.data.rbces";
//作者名字
private static String authorName = "xuweichao";
/**
* 全局设置
*
* @return
*/
public static GlobalConfig globalConfig() {
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(projectPath + "/src/main/java")
// 是否支持 AR
.setActiveRecord(true)
//设置作者名字
.setAuthor(authorName)
//文件覆盖(全新文件)
.setFileOverride(true)
//主键策略
.setIdType(IdType.AUTO)
//SQL 映射文件
.setBaseResultMap(true)
//SQL 片段
.setBaseColumnList(true)
.setSwagger2(true)
.setEnableCache(false)
.setOpen(false)
//时间类型
.setDateType(DateType.ONLY_DATE)
.setEnableCache(false)
;
return globalConfig;
}
/**
* 数据源配置
*
* @return
*/
public static DataSourceConfig dataSourceConfig() {
DataSourceConfig dataSourceConfig = new DataSourceConfig();
ResourceBundle rootResource = ResourceBundle.getBundle("application");
String url = rootResource.getString("spring.datasource.url");
String username = rootResource.getString("spring.datasource.username");
String password = rootResource.getString("spring.datasource.password");
String driverClassName = rootResource.getString("spring.datasource.driver-class-name");
dataSourceConfig
.setDbType(DbType.MYSQL)
.setUrl(url)
.setDriverName(driverClassName)
.setUsername(username)
// .setSchemaName("public")
.setPassword(password);
return dataSourceConfig;
}
/**
* 包名相关配置
*
* @return
*/
public static PackageConfig packageConfig(String moduleName) {
PackageConfig packageConfig = new PackageConfig();
//配置父包路径
packageConfig.setParent(parentPackageName)
.setMapper("mybatis.mapper")
.setXml("mybatis.mapper")
.setEntity("mybatis.entity")
.setService("service")
//会自动生成 impl，可以不设定
.setServiceImpl("service.impl")
.setController("controller");
if (StringUtils.isNotEmpty(moduleName)) {
//配置业务包路径
packageConfig.setModuleName(moduleName);
}
return packageConfig;
}
/**
* 配置模板
*
* @return
*/
public static InjectionConfig injectionConfig(String moduleName) {
InjectionConfig injectionConfig = new InjectionConfig() {
//自定义属性注入:abc
//在.ftl(或者是.vm)模板中，通过${cfg.abc}获取属性
@Override
public void initMap() {
// Map<String, Object> map = new HashMap<>();
// map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
// this.setMap(map);
}
};
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/mapper.xml.vm";
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
if (StringUtils.isEmpty(moduleName)) {
// 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
return projectPath + "/src/main/java/com/elens/data/rbces/mybatis/mapper/"
+ tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
} else {
return projectPath + "/src/main/java/com/elens/data/rbces/mybatis/mapper/"
+ moduleName + "/"
+ tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
}
});
injectionConfig.setFileOutConfigList(focList);
return injectionConfig;
}
/**
* 生成策略配置
*
* @param tableName
* @return
*/
public static StrategyConfig strategyConfig(String moduleName, String... tableName) {
StrategyConfig strategyConfig = new StrategyConfig();
//设置命名规则 underline_to_camel 底线变驼峰
strategyConfig.setNaming(NamingStrategy.underline_to_camel)
//设置设置列命名 underline_to_camel 底线变驼峰
.setColumnNaming(NamingStrategy.underline_to_camel)
//设置继承类
//.setSuperEntityClass("com.maoxs.pojo")
//设置继承类
//.setSuperControllerClass("com.maoxs.controller")
//是否加入lombok
.setEntityLombokModel(true)
.setRestControllerStyle(true)
.setControllerMappingHyphenStyle(true)
//设置表名
.setInclude(tableName)
//设置超级列
// .setSuperEntityColumns("id")
//设置controller映射联字符
.setControllerMappingHyphenStyle(true)
//表的前缀
.setTablePrefix(packageConfig(moduleName).getModuleName() + "_");
return strategyConfig;
}
/**
* 配置模板
*
* @return
*/
public static TemplateConfig templateConfig() {
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
templateConfig.setController("/templates/controller.java");
templateConfig.setXml(null);
return templateConfig;
}
public static void Generator(String moduleName, String... tableName) {
AutoGenerator mpg = new AutoGenerator()
.setCfg(injectionConfig(moduleName))
.setTemplate(templateConfig())
.setGlobalConfig(globalConfig())
.setDataSource(dataSourceConfig())
.setPackageInfo(packageConfig(moduleName))
.setStrategy(strategyConfig(moduleName, tableName))
// 选择 freemarker 引擎需要指定如下加，注意 pom 依赖必须有！默认 Veloctiy
.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
public static void main(String[] args) {
Generator(null, new String[]{"elens_report"});
}
}
这里有些包名，自定义的东西根据情况进行修改。
我这里对controller 类的生成做了一个模板，在/resources/templates 下创建controller.java.ftl
代码如下：
package ${package.Controller};
<#if restControllerStyle>
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.java.Log;
import org.springframework.web.bind.annotation.*;
<#else>
import org.springframework.stereotype.Controller;
</#if>
<#if superControllerClassPackage??>
import ${superControllerClassPackage};
</#if>
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.springframework.beans.factory.annotation.Autowired;
import com.elens.data.rbces.vo.Wrapper;
import com.elens.data.rbces.vo.WrapMapper;
import com.elens.data.rbces.vo.QueryPageDto;
import ${package.Service}.${table.serviceName};
import ${package.Entity}.${entity};
/**
*
* @author ${author}
* @since ${date}
*/
<#if restControllerStyle??>
@Log
@Api(value="${entity} 相关接口",tags ="${entity} 相关接口")
@RestController
<#else>
@Controller
</#if>
@RequestMapping("<#if package.ModuleName??>${package.ModuleName}</#if><#if controllerMappingHyphenStyle??>${controllerMappingHyphen}<#else>${table.entityPath}</#if>")
<#if superControllerClass??>
public class ${table.controllerName} extends ${superControllerClass} {
<#else>
public class ${table.controllerName} {
</#if>
@Autowired
public ${table.serviceName} ${table.entityPath}Service;
/**
* 分页查询数据
*
* @return
*/
@ApiOperation(value = "分页查询", notes = "分页查询")
@PostMapping("getPage")
public Wrapper get${entity}List(@RequestBody QueryPageDto queryPageDto){
log.info("获取的参数：===>>" + queryPageDto);
Page<${entity}> page = new Page<>(queryPageDto.getPage(), queryPageDto.getSize());
try{
QueryWrapper<${entity}> queryWrapper = new QueryWrapper<>();
<#--queryWrapper.select("user_name", "user_company");-->
<#--queryWrapper.like("user_name", "测试");-->
<#--queryWrapper.ne("user_company", "");-->
${table.entityPath}Service.pageMaps(page, queryWrapper);
}catch(Exception e){
e.printStackTrace();
return WrapMapper.error();
}
return WrapMapper.wrap(Wrapper.SUCCESS_CODE, Wrapper.SUCCESS_MESSAGE, page);
}
/**
* 添加修改
* @param ${table.entityPath}
* @return
*/
@ApiOperation(value = "添加或修改", notes = "根据id添加或修改")
@PostMapping("addUpd")
public Wrapper ${table.entityPath}AddUpd(${entity} ${table.entityPath}){
log.info("获取的参数：===>>" + ${table.entityPath});
try{
${table.entityPath}Service.saveOrUpdate(${table.entityPath});
}catch(Exception e){
e.printStackTrace();
return WrapMapper.error();
}
return WrapMapper.ok();
}
/**
* 根据id删除对象
* @param id 实体ID
*/
@ApiOperation(value = "删除", notes = "根据id删除")
@GetMapping("del/{id}")
public Wrapper ${table.entityPath}Delete(@PathVariable int id){
log.info("获取的参数：===>>" + id);
try{
${table.entityPath}Service.removeById(id);
}catch(Exception e){
e.printStackTrace();
return WrapMapper.error();
}
return WrapMapper.ok();
}
}
其中包含了增删改，分页查询功能。
启动MysqlGenerator 类：
可见生成目录
文件名为红色的即为自动生成的文件。
controller 文件如下：
@Log
@Api(value="ElensReport 相关接口",tags ="ElensReport 相关接口")
@RestController
@RequestMapping("elens-report")
public class ElensReportController {
@Autowired
public IElensReportService elensReportService;
/**
* 分页查询数据
*
* @return
*/
@ApiOperation(value = "分页查询", notes = "分页查询")
@PostMapping("getPage")
public Wrapper getElensReportList(@RequestBody QueryPageDto queryPageDto){
log.info("获取的参数：===>>" + queryPageDto);
Page<ElensReport> page = new Page<>(queryPageDto.getPage(), queryPageDto.getSize());
try{
QueryWrapper<ElensReport> queryWrapper = new QueryWrapper<>();
elensReportService.pageMaps(page, queryWrapper);
}catch(Exception e){
e.printStackTrace();
return WrapMapper.error();
}
return WrapMapper.wrap(Wrapper.SUCCESS_CODE, Wrapper.SUCCESS_MESSAGE, page);
}
/**
* 添加修改
* @param elensReport
* @return
*/
@ApiOperation(value = "添加或修改", notes = "根据id添加或修改")
@PostMapping("addUpd")
public Wrapper elensReportAddUpd(ElensReport elensReport){
log.info("获取的参数：===>>" + elensReport);
try{
elensReportService.saveOrUpdate(elensReport);
}catch(Exception e){
e.printStackTrace();
return WrapMapper.error();
}
return WrapMapper.ok();
}
/**
* 根据id删除对象
* @param id 实体ID
*/
@ApiOperation(value = "删除", notes = "根据id删除")
@GetMapping("del/{id}")
public Wrapper elensReportDelete(@PathVariable int id){
log.info("获取的参数：===>>" + id);
try{
elensReportService.removeById(id);
}catch(Exception e){
e.printStackTrace();
return WrapMapper.error();
}
return WrapMapper.ok();
}
}这里是简单增删改查接口，service调用的方法都是MP 自带的，如果需要其他方法也可以配置到模板中。
生成的实体类，会配置好lombok 相关注解。
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel(value="ElensReport对象", description="")
public class ElensReport extends Model<ElensReport> {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.AUTO)
private Integer id;
@ApiModelProperty(value = "报告名称")
private String reportName;
@ApiModelProperty(value = "标题")
private String reportTitle;
@ApiModelProperty(value = "报告内容")
private String reportContent;
@ApiModelProperty(value = "修改时间")
private Date updateTime;
private String photo;
private String perId;
private Date createTime;
@Override
protected Serializable pkVal() {
return this.id;
}
}
//Mapper 接口 集成BaseMapper
public interface ElensReportMapper extends BaseMapper<ElensReport> {
}BaseMapper chak查看源码会看到，其中已经包含了绝大多数我们常用的操作方法。
mapper.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.elens.data.rbces.mybatis.mapper.ElensReportMapper">
<!-- 通用查询映射结果 -->
<resultMap id="BaseResultMap" type="com.elens.data.rbces.mybatis.entity.ElensReport">
<id column="id" property="id" />
<result column="report_name" property="reportName" />
<result column="report_title" property="reportTitle" />
<result column="report_content" property="reportContent" />
<result column="update_time" property="updateTime" />
<result column="photo" property="photo" />
<result column="per_id" property="perId" />
<result column="create_time" property="createTime" />
</resultMap>
<!-- 通用查询结果列 -->
<sql id="Base_Column_List">
id, report_name, report_title, report_content, update_time, photo, per_id, create_time
</sql>
</mapper>
service 接口：
public interface IElensReportService extends IService<ElensReport> {
}IService 接口也是MP 自带的接口同样内置了很多常用的方法：
服务实现类：@Service
public class ElensReportServiceImpl extends ServiceImpl<ElensReportMapper, ElensReport> implements IElensReportService {
}除此之外，需要在Application 启动类中添加注解@mapperScan 扫描注入 mapper。
我这里配置好了swagger。
@EnableSwagger2
@Configuration
public class SwaggerConfig {
@Bean
public Docket apiDoc() {
return docket();
}
private Docket docket() {
return new Docket(DocumentationType.SWAGGER_2).select()
// .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))//这里采用包含注解的方式来确定要显示的接口
// .apis(RequestHandlerSelectors.basePackage("com.elens.data.oauth.manager.controller")) //这里采用包扫描的方式来确定要显示的接口
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
.paths(PathSelectors.any())
.build()
.ignoredParameterTypes(Errors.class)
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Swagger2 api文档")
.description("Swagger2 api文档")
.version("1.0.0")
.build();
}
}启动后数据 浏览器输入：
http:localhost:port/swagger-ui.html 可以看到生成的接口
这样就可以直接进行测试。当然了，如果MP 自带的方法无法满足业务需求，我们完全可以在Service 中自定义方法，在Mapper.xml 中按Mybatis 的方式 写SQL。