Spring中使用Mybatis-Plus

简介

概述

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。愿景是成为 MyBatis 最好的搭档，就像 魂斗罗中的 1P、2P，基友搭配，效率翻倍。

官方文档：https://mybatis.plus/

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
• 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作。

框架结构

MP与Spring集成

1、准备数据表

CREATE TABLE mp_user
(
    id BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
    NAME VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT(11) NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);
INSERT INTO mp_user (id, NAME, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

2、创建普通的Maven工程，在pom文件中添加依赖。

<!-- 配置版本属性 -->
<properties>
    <mybatisplus.version>3.4.0</mybatisplus.version>
    <spring.version>5.2.8.RELEASE</spring.version>
    <mysql.version>5.1.47</mysql.version>
    <!-- 注意只能使用2.0以下的版本 -->
    <log4j.version>1.2.17</log4j.version>
</properties>

<dependencies>
    <!-- mybatis-plus会自动维护mybatis以及mybatis与spring的整合-->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>${mybatisplus.version}</version>
    </dependency>

    <!-- 导入spring -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-expression</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-orm</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <!-- mysql数据库驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql.version}</version>
    </dependency>
    <!-- c3p0连接池 -->
    <dependency>
        <groupId>com.mchange</groupId>
        <artifactId>c3p0</artifactId>
        <version>0.9.5.2</version>
    </dependency>

    <!-- log4j -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>${log4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.6.6</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.30</version>
    </dependency>

    <!-- junit测试 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
</dependencies>

特别说明：Mybatis 及 Mybatis-Spring 依赖请勿加入项目配置，以免引起版本冲突，Mybatis-Plus 会自动维护。

3、准备log4j日志配置文件、数据库连接配置、mybatis的配置文件及spring的配置文件。

• log4j.properties

log4j.rootLogger=DEBUG,myConsole
log4j.appender.myConsole=org.apache.log4j.ConsoleAppender
log4j.appender.myConsole.ImmediateFlush=true
log4j.appender.myConsole.Target=System.out
log4j.appender.myConsole.layout=org.apache.log4j.PatternLayout
log4j.appender.myConsole.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

log4j.logger.com.mchange.v2=ERROR

• jdbc.properties

jdbc.user=root
jdbc.password=root123
jdbc.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8
jdbc.driver=com.mysql.jdbc.Driver

• mybatis-config.xml

<?xml version="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>

• applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xsi:schemaLocation="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.3.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">
	
	<!-- 配置数据源 -->
	<context:property-placeholder location="classpath:jdbc.properties"/>

	<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
		<property name="user" value="${jdbc.user}"/>
		<property name="password" value="${jdbc.password}"/>
		<property name="jdbcUrl" value="${jdbc.url}"/>
		<property name="driverClass" value="${jdbc.driver}"/>
	</bean>

	<!-- 整合MyBatis -->
	<!-- mybatis提供的：org.mybatis.spring.SqlSessionFactoryBean -->
	<!-- mp提供的：com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean -->
	<bean id="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
		<property name="configLocation" value="classpath:mybatis-config.xml"/>
		<property name="dataSource" ref="dataSource"/>
		<!-- 别名处理 -->
		<property name="typeAliasesPackage" value="com.coydone.entity"></property>
		<!-- 注入全局策略配置 -->
		<property name="globalConfig" ref="globalConfig"/>
	</bean>

	<!-- 配置MP的全局策略配置 -->
	<bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig">
		<property name="dbConfig" ref="dbConfig"/>
	</bean>
	<bean id="dbConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig">
		<property name="idType" value="AUTO"></property>
	</bean>
	<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
		<property name="basePackage" value="com.coydone.mapper"/>
	</bean>

	<!-- 配置Service自动扫描的包 -->
	<context:component-scan base-package="com.coydone.service"/>

	<!-- 配置声明式事务 -->
	<bean id="dataSourceTransactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
		<property name="dataSource" ref="dataSource"/>
	</bean>

	<aop:config>
		<aop:advisor advice-ref="txAdvice" pointcut="execution(* *..*Service.*(..))"/>
	</aop:config>

	<tx:advice id="txAdvice" transaction-manager="dataSourceTransactionManager">
		<tx:attributes>
			<tx:method name="get*" read-only="true"/>
			<tx:method name="add*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
			<tx:method name="delete*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
			<tx:method name="update*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
		</tx:attributes>
	</tx:advice>
</beans>

MP和Spring完成基本CRUD

整合MP

1、在Spring的配置文件中，将sqlSessionFactoryBean的配置改为MP的。

<bean id="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
</bean>

2、编写数据库表对应的实体类。

public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
    //省略有参构造、无参构造、getter()、setter()、toString()方法
}

3、编写mapper接口。

继承MP的BaseMapper接口，此时对单表的基本CRUD操作无需写Mapper映射文件，使用方法同通用Mapper，这里利用了JPA的原理

public interface UserMapper extends BaseMapper<User> {
}

4、编写测试方法对BaseMapper接口中的方法测试。

public class MapperTest {
    private ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
    private UserMapper userMapper = ac.getBean(UserMapper.class);
    @Test
    public void testAdd(){
        User user = new User(null, "李四", 22, "ls@163.com");
        int i = userMapper.insert(user);
        System.out.println(i);
        //获取插入的主键id
        System.out.println(user.getId());
    }
}

这里的id值为null，id采取自增形式。我们需要在实体类中对其进行配置。

@TableName("mp_user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
}

• @TableName()注解用于将数据库表与实体类相互映射，默认为下划线转大写。（mp_user→MpUser）。
• @TableId()注解用于指定实体类中的主键Id字段，type = IdType.AUTO表示id自增。

如果不想在每个实体类中这样指定，我们可以在Spring的配置文件中配置MP的全局策略。

<bean id="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
    <!-- 注入全局策略配置 -->
    <property name="globalConfig" ref="globalConfig"/>
</bean>

<!-- 配置MP的全局策略配置 -->
<bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig">
    <property name="dbConfig" ref="dbConfig"/>
</bean>
<bean id="dbConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig">
    <!-- 配置主键id自增 -->
    <property name="idType" value="AUTO"></property>
</bean>

详细说明见官方文档：https://mybatis.plus/config/#dbconfig-2

• @TableField(exist = false)表示实体中的字段在数据库表中不存在。

配置xxxMapper.xml

如在resources下的mapper目录下创建UserMapper.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.coydone.mapper.UserMapper">
</mapper>

在Spring配置文件中配置其所在位置。在sqlSessionFactoryBean下。

<!-- 加载xxxMapper.xml -->
<property name="mapperLocations">
   <array>
      <value>classpath:mapper/*Mapper.xml</value>
   </array>
</property>

增加

int insert(T entity);

该方法会自动将主键值回写到实体类中，支持可变的插入，如我们要插入的字段只是表的一部分，MP会自动判断是否为空，进行灵活的插入。

删除

//根据id删除
int deleteById(Serializable id);
//根据map条件删除（map为表字段的map对象）
int deleteByMap(@Param("cm") Map<String, Object> columnMap);
//条件删除
int delete(@Param("ew") Wrapper<T> wrapper);
//通过id批量删除
int deleteBatchIds(@Param("coll") Collection<? extends Serializable> idList);

@Test
public void testDelete(){
    //根据id批量删除
    List<Serializable> idList= new ArrayList<>();
    idList.add(8);
    idList.add(9);
    int rows = userMapper.deleteBatchIds(idList);
    System.out.println(rows);//2
}
@Test
public void testDeleteByMap(){
    //删除id为2的记录
    Map<String, Object> map = new HashMap<>();
    map.put("id",2);
    userMapper.deleteByMap(map);
}

修改

//根据主键修改
int updateById(@Param("et") T entity);
//根据条件修改
int update(@Param("et") T entity, @Param("ew") Wrapper<T> updateWrapper);

@Test
public void testUpdateById(){
    //根据id修改
    int rows = userMapper.updateById(new User(3L, "赵六", 20, "zl@163.com"));
    System.out.println(rows);//1
}
@Test
//将姓名为 yasuo 的用户的姓名修改为 亚索。
public void testUpdate(){
    User user = new User();
    user.setName("亚索");
    //使用条件构造器
    UpdateWrapper<User> userWrapper = new UpdateWrapper<>();
    userWrapper.eq("name","yasuo");
    userMapper.update(user, userWrapper);
}

查询

//通过id查询一个
T selectById(Serializable id);
//通过id批量查询多个
List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList);

@Test
//根据id批量查询
public void testSelect2(){
    List idList = new ArrayList();
    idList.add(3);
    idList.add(5);
    idList.add(6);
    List<User> list = userMapper.selectBatchIds(idList);
    for (User user : list) {
        System.out.println(user);
    }
}

@Test
//查询年龄在20-22之间或者姓名为coydone的用户
public void testSelect3(){
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.between("age", 20, 22).or().eq("name","coydone");
    List<User> users = userMapper.selectList(queryWrapper);
    for (User user : users) {
        System.out.println(user);
    }
}

MP-AR模式开发

AR(ActiveRecord)：ActiveRecord 一直广受动态语言（ PHP 、 Ruby 等）的喜爱，而 Java 作为准静态语言，对于ActiveRecord 往往只能感叹其优雅，然后MP提供了一套API可以把静态变成动态。

• 让实体类继承Model接口。

public class User extends Model<User> implements Serializable {}

• 此时调用user对象时，它本身就有了userMapper的所有方法，可以通过自己调用其CRUD方法。

@Test
public void testAR1(){
    User user = new User();
    user.deleteById(3);
}
@Test
public void testAR2(){
    User user = new User();
    User selectById = user.selectById(4);
    System.out.println(selectById);
}

MP的分页

在Spring的配置文件中配置分页插件。在sqlSessionFactoryBean下。

<property name="plugins">
    <array>
        <!-- 配置分页插件 -->
        <bean class="com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor"></bean>
    </array>
</property>

@Test
public void testSelect4(){
    IPage<User> page=new Page<>(1, 5);
    userMapper.selectPage(page, null);
    System.out.println("总条数:"+page.getTotal());
    System.out.println("总页数："+page.getPages());
    System.out.println("当前页码："+page.getCurrent());
    System.out.println("每页条数："+page.getSize());
    page.getRecords().forEach(user -> System.out.println(user));
}

条件构造器

MP的条件构造器为Wrapper，其作用是为我们动态拼接SQL。

官方文档：https://mybatis.plus/guide/wrapper.html

代码生成器

MP 的代码生成器可生成: 实体类(可以选择是否支持 AR)、Mapper 接口、Mapper 映射文件、 Service 层、Controller 层。

代码生成器依赖

1、模板引擎

MP 的代码生成器默认使用的是 Apache 的 Velocity 模板，当然也可以更换为别的模板技术，例如 freemarker。需要加入 Apache Velocity 的依赖。

2、加入mybatis-plus-generator依赖。

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.0</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
</dependency>

MP 代码生成器示例代码

package com.coydone.generator;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

public class CodeGenerator {
    public static void main(String[] args) {
        // 1、全局配置
        GlobalConfig config = new GlobalConfig();
        config.setActiveRecord(true) // 是否支持AR模式
                .setAuthor("coydone")   // 作者
                .setOutputDir("E:\idea_workspace\zixue\mp_generator\src\main\java") // 生成路径
                .setFileOverride(true) // 文件覆盖
                .setOpen(false)//是否打开文件目录
                .setIdType(IdType.AUTO) // 主键策略自增
                .setServiceName("%sService") //设置生成的service接口名首字母是否为I,默认是以I开头
                .setBaseColumnList(true) // 基本列
                .setBaseResultMap(true); // 返回结果map

        // 2、数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDbType(DbType.MYSQL) // 设置数据库类型
                .setDriverName("com.mysql.jdbc.Driver")
                .setUrl("jdbc:mysql:///kgcnews?useUnicode=true&characterEncoding=UTF-8")
                .setUsername("root")
                .setPassword("root123");

        // 3、策略配置
        StrategyConfig stConfig = new StrategyConfig();
        stConfig.setCapitalMode(true) // 全局大写命名
                .setColumnNaming(NamingStrategy.underline_to_camel)  //表名 字段名 是否使用下滑线命名
                .setNaming(NamingStrategy.underline_to_camel) // 数据库表映射到实体的命名策略
                .setTablePrefix("news_");// 表前缀
                //生成的表,不写表示生成所有的表
                // .setInclude("news_category");

        // 4、包名策略配置
        PackageConfig pkConfig = new PackageConfig();
        pkConfig.setParent("com.coydone")
                .setController("controller")
                .setEntity("entity")
                .setMapper("mapper")
                .setService("service")
                .setXml("mapper");

        // 5、整合配置
        AutoGenerator ag = new
                AutoGenerator().setGlobalConfig(config)
                .setDataSource(dataSourceConfig)
                .setStrategy(stConfig)
                .setPackageInfo(pkConfig);

        // 6、执行
        ag.execute();
    }
}