mybatisplus

前言：

mybatis在持久层框架中还是比较火的，一般项目都是基于ssm。虽然mybatis可以直接在xml中通过SQL语句操作数据库，很是灵活。但正其操作都要通过SQL语句进行，就必须写大量的xml文件，很是麻烦。mybatis-plus就很好的解决了这个问题。

一、mybatis-plus简介：

Mybatis-Plus（简称MP）是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。这是官方给的定义，关于mybatis-plus的更多介绍及特性，可以参考mybatis-plus官网。那么它是怎么增强的呢？其实就是它已经封装好了一些crud方法，我们不需要再写xml了，直接调用这些方法就行，就类似于JPA。

二、spring整合mybatis-plus:

正如官方所说，mybatis-plus在mybatis的基础上只做增强不做改变，因此其与spring的整合亦非常简单。只需把mybatis的依赖换成mybatis-plus的依赖，再把sqlSessionFactory换成mybatis-plus的即可。接下来看具体操作： 1、pom.xml: 核心依赖如下：

org.springframework

spring-context

4.3.14.RELEASE

org.springframework

spring-orm

4.3.14.RELEASE

org.springframework

spring-test

4.3.14.RELEASE

test

com.baomidou

mybatis-plus

2.3

注意：这些是核心依赖，本项目还用到了mysql驱动、c3p0、日志（slf4j-api，slf4j-log4j2）、lombok。集成mybatis-plus要把mybatis、mybatis-spring去掉，避免冲突；lombok是一个工具，添加了这个依赖，开发工具再安装Lombok插件，就可以使用它了，最常用的用法就是在实体类中使用它的@Data注解，这样实体类就不用写set、get、toString等方法了。关于Lombok的更多用法，请自行百度。

2、log4j.xml:

HH:mm:ss,SSS} %m (%F:%L) \n"/>

3、jdbc.properties:

jdbc.driver=com.mysql.jdbc.Driver

jdbc.url=jdbc:mysql:///数据库名?useUnicode=true&characterEncoding=utf8

jdbc.username=#

jdbc.password=#

4、mybatis-config.xml:

PUBLIC "-//mybatis.org//DTD Config 3.0//EN"

"http://mybatis.org/dtd/mybatis-3-config.dtd">

注：因为是与spring整合，所有mybatis-plus的大部分都写在spring的配置文件中，这里定义一个空的mybatis-config.xml即可。

5、spring-dao.xml:

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:p="http://www.springframework.org/schema/p"

xmlns:aop="http://www.springframework.org/schema/aop"

xmlns:context="http://www.springframework.org/schema/context"

xmlns:jee="http://www.springframework.org/schema/jee"

xmlns:tx="http://www.springframework.org/schema/tx"

xsi:schemaLocation="    

http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd  

http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd  

http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd  

http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd  

http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">

6、entity:

@Data

@TableName(value="tb_employee")//指定表名

publicclassEmployee{

//value与数据库主键列名一致，若实体类属性名与表主键列名一致可省略value

@TableId(value="id",type=IdType.AUTO)//指定自增策略

privateIntegerid;

//若没有开启驼峰命名，或者表中列名不符合驼峰规则，可通过该注解指定数据库表中的列名，exist标明数据表中有没有对应列

@TableField(value="last_name",exist=true)

privateStringlastName;

privateStringemail;

privateIntegergender;

privateIntegerage;

}

7、mapper:

publicinterfaceEmplopyeeDaoextendsBaseMapper{

}

这样就完成了mybatis-plus与spring的整合。首先是把mybatis和mybatis-spring依赖换成mybatis-plus的依赖，然后把sqlsessionfactory换成mybatis-plus的，然后实体类中添加@TableName、@TableId等注解，最后mapper继承BaseMapper即可。

8、测试：

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration({"classpath:spring/spring-dao.xml"})

publicclasstest{

@Autowired

privateDataSourcedataSource;

@Test

publicvoidtestDataSource()throwsSQLException{

System.out.println(dataSource.getConnection());

   }

}

运行该junit，可输出获取到的连接，说明整合没问题：

image.png

本文所有代码本人均亲自测试过，本文涉及代码又较多，为了不影响篇幅，故非必要处不再截图。接下来的所有操作都是基于此整合好的项目。

三、mp的通用crud:

需求： 存在一张 tb_employee 表，且已有对应的实体类 Employee，实现tb_employee 表的 CRUD 操作我们需要做什么呢？ 基于 Mybatis： 需要编写 EmployeeMapper 接口，并在 EmployeeMapper.xml 映射文件中手动编写 CRUD 方法对应的sql语句。 基于 MP： ***只需要创建 EmployeeMapper 接口, 并继承 BaseMapper 接口。 我们已经有了Employee、tb_employee了，并且EmployeeDao也继承了BaseMapper了，接下来就使用crud方法。**

1、insert操作：

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration({"classpath:spring/spring-dao.xml"})

publicclasstest{

@Autowired

privateEmplopyeeDaoemplopyeeDao;

@Test

publicvoidtestInsert(){

Employeeemployee=newEmployee();

employee.setLastName("东方不败");

employee.setEmail("[email protected]");

employee.setGender(1);

employee.setAge(20);

emplopyeeDao.insert(employee);

//mybatisplus会自动把当前插入对象在数据库中的id写回到该实体中

System.out.println(employee.getId());

   }

}

执行添加操作，直接调用insert方法传入实体即可。

2、update操作：

@Test

publicvoidtestUpdate(){

Employeeemployee=newEmployee();

employee.setId(1);

employee.setLastName("更新测试");

//emplopyeeDao.updateById(employee);//根据id进行更新，没有传值的属性就不会更新

emplopyeeDao.updateAllColumnById(employee);//根据id进行更新，没传值的属性就更新为null

}

注：注意这两个update操作的区别，updateById方法，没有传值的字段不会进行更新，比如只传入了lastName，那么age、gender等属性就会保留原来的值；updateAllColumnById方法，顾名思义，会更新所有的列，没有传值的列会更新为null。

3、select操作：

(1)、根据id查询：

Employee employee = emplopyeeDao.selectById(1);

(2)、根据条件查询一条数据：

EmployeeemployeeCondition=newEmployee();

employeeCondition.setId(1);

employeeCondition.setLastName("更新测试");

//若是数据库中符合传入的条件的记录有多条，那就不能用这个方法，会报错

Employeeemployee=emplopyeeDao.selectOne(employeeCondition);

注：这个方法的sql语句就是where id = 1 and last_name = 更新测试，若是符合这个条件的记录不止一条，那么就会报错。

(3)、根据查询条件返回多条数据： 当符合指定条件的记录数有多条时，上面那个方法就会报错，就应该用这个方法。

MapcolumnMap=newHashMap<>();

columnMap.put("last_name","东方不败");//写表中的列名

columnMap.put("gender","1");

Listemployees=emplopyeeDao.selectByMap(columnMap);

System.out.println(employees.size());

注：查询条件用map集合封装，columnMap，写的是数据表中的列名，而非实体类的属性名。比如属性名为lastName，数据表中字段为last_name，这里应该写的是last_name。selectByMap方法返回值用list集合接收。

(4)、通过id批量查询：

ListidList=newArrayList<>();

idList.add(1);

idList.add(2);

idList.add(3);

Listemployees=emplopyeeDao.selectBatchIds(idList);

System.out.println(employees);

注：把需要查询的id都add到list集合中，然后调用selectBatchIds方法，传入该list集合即可，该方法返回的是对应id的所有记录，所有返回值也是用list接收。

(5)、分页查询：

Listemployees=emplopyeeDao.selectPage(newPage<>(1,2),null);

System.out.println(employees);

注：selectPage方法就是分页查询，在page中传入分页信息，后者为null的分页条件，这里先让其为null，讲了条件构造器再说其用法。这个分页其实并不是物理分页，而是内存分页。也就是说，查询的时候并没有limit语句。等配置了分页插件后才可以实现真正的分页。

4、delete操作：

(1)、根据id删除：

emplopyeeDao.deleteById(1);

(2)、根据条件删除：

MapcolumnMap=newHashMap<>();

columnMap.put("gender",0);

columnMap.put("age",18);

emplopyeeDao.deleteByMap(columnMap);

注：该方法与selectByMap类似，将条件封装在columnMap中，然后调用deleteByMap方法，传入columnMap即可，返回值是Integer类型，表示影响的行数。

(3)、根据id批量删除：

ListidList=newArrayList<>();

idList.add(1);

idList.add(2);

emplopyeeDao.deleteBatchIds(idList);

注：该方法和selectBatchIds类似，把需要删除的记录的id装进idList，然后调用deleteBatchIds，传入idList即可。

四、全局策略配置：

通过上面的小案例我们可以发现，实体类需要加@TableName注解指定数据库表名，通过@TableId注解指定id的增长策略。实体类少倒也无所谓，实体类一多的话也麻烦。所以可以在spring-dao.xml的文件中进行全局策略配置。

这里配置了还没用，还需要在sqlSessionFactory中注入配置才会生效。如下：

如此一来，实体类中的@TableName注解和@TableId注解就可以去掉了。

五、条件构造器(EntityWrapper)：

以上基本的 CRUD 操作，我们仅仅需要继承一个 BaseMapper 即可实现大部分单表 CRUD 操作。BaseMapper 提供了多达 17 个方法供使用, 可以极其方便的实现单一、批量、分页等操作，极大的减少开发负担。但是mybatis-plus的强大不限于此，请看如下需求该如何处理： 需求： 我们需要分页查询 tb_employee 表中，年龄在 18~50 之间性别为男且姓名为 xx 的所有用户，这时候我们该如何实现上述需求呢？ 使用MyBatis : 需要在 SQL 映射文件中编写带条件查询的 SQL,并用PageHelper 插件完成分页. 实现以上一个简单的需求，往往需要我们做很多重复单调的工作。 使用MP: 依旧不用编写 SQL 语句，MP 提供了功能强大的条件构造器 ------  EntityWrapper。

接下来就直接看几个案例体会EntityWrapper的使用。

1、分页查询年龄在18 - 50且gender为0、姓名为tom的用户：

Listemployees=emplopyeeDao.selectPage(newPage(1,3),

newEntityWrapper()

.between("age",18,50)

.eq("gender",0)

.eq("last_name","tom")

);

    @Override

    publicResponsePageEx