Mybatis-Plus

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

特点

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 curd，性能基本无损耗，直接面向对象操作
• 强大的 crud 操作：内置通用 mapper、通用 service，仅仅通过少量配置即可实现单表大部分 crud 操作，更有强大的条件构造器，满足各类使用需求
• 支持 lambda 形式调用：通过 lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 id 生成器 - sequence），可自由配置，完美解决主键问题
• 支持 activerecord 模式：支持 activerecord 形式调用，实体类只需继承 model 类即可进行强大的 crud 操作
• 支持自定义全局通用操作：支持全局通用方法注入（ write once, use anywhere ）
• 内置代码生成器：采用代码或者 maven 插件可快速生成 mapper 、 model 、 service 、 controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
• 内置分页插件：基于 mybatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 list 查询
• 分页插件支持多种数据库：支持 mysql、mariadb、oracle、db2、h2、hsql、sqlite、postgre、sqlserver 等多种数据库
• 内置性能分析插件：可输出 sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

Mybatis-Plus支持的数据库

• MySQL 、 mariadb 、 oracle 、 db2 、SQLServer、 h2 、 hsql 、 sqlite 、 postgresql
• 达梦数据库 、 虚谷数据库 、 人大金仓数据库

快速开始

• 创建一个空的 Spring Boot 工程

可以使用 Spring Initializer 快速初始化一个 Spring Boot 工程

添加依赖

• 引入 Spring Boot Starter 父工程：

<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.4.RELEASE</version>
<relativePath/>
</parent>

• 引入 mybatis-plus-boot-starter、mysql-connector-java、lombok 的依赖

<!--mybatis-plus的依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!--mysql驱动包的依赖-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!--lombok的依赖-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>

打开左侧Maven依赖

• ok依赖添加成功！

配置

• 在application.yml 或 properties 中添加数据库的配置

spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://你的数据库地址:3306/t91?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT
username: root
password: root

• mybatis-plus的配置 根据需求来进行添加

#database-id: oracle # 自定义配置如果不是MySQL的话  可以指定数据库
mybatis-plus:
type-aliases-package: cn.yufire.mybatisplus.domain # 指定实体类的位置
mapper-locations: classpath:mappers/*.xml # 指定mapper文件所在的位置
#configuration:
#database-id: ${database-id} #指定数据库为 oracle

• 在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 包所在的位置：

- 编写实体类 User.java（此处使用了 Lombok 简化代码） 也可使用MyBatisCodeHelperPro生成实体类和Mapper 甚至service
​```java
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}

• 编写Mapper类 UserMapper.java

• mapper.UserMapper

//BaseMapper<User> 由MyBatis-Plus提供 继承他即可获得mybatis-plus的超强能力
public interface UserMapper extends BaseMapper<User> {

/**
* 也可以写自定义接口
*/
//public int getUserCount();
}

@SpringBootApplication
//指定你的Mapper 包所在位置
@MapperScan("cn.yufire.mybatis-plus-demo.mapper")
public class Application {

public static void main(String[] args) {
SpringApplication.run(QuickStartApplication.class, args);
}

}

开始使用 !!!

• 使用SpringBoot自动生成的测试类，进行功能测试：

@RunWith(SpringRunner.class)
@SpringBootTest
public class SampleTest {
// 把自己的 UserMapper接口注入进来 如果报空指针异常请去检查
// SpringBoot启动类是否写了 @MapperScan("xxx.xxx.mapper")注解
@Autowired
private UserMapper userMapper;

@Test
public void testSelect() {
System.out.println(("----- 查询全部的方法 ------"));
//传递空参数就是查询全部
List<User> userList = userMapper.selectList(null);
//java的高阶函数
userList.forEach(System.out::println);
}

}

UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件

• 控制台输出:

User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)

小结

• 通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！

• 从以上步骤中，我们可以看到集成MyBatis-Plus非常的简单，只需要引入

  mybatis-plus-boot-starter

  工程，并配置

  mapper

  扫描路径即可。

使用Spring Boot 或 MVC 整合MyBatis-Plus

全新的 MyBatis-Plus 3.0 版本基于 JDK8，提供了 lambda 形式的调用，所以安装集成 MP3.0 要求如下：

• JDK 8+
• Maven or Gradle

SpringBoot配置

• 版本可以去 官网 或 Maven仓库 查询最新的版本

<!--Maven方式-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1.tmp</version>
</dependency>

<!--Gradle方式：-->
compile group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: '3.3.1.tmp'

Spring MVC配置

<!--Maven-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>3.3.1.tmp</version>
</dependency>

其他方式可以去官网查寻

官网安装教程

配置

• MyBatis-Plus 的配置异常的简单，我们仅需要一些简单的配置即可使用 MyBatis-Plus 的强大功能！

在讲解配置之前，请确保您已经安装了 MyBatis-Plus，如果您尚未安装，请查看 上面的安装教程。

• Spring Boot 工程： 只需要 配置 MapperScan 注解即可使用

@SpringBootApplication
//指定你的Mapper 包所在位置
@MapperScan("cn.yufire.mybatis-plus-demo.mapper")
public class Application {

public static void main(String[] args) {
SpringApplication.run(QuickStartApplication.class, args);
}

}

• Spring MVC 工程： 配置 MapperScan

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.baomidou.mybatisplus.samples.quickstart.mapper"/>
</bean>

• 调整 SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
</bean>

• 通常来说，一般的简单工程，通过以上配置即可正常使用 MyBatis-Plus，
• 同时 MyBatis-Plus 提供了大量的个性化配置来满足不同复杂度的工程，大家可根据自己的项目按需取用，详细配置请参考配置一文

CRUD接口-传送门

- 由于接口太多 请去官网查看

条件构造器

• AbstractWrapper
• 他是QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类

AbstractWrapper类的方法 详情请见官网说明

测试demo

@Test
public void selectByName(){
List<User> users = userMapper.selectList(
new QueryWrapper<User>()
.eq("name","张三")

);
users.forEach(System.out::println);
}

1. QueryWrapper 和 UpdateWrapper继承与 它 拥有他的所有方法

• QueryWrapper 类 自有的方法

3.0.5

例:

select("id", "name", "age")

• UpdateWrapper 类 自有的方法

• 例:

  set("name", "老李头")

• 例:

  set("name", "")

  —>数据库字段值变为空字符串
• 例:

  set("name", null)

  —>数据库字段值变为

  null

• 例:

  setSql("name = '老李头'")

自定义SQL

• 方案一 注解方式 xxxMapper.java

@Select("select * from mysql_data ${ew.customSqlSegment}")
List<MysqlData> getAll(@Param(Constants.WRAPPER) Wrapper wrapper);

• 方案二 XML形式 Mapper.xml 与mybatis一样

<select id="getAll" resultType="MysqlData">
SELECT * FROM mysql_data ${ew.customSqlSegment}
</select>

Mybatis-Plus常用配置

database-id: oracle # 配置自定义数据库
mybatis-plus:
type-aliases-package: cn.yufire.mybatisplus.domain # 指定实体类的位置
mapper-locations: classpath:mappers/*.xml # 指定mapper文件所在的位置
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 显示生成的sql语句 及参数
#database-id: ${database-id} #指定数据库为 oracle
global-config:
db-config:
#全局表名的前缀
table-prefix: tb_ # 表名前缀，全局配置后可省略@TableName()配置。

配置性能分析插件

Mybatis-Plus可搭配

p6spy

1. 添加依赖

<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>最新版本</version>
</dependency>

1. 修改 application.yml 的数据库配置
   修改驱动类为 P6SpyDriver
   • 修改链接url前缀为

     jdbc:p6spy

spring:
datasource:
driver-class-name: com.p6spy.engine.spy.P6SpyDriver
url: jdbc:p6spy:mysql://127.0.0.1/db_name
username: root
password: root

1. 添加

   p6spy

   的配置文件

   spy.properties

#3.2.1以上使用
modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 设置 p6spy driver 代理
deregisterdrivers=true
# 取消JDBC URL前缀
useprefix=true
# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,commit,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2

1. 打开测试类

package cn.yufire.wms;

import cn.yufire.wms.pojo.WmsAccessRecord;
import cn.yufire.wms.service.WmsAccessRecordService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class WmsSpringbootApplicationTests {

@Autowired
private WmsAccessRecordService wmsAccessRecordService;

@Test
void contextLoads() {
// 查询数据
List<WmsAccessRecord> list = wmsAccessRecordService.list();
// 输出打印
list.forEach(System.out::println);
}

}

观察控制台 打印的结果