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: 核心依赖如下：

<!-- spring -->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-context</artifactId>

<version>4.3.14.RELEASE</version>

</dependency>

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-orm</artifactId>

<version>4.3.14.RELEASE</version>

</dependency>

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-test</artifactId>

<version>4.3.14.RELEASE</version>

<scope>test</scope>

</dependency>

<!-- mp 依赖 -->

<dependency>

<groupId>com.baomidou</groupId>

<artifactId>mybatis-plus</artifactId>

<version>2.3</version>

</dependency>

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

2、log4j.xml:

<?xmlversion="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configurationxmlns:log4j="http://jakarta.apache.org/log4j/">

<appendername="STDOUT"class="org.apache.log4j.ConsoleAppender">

<paramname="Encoding"value="UTF-8"/>

<layoutclass="org.apache.log4j.PatternLayout">

<paramname="ConversionPattern"value="%-5p %d{MM-dd

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

</layout>

</appender>

<loggername="java.sql">

<levelvalue="debug"/>

</logger>

<loggername="org.apache.ibatis">

<levelvalue="info"/>

</logger>

<root>

<levelvalue="debug"/>

<appender-refref="STDOUT"/>

</root>

</log4j:configuration>

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:

<?xmlversion="1.0" encoding="UTF-8"?>

<!DOCTYPE configuration

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

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

<configuration>

</configuration>

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

5、spring-dao.xml:

<?xmlversion="1.0" encoding="UTF-8"?>

<beansxmlns="http://www.springframework.org/schema/beans"

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">


<!-- 配置整合mybatis-plus过程 -->

<!-- 1、配置数据库相关参数properties的属性：${url} -->

<context:property-placeholderlocation="classpath:jdbc.properties"/>

<!-- 2、配置数据库连接池 -->

<beanid="dataSource"class="com.mchange.v2.c3p0.ComboPooledDataSource">

<propertyname="driverClass"value="${jdbc.driver}"/>

<propertyname="jdbcUrl"value="${jdbc.url}"/>

<propertyname="user"value="${jdbc.username}"/>

<propertyname="password"value="${jdbc.password}"/>

</bean>

<!-- mybatis的sqlsessionFactorybean：org.mybatis.spring.SqlSessionFactoryBean-->

<!-- 3、配置mybatis-plus的sqlSessionFactory -->

<beanid="sqlSessionFactory"class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">

<propertyname="dataSource"ref="dataSource"/>

<propertyname="configLocation"value="classpath:mybatis-config.xml"/>

<propertyname="typeAliasesPackage"value="com.zhu.mybatisplus.entity"/>

</bean>

<!-- 4、DAO接口所在包名，Spring会自动查找其下的类 -->

<beanclass="org.mybatis.spring.mapper.MapperScannerConfigurer">

<propertyname="basePackage"value="com.zhu.mybatisplus.dao"/>

<propertyname="sqlSessionFactoryBeanName"value="sqlSessionFactory"/>

</bean>

</beans>

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<Employee>{

}

这样就完成了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("dfbb@163.com");

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)、根据查询条件返回多条数据： 当符合指定条件的记录数有多条时，上面那个方法就会报错，就应该用这个方法。

Map<String,Object>columnMap=newHashMap<>();

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

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

List<Employee>employees=emplopyeeDao.selectByMap(columnMap);

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

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

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

List<Integer>idList=newArrayList<>();

idList.add(1);

idList.add(2);

idList.add(3);

List<Employee>employees=emplopyeeDao.selectBatchIds(idList);

System.out.println(employees);

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

(5)、分页查询：

List<Employee>employees=emplopyeeDao.selectPage(newPage<>(1,2),null);

System.out.println(employees);

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

4、delete操作：

(1)、根据id删除：

emplopyeeDao.deleteById(1);

(2)、根据条件删除：

Map<String,Object>columnMap=newHashMap<>();

columnMap.put("gender",0);

columnMap.put("age",18);

emplopyeeDao.deleteByMap(columnMap);

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

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

List<Integer>idList=newArrayList<>();

idList.add(1);

idList.add(2);

emplopyeeDao.deleteBatchIds(idList);

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

四、全局策略配置：

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

<!-- 5、mybatisplus的全局策略配置 -->

<beanid="globalConfiguration"class="com.baomidou.mybatisplus.entity.GlobalConfiguration">

<!-- 2.3版本后，驼峰命名默认值就是true，所以可不配置 -->

<!--<property name="dbColumnUnderline" value="true"/>-->

<!-- 全局主键自增策略，0表示auto -->

<propertyname="idType"value="0"/>

<!-- 全局表前缀配置 -->

<propertyname="tablePrefix"value="tb_"/>

</bean>

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

<!-- 3、配置mybatisplus的sqlSessionFactory -->

<beanid="sqlSessionFactory"class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">

<propertyname="dataSource"ref="dataSource"/>

<propertyname="configLocation"value="classpath:mybatis-config.xml"/>

<propertyname="typeAliasesPackage"value="com.zhu.mybatisplus.entity"/>

<!-- 注入全局配置 -->

<propertyname="globalConfig"ref="globalConfiguration"/>

</bean>

如此一来，实体类中的@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的用户：

List<Employee>employees=emplopyeeDao.selectPage(newPage<Employee>(1,3),

newEntityWrapper<Employee>()

.between("age",18,50)

.eq("gender",0)

.eq("last_name","tom")

);

    @Override

    publicResponsePageEx<Object>queryEntplatformPageList(Entplatformentplatform,Integercurrent,Integersize) {

        Page<Entplatform>page=newPage<Entplatform>(current,size);


        EntityWrapper<Entplatform>wrapper=newEntityWrapper<Entplatform>();

        wrapper.eq("state",StateType.NORMAL);// 只查询未删除数据

        wrapper.eq("project_id",entplatform.getProjectId());


        List<Entplatform>entplatformList=this.baseMapper.selectPage(page,wrapper);


        returnResponsePageEx.createSuccess(entplatformList,page.getTotal());

    }

注：由此案例可知，分页查询和之前一样，new 一个page对象传入分页信息即可。至于分页条件，new 一个EntityWrapper对象，调用该对象的相关方法即可。between方法三个参数，分别是column、value1、value2，该方法表示column的值要在value1和value2之间；eq是equals的简写，该方法两个参数，column和value，表示column的值和value要相等。注意column是数据表对应的字段，而非实体类属性字段。

2、查询gender为0且名字中带有老师、或者邮箱中带有a的用户：

List<Employee>employees=emplopyeeDao.selectList(

newEntityWrapper<Employee>()

.eq("gender",0)

.like("last_name","老师")

//.or()//和or new 区别不大

.orNew()

.like("email","a")

);

注：未说分页查询，所以用selectList即可，用EntityWrapper的like方法进行模糊查询，like方法就是指column的值包含value值，此处like方法就是查询last_name中包含“老师”字样的记录；“或者”用or或者orNew方法表示，这两个方法区别不大，用哪个都可以，可以通过控制台的sql语句自行感受其区别。

3、查询gender为0，根据age排序，简单分页：

List<Employee>employees=emplopyeeDao.selectList(

newEntityWrapper<Employee>()

.eq("gender",0)

.orderBy("age")//直接orderby 是升序，asc

.last("desc limit 1,3")//在sql语句后面追加last里面的内容(改为降序，同时分页)

);

注：简单分页是指不用page对象进行分页。orderBy方法就是根据传入的column进行升序排序，若要降序，可以使用orderByDesc方法，也可以如案例中所示用last方法；last方法就是将last方法里面的value值追加到sql语句的后面，在该案例中，最后的sql语句就变为select ······ order by desc limit 1, 3，追加了desc limit 1,3所以可以进行降序排序和分页。

4、分页查询年龄在18 - 50且gender为0、姓名为tom的用户： 条件构造器除了EntityWrapper，还有Condition。用Condition来处理一下这个需求：

List<Employee>employees=emplopyeeDao.selectPage(

newPage<Employee>(1,2),

Condition.create()

.between("age",18,50)

.eq("gender","0")

);

注：Condition和EntityWrapper的区别就是，创建条件构造器时，EntityWrapper是new出来的，而Condition是调create方法创建出来。

5、根据条件更新：

@Test

publicvoidtestEntityWrapperUpdate(){

Employeeemployee=newEmployee();

employee.setLastName("苍老师");

employee.setEmail("cjk@sina.com");

employee.setGender(0);

emplopyeeDao.update(employee,

newEntityWrapper<Employee>()

.eq("last_name","tom")

.eq("age",25)

       );

}

注：该案例表示把last_name为tom，age为25的所有用户的信息更新为employee中设置的信息。

6、根据条件删除：

emplopyeeDao.delete(

newEntityWrapper<Employee>()

.eq("last_name","tom")

.eq("age",16)

);

注：该案例表示把last_name为tom、age为16的所有用户删除。

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,294评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,493评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,790评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,595评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,718评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,906评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,053评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,797评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,250评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,388评论 4赞 332
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,018评论 3赞 316
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2赞 350

推荐阅读更多精彩内容