MyBatis-Plus(简称 MP),是一个 MyBatis 的增强工具包,只做增强不做改变. 发工作、提高生产率而生。
我们的愿景是成为 Mybatis 最好的搭档,就像 魂斗罗 中的 1P、2P,基友搭配,效率翻倍。
官方地址:
http://mp.baomidou.com
代码发布地址:
Github:
https://github.com/baomidou/mybatis-plus
Gitee:
https://gitee.com/baomidou/mybatis-plus
文档发布地址:
http://mp.baomidou.com/
我们将通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能,在此之前,我们假设您已经对以下知识掌握:
现有一张Employee表,其表结构如下:
其对应的数据库 Schema 脚本如下:
-- 创建库
CREATE DATABASE mpdb;
-- 使用库
USE mpdb;
-- 创建表
CREATE TABLE employee(
id INT(11) PRIMARY KEY AUTO_INCREMENT,
last_name VARCHAR(50),
email VARCHAR(50),
gender CHAR(1),
age int
);
INSERT INTO employee(last_name,email,gender,age) VALUES('Tom','[email protected]',1,22);
INSERT INTO employee(last_name,email,gender,age) VALUES('Jerry','[email protected]',0,25);
INSERT INTO employee(last_name,email,gender,age) VALUES('Black','[email protected]',1,30);
INSERT INTO employee(last_name,email,gender,age) VALUES('White','[email protected]',0,35);
public class Employee {
private Integer id;
private String lastName;
private String email;
private Integer gender;
private Integer age;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Integer getGender() {
return gender;
}
public void setGender(Integer gender) {
this.gender = gender;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Employee(Integer id, String lastName, String email, Integer gender, Integer age) {
super();
this.id = id;
this.lastName = lastName;
this.email = email;
this.gender = gender;
this.age = age;
}
public Employee() {
super();
}
@Override
public String toString() {
return "Employee [id=" + id + ", lastName=" + lastName + ", email=" + email + ", gender=" + gender + ", age=" + age + "]";
}
}
<dependencies>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plusartifactId>
<version>2.3version>
dependency>
<dependency>
<groupId>junitgroupId>
<artifactId>junitartifactId>
<version>4.12version>
dependency>
<dependency>
<groupId>log4jgroupId>
<artifactId>log4jartifactId>
<version>1.2.17version>
dependency>
<dependency>
<groupId>com.mchangegroupId>
<artifactId>c3p0artifactId>
<version>0.9.5.2version>
dependency>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>5.1.37version>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-contextartifactId>
<version>4.3.8.RELEASEversion>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-ormartifactId>
<version>4.3.8.RELEASEversion>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-testartifactId>
<version>4.3.8.RELEASEversion>
dependency>
dependencies>
特别说明: Mybatis及Mybatis-Spring 依赖请勿加入项目配置,以免引起版本冲突!!!
Mybatis-Plus 会自动帮你维护!
2. 加入 MyBatis 的全局配置文件
<configuration>
configuration>
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
<param name="Encoding" value="UTF-8" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS} %m (%F:%L) \n" />
layout>
appender>
<logger name="java.sql">
<level value="debug" />
logger>
<logger name="org.apache.ibatis">
<level value="info" />
logger>
<root>
<level value="debug" />
<appender-ref ref="STDOUT" />
root>
log4j:configuration>
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/mpdb?useUnicode=true&characterEncoding=utf8
jdbc.username=root
jdbc.password=123
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:mybatis-spring="http://mybatis.org/schema/mybatis-spring"
xsi:schemaLocation="http://mybatis.org/schema/mybatis-spring
http://mybatis.org/schema/mybatis-spring-1.2.xsd http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">
<context:property-placeholder location="classpath:db.properties" />
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="${jdbc.driver}">property>
<property name="jdbcUrl" value="${jdbc.url}">property>
<property name="user" value="${jdbc.username}">property>
<property name="password" value="${jdbc.password}">property>
bean>
<bean id="sqlSessionFactoryBean" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource">property>
<property name="configLocation" value="classpath:mybatis-config.xml">property>
<property name="typeAliasesPackage" value="com.mp.bean">property>
bean>
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.mp.mapper">property>
bean>
<bean id="dataSourceTransactionManager"
class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource">property>
bean>
<tx:annotation-driven transaction-manager="dataSourceTransactionManager" />
beans>
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:applicationContext.xml")
public class TestMp {
@Autowired
DataSource ds;
@Test
public void testDataSource(){
System.out.println(ds);
}
}
<bean id="sqlSessionFactoryBean"
class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
<property name="dataSource" ref="dataSource">property>
<property name="configLocation" value="classpath:mybatis-config.xml">property>
<property name="typeAliasesPackage" value="com.mp.bean">property>
bean>
/**
* Mapper接口
* 基于Mybatis: 在Mapper接口中编写CRUD相关的方法 提供Mapper接口所对应的SQL映射文件 以及 方法对应的SQL语句.
* 基于MP: 让XxxMapper接口继承 BaseMapper接口即可.
* BaseMapper:泛型指定的就是当前Mapper接口所操作的实体类类型
*/
public interface EmployeeMapper extends BaseMapper<Employee> {
}
Mybatis: 需要通过 useGeneratedKeys以及keyProperty 来设置
MP: 自动将主键值回写到实体类中
/*
* MybatisPlus会默认使用实体类的类名到数据中找对应的表.
*/
@TableName(value="employee")
public class Employee {
/*
* @TableId:
* value: 指定表中的主键列的列名, 如果实体属性名与列名一致,可以省略不指定.
* type: 指定主键策略.
*/
@TableId(value="id" , type =IdType.AUTO)
private Integer id;
@TableField(value = "last_name")
private String lastName;
@TableField(value = "email")
private String email;
@TableField(value = "gender")
private Integer gender;
@TableField(value = "age")
private Integer age;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public Integer getGender() {
return gender;
}
public void setGender(Integer gender) {
this.gender = gender;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Employee(Integer id, String lastName, String email, Integer gender, Integer age) {
super();
this.id = id;
this.lastName = lastName;
this.email = email;
this.gender = gender;
this.age = age;
}
public Employee(String lastName, String email, Integer gender, Integer age) {
super();
this.lastName = lastName;
this.email = email;
this.gender = gender;
this.age = age;
}
public Employee() {
super();
}
@Override
public String toString() {
return "Employee [id=" + id + ", lastName=" + lastName + ", email=" + email + ", gender=" + gender + ", age=" + age + "]";
}
}
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:applicationContext.xml")
public class TestCRUD {
@Autowired
EmployeeMapper em;
@Test
public void testAdd(){
Employee e=new Employee("zhangsan", "[email protected]", 1, 18);
int count = em.insert(e);
System.out.println(count>0?"成功":"失败");
}
@Test
public void testAdd1(){
Employee e=new Employee("zhangsan", "[email protected]");
int count = em.insertAllColumn(e);
System.out.println(count>0?"成功":"失败");
System.out.println("新增成功之后的主键是:"+e.getId());
}
}
@TableName
全局的 MP 配置:
@TableField
全局的 MP 配置:
@TableId
全局的 MP 配置:
支持主键自增的数据库插入数据获取主键值
<bean id="sqlSessionFactoryBean"
class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
<property name="dataSource" ref="dataSource">property>
<property name="configLocation" value="classpath:mybatis-config.xml">property>
<property name="typeAliasesPackage" value="com.mp.bean">property>
<property name="globalConfig" ref="globalConfiguration"/>
bean>
<bean id="globalConfiguration" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
<property name="dbColumnUnderline" value="true"/>
<property name="idType" value="0"/>
<property name="tablePrefix" value="t_"/>
bean>
@Test
public void testUopdate(){
Employee e=new Employee(2,"xiaozhang", "[email protected]", 1, 18);
Integer count = em.updateById(e);
System.out.println(count>0?"成功":"失败");
}
@Test
public void testUopdate1(){
Employee e=new Employee(2,"xiaozhang", "[email protected]");
Integer count = em.updateAllColumnById(e);
System.out.println(count>0?"成功":"失败");
}
@Test
public void testselectById(){
Employee e = em.selectById(2);
System.out.println(e);
}
@Test
public void testselectOne() {
Employee employee = new Employee();
employee.setLastName("Black");
employee.setGender(0);
Employee result = em.selectOne(employee);
System.out.println("result: " + result);
}
@Test
public void testselectBatchIds(){
List<Integer> idList = new ArrayList<>();
idList.add(4);
idList.add(5);
idList.add(6);
idList.add(7);
List<Employee> emps = em.selectBatchIds(idList);
System.out.println(emps);
}
@Test
public void testselectByMap(){
Map<String, Object> columnMap = new HashMap<>();
columnMap.put("last_name", "Tom");
columnMap.put("gender", 1);
List<Employee> emps = em.selectByMap(columnMap);
System.out.println(emps);
}
@Test
public void testselectPage() {
List<Employee> emps = em.selectPage(new Page<>(3, 2), null);
for (Employee employee : emps) {
System.out.println(employee);
}
}
@Test
public void testdeleteById() {
Integer result = em.deleteById(1);
System.out.println("result: " + result);
}
@Test
public void testdeleteByMap(){
Map<String,Object> columnMap = new HashMap<>();
columnMap.put("last_name", "White");
columnMap.put("email", "[email protected]");
Integer result = em.deleteByMap(columnMap);
System.out.println("result: " + result );
}
@Test
public void testdeleteBatchIds(){
List<Integer> idList = new ArrayList<>();
idList.add(10);
idList.add(11);
idList.add(12);
Integer result = em.deleteBatchIds(idList);
System.out.println("result: " + result );
}
以上是基本的 CRUD 操作,如您所见,我们仅仅需要继承一个 BaseMapper 即可实现大部分单表 CRUD 操作。BaseMapper 提供了多达 17 个方法给大家使用, 可以极其方便的实现单一、批量、分页等操作。极大的减少开发负担,难道这就是 MP 的强大之处了吗?
提出需求:
现有一个需求,我们需要分页查询 tbl_employee 表中,年龄在 18~50 之间性别为男且姓名为 xx 的所有用户,这时候我们该如何实现上述需求呢?
MyBatis : 需要在 SQL 映射文件中编写带条件查询的 SQL,并基于 PageHelper 插件完成分页. 实现以上一个简单的需求,往往需要我们做很多重复单调的工作。普通的 Mapper 能够解决这类痛点吗?
MP: 依旧不用编写 SQL 语句, MP 提供了功能强大的条件构造器 EntityWrapper
@Test
public void test1() {
List<Employee> emps = em.selectPage(new Page<Employee>(1, 3),
new EntityWrapper<Employee>().eq("last_name", "Black"));
for (Employee e : emps) {
System.out.println(e);
}
}
@Test
public void test2() {
// 分页查询t_employee表中,年龄在18~50之间且性别为男且姓名为Tom的所有用户
List<Employee> emps = em.selectPage(new Page<Employee>(1, 2),
new EntityWrapper<Employee>().between("age", 18, 50).eq("gender", 1).eq("last_name", "Tom"));
for (Employee e : emps) {
System.out.println(e);
}
}
@Test
public void tes3() {
List<Employee> emps = em.selectPage(new Page<Employee>(1, 2),
Condition.create().between("age", 18, 50).eq("gender", "1").eq("last_name", "Tom"));
System.out.println(emps);
}
@Test
public void test4(){
// 查询t_employee表中, 性别为女并且名字中带有"老师" 或者 邮箱中带有"a"
List<Employee> emps = em.selectList(
new EntityWrapper<Employee>()
.eq("gender", 0)
.like("last_name", "zhangsan")
//.or() // SQL: (gender = ? AND last_name LIKE ? OR email LIKE ?)
.orNew() // SQL: (gender = ? AND last_name LIKE ?) OR (email LIKE ?)
.like("email", "a")
);
System.out.println(emps);
}
@Test
public void test5(){
// 查询性别为男的, 根据age进行排序(asc/desc), 简单分页
List<Employee> emps = em.selectList(
new EntityWrapper<Employee>()
.eq("gender", 1)
.orderBy("age")
//.orderDesc(Arrays.asList(new String [] {"age"}))
.last("desc limit 1,3")
);
System.out.println(emps);
}
@Test
public void testUpdate1(){
Employee employee = new Employee();
employee.setLastName("Jack");
employee.setEmail("[email protected]");
employee.setGender(0);
int count=em.update(employee,
new EntityWrapper<Employee>()
.eq("last_name", "Black")
.eq("age", 44)
);
System.out.println(count);
}
/**
* 条件构造器 删除操作
*/
@Test
public void testDelete1() {
int count=em.delete(
new EntityWrapper<Employee>()
.eq("last_name", "Tom")
.eq("age", 22)
);
System.out.println(count);
}
MP: EntityWrapper Condition 条件构造器
MyBatis MBG :xxxExample→Criteria : QBC( Query By Criteria)
Hibernate :→Criteria : QBC( Query By Criteria)
MP提供了大量的自定义设置,生成的代码完全能够满足各类型的需求
MP 的代码生成器 和 Mybatis MBG 代码生成器:
MP 的代码生成器都是基于 java 代码来生成。MBG 基于 xml 文件进行代码生成
MyBatis 的代码生成器可生成: 实体类、Mapper 接口、Mapper 映射文件
MP 的代码生成器可生成:实体类(可以选择是否支持 AR)、Mapper接口、Mapper 映射文件、Service层、Controller 层.
表及字段命名策略选择
在MP中,我们建议数据库表名和表字段名采用驼峰命名方式, 如果采用下划线命名方式 请开启全局下划线开关,如果表名字段名命名方式不一致请注解指定,我们建议最好保持一致。
这么做的原因是为了避免在对应实体类时产生的性能损耗,这样字段不用做映射就能直接和实体类对应。当然如果项目里不用考虑这点性能损耗,那么你采用下滑线也是没问题的,只需要在生成代码时配置 dbColumnUnderline 属性就可以.
<!-- Apache Velocity的依赖 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>org.slf4jgroupId>
<artifactId>slf4j-apiartifactId>
<version>1.7.7version>
dependency>
<dependency>
<groupId>org.slf4jgroupId>
<artifactId>slf4j-log4j12artifactId>
<version>1.7.7version>
dependency>
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:applicationContext.xml")
public class TestMp {
@Autowired
DataSource ds;
@Test
public void testGenerator() {
// 1. 全局配置
GlobalConfig config = new GlobalConfig();
config.setActiveRecord(true) // 是否支持AR模式
.setAuthor("bruceliu") // 作者
.setOutputDir("H:\\myworkspace123\\MyBatis-plus-Auto\\src\\main\\java") // 生成路径
.setFileOverride(true) // 文件覆盖
.setIdType(IdType.AUTO) // 主键策略
.setServiceName("%sService") // 设置生成的service接口的名字的首字母是否为I
// IEmployeeService
.setBaseResultMap(true).setBaseColumnList(true);
//2. 数据源配置
DataSourceConfig dsConfig = new DataSourceConfig();
dsConfig.setDbType(DbType.MYSQL) // 设置数据库类型
.setDriverName("com.mysql.jdbc.Driver")
.setUrl("jdbc:mysql://127.0.0.1:3306/mpdb?useUnicode=true&characterEncoding=utf8")
.setUsername("root")
.setPassword("123");
//3. 策略配置
StrategyConfig stConfig = new StrategyConfig();
stConfig.setCapitalMode(true) //全局大写命名
.setDbColumnUnderline(true) // 指定表名 字段名是否使用下划线
.setNaming(NamingStrategy.underline_to_camel) // 数据库表映射到实体的命名策略
.setTablePrefix("t_")
.setInclude("t_employee"); // 生成的表
//4. 包名策略配置
PackageConfig pkConfig = new PackageConfig();
pkConfig.setParent("com.mp")
.setMapper("mapper")
.setService("service")
.setController("controller")
.setEntity("bean")
.setXml("mapper");
//5. 整合配置
AutoGenerator ag = new AutoGenerator();
ag.setGlobalConfig(config)
.setDataSource(dsConfig)
.setStrategy(stConfig)
.setPackageInfo(pkConfig);
//6. 执行
ag.execute();
}
}
EmployeeServiceImpl 继承了 ServiceImpl 类,mybatis-plus 通过这种方式为我们注入了 EmployeeMapper,这样可以使用 service 层默认为我们提供的很多方法,也可以调用我们自己在 dao 层编写的操作数据库的方法.
插件机制:
Mybatis 通过插件(Interceptor) 可以做到拦截四大对象相关方法的执行,根据需求,完成相关数据的动态改变。
Executor
StatementHandler
ParameterHandler
ResultSetHandler
插件原理
四大对象的每个对象在创建时,都会执行interceptorChain.pluginAll(),会经过每个插件对象的 plugin()方法,目的是为当前的四大对象创建代理。代理对象就可以拦截到四大对象相关方法的执行,因为要执行四大对象的方法需要经过代理.
<configuration>
<plugins>
<plugin interceptor="com.baomidou.mybatisplus.plugins.PaginationInterceptor">plugin>
plugins>
configuration>
或者:
<bean id="sqlSessionFactoryBean"
class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
<property name="dataSource" ref="dataSource">property>
<property name="configLocation" value="classpath:mybatis-config.xml">property>
<property name="typeAliasesPackage" value="com.mp.bean">property>
<property name="globalConfig" ref="globalConfiguration" />
<property name="plugins">
<list>
<bean class="com.baomidou.mybatisplus.plugins.PaginationInterceptor">bean>
<bean class="com.baomidou.mybatisplus.plugins.SqlExplainInterceptor">
<property name="stopProceed" value="true">property>
bean>
list>
property>
bean>
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:applicationContext.xml")
public class TestPlugin {
@Autowired
EmployeeMapper employeeMapper;
/**
* 测试分页插件
*/
@Test
public void testPage() {
Page<Employee> page = new Page<Employee>(1,3);
List<Employee > emps = employeeMapper.selectPage(page, null);
System.out.println(emps);
System.out.println("===============获取分页相关的一些信息======================");
System.out.println("总条数:" +page.getTotal());
System.out.println("当前页码: "+ page.getCurrent());
System.out.println("总页码:" + page.getPages());
System.out.println("每页显示的条数:" + page.getSize());
System.out.println("是否有上一页: " + page.hasPrevious());
System.out.println("是否有下一页: " + page.hasNext());
//将查询的结果封装到page对象中
page.setRecords(emps);
}
}
<property name="plugins">
<list>
<bean class="com.baomidou.mybatisplus.plugins.PaginationInterceptor">bean>
<bean class="com.baomidou.mybatisplus.plugins.SqlExplainInterceptor">
<property name="stopProceed" value="true">property>
bean>
<bean class="com.baomidou.mybatisplus.plugins.PerformanceInterceptor">
<property name="format" value="true">property>
bean>
list>
property>
/**
* 测试 性能分析插件
*/
@Test
public void testPerformance() {
Employee employee = new Employee();
employee.setLastName("mly");
employee.setEmail("[email protected]");
employee.setGender("0");
employee.setAge(22);
employeeMapper.insert(employee);
}