简介

MyBatis-Plus是MyBatis的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。MyBatis-Plus提供了通用的mapper和service，可以在不编写任何SQL语句的情况下，快速地实现对单表的CRUD、批量、逻辑删除、分页等操作。

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下，如果不在下列表查看分页部分教程 PR 您的支持。

• MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb

• 达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库

框架结构

官方文档：https://baomidou.com/pages/24112f/

入门案例

开发环境

• IDE：IDEA 2019.3.5
• JDK：JDK8+
• 构建工具：Maven 3.5.4
• MySQL：MySQL 8.0.24
• Navicat：Navicat Premium 15
• Spring Boot：2.6.7
• MyBatis-Plus：3.5.1

https://baomidou.com/pages/24112f/

准备数据

打开Navicat运行以下SQL脚本进行建库建表

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');

https://baomidou.com/pages/24112f/

创建SpringBoot工程

初始化工程

使用 Spring Initializer 快速初始化一个 Spring Boot 工程

引入SpringBoot父工程

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.1</version><relativePath/> </parent>

添加依赖

<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>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.1</version></dependency><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></dependencies>

安装Lombok插件

配置编码

配置application.yml文件

#配置端口server:port: 80spring:#配置数据源datasource:#配置数据源类型type: com.zaxxer.hikari.HikariDataSource#配置连接数据库的信息driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://localhost:3306/mybatis_plus" />-8&useSSL=falseusername: rootpassword: root#MyBatis-Plus相关配置mybatis-plus:configuration:#配置日志，加入日志功能，可以查看MyBatisPlus生成的SQL语句。log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

注意：

加入日志功能

详见application.yml文件。

编写实体类 User.java

（此处使用了 Lombok 简化代码）

package com.xxxx.mybatisplus.pojo;import lombok.Data;@Datapublic class User {private Long id;private String name;private Integer age;private String email;}

@Data：注解在类上，提供类所有属性的 Getting 和 Setting方法，此外还提供了equals、canEqual、hashCode、toString等方法。

创建mapper接口并扫描

编写 Mapper 包下的 UserMapper接口

package com.xxxx.mybatisplus.mapper;import com.baomidou.mybatisplus.core.mapper.BaseMapper;import com.xxxx.mybatisplus.pojo.User;public interface UserMapper extends BaseMapper<User>{}

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

package com.xxxx.mybatisplus;import org.mybatis.spring.annotation.MapperScan;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication//扫描接口所在的包@MapperScan("com.xxxx.mybatisplus.mapper")public class MybatisplusApplication {public static void main(String[] args) {SpringApplication.run(MybatisplusApplication.class, args);}}

简单的查询测试

package com.xxxx.mybatisplus;import com.xxxx.mybatisplus.mapper.UserMapper;import com.xxxx.mybatisplus.pojo.User;import net.minidev.json.JSONUtil;import org.junit.jupiter.api.Test;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;import java.util.List;@SpringBootTestpublic class MyBatisPlusTest {//@Autowired，会报红，要在mapper接口上加@Repository@ResourceUserMapper userMapper;@Testpublic void testSelectList() {//通过条件构造器查询一个list集合，若没有条件，则可以设置参数为nullList<User> list = userMapper.selectList(null);list.forEach(System.out::println);}}

控制台查询结果：

 

增删改查

BaseMapper

说明:

• 通用 CRUD 封装BaseMapper 接口，为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器
• 泛型 T 为任意实体对象
• 参数 Serializable 为任意类型主键 Mybatis-Plus 不推荐使用复合主键约定每一张表都有自己的唯一 id 主键
• 对象 Wrapper 为条件构造器

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，因此我们继承该接口以后可以直接使用。

BaseMapper中提供的CRUD方法

• 增加：Insert

// 插入一条记录int insert(T entity);

• 删除：Delete

// 根据 entity 条件，删除记录int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);// 删除（根据ID 批量删除）int deleteBatchIds(@Param(Constants.COLLECTION) Collection<" />extends Serializable> idList);// 根据 ID 删除int deleteById(Serializable id);// 根据 columnMap 条件，删除记录int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

• 修改：Update

// 根据 whereWrapper 条件，更新记录int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) Wrapper<T> whereWrapper);// 根据 ID 修改int updateById(@Param(Constants.ENTITY) T entity);

• 查询：Select

// 根据 ID 查询T selectById(Serializable id);// 根据 entity 条件，查询一条记录T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);// 查询（根据ID 批量查询）List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);// 根据 entity 条件，查询全部记录List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);// 查询（根据 columnMap 条件）List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);// 根据 Wrapper 条件，查询全部记录List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);// 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);// 根据 entity 条件，查询全部记录（并翻页）IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);// 根据 Wrapper 条件，查询全部记录（并翻页）IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);// 根据 Wrapper 条件，查询总记录数Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

添加示例

@Test//实现新增用户信息public void testInsert(){User user = new User();user.setName("张三");user.setAge(23);user.setEmail("zahngsan@xxxx.com");int result = userMapper.insert(user);System.out.println("result:"+result);System.out.println("id:"+user.getId());}

注：在MyBatisPlus中，默认使用雪花算法生成id。

删除示例

deleteById

@Testpublic void testDelete(){//通过id删除用户信息int result = userMapper.deleteById(1548596044798009345L);System.out.println("result:"+result);}

deleteByMap

@Testpublic void testDelete(){Map<String,Object> map = new HashMap<>();map.put("name","张三");map.put("age",23);//根据map集合中设置的条件删除用户信息int result = userMapper.deleteByMap(map);System.out.println("result:"+result);}

 
deleteBatchIds

@Testpublic void testDelete(){List<Long> list = Arrays.asList(1L,2L,3L);//通过多个id批量删除int result = userMapper.deleteBatchIds(list);System.out.println("result:"+result);}

修改示例

updateById

@Testpublic void testUpdate(){User user = new User();user.setId(4L);user.setName("张三");user.setEmail("zahngsan@xxxx.com");int result = userMapper.updateById(user);System.out.println("result:"+result);}

查询示例

selectById

@Testpublic void testSelect(){//通过id查询用户信息//SELECT id,name,age,email FROM user WHERE id=" />User user = userMapper.selectById(1L);System.out.println(user);}

selectBatchIds

@Testpublic void testSelect(){List<Long> list = Arrays.asList(1L,2L,3L);//通过多个id查询多个用户信息//SELECT id,name,age,email FROM user WHERE id IN ( " />List<User> users = userMapper.selectBatchIds(list);}

selectByMap

@Testpublic void testSelect(){Map<String,Object> map = new HashMap<>();map.put("name","jack");map.put("age",20);//根据map集合中的条件查询List<User> users = userMapper.selectByMap(map);users.forEach(System.out::println);}

BaseMapper.java源码

/* * Copyright (c) 2011-2022, baomidou (jobob@qq.com). * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */package com.baomidou.mybatisplus.core.mapper;import com.baomidou.mybatisplus.core.conditions.Wrapper;import com.baomidou.mybatisplus.core.metadata.IPage;import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;import com.baomidou.mybatisplus.core.toolkit.Constants;import com.baomidou.mybatisplus.core.toolkit.ExceptionUtils;import org.apache.ibatis.annotations.Param;import java.io.Serializable;import java.util.Collection;import java.util.List;import java.util.Map;/* :`.:, :::,,. ::`:::::: ::``,:,` .:` `:: `::::::::.:``:';,`::::, .:::` `@++++++++: ``:::`@+++++++++++# :::, #++++++++++++++` ,:`::::::;'##++++++++++ .@#@;` ::::::::::::::::::::;#@####@, :::::::::::::::+#;::.@@######+@:::::::::::::.#@:; ,@@########':::::::::::: .#''':` ;##@@@+:##########@::::::::::: @#;.,:.#@@@######++++#####'::::::::: .##+,:#`@@@@@#####+++++'#####+::::::::` ,`::@#:``@@@@#####++++++'#####+#':::::::::::@. @@@@######+++++''#######+##';::::;':,`@@@@#####+++++'''#######++++++++++` #@@#####++++++''########++++++++' `#@######+++++''+########+++++++;`@@#####+++++''##########++++++, @@######+++++'##########+++++#`@@@@#####+++++############++++;;#@@@@@####++++##############+++, @@@@@@@@@@@###@###############++' @#@@@@@@@@@@@@###################+:`@#@@@@@@@@@@@@@@###################'`:@#@@@@@@@@@@@@@@@@@##################,,@@@@@@@@@@@@@@@@@@@@################; ,#@@@@@@@@@@@@@@@@@@@##############+`.#@@@@@@@@@@@@@@@@@@#############@,@@@@@@@@@@@@@@@@@@@###########@, :#@@@@@@@@@@@@@@@@##########@,`##@@@@@@@@@@@@@@@########+,`+@@@@@@@@@@@@@@@#####@:``:@@@@@@@@@@@@@@##@;. `,'@@@@##@@@+;,```...`` _ _ /_ _ _/_. ____/_/ / //_//_//_|/ /_\/_///_/_\Talk is cheap. Show me the code. _/ / *//** * Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能 * 
这个 Mapper 支持 id 泛型
 * * @author hubin * @since 2016-01-23 */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(Constants.COLUMN_MAP) Map<String, Object> columnMap);/** * 根据 entity 条件，删除记录 * * @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句） */int delete(@Param(Constants.WRAPPER) Wrapper<T> 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<T> updateWrapper);/** * 根据 ID 查询 * * @param id 主键ID */T selectById(Serializable id);/** * 查询（根据ID 批量查询） * * @param idList 主键ID列表(不能为 null 以及 empty) */List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);/** * 查询（根据 columnMap 条件） * * @param columnMap 表字段 map 对象 */List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);/** * 根据 entity 条件，查询一条记录 * 
查询一条记录，例如 qw.last("limit 1") 限制取一条记录, 注意：多条数据会报异常
 * * @param queryWrapper 实体对象封装操作类（可以为 null） */default T selectOne(@Param(Constants.WRAPPER) 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");}return ts.get(0);}return null;}/** * 根据 Wrapper 条件，判断是否存在记录 * * @param queryWrapper 实体对象封装操作类 * @return */default boolean exists(Wrapper<T> queryWrapper) {Long count = this.selectCount(queryWrapper);return null != count && count > 0;}/** * 根据 Wrapper 条件，查询总记录数 * * @param queryWrapper 实体对象封装操作类（可以为 null） */Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);/** * 根据 entity 条件，查询全部记录 * * @param queryWrapper 实体对象封装操作类（可以为 null） */List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);/** * 根据 Wrapper 条件，查询全部记录 * * @param queryWrapper 实体对象封装操作类（可以为 null） */List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);/** * 根据 Wrapper 条件，查询全部记录 * 
注意： 只返回第一个字段的值
 * * @param queryWrapper 实体对象封装操作类（可以为 null） */List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);/** * 根据 entity 条件，查询全部记录（并翻页） * * @param page 分页查询条件（可以为 RowBounds.DEFAULT） * @param queryWrapper 实体对象封装操作类（可以为 null） */<P extends IPage<T>> P selectPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);/** * 根据 Wrapper 条件，查询全部记录（并翻页） * * @param page 分页查询条件 * @param queryWrapper 实体对象封装操作类 */<P extends IPage<Map<String, Object>>> P selectMapsPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);}