mybatis-plus的使用

Mybatis-Plus

1、简单概述

mybatis-plus是一款Mybatis增强工具，用于简化开发，提高效率。下文使用缩写mp 来简化表示mybatis-plus ，本文主要介绍mp搭配SpringBoot的使用。

注：本文使用的mp版本是当前最新的3.4.2，早期版本的差异请自行查阅文档

官方网站：baomidou.com/

2、快速入门

1、创建一个springboot项目；

2、引入依赖；

<!-- pom.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>mybatis-plus</name>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.2</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

3、配置数据库

# application.yml
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mp?serverTimezone=Asia/Shanghai
    username: root
    password: root

mybatis-plus:
  configuration:
	#开启SQL语句打印
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

4、创建一个实体类

package com.example.mp.po;
import lombok.Data;
import java.time.LocalDateTime;
@Data
public class User {
 private Long id;
 private String name;
 private Integer age;
 private String email;
 private Long managerId;
 private LocalDateTime createTime;
}

5、创建一个mapper接口

package com.example.mp.mappers;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.mp.po.User;
public interface UserMapper extends BaseMapper<User> { }

6、在SpringBoot启动类上配置mapper接口的扫描路径

package com.example.mp;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.example.mp.mappers")
public class MybatisPlusApplication {
 public static void main(String[] args) {
  SpringApplication.run(MybatisPlusApplication.class, args);
 }
}

7、在数据库中创建对应的表

DROP TABLE IF EXISTS user;
CREATE TABLE user (
id BIGINT(20) PRIMARY KEY NOT NULL COMMENT '主键',
name VARCHAR(30) DEFAULT NULL COMMENT '姓名',
age INT(11) DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) DEFAULT NULL COMMENT '邮箱',
manager_id BIGINT(20) DEFAULT NULL COMMENT '直属上级id',
create_time DATETIME DEFAULT NULL COMMENT '创建时间',
CONSTRAINT manager_fk FOREIGN KEY(manager_id) REFERENCES user (id)
) ENGINE=INNODB CHARSET=UTF8;

INSERT INTO user (id, name, age ,email, manager_id, create_time) VALUES
(1, '大BOSS', 40, 'boss@baomidou.com', NULL, '2021-03-22 09:48:00'),
(2, '李经理', 40, 'boss@baomidou.com', 1, '2021-01-22 09:48:00'),
(3, '黄主管', 40, 'boss@baomidou.com', 2, '2021-01-22 09:48:00'),
(4, '吴组长', 40, 'boss@baomidou.com', 2, '2021-02-22 09:48:00'),
(5, '小菜', 40, 'boss@baomidou.com', 2, '2021-02-22 09:48:00')

8、编写一个单元测试类

@SpringBootTest
@Slf4j
class MpApplicationTests {
    
    @Autowired
    private UserMapper userMapper;

    @Test
    void testSelect() {
        List<User> users = userMapper.selectList(null);
        for (User user : users) {
            log.info("------{}", user);
        }
    }
}

9、准备工作完成

10、运行测试类

==>  Preparing: SELECT id,name,age,email,manager_id,create_time FROM user
==> Parameters: 
<==    Columns: id, name, age, email, manager_id, create_time
<==        Row: 1, 大BOSS, 40, boss@baomidou.com, null, 2021-03-22 09:48:00
<==        Row: 2, 李经理, 40, boss@baomidou.com, 1, 2021-01-22 09:48:00
<==        Row: 3, 黄主管, 40, boss@baomidou.com, 2, 2021-01-22 09:48:00
<==        Row: 4, 吴组长, 40, boss@baomidou.com, 2, 2021-02-22 09:48:00
<==        Row: 5, 小菜, 40, boss@baomidou.com, 2, 2021-02-22 09:48:00
<==      Total: 5

可以看到，针对单表的基本CRUD操作，只需要创建好实体类，并创建一个继承自BaseMapper的接口即可，可谓非常简洁。并且，我们注意到，User类中的managerId，createTime属性自动和数据库表中的manager_id，create_time对应了起来，这是因为mp自动做了数据库下划线命名到Java类的驼峰命名之间的转化。

2、注解

mp一共提供了8个注解，这些注解是用在Java的实体类上面的

  • @TableName

注解在类上，指定类和数据库表的映射关系。实体类的类名（转成小写后）和数据库表名相同时 ，可以不指定该注解。

  • @TableId

注解在实体类的某一字段上，表示这个字段对应数据库表的主键 。当主键名为id时（表中列名为id，实体类中字段名为id），无需使用该注解显式指定主键，mp会自动关联。若类的字段名和表的列名不一致，可用value属性指定表的列名。另，这个注解有个重要的属性type，用于指定主键策略，参见主键策略小节

  • @TableField

注解在某一字段上，指定Java实体类的字段和数据库表的列的映射关系。这个注解有如下几个应用场景。

  • 排除非表字段

    若Java实体类中某个字段，不对应表中的任何列，它只是用于保存一些额外的，或组装后的数据，则可以设置exist属性为false，这样在对实体对象进行插入时，会忽略这个字段。排除非表字段也可以通过其他方式完成，如使用static或transient关键字，但个人觉得不是很合理，不做赘述

  • 字段验证策略

    通过insertStrategy，updateStrategy，whereStrategy属性进行配置，可以控制在实体对象进行插入，更新，或作为WHERE条件时，对象中的字段要如何组装到SQL语句中。参见配置小节

  • 字段填充策略

    通过fill属性指定，字段为空时会进行自动填充

  • @Version

乐观锁注解，参见乐观锁小节

  • @EnumValue

注解在枚举字段上

  • @TableLogic

逻辑删除，参见逻辑删除小节

  • KeySequence

序列主键策略（oracle）

  • InterceptorIgnore

插件过滤规则

3、CRUD接口

mp封装了一些最基础的CRUD方法，只需要直接继承mp提供的接口，无需编写任何SQL，即可食用。mp提供了两套接口，分别是Mapper CRUD接口和Service CRUD接口。并且mp还提供了条件构造器Wrapper，可以方便地组装SQL语句中的WHERE条件，参见条件构造器小节

3.1、Mapper CRUD

只需定义好实体类，然后创建一个接口，继承mp提供的BaseMapper，即可使用。mp会在mybatis启动时，自动解析实体类和表的映射关系，并注入带有通用CRUD方法的mapper。BaseMapper里提供的方法，部分列举如下：

  • insert(T entity) 插入一条记录
  • deleteById(Serializable id) 根据主键id删除一条记录
  • delete(Wrapper<T> wrapper) 根据条件构造器wrapper进行删除
  • selectById(Serializable id) 根据主键id进行查找
  • selectBatchIds(Collection idList) 根据主键id进行批量查找
  • selectByMap(Map<String,Object> map) 根据map中指定的列名和列值进行等值匹配 查找
  • selectMaps(Wrapper<T> wrapper) 根据 wrapper 条件，查询记录，将查询结果封装为一个Map，Map的key为结果的列，value为值
  • selectList(Wrapper<T> wrapper) 根据条件构造器wrapper进行查询
  • update(T entity, Wrapper<T> wrapper) 根据条件构造器wrapper进行更新
  • updateById(T entity)

简单的使用示例如前文快速入门小节，下面讲解几个比较特别的方法

3.1.1、selectMaps

BaseMapper接口还提供了一个selectMaps方法，这个方法会将查询结果封装为一个Map，Map的key为结果的列，value为值

只查部分列

当某个表的列特别多，而SELECT的时候只需要选取个别列，查询出的结果也没必要封装成Java实体类对象时（只查部分列时，封装成实体后，实体对象中的很多属性会是null），则可以用selectMaps，获取到指定的列后，再自行进行处理即可

比如：

    @Test
    public void test3() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.select("id", "name", "email").likeRight("name", "黄");
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

控制台输出，可以看到控制台输出来对应的值：

==>  Preparing: SELECT id,name,email FROM user WHERE (name LIKE ?)
==> Parameters: 黄%(String)
<==    Columns: id, name, email
<==        Row: 3, 黄主管, boss@baomidou.com
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@19058533]
{name=黄主管, id=3, email=boss@baomidou.com}

进行数据统计

    @Test
    public void test4() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.select("manager_id", "avg(age) avg_age", "min(age) min_age", "max(age) max_age")
                .groupBy("manager_id").having("sum(age) < {0}", 500);
        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
        maps.forEach(System.out::println);
    }

控制台输出：

==>  Preparing: SELECT manager_id,avg(age) avg_age,min(age) min_age,max(age) max_age FROM user GROUP BY manager_id HAVING sum(age) < ?
==> Parameters: 500(Integer)
<==    Columns: manager_id, avg_age, min_age, max_age
<==        Row: null, 40.0000, 40, 40
<==        Row: 1, 40.0000, 40, 40
<==        Row: 2, 40.0000, 40, 40
<==      Total: 3
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4315e9af]
{max_age=40, avg_age=40.0000, min_age=40}
{max_age=40, avg_age=40.0000, manager_id=1, min_age=40}
{max_age=40, avg_age=40.0000, manager_id=2, min_age=40}

3.1.2、selectObjs

只会返回第一个字段（第一列）的值，其他字段会被舍弃

比如：

    @Test
    public void test5() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.select("id", "name").like("name", "黄");
        List<Object> objects = userMapper.selectObjs(wrapper);
        objects.forEach(System.out::println);
    }

控制台输出，可以看到控制台上只是输出了第一条记录的第一列的值：

==>  Preparing: SELECT id,name FROM user WHERE (name LIKE ?)
==> Parameters: %黄%(String)
<==    Columns: id, name
<==        Row: 3, 黄主管
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@69e05f61]
3

3.1.3、selectCount

查询满足条件的总数，注意，使用这个方法，不能调用QueryWrapper的select方法设置要查询的列了。这个方法会自动添加select count(*)

比如

    @Test
    public void test6() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.like("name", "黄");

        Integer count = userMapper.selectCount(wrapper);
        System.out.println(count);
    }

控制台显示：

==>  Preparing: SELECT COUNT( * ) FROM user WHERE (name LIKE ?)
==> Parameters: %黄%(String)
<==    Columns: COUNT( * )
<==        Row: 1
<==      Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@2babf189]
1

3.2、Service CRUD

另外一套CRUD是Service层的，只需要编写一个接口，继承IService，并创建一个接口实现类，即可使用。（这个接口提供的CRUD方法，和Mapper接口提供的功能大同小异，比较明显的区别在于IService支持了更多的批量化操作 ，如saveBatch，saveOrUpdateBatch等方法。

使用示例如下

  1. 首先，新建一个接口，继承IService
package com.example.mp.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.example.mp.po.User;

public interface UserService extends IService<User> {}

测试代码：

    @Test
    public void testGetOne() {
        LambdaQueryWrapper<User> wrapper = Wrappers.<User>lambdaQuery();
        wrapper.gt(User::getAge, 28);
        User one = userService.getOne(wrapper, false);
        // 第二参数指定为false,使得在查到了多行记录时,不抛出异常,而返回第一条记录
        System.out.println(one);
    }

输出控制台如下所示：

==>  Preparing: SELECT id,name,age,email,manager_id,create_time FROM user WHERE (age > ?)
==> Parameters: 28(Integer)
<==    Columns: id, name, age, email, manager_id, create_time
<==        Row: 1, 大BOSS, 40, boss@baomidou.com, null, 2021-03-22 09:48:00
<==        Row: 2, 李经理, 40, boss@baomidou.com, 1, 2021-01-22 09:48:00
<==        Row: 3, 黄主管, 40, boss@baomidou.com, 2, 2021-01-22 09:48:00
<==        Row: 4, 吴组长, 40, boss@baomidou.com, 2, 2021-02-22 09:48:00
<==        Row: 5, 小菜, 40, boss@baomidou.com, 2, 2021-02-22 09:48:00
<==      Total: 5
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@1046498a]
2021-10-21 01:01:09.881  WARN 7376 --- [           main] c.e.mp.service.impl.UserServiceImpl      : Warn: execute Method There are  5 results.
User(id=1, name=大BOSS, age=40, email=boss@baomidou.com, managerId=null, createTime=2021-03-22T09:48)

另外，IService也支持链式调用，代码写起来非常简洁，查询示例如下：

@Test
public void testChain() {
    List<User> list = userService.lambdaQuery().gt(User::getAge, 39).likeRight(User::getName, "王").list();
    list.forEach(System.out::println);
}

控制台输出：

==>  Preparing: SELECT id,name,age,email,manager_id,create_time FROM user WHERE (age > ? AND name LIKE ?)
==> Parameters: 39(Integer), 王%(String)
<==      Total: 0
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@3491e86e]

删除示例如下:

    @Test
    public void testChainOne() {
        userService.lambdaUpdate().like(User::getName, "青蛙").remove();
    }

输出控制台如下所示：

JDBC Connection [HikariProxyConnection@1294058862 wrapping com.mysql.cj.jdbc.ConnectionImpl@726aa968] will not be managed by Spring
==>  Preparing: DELETE FROM user WHERE (name LIKE ?)
==> Parameters: %青蛙%(String)
<==    Updates: 0

更新示例如下

    @Test
    public void testChainThree() {
        userService.lambdaUpdate().gt(User::getAge, 39).likeRight(User::getName, "王").set(User::getEmail, "w39@baomidou.com").update();
    }

控制台输出：

==>  Preparing: UPDATE user SET email=? WHERE (age > ? AND name LIKE ?)
==> Parameters: w39@baomidou.com(String), 39(Integer), 王%(String)
<==    Updates: 0

4、条件构造器

mp让我觉得极其方便的一点在于其提供了强大的条件构造器Wrapper，可以非常方便的构造WHERE条件。条件构造器主要涉及到3个类，AbstractWrapper。QueryWrapper，UpdateWrapper，它们的类关系如下：

在AbstractWrapper中提供了非常多的方法用于构建WHERE条件，而QueryWrapper针对SELECT语句，提供了select()方法，可自定义需要查询的列，而UpdateWrapper针对UPDATE语句，提供了set()方法，用于构造set语句。条件构造器也支持lambda表达式，写起来非常舒爽。

下面对AbstractWrapper中用于构建SQL语句中的WHERE条件的方法进行部分列举

  • eq：equals，等于
  • allEq：all equals，全等于
  • ne：not equals，不等于
  • gt：greater than ，大于 >
  • ge：greater than or equals，大于等于≥
  • lt：less than，小于<
  • le：less than or equals，小于等于≤
  • between：相当于SQL中的BETWEEN
  • notBetween
  • like：模糊匹配。like("name","黄")，相当于SQL的name like '%黄%'
  • likeRight：模糊匹配右半边。likeRight("name","黄")，相当于SQL的name like '黄%'
  • likeLeft：模糊匹配左半边。likeLeft("name","黄")，相当于SQL的name like '%黄'
  • notLike：notLike("name","黄")，相当于SQL的name not like '%黄%'
  • isNull
  • isNotNull
  • in
  • and：SQL连接符AND
  • or：SQL连接符OR
  • apply：用于拼接SQL，该方法可用于数据库函数，并可以动态传参
  • .......

使用示例

下面通过一些具体的案例来练习条件构造器的使用。（使用前文创建的user表）

// 案例先展示需要完成的SQL语句，后展示Wrapper的写法

// 1. 名字中包含佳，且年龄小于25
// SELECT * FROM user WHERE name like '%佳%' AND age < 25
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.like("name", "佳").lt("age", 25);
List<User> users = userMapper.selectList(wrapper);
// 下面展示SQL时，仅展示WHERE条件；展示代码时, 仅展示Wrapper构建部分

// 2. 姓名为黄姓，且年龄大于等于20，小于等于40，且email字段不为空
// name like '黄%' AND age BETWEEN 20 AND 40 AND email is not null
wrapper.likeRight("name","黄").between("age", 20, 40).isNotNull("email");

// 3. 姓名为黄姓，或者年龄大于等于40，按照年龄降序排列，年龄相同则按照id升序排列
// name like '黄%' OR age >= 40 order by age desc, id asc
wrapper.likeRight("name","黄").or().ge("age",40).orderByDesc("age").orderByAsc("id");

// 4.创建日期为2021年3月22日，并且直属上级的名字为李姓
// date_format(create_time,'%Y-%m-%d') = '2021-03-22' AND manager_id IN (SELECT id FROM user WHERE name like '李%')
wrapper.apply("date_format(create_time, '%Y-%m-%d') = {0}", "2021-03-22")  // 建议采用{index}这种方式动态传参, 可防止SQL注入
    .inSql("manager_id", "SELECT id FROM user WHERE name like '李%'");
// 上面的apply, 也可以直接使用下面这种方式做字符串拼接，但当这个日期是一个外部参数时，这种方式有SQL注入的风险
wrapper.apply("date_format(create_time, '%Y-%m-%d') = '2021-03-22'");

// 5. 名字为王姓，并且（年龄小于40，或者邮箱不为空）
// name like '王%' AND (age < 40 OR email is not null)
wrapper.likeRight("name", "王").and(q -> q.lt("age", 40).or().isNotNull("email"));

// 6. 名字为王姓，或者（年龄小于40并且年龄大于20并且邮箱不为空）
// name like '王%' OR (age < 40 AND age > 20 AND email is not null)
wrapper.likeRight("name", "王").or(
    q -> q.lt("age",40)
      .gt("age",20)
      .isNotNull("email")
  );

// 7. (年龄小于40或者邮箱不为空) 并且名字为王姓
// (age < 40 OR email is not null) AND name like '王%'
wrapper.nested(q -> q.lt("age", 40).or().isNotNull("email"))
    .likeRight("name", "王");

// 8. 年龄为30，31，34，35
// age IN (30,31,34,35)
wrapper.in("age", Arrays.asList(30,31,34,35));
// 或
wrapper.inSql("age","30,31,34,35");

// 9. 年龄为30，31，34，35, 返回满足条件的第一条记录
// age IN (30,31,34,35) LIMIT 1
wrapper.in("age", Arrays.asList(30,31,34,35)).last("LIMIT 1");

// 10. 只选出id, name 列 (QueryWrapper 特有)
// SELECT id, name FROM user;
wrapper.select("id", "name");

// 11. 选出id, name, age, email, 等同于排除 manager_id 和 create_time
// 当列特别多, 而只需要排除个别列时, 采用上面的方式可能需要写很多个列, 可以采用重载的select方法，指定需要排除的列
wrapper.select(User.class, info -> {
   String columnName = info.getColumn();
   return !"create_time".equals(columnName) && !"manager_id".equals(columnName);
  });

Condition

条件构造器的诸多方法中，均可以指定一个boolean类型的参数condition，用来决定该条件是否加入最后生成的WHERE语句中，比如：

String name = "黄"; // 假设name变量是一个外部传入的参数
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.like(StringUtils.hasText(name), "name", name);
// 仅当 StringUtils.hasText(name) 为 true 时, 会拼接这个like语句到WHERE中
// 其实就是对下面代码的简化
if (StringUtils.hasText(name)) {
 wrapper.like("name", name);
}

实体对象作为条件

调用构造函数创建一个Wrapper对象时，可以传入一个实体对象。后续使用这个Wrapper时，会以实体对象中的非空属性，构建WHERE条件（默认构建等值匹配 的WHERE条件，这个行为可以通过实体类里各个字段上的@TableField注解中的condition属性进行改变）

示例如下:

原文参考：https://mp.weixin.qq.com/s/SBkYZrBbGEgBe09erNr7tg

posted @ 2021-10-21 01:13  雩娄的木子  阅读(338)  评论(0)  编辑  收藏  举报