MyBatis-Plus

MyBatis-Plus

https://baomidou.com

1、快速入门

1.1、简介

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

特性

  • 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

  • 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

支持数据库

MyBatis-Plus 支持任何能使用 MyBatis 进行 CRUD, 并且支持标准 SQL 的数据库，包括MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb

框架结构

framework

1.2、创建数据库和表

 CREATE DATABASE `mybatis_plus` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
 use `mybatis_plus`;
 CREATE TABLE `user` (
   `id` bigint(20) NOT NULL COMMENT '主键ID', 
   `name` varchar(30) DEFAULT NULL COMMENT '姓名', 
   `age` int(11) DEFAULT NULL COMMENT '年龄', 
   `email` varchar(50) DEFAULT NULL COMMENT '邮箱', 
   PRIMARY KEY (`id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 INSERT INTO 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');

1.3、安装Mybatis-Plus

				<!--mybatis plus启动器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <!--lombok用于简化实体类开发-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

1.4、配置

配置application.yml

spring:
  #  配置数据源信息
  datasource:
    # 配置数据源类型
    type: com.zaxxer.hikari.HikariDataSource
    # 配置连接数据库的信息
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false
    username: root
    password: 12345678

在SpringBoot工程启动类中配置MapperScan注解

//
@SpringBootApplication
// 设置mybatis-plus扫描mapper接口的路径
@MapperScan("com.colin.mybatisplus.mapper")
public class MybatisplusApplication {

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

}

添加实体类User

//=======src/main/java/com/colin/mybatisplus/pojo/User.java======
@Data //lombok注解，用于快速构建实体类
public class User {

    private Long id;
    private String name;
    private Integer age;
    private String email;

}

创建UserMapper接口

//========src/main/java/com/colin/mybatisplus/mapper/UserMapper.java=========
// BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的实体类型
public interface UserMapper extends BaseMapper<User> {
}

测试

//=========src/test/java/com/colin/mybatisplus/MybatisPlusTest.java========
@SpringBootTest
public class MybatisPlusTest {

    // userMapper报错是由于找不到注入的对象，因为类是动态创建的，但是程序可以正确执行。
    // 为了避免报错，可以在mapper接口上添加 @Repository 注解
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectList(){
        // selectList()根据MP内置的条件构造器wapper查询一个list集合，null表示没有条件，即查询所有
        List<User> userList = userMapper.selectList(null);
        userList.forEach(System.out::println);
    }

}

1.5、添加日志功能

在application.yml中添加日志，可以查看Mybatis-Plus自动生成的sql语句

#=========src/main/resources/application.yml==========
# 配置MyBatis日志 mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

 

Mybatis-Plus操作的表和字段由实体类和实体类中的属性决定

 

2、基本CRUD

2.1、BaseMapper

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用，接口如下

public interface BaseMapper<T> extends Mapper<T> {

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

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

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

    /**
     * 根据 columnMap 条件，删除记录
     * @param columnMap 表字段 map 对象
     */
    int deleteByMap(@Param("cm") Map<String, Object> columnMap);

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

    /**
     * 删除(根据ID 批量删除)
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    int deleteBatchIds(@Param("coll") Collection<?> idList);

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

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

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

    /**
     * 查询(根据ID 批量查询)
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> idList);

    /**
     * 查询(根据 columnMap 条件)
     * @param columnMap 表字段 map 对象
     */
    List<T> selectByMap(@Param("cm") Map<String, Object> columnMap);

    /**
     * 根据 entity 条件，查询一条记录
     * <p>查询一条记录，例如 qw.last("limit 1") 限制取一条记录, 注意:多条数据会报异常 </p>
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    default T selectOne(@Param("ew") Wrapper<T> queryWrapper) {
        List<T> 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", new Object[0]);
            } else {
                return ts.get(0);
            }
        } else {
            return null;
        }
    }

    default boolean exists(Wrapper<T> queryWrapper) {
        Long count = this.selectCount(queryWrapper);
        return null != count && count > 0L;
    }

    /**
     * 根据 Wrapper 条件，查询总记录数
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    Long selectCount(@Param("ew") Wrapper<T> queryWrapper);

    /**
     * 根据 entity 条件，查询全部记录
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<T> selectList(@Param("ew") Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     * <p>注意: 只返回第一个字段的值</p>
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    List<Object> selectObjs(@Param("ew") Wrapper<T> queryWrapper);

    /**
     * 根据 entity 条件，查询全部记录(并翻页)
     * @param page 分页查询条件(可以为 RowBounds.DEFAULT)
     * @param queryWrapper 实体对象封装操作类(可以为 null)
     */
    <P extends IPage<T>> P selectPage(P page, @Param("ew") Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录(并翻页)
     * @param page 分页查询条件
     * @param queryWrapper 实体对象封装操作类
     */
    <P extends IPage<Map<String, Object>>> P selectMapsPage(P page, @Param("ew") Wrapper<T> queryWrapper);
}

 

2.2、插入

@Test
public void testInsert(){
		User user = new User(null, "张三", 23, "zhangsan@atguigu.com"); 
  	//INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? ) 
  	int result = userMapper.insert(user); 
  	System.out.println("受影响行数:"+result);
		//1475754982694199298 
  	System.out.println("id自动获取:"+user.getId());
}

最终执行的结果，所获取的id为1475754982694199298

这是因为MyBatis-Plus在实现插入数据时，会默认基于雪花算法的策略生成id（因此表中id要使用bigint类型，实体类中id要使用Long类型）

2.3、删除

2.3.1、根据id删除

@Test
public void testDeleteById(){
		//通过id删除用户信息
		//DELETE FROM user WHERE id=?
		int result = userMapper.deleteById(1475754982694199298L); //加上L表示Long类型数据
  	System.out.println("受影响行数:"+result);
}

2.3.2、根据id批量删除

@Test
public void testDeleteBatchIds(){ 
  	//通过多个id批量删除
		//DELETE FROM user WHERE id IN ( ? , ? , ? ) 
  	List<Long> idList = Arrays.asList(1L, 2L, 3L); 
  	int result = userMapper.deleteBatchIds(idList); 
  	System.out.println("受影响行数:"+result);
}

2.3.3、根据map条件删除记录

@Test
public void testDeleteByMap(){ 
  	//根据map集合中所设置的条件删除记录
		//DELETE FROM user WHERE name = ? AND age = ? 
  	Map<String, Object> map = new HashMap<>(); 
  	map.put("age", 23);
		map.put("name", "张三");
		int result = userMapper.deleteByMap(map); 
  	System.out.println("受影响行数:"+result);
}

2.4、修改

@Test
public void testUpdateById(){
		User user = new User(4L, "admin", 22, null); 
  	//UPDATE user SET name=?, age=? WHERE id=? 
  	int result = userMapper.updateById(user); 
  	System.out.println("受影响行数:"+result);
}

 

2.5、查询

2.5.1、根据id查询用户信息

@Test
public void testSelectById(){
		//根据id查询用户信息
		//SELECT id,name,age,email FROM user WHERE id=? 
  	User user = userMapper.selectById(4L); 
  	System.out.println(user);
}

2.5.2、根据多个id查询多个用户信息

@Test
public void testSelectBatchIds(){
		//根据多个id查询多个用户信息
		//SELECT id,name,age,email FROM user WHERE id IN ( ? , ? ) 
  	List<Long> idList = Arrays.asList(4L, 5L);
		List<User> list = userMapper.selectBatchIds(idList); 
  	list.forEach(System.out::println);
}

2.5.3、通过map查询用户信息

@Test
public void testSelectByMap(){
		//通过map条件查询用户信息
		//SELECT id,name,age,email FROM user WHERE name = ? AND age = ? 
  	Map<String, Object> map = new HashMap<>();
		map.put("age", 22);
		map.put("name", "admin");
		List<User> list = userMapper.selectByMap(map); 
  	list.forEach(System.out::println);
}

2.5.4、查询所有数据

@Test
public void testSelectList(){ 
  	//查询所有用户信息
    //SELECT id,name,age,email FROM user
    List<User> list = userMapper.selectList(null);
    list.forEach(System.out::println);
}

2.5.5、自定义功能

在resources/mapper/下编写.xml文件，在mapper接口中声明方法即可

 

2.6、通用Service

说明：

  • 通用 Service CRUD 封装IService接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆，

  • 泛型 T 为任意实体对象

  • 建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus提供的基类

  • 对象 Wrapper 为 条件构造器

2.6.1、IService

MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑。详情查看源码IService和ServiceImpl。

ServiceImpl<M extends BaseMapper<T>, T> 中 M 表示当前操作的mapper接口， T 表示当前操作的实体类

使用时建议不要直接使用ServiceImpl，而是通过以下继承接口的方式，这样在使用IService功能的同时可以添加更多自定义的功能

2.6.2、创建Service接口和实现类

//===src/main/java/com/colin/mybatisplus/service/UserService.java===
/**
 * UserService继承IService模板提供的基础功能
 */
public interface UserService extends IService<User> {
}
//===com/colin/mybatisplus/service/impl/UserServiceImpl.java===
/**
 * ServiceImpl实现了IService，提供了IService中基础功能的实现
 * 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现 
 */
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {

}

2.6.3、测试查询记录数

@SpringBootTest
public class MybatisPlusServiceTest {

    @Autowired
    private UserService userService;

    @Test
    public void testGetCount(){
        // SELECT COUNT( * ) FROM user
        long count = userService.count();
        System.out.println(count);
    }

}

2.6.4、测试批量插入

因为SQL长度有限制，海量数据插入单条SQL无法实行。因此Mybatis-Plus将批量插入放在了通用Service中实现，而不是通用Mapper

@Test
public void testSaveBatch(){
		// SQL长度有限制，海量数据插入单条SQL无法实行，
		// 因此MP将批量插入放在了通用Service中实现，而不是通用Mapper 
  	ArrayList<User> users = new ArrayList<>();
		for (int i = 0; i < 5; i++) {
        User user = new User();
        user.setName("user" + i);
        user.setAge(20 + i);
        users.add(user);
		}
    //SQL:INSERT INTO t_user ( username, age ) VALUES ( ?, ? )
    boolean b = userService.saveBatch(users);
    System.out.println(b);
}

 

3、常用注解

3.1、@TableName

经过以上的测试，在使用MyBatis-Plus实现基本的CRUD时，我们并没有指定要操作的表，只是在 Mapper接口继承BaseMapper时，设置了泛型User，所以操作的表默认为user表。由此得出结论，MyBatis-Plus在确定操作的表时，由BaseMapper的泛型决定，即实体类型决定，且默认操作的表名和实体类型的类名一致。

3.1.1、使用@TableName分别配置

若实体类类型的类名和要操作的表的表名不一致，在实体类类型上添加@TableName("t_user")，标识实体类对应的表，即可成功执行SQL语句

3.1.2、使用全局配置

在开发的过程中，我们经常遇到以上的问题，即实体类所对应的表都有固定的前缀，例如t_或tbl_

此时，可以使用MyBatis-Plus提供的全局配置，在application.yml为实体类所对应的表名设置默认的前缀，那么就不需要在每个实体类上通过@TableName标识实体类对应的表

mybatis-plus:
  configuration:
		# 配置MyBatis日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  # 设置MyBatisPlus的全局配置
  global-config:
		db-config:
			# 配置MyBatis-Plus操作表的默认前缀 
			table-prefix: t_

3.2、@TableId

@TableId将实体类中的属性对应的字段标识为主键，如果不指定，MyBatisPlus默认将名为id的属性作为主键

//===com/colin/mybatisplus/pojo/User.java===
@Data
@TableName("user")
public class User {
    
    @TableId
    private Long id;
    
    private String name;
    private Integer age;
    private String email;

}

 

3.2.1、@TableId的value属性

value属性用于设置实体类属性对应表中的主键字段名

若实体类中主键对应的属性为id，而表中表示主键的字段为uid，此时若只在属性id上添加注解 @TableId，则抛出异常Unknown column 'id' in 'field list'，即MyBatis-Plus仍然会将id作为表的主键操作，而表中表示主键的是字段uid

3.2.2、@TableId的type属性

type属性用来定义主键生成策略

常见的主键策略：

值描述
IdType.ASSIGN_ID(默认) 基于雪花算法的策略生成数据id，与数据库id是否设置自增无关
IdType.AUTO 使用数据库的自增策略，注意，该类型请确保数据库设置了id自增，否则无效

配置全局组件策略：

mybatis-plus:
  configuration:
		# 配置MyBatis日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
		db-config:
			# 配置MyBatis-Plus操作表的默认前缀 
			table-prefix: t_
			# 配置MyBatis-Plus的主键策略 
			id-type: auto

 

3.2.3、雪花算法

  • 背景

    • 需要选择合适的方案去应对数据规模的增长，以应对逐渐增长的访问压力和数据量。

    • 数据库的扩展方式主要包括:业务分库、主从复制，数据库分表。

  • 数据库分表

    • 将不同业务数据分散存储到不同的数据库服务器，能够支撑百万甚至千万用户规模的业务，但如果业务继续发展，同一业务的单表数据也会达到单台数据库服务器的处理瓶颈。例如，淘宝的几亿用户数据，如果全部存放在一台数据库服务器的一张表中，肯定是无法满足性能要求的，此时就需要对单表数据进行拆分。

      截屏2022-06-09 16.25.56

  • 垂直分表

    • 垂直分表适合将表中某些不常用且占了大量空间的列拆分出去。

  • 水平分表

    • 水平分表适合表行数特别大的表，有的公司要求单表行数超过 5000 万就必须进行分表，这个数字可以 作为参考，但并不是绝对标准，关键还是要看表的访问性能。对于一些比较复杂的表，可能超过 1000 万就要分表了;而对于一些简单的表，即使存储数据超过 1 亿行，也可以不分表。

      但不管怎样，当看到表的数据量达到千万级别时，作为架构师就要警觉起来，因为这很可能是架构的性能瓶颈或者隐患。

      水平分表相比垂直分表，会引入更多的复杂性，例如要求全局唯一的数据id该如何处理

    • 主键自增

      1. 以最常见的用户 ID 为例，可以按照 1000000 的范围大小进行分段，1 ~ 999999 放到表 1中， 1000000 ~ 1999999 放到表2中，以此类推。

      2. 复杂点:分段大小的选取。分段太小会导致切分后子表数量过多，增加维护复杂度;分段太大可能会 导致单表依然存在性能问题，一般建议分段大小在 100 万至 2000 万之间，具体需要根据业务选取合适 的分段大小。

      3. 优点:可以随着数据的增加平滑地扩充新的表。例如，现在的用户是 100 万，如果增加到 1000 万， 只需要增加新的表就可以了，原有的数据不需要动。

      4. 缺点:分布不均匀。假如按照 1000 万来进行分表，有可能某个分段实际存储的数据量只有 1 条，而 另外一个分段实际存储的数据量有 1000 万条。

    • 取模

      1. 同样以用户 ID 为例，假如我们一开始就规划了 10 个数据库表，可以简单地用 user_id % 10 的值来 表示数据所属的数据库表编号，ID 为 985 的用户放到编号为 5 的子表中，ID 为 10086 的用户放到编号 为 6 的子表中。

      2. 复杂点:初始表数量的确定。表数量太多维护比较麻烦，表数量太少又可能导致单表性能存在问题。

      3. 优点:表分布比较均匀。

      4. 缺点:扩充新的表很麻烦，所有数据都要重分布。

    • 雪花算法

      • 雪花算法是由Twitter公布的分布式主键生成算法，它能够保证不同表的主键的不重复性，以及相同表的主键的有序性(后添加的id比先添加的id大)。

      • 核心思想：

        • 长度共64bit(一个long型)。

        • 首先是一个符号位，1bit标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0。

        • 41bit时间截(毫秒级)，存储的是时间截的差值(当前时间截 - 开始时间截)，结果约等于69.73年。

        • 10bit作为机器的ID(5个bit是数据中心，5个bit的机器ID，可以部署在1024个节点)。

        • 12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID)。

      • 优点:整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高。

      • 截屏2022-06-09 16.33.04

 

3.3、@TableField

@TableField 指定属性对应的字段名，用于处理实体类中的属性名和字段名不一致的情况

3.3.1、情况一：驼峰和下划线转换

若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格，例如实体类属性userName，表中字段user_name。此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格，相当于在MyBatis中配置<setting name="mapUnderscoreToCamelCase" value="true"/>

3.3.2、情况二：其他情况

若实体类中的属性和表中的字段不满足情况1，例如实体类属性name，表中字段username，此时需要在实体类属性上使用@TableField("username")设置属性所对应的字段名

3.4、@TableLogic

3.4.1、逻辑删除

物理删除:真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据

逻辑删除:假删除，添加一个代表是否被删除的字段，将对应数据中代表是否被删除的字段的状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

使用场景:逻辑删除后可以进行数据恢复

3.4.2、实现逻辑删除

  1. 在数据库中创建逻辑删除状态列is_deleted，设置默认值为0

  2. 在实体类中添加逻辑删除属性@TableLogic

    @Data
    @TableName("user")
    public class User {

        @TableId
        private Long id;
        @TableField("username")
        private String name;
        
        private Integer age;
        private String email;

        @TableLogic
        private Integer isDeleted;

    }

  3. 测试

    此时原来的删除功能会变为执行修改is_deleted字段，查询时被标记为删除的字段不会被查询出来

 

4、条件构造器和常用接口

4.1、wapper

截屏2022-06-09 17.47.45

  • Wrapper : 条件构造抽象类，最顶端父类

    • AbstractWrapper : 用于查询条件封装，生成 sql 的 where 条件

      • QueryWrapper : 查询条件封装

      • UpdateWrapper : Update 条件封装

      • AbstractLambdaWrapper : 使用Lambda 语法

        • LambdaQueryWrapper :用于Lambda语法使用的查询Wrapper

        • LambdaUpdateWrapper : Lambda 更新封装Wrapper

4.2、QueryWapper

通过创建一个QueryWapper对象可以组装各种条件，QueryWapper的column参数为字段名

4.2.1、组装查询条件

@Test
public void test01(){ 
  	//查询用户名包含a，年龄在20到30之间，并且邮箱不为null的用户信息
		//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (username LIKE ? AND age BETWEEN ? AND ? AND email IS NOT NULL)
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.like("username", "a")
            .between("age", 20, 30)
            .isNotNull("email");
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

4.2.2、组装排序条件

@Test
public void test02(){
		//按年龄降序查询用户，如果年龄相同则按id升序排列
		//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 ORDER BY age DESC,id ASC
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper
            .orderByDesc("age")
            .orderByAsc("id");
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

4.2.3、组装删除条件

@Test
public void test03(){
		//删除email为空的用户
		//DELETE FROM t_user WHERE (email IS NULL) 
  	QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
  	queryWrapper.isNull("email"); 
  	//条件构造器也可以构建删除语句的条件
		int result = userMapper.delete(queryWrapper); 
  	System.out.println("受影响的行数:" + result);
}

4.2.4、组装修改条件

@Test
public void test04() {
		QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
  	//将(年龄大于20并且用户名中包含有a)或邮箱为null的用户信息修改
		//UPDATE t_user SET age=?, email=? WHERE (username LIKE ? AND age > ? OR email IS NULL)
    queryWrapper
            .like("username", "a")
            .gt("age", 20)
            .or() // 将两个条件用or连接
            .isNull("email");
		User user = new User();
		user.setAge(18); user.setEmail("user@atguigu.com");
		int result = userMapper.update(user, queryWrapper); // 第一个参数是要修改的字段值，第二个参数是修改条件
  	System.out.println("受影响的行数:" + result);
}

使用lambda表达式（lambda表达式中的条件优先执行）

@Test
public void test04() {
		QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
  	//将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
		//UPDATE t_user SET age=?, email=? WHERE (username LIKE ? AND (age > ? OR email IS NULL)) 
  	//lambda表达式内的逻辑优先运算 
  	queryWrapper
            .like("username", "a")
            .and(i -> i.gt("age", 20).or().isNull("email"));
    User user = new User();
		user.setAge(18); user.setEmail("user@atguigu.com");
		int result = userMapper.update(user, queryWrapper); 
  	System.out.println("受影响的行数:" + result);
}

4.2.5、组装select子句

设置要查询的字段

@Test
public void test05() {
		//查询用户信息的username和age字段
		//SELECT username,age FROM t_user
		QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
  	queryWrapper.select("username", "age"); 
  	//selectMaps()返回Map集合列表，通常配合select()使用，避免User对象中没有被查询到的列值为null
		List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper); 
  	maps.forEach(System.out::println);
}

4.2.6、实现子查询

@Test
public void test06() {
		//查询id小于等于3的用户信息
		//SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (id IN (select id from t_user where id <= 3))
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.inSql("id", "select id from t_user where id <= 3");
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

4.3、UpdateWapper

@Test
public void test07() { 
  	//将(年龄大于20或邮箱为null)并且用户名中包含有a的用户信息修改 
  	//组装set子句以及修改条件
		UpdateWrapper<User> updateWrapper = new UpdateWrapper<>(); 
  	//lambda表达式内的逻辑优先运算
		updateWrapper
        .set("age", 18)
        .set("email", "user@atguigu.com")
        .like("username", "a")
        .and(i -> i.gt("age", 20).or().isNull("email"));
		//这里必须要创建User对象，否则无法应用自动填充。如果没有自动填充，可以设置为null
    int result = userMapper.update(null, updateWrapper);
    //UPDATE t_user SET username=?, age=?,email=? WHERE (username LIKE ? AND (age > ? OR email IS NULL))
  
		//User user = new User(); 
  	//user.setName("张三");
    //int result = userMapper.update(user, updateWrapper);
    //UPDATE t_user SET age=?,email=? WHERE (username LIKE ? AND (age > ? OR email IS NULL))
    System.out.println(result);
}

4.4、condition

在真正开发的过程中，组装条件是常见的功能，而这些条件数据来源于用户输入，是可选的，因此我们在组装这些条件时，必须先判断用户是否选择了这些条件，若选择则需要组装该条件，若没有选择则一定不能组装，以免影响SQL执行的结果

  • 方式一：

@Test
public void test08() {
		//定义查询条件，有可能为null(用户未输入或未选择)
		String username = null;
		Integer ageBegin = 10;
		Integer ageEnd = 24;
		QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
  	//StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace)构成
  	if(StringUtils.isNotBlank(username)){
   		 queryWrapper.like("username","a");
		}
		if(ageBegin != null){
  		  queryWrapper.ge("age", ageBegin);
		}
		if(ageEnd != null){
    		queryWrapper.le("age", ageEnd);
		}
    //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (age >= ? AND age <= ?)
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

  • 方式二：用带condition参数的重载方法构建查询条件，简化代码的编写

@Test
public void test08UseCondition() {
		//定义查询条件，有可能为null(用户未输入或未选择)
		String username = null;
		Integer ageBegin = 10;
		Integer ageEnd = 24;
		QueryWrapper<User> queryWrapper = new QueryWrapper<>(); 
  	//StringUtils.isNotBlank()判断某字符串是否不为空且长度不为0且不由空白符(whitespace)构成
		queryWrapper
    		    .like(StringUtils.isNotBlank(username), "username", "a")
            .ge(ageBegin != null, "age", ageBegin)
            .le(ageEnd != null, "age", ageEnd);
    //SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE (age >= ? AND age <= ?)
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

 

4.5、LambdaQueryWrapper

使用LambdaQueryWrapper可以避免使用字符串表示字段，防止运行时错误（推荐使用）

@Test
public void test09() {
		//定义查询条件，有可能为null(用户未输入)
		String username = "a";
		Integer ageBegin = 10;
		Integer ageEnd = 24;
		LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>(); 
  	//避免使用字符串表示字段，防止运行时错误
		queryWrapper
            .like(StringUtils.isNotBlank(username), User::getName, username)
            .ge(ageBegin != null, User::getAge, ageBegin)
            .le(ageEnd != null, User::getAge, ageEnd);
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

 

4.6、LambdaUpdateWrapper

@Test
public void test10() { 
  	//组装set子句
    LambdaUpdateWrapper<User> updateWrapper = new LambdaUpdateWrapper<>();
    updateWrapper
        .set(User::getAge, 18)
        .set(User::getEmail, "user@atguigu.com")
        .like(User::getName, "a")
        .and(i -> i.lt(User::getAge, 24).or().isNull(User::getEmail)); 
  	//lambda表达式内的逻辑优先运算
		User user = new User();
		int result = userMapper.update(user, updateWrapper); 
  	System.out.println("受影响的行数:" + result);
}

 

5、插件

5.1、分页插件

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

5.1.1、添加配置类

//===src/main/java/com/colin/mybatisplus/config/MyBatisPlusConfig.java===
@Configuration
@MapperScan("com.colin.mybatisplus.mapper") //可以将启动类中的mapper扫描注解移到此处
public class MyBatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        // 创建拦截器对象
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 在拦截器对象中添加内部拦截器，即需要的插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

}

5.1.2、测试

//===src/test/java/com/colin/mybatisplus/MybatisPlusPluginTest.java===
@SpringBootTest
public class MybatisPlusPluginTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testPage(){
        // 设置分页参数
        // 创建Page对象，第一个参数是当前页码，第二个参数是页面大小
        Page<User> page = new Page<>(2, 3);
        // 使用selectPage进行分页，第一个参数是Page对象，第二个是分页条件
        userMapper.selectPage(page, null);

        // 获取分页数据
        System.out.println(page);
        // 获取记录
        List<User> list = page.getRecords(); 
        list.forEach(System.out::println);
        
        System.out.println("当前页:"+page.getCurrent());
        System.out.println("每页显示的条数:"+page.getSize()); 
        System.out.println("总记录数:"+page.getTotal()); 
        System.out.println("总页数:"+page.getPages()); 
        System.out.println("是否有上一页:"+page.hasPrevious()); 
        System.out.println("是否有下一页:"+page.hasNext());
    }

}

 

5.2、xml自定义分页

5.2.1、UserMapper中定义接口方法

/**
 * 根据年龄查询用户列表，分页显示
 * @param page 分页对象,xml中可以从里面进行取值,传递参数 Page 即自动分页,必须放在第一位 * @param age 年龄
 * @return
 */
IPage<User> selectPageVo(@Param("page") Page<User> page, @Param("age") Integer age);

5.2.2、UserMapper.xml中编写SQL

<!--===src/main/resources/mapper/UserMapper.xml===-->
<!--SQL片段，记录基础字段-->
<sql id="BaseColumns">id,username,age,email</sql>

<!--IPage<User> selectPageVo(Page<User> page, Integer age);-->
<select id="selectPageVo" resultType="User">
    SELECT <include refid="BaseColumns"></include> FROM t_user WHERE age > #{age}
</select>

注意在这里resultType使用User前需要在application.yml中设置类型别名对应的包

  # 配置类型别名所对应的包，包下的所有实体类都可以使用类名来作为类型别名
  type-aliases-package: com.colin.mybatisplus.pojo

5.2.3、测试

@Test
public void testSelectPageVo(){ 
  	//设置分页参数
		Page<User> page = new Page<>(1, 5); 
  	userMapper.selectPageVo(page, 20);
		//获取分页数据
		List<User> list = page.getRecords(); 
  	list.forEach(System.out::println); 
  	System.out.println("当前页:"+page.getCurrent()); 
  	System.out.println("每页显示的条数:"+page.getSize()); 
  	System.out.println("总记录数:"+page.getTotal()); 
  	System.out.println("总页数:"+page.getPages()); 
  	System.out.println("是否有上一页:"+page.hasPrevious()); 
  	System.out.println("是否有下一页:"+page.hasNext());
}

 

5.3、乐观锁

5.3.1、乐观锁和悲观锁

  • 乐观锁：在操作数据库保存结果前，先检查是否有修改，如果出现了修改则更新当前数据库状态，不保存当前操作

  • 悲观锁：一个用户对数据库的操作完成后另一个用户才可以操作

5.3.2、模拟修改冲突

  1. 数据库中增加商品表

CREATE TABLE t_product
(
		id BIGINT(20) NOT NULL COMMENT '主键ID',
		NAME VARCHAR(30) NULL DEFAULT NULL COMMENT '商品名称', 
		price INT(11) DEFAULT 0 COMMENT '价格',
		VERSION INT(11) DEFAULT 0 COMMENT '乐观锁版本号', 
		PRIMARY KEY (id)
);

  1. 添加数据

INSERT INTO t_product (id, NAME, price) VALUES (1, '外星人笔记本', 100);

  1. 添加实体类

@Data
public class Product {

    @TableId
    private Integer id;

    private String name;
    private Integer price;
    private Integer version;

}

  1. 添加mapper接口

@Repository
public interface ProductMapper extends BaseMapper<Product> {
}

  1. 测试

    @Test
    public void testProduct01(){
        //1、小李
        Product p1 = productMapper.selectById(1L);
        System.out.println("小李取出的价格:" + p1.getPrice());
        //2、小王
        Product p2 = productMapper.selectById(1L);
        System.out.println("小王取出的价格:" + p2.getPrice());
        //3、小李将价格加了50元，存入了数据库
        p1.setPrice(p1.getPrice() + 50);
        int result1 = productMapper.updateById(p1);
        System.out.println("小李修改结果:" + result1);
        //4、小王得知小李加了50元后，将商品减了30元，存入了数据库
        p2.setPrice(p2.getPrice() - 30);
        int result2 = productMapper.updateById(p2);
        System.out.println("小王修改结果:" + result2);
        //最后的结果
        Product p3 = productMapper.selectById(1L);
        //价格覆盖，最后的结果:70
        System.out.println("最后的结果:" + p3.getPrice());
    }

未使用乐观锁之前，会出现修改错误

5.3.3、乐观锁的实现流程

  1. 数据库中添加version字段，在实体类中标识@Version

  2. 取出记录时，获取当前version

5.3.4、Mybatis-Plus实现乐观锁

  1. 修改实体类

//===src/main/java/com/colin/mybatisplus/pojo/Product.java===
@Data
@TableName("t_product")
public class Product {

    @TableId
    private Long id;

    private String name;
    private Integer price;

    @Version //标识乐观锁版本号字段
    private Integer version;

}

  1. 添加乐观锁插件配置

//===src/main/java/com/colin/mybatisplus/config/MyBatisPlusConfig.java===
@Configuration
@MapperScan("com.colin.mybatisplus.mapper") //可以将启动类中的mapper扫描注解移到此处
public class MyBatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        // 创建拦截器对象
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();

        // 在拦截器对象中添加内部拦截器，即需要的插件
        // 添加分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        // 添加乐观锁插件
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }

}

  1. 测试（和上一节测试代码相同）

最终结果为150，先更新了小李的操作，改变了版本号，小王的操作与版本号不匹配，操作失败

5.3.5、优化修改流程

    @Test
    public void testProduct01(){
        //1、小李
        Product p1 = productMapper.selectById(1L);
        System.out.println("小李取出的价格:" + p1.getPrice());
        //2、小王
        Product p2 = productMapper.selectById(1L);
        System.out.println("小王取出的价格:" + p2.getPrice());
        //3、小李将价格加了50元，存入了数据库
        p1.setPrice(p1.getPrice() + 50);
        int result1 = productMapper.updateById(p1);
        System.out.println("小李修改结果:" + result1);
        //4、小王得知小李加了50元后，将商品减了30元，存入了数据库
        p2.setPrice(p2.getPrice() - 30);
        int result2 = productMapper.updateById(p2);
        System.out.println("小王修改结果:" + result2);
        if (result2 == 0){
            // 小王修改失败，重新获取version并再次操作
            p2 = productMapper.selectById(1L); // 
            p2.setPrice(p2.getPrice() - 30);
            result2 = productMapper.updateById(p2);
        }
        System.out.println("小王重新修改的结果:" + result2);
        //最后的结果
        Product p3 = productMapper.selectById(1L);
        //价格覆盖，最后的结果:70
        System.out.println("最后的结果:" + p3.getPrice());
    }

 

6、通用枚举

表中的有些字段值是固定的，例如性别(男或女)，此时我们可以使用MyBatis-Plus的通用枚举来实现

需要回顾关于枚举类型的知识

  1. 在数据库中添加性别字段

 

  1. 创建通用枚举类型，使用@EnumValue标识存储到数据库中的值

//===src/main/java/com/colin/mybatisplus/enums/SexEnum.java===
@Getter // 因为存储的是常量，所以只需要设置getter方法
public enum SexEnum {

    MALE(0, "man"),
    FEMALE(1, "woman");

    @EnumValue // 将本注解标识的属性的值存储到数据库中（如果不配置则存储的是字符串MALE/FEMALE）
    private Integer sex;

    private String sexName;

    SexEnum(Integer sex, String sexName) {
        this.sex = sex;
        this.sexName = sexName;
    }
}

  1. 配置扫描通用枚举

#application.yml
mybatis-plus:
  # 配置扫描通用枚举
	type-enums-package: com.atguigu.mybatisplus.enums

  1. 测试

@SpringBootTest
public class MybatisPlusEnumTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testEnums(){
        User user = new User();
        user.setName("lisi");
        user.setAge(22);
        user.setSex(SexEnum.FEMALE);
        int result = userMapper.insert(user);
        System.out.println("result = " + result);
    }

}

 

7、代码生成器

  1. 引入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.1</version>
</dependency>
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

 

  1. 快速生成（创建测试类，直接运行）

public class FastAutoGeneratorTest {

    public static void main(String[] args) {
        FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/mybatis_plus?characterEncoding=utf-8&userSSL=false", "root", "123456")
                .globalConfig(builder -> {
                    builder.author("atguigu") // 设置作者
                            // .enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .outputDir("D://mybatis_plus"); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("com.atguigu") // 设置父包名
                            .moduleName("mybatisplus") // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://mybatis_plus")); // 设置mapperXml生成路径
                })
                .strategyConfig(builder -> {
                    builder.addInclude("t_user") // 设置需要生成的表名
                            .addTablePrefix("t_", "c_"); // 设置过滤表前缀
                })
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker 引擎模板，默认的是Velocity引擎模板
                .execute();
    }

}

 

8、多数据源

查看官网

适用于多种场景:纯粹多库、读写分离、一主多从、混合模式等

  1. 创建数据库及表

创建新的数据库和表

CREATE DATABASE `mybatis_plus_1` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
use `mybatis_plus_1`;
CREATE TABLE product
(
	id BIGINT(20) NOT NULL COMMENT '主键ID',
	name VARCHAR(30) NULL DEFAULT NULL COMMENT '商品名称', 
  price INT(11) DEFAULT 0 COMMENT '价格',
	version INT(11) DEFAULT 0 COMMENT '乐观锁版本号', 
  PRIMARY KEY (id)
);

添加数据

INSERT INTO product (id, NAME, price) VALUES (1, '外星人笔记本', 100);

删除原数据库中的表

use mybatis_plus;
DROP TABLE IF EXISTS product;

  1. 引入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.5.0</version>
</dependency>

  1. 配置多数据源

spring:
  # 配置数据源信息 datasource:
  dynamic:
    # 设置默认的数据源或者数据源组,默认值即为master
    primary: master
    # 严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源 
    strict: false
  datasource:
    master:
      url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
      driver-class-name: com.mysql.cj.jdbc.Driver
      username: root
      password: 123456
    slave_1:
      url: jdbc:mysql://localhost:3306/mybatis_plus_1?characterEncoding=utf-8&useSSL=false
      driver-class-name: com.mysql.cj.jdbc.Driver
      username: root
      password: 123456

  1. 创建用户service（@DS还可以加到方法上）

public interface UserService extends IService<User> {
}
@DS("master") //指定所操作的数据源
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}

  1. 创建商品service

public interface ProductService extends IService<Product> {
}
@DS("slave_1")
@Service
public class ProductServiceImpl extends ServiceImpl<ProductMapper, Product> implements ProductService {
}

  1. 测试

@Autowired
private UserService userService;
@Autowired
private ProductService productService;
@Test
public void testDynamicDataSource(){
    System.out.println(userService.getById(1L));
    System.out.println(productService.getById(1L));
}

将写操作方法加上主库数据源，读操作方法加上从库数据源，自动切换，就能实现读写分离

9、MyBatisX插件

MyBatisX一款基于 IDEA 的快速开发插件，为效率而生。（需要在idea中安装MyBatisX插件）

MyBatisX插件用法：https://baomidou.com/pages/ba5b24/

9.1、功能

  1. XML和对应mapper接口的跳转

 

  1. 快速生成代码

先在 idea 配置 Database 配置数据源，然后右键选中数据源，使用MBX的代码生成器

 

  1. JPA提示，快速生成CRUD

在mapper接口中写出方法名，然后补全即可

生成查询

  1. 重置模版

生成代码

 
posted @ 2022-08-31 01:52  Colin13  阅读(214)  评论(0)  编辑  收藏  举报