MyBatis-plus框架

目录

1.MyBatis-plus基础

1.1.mybatis-plus简介

1.2.基本使用

1.3.注解映射

1.4.命名转换问题

1.4.1.自动转换命名

1.4.2.关闭命名转换功能

2.MyBatis-plus的CRUD

2.1.BaseMapper核心接口

2.2.基础增删改查

2.3.QueryWrapper的用法

2.4.UpdateWrapper的用法

2.5.分页查询

2.6.其它复杂操作

3.MyBatis-plus逆向工程

---

1.MyBatis-plus基础

1.1.mybatis-plus简介

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

MyBatis-plus官网：MyBatis-Plus

特点：

1. 润物无声：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
2. 效率至上：只需简单配置，即可快速进行单表 CRUD 操作，从而节省大量时间。
3. 丰富功能：代码生成、自动分页、逻辑删除、自动填充等功能一应俱全

1.2.基本使用

下面我们就按照官网的 “快速开始” 教程，开始mybatis-plus的使用。

1. 数据库中创建表

SET FOREIGN_KEY_CHECKS=0;
-- ----------------------------
-- Table structure for dept
-- ----------------------------
DROP TABLE IF EXISTS `dept`;
CREATE TABLE `dept` (
  `deptno` int(2) NOT NULL AUTO_INCREMENT,
  `dname` varchar(14) NOT NULL,
  `loc` varchar(50) DEFAULT NULL,
  PRIMARY KEY (`deptno`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records 
-- ----------------------------
INSERT INTO `dept` VALUES (1, '总裁办公室', '北京');
INSERT INTO `dept` VALUES (2, '技术部', '沈阳');
INSERT INTO `dept` VALUES (3, '销售部', '大连');

1. 创建SpringBoot工程，在pom.xml文件中添加mybatis-plus依赖

	4.0.0
	
		org.springframework.boot
		spring-boot-starter-parent
		2.6.6
		 
	
	com.neusoft
	smp
	0.0.1-SNAPSHOT
	smp
	Demo project for Spring Boot
	
		1.8
	
	
		
			org.springframework.boot
			spring-boot-starter-web
		

		
			org.springframework.boot
			spring-boot-starter-test
			test
		

         
		
			com.baomidou
			mybatis-plus-boot-starter
			3.5.1
		
		
		
			mysql
			mysql-connector-java
			5.1.49
		
        
		
	

	
		
			
				org.springframework.boot
				spring-boot-maven-plugin
			
		
	

1. 在SpringBoot配置文件中添加如下配置信息

server:
    port: 8080
    servlet:
        context-path: /smp
        
logging:
    level:
        #org.springframework: debug
        com.neusoft.smp.mapper: debug
        
spring:
    datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://localhost:3306/empinfo?characterEncoding=utf-8
        username: root
        password: 123

1. 在 Spring Boot 启动类中添加  @MapperScan 注解，扫描 Mapper 文件夹

package com.neusoft.smp;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.neusoft.smp.mapper")
public class SmpApplication {

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

}

• • 注意：此处也可以不使用@MapperScan注解，那么就需要在每一个Mapper上添加 @Mapper注解

1. 添加实体对象

package com.neusoft.smp.po;
public class Dept {
	private Integer deptno;
	private String dname;
	private String loc;
    
    @Override
	public String toString() {
		return this.deptno + "\t" + this.dname + "\t" + this.loc;
	}
	...
}

1. 添加Mapper接口

package com.neusoft.smp.mapper;

import org.apache.ibatis.annotations.Mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.neusoft.smp.po.Dept;

//在主启动类已经使用@MapperScan注解统一引入，所以这里不需要@Mapper注解了
public interface DeptMapper extends BaseMapper {}

• 这里要注意：Mapper接口要继承自BaseMapper父接口，并通过泛型指定实体类型。

1. 在测试类中进行功能测试

package com.neusoft.smp;

import java.util.List;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import com.neusoft.smp.mapper.DeptMapper;
import com.neusoft.smp.po.Dept;

@SpringBootTest
class SmpApplicationTests {
	
	@Autowired
    private DeptMapper deptMapper;

    @Test
    public void testSelect() {
        List list = deptMapper.selectList(null);
        for(Dept dept : list) {
        	System.out.println(dept);
        }
    }
}

• 这里就可以使用BaseMapper父接口中自动生成的selectList进行全查询了（因为是全查询，所以参数为null）。

1.3.注解映射

上面实例中，实体类名与表名，包括属性名与字段名都是完全一致的，所以mybatis-plus是可以识别的。但在实际开发中，很有可能会出现表名与实体类名不一致，或者属性名与字段名不一致的情况。此时就需要使用注解来进行映射。

• @TableName：表名注解，标识实体类对应的表。

• @TableId：主键注解（可以使用 type=IdType.AUTO 形式指定主键生成策略）

• @TableField：字段注解（非主键）

注意：如果实体类名与属性名与数据库完全一致，那么上面注解都可以省略。

1. 创建deptinfo表：

SET FOREIGN_KEY_CHECKS=0;
-- ----------------------------
-- Table structure for deptinfo
-- ----------------------------
DROP TABLE IF EXISTS `deptinfo`;
CREATE TABLE `deptinfo` (
  `deptid` int(2) NOT NULL AUTO_INCREMENT,
  `deptname` varchar(14) NOT NULL,
  `deptloc` varchar(50) DEFAULT NULL,
  PRIMARY KEY (`deptid`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records 
-- ----------------------------
INSERT INTO `deptinfo` VALUES ('1', '总裁办公室', '北京');
INSERT INTO `deptinfo` VALUES ('2', '技术部', '沈阳');
INSERT INTO `deptinfo` VALUES ('3', '销售部', '大连');

1. 实体类名与表名，属性名与字段名都不一致。此时，就可以使用上面的三个注解进行映射。

@TableName("deptinfo")
public class Dept {

	@TableId(value="deptid",type=IdType.AUTO)
	private Integer deptno;
	@TableField("deptname")
	private String dname;
	@TableField("deptloc")
	private String loc;
    
    ...
}

1. 测试运行后，MyBatis-plus自动生成的sql语句如下

SELECT deptid AS deptno,deptname AS dname,deptloc AS loc FROM deptinfo

附录：

主键生成策略类型	描述
AUTO	数据库 ID 自增
INPUT	insert 前自行 set 主键值
ASSIGN_ID	分配 ID(主键类型为 Number(Long 和 Integer)或 String)
ASSIGN_UUID	分配 UUID,主键类型为 String

1.4.命名转换问题

在实际开发中，项目中的类名、属性名，包括数据库中的表名、字段名，这些命名要严格遵守规范。一般来说：

• 在数据库设计中，由于数据库不区分大小写，所以都采用下划线命名法。

• 在java中，类名都采用帕斯卡命名法（大驼峰），属性名都采用驼峰命名法。

1.4.1.自动转换命名

mybatis-plus在生成sql语句时，会自动将java中类名或属性名中的驼峰命名，转换为下划线命名。

1. 数据库中创建表，采用下划线命名

SET FOREIGN_KEY_CHECKS=0;
-- ----------------------------
-- Table structure for dept
-- ----------------------------
DROP TABLE IF EXISTS `dept`;
CREATE TABLE `dept` (
  `dept_id` int(11) NOT NULL AUTO_INCREMENT,
  `dept_name` varchar(20) NOT NULL,
  `dept_loc` varchar(20) DEFAULT NULL,
  PRIMARY KEY (`dept_id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records 
-- ----------------------------
INSERT INTO `dept` VALUES ('1', '总裁办公室', '北京');
INSERT INTO `dept` VALUES ('2', '技术部', '沈阳');
INSERT INTO `dept` VALUES ('3', '销售部', '大连');

1. 实体类中采用驼峰命名

public class Dept {

	private Integer deptId;
	private String deptName;
	private String deptLoc;
    
    @Override
	public String toString() {
		return this.deptId + "\t" + this.deptName + "\t" + this.deptLoc;
	}
    //...
}

1. 测试运行后，MyBatis-plus自动生成的sql语句如下

SELECT dept_id,dept_name,dept_loc FROM dept

1.4.2.关闭命名转换功能

如果数据库中没有采用下划线命名法，那么可以在SpringBoot的application.yml配置文件中关闭此功能：

mybatis-plus:
    configuration:
        map-underscore-to-camel-case: false

关闭此功能后，MyBatis-plus自动生成的sql语句如下

SELECT deptId,deptName,deptLoc FROM dept

2.MyBatis-plus的CRUD

2.1.BaseMapper核心接口

查看BaseMapper核心接口的源代码，这里详细说明了封装的增删改查方法：

/**
 * Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能
 */
public interface BaseMapper extends Mapper {

    /**
     * 插入一条记录
     * @param entity 实体对象
     */
    int insert(T entity);

    /**
     * 根据 ID 删除
     * @param id 主键ID
     */
    int deleteById(Serializable id);

    /**
     * 根据实体(ID)删除
     * @param entity 实体对象
     */
    int deleteById(T entity);

    /**
     * 根据 columnMap 条件，删除记录
     * @param columnMap 表字段 map 对象
     */
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

    /**
     * 根据 entity 条件，删除记录
     * @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
     */
    int delete(@Param(Constants.WRAPPER) Wrapper queryWrapper);

    /**
     * 删除（根据ID或实体 批量删除）
     * @param idList 主键ID列表或实体列表(不能为 null 以及 empty)
     */
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);

    /**
     * 根据 ID 修改
     * @param entity 实体对象
     */
    int updateById(@Param(Constants.ENTITY) T entity);

    /**
     * 根据 whereEntity 条件，更新记录
     * @param entity        实体对象 (set 条件值,可以为 null)
     * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
     */
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);

    /**
     * 根据 ID 查询
     * @param id 主键ID
     */
    T selectById(Serializable id);

    /**
     * 查询（根据ID 批量查询）
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    List selectBatchIds(@Param(Constants.COLLECTION) Collection idList);

    /**
     * 查询（根据 columnMap 条件）
     * @param columnMap 表字段 map 对象
     */
    List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

    /**
     * 根据 entity 条件，查询一条记录
     * 
查询一条记录，例如 qw.last("limit 1") 限制取一条记录, 注意：多条数据会报异常
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    default T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper) {
        List ts = this.selectList(queryWrapper);
        if (CollectionUtils.isNotEmpty(ts)) {
            if (ts.size() != 1) {
                throw ExceptionUtils.mpe("One record is expected, but the query result is multiple records");
            }
            return ts.get(0);
        }
        return null;
    }

    /**
     * 根据 Wrapper 条件，判断是否存在记录
     * @param queryWrapper 实体对象封装操作类
     * @return
     */
    default boolean exists(Wrapper queryWrapper) {
        Long count = this.selectCount(queryWrapper);
        return null != count && count > 0;
    }

    /**
     * 根据 Wrapper 条件，查询总记录数
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    Long selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper);

    /**
     * 根据 entity 条件，查询全部记录
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     * 
注意： 只返回第一个字段的值
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List