CSDN话题挑战赛第2期
参赛话题：学习笔记

Mybatis-plus

学习之路，长路漫漫，需要您的陪伴。
关注一波，您的关注是我最大的动力。

文章目录

Mybatis-plus
一、简介
二、入门案例
三、基本CRUD
- 1、BaseMapper
- 2、增
- 3、删
- 4、查
- 5、改
四、通用Service

一、简介

MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上**只做增强不做改变，为

简化开发、提高效率而生。

Mybatis-Plus具有多种优良特性，如无侵入、损耗小、支持主键自动生成等。

框架结构

代码及文档地址

官方地址: http://mp.baomidou.com

代码发布地址:

Github: https://github.com/baomidou/mybatis-plus

Gitee: https://gitee.com/baomidou/mybatis-plus

文档发布地址: https://baomidou.com/pages/24112f

接下来我们通过一个入门案例了解一下Mybatis-plus

二、入门案例

1、开发环境：

IDE：idea 2019.2
JDK：JDK8+
构建工具：maven 3.5.4
MySQL版本：MySQL 5.7
Spring Boot：2.7.3
MyBatis-Plus：3.5.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');

3、创建springboot并导入依赖

使用 Spring Initializr 快速初始化一个 Spring Boot 工程并导入以下依赖：

① 初始化工程

可以将不用的文件删除，只剩下面主要文件即可：

② 导入依赖

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

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

③ ideal中安装lombok插件

lombok：Lombok_百度百科 (baidu.com)

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?characterEncoding=utf8&useSSL=false&serverTimezone=UTC&rewriteBatchedStatements=true
    username: root
    password: '123456'

注意：

1、驱动类driver-class-name

spring boot 2.0（内置jdbc5驱动），驱动类使用：

driver-class-name: com.mysql.jdbc.Driver

spring boot 2.1及以上（内置jdbc8驱动），驱动类使用：

driver-class-name: com.mysql.cj.jdbc.Driver

否则运行测试用例的时候会有 WARN 信息

2、连接地址url

MySQL5.7版本的url：

jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false

MySQL8.0版本的url：

jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=UTC&characterEncoding=utf-8&useSSL=false

否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value ‘ÖÐ¹ú±ê×¼Ê±¼ä’ is unrecognized or

represents more

② 启动类：

创建mapper包

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Umumm9GL-1664548781628)(C:\Users\86133\AppData\Roaming\Typora\typora-user-images\image-20220930220345917.png)]

在Spring Boot启动类中添加@MapperScan注解，扫描mapper包

@SpringBootApplication 
@MapperScan("com.atguigu.mybatisplus.mapper") 
public class MybatisplusApplication { 
    public static void main(String[] args) { 
        SpringApplication.run(MybatisplusApplication.class, args); 
    } 
}

③ 添加实体

lombok中的Data注解自动为User实体类生成get、set、tostring、equal以及hashcode方法。

@Data //lombok注解 
public class User { 
    private Long id; 
    private String name; 
    private Integer age; 
    private String email; 
}

User类编译之后的结果：

④ 添加mapper

在mapper包中加入UserMapper接口

BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的

实体类型

public interface UserMapper extends BaseMapper<User> { }

⑤ 测试

@RunWith(SpringRunner.class)
@SpringBootTest 
public class MybatisPlusTest { 

    @Autowired 
    private UserMapper userMapper; 

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

IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确

的执行。

为了避免报错，可以在mapper接口上添加 @Repository 注解

输出结果：

⑥ 添加日志

在application.yml中配置日志输出

# 配置MyBatis日志 
mybatis-plus: 
	configuration: 
			log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

查询输出日志：

三、基本CRUD

1、BaseMapper

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用。其中代码过多，我就不放出来占篇幅了，大家可以在ideal中通过【crtl+N】查找BaseMapper类，点击下载源码后可以看到中文的对于各个方法的注释，还是很方便的。

2、增

    @Test
    public void testInsert() {
        //新增用户信息
        //日志输出的sql语句：INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
        User user=new User();
        user.setName("张三");
        user.setAge(23);
        user.setEmail("zhangsan@atguigu.com");
        int insert = usermapper.insert(user);
        System.out.println("id = " + user.getId());
    }

这里我们输出id是想看看是否有自动为实体类的id属性赋值上mp生成的id

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

这是因为MyBatis-Plus在实现插入数据时，会默认基于雪花算法的策略生成id

3、删

@Test
public void testDelete() {

    //① 通过id删除用户信息
    //日志输出的sql语句：DELETE FROM user WHERE id=?
    int res = usermapper.deleteById(1575763063053762562L);
    System.out.println("res = " + res);

    //② 根据map集合中所设置的条件进行删除
    //日志输出的sql语句：DELETE FROM user WHERE name = ? AND age = ?
    Map<String,Object> map=new HashMap<>();
    map.put("name","张三");  // name==张三
    map.put("age",23);       // age==23
    usermapper.deleteByMap(map);


    //③ 通过多个id执行批量删除
    //日志输出的sql语句：DELETE FROM user WHERE id IN ( ? , ? , ? )
    List<Long> idlist = Arrays.asList(1L, 2L, 3L);
    int res = usermapper.deleteBatchIds(idlist);
    System.out.println("res = " + res);

}

4、查

	@Test
    public void testUpdate() {
        //修改用户信息
        //日志输出的sql语句：UPDATE user SET name=?, email=? WHERE id=?
        User user = new User();
        user.setUid(4L);
        user.setName("李四");
        user.setEmail("lisi@atguigu.com");
        //传递的参数为实体类对象
        int res = usermapper.updateById(user);
        System.out.println("res = " + res);
    }

5、改

	@Test
    public void testSelect() {

        //通过id查找
        //日志输出的sql语句：SELECT id,name,age,email FROM user WHERE id=?
        User user = usermapper.selectById(1L);
        System.out.println("user = " + user);

        //根据用户id查询多个用户信息
        //日志输出的sql语句：SELECT id,name,age,email FROM user WHERE id IN ( ? , ? , ? )
        List<Long> idlist = Arrays.asList(1L, 2L, 3L);
        List<User> userList = usermapper.selectBatchIds(idlist);
        userList.forEach(System.out::println);

        //根据map集合中的条件查询用户信息
        //日志输出的sql语句：SELECT id,name,age,email FROM user WHERE name = ?
        Map<String,Object> map=new HashMap<>();
        map.put("name","Jack");
        List<User> userList = usermapper.selectByMap(map);
        userList.forEach(System.out::println);

        //查询所有数据
        //日志输出的sql语句：SELECT id,name,age,email FROM user
        List<User> list = usermapper.selectList(null);
        list.forEach(System.out::println);
        
    }

通过观察BaseMapper中的方法，大多方法中都有Wrapper类型的形参，此为条件构造器，可针

对于SQL语句设置不同的条件，若没有条件，则可以为该形参赋值null，即查询（删除/修改）所

有数据

四、通用Service

说明:

通用 Service CRUD 封装IService接口，进一步封装 CRUD 采用 get 查询单行 remove 删

除 list 查询集合 page 分页前缀命名方式区分 Mapper 层避免混淆，

泛型 T 为任意实体对象

建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承

Mybatis-Plus 提供的基类

官网地址：https://baomidou.com/pages/49cc81/#service-crud-%E6%8E%A5%E5%8F%A3

IService

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

详情查看源码IService和ServiceImpl，ideal中可通过【crtl+N】查找源码

① 创建Service接口和实现类ServiceImpl

/**
 * UserService继承IService模板提供的基础功能 
 */ 
public interface UserService extends IService<User> { 
}

/**
 * ServiceImpl实现了IService，提供了IService中基础功能的实现 
 * 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现 
 */ 
@Service 
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService { }

② 创建测试类

在test下创建MybatisplusServiceTest测试类

内容如下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisplusServiceTest {

    @Autowired
    public UserService userService;
    
}

③ 测试查询记录数

	@Test
    public void countselect() {
        //查询总记录数
        //日志输出的sql语句：SELECT COUNT( * ) FROM user
        long res = userService.count();
        System.out.println("res = " + res);
    }

④ 测试批量插入

    @Test
    public void testInsertMore() {
        //通过for循环实现批量插入
        //日志输出的sql语句：INSERT INTO t_user ( user_name, age, email ) VALUES ( ?, ?, ? )
        List<User> list = new ArrayList<User>();
        for (int i = 1; i < 10; i++) {
            User user = new User();
            user.setName("zjy"+i);
            user.setAge(20+i);
            user.setEmail("zjy"+i+"@atguigu.com");
            list.add(user);
        }
        boolean b = userService.saveBatch(list);
        System.out.println("b = " + b);
    }