Mybatais-plus超详细教程

前言

在学习Mybatis-plus之前，这里默认大家都已经对mybatis使用有了一定的了解。都会使用mybatis

什么是Mybatis-plus

MyBatis-Plus（简称 MP）是一个 MyBatis 的一款增强工具，在 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

引入依赖

	<dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-boot-starter</artifactId>
       <version>3.5.1</version>
   </dependency>

配置日志

默认情况下的所有sql都是不打印的，我们如果调试的时候想要看到所写代码生成的sql，需要在yml文件中配置以下日志规则

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

Service CRUD 接口

注意：
1、通用 Service CRUD 封装IService 接口，进一步封装 CRUD 采用 get 查询单行、remove 删除、list 查询集合、page 分页 前缀命名方式区分Mapper层避免混淆，
2、泛型 T 为任意实体对象
3、如果存在自定义通用 Service 方法的可能，请创建自己的IBaseService继承 Mybatis-Plus 提供的基类对象 Wrapper 为 条件构造器

Save

// 插入一条记录（选择字段，策略插入），entity就是我们要保存的对象
boolean save(T entity);

// 插入（批量），entityList就是我们要保存的对象集合
boolean saveBatch(Collection entityList);

// 插入（批量），bathSize是插入批次数量
boolean saveBatch(Collection entityList, int batchSize);

SaveOrUpdate

// TableId 注解存在更新记录，否插入一条记录
boolean saveOrUpdate(T entity);

// 根据updateWrapper尝试更新，否继续执行saveOrUpdate(T)方法
boolean saveOrUpdate(T entity, Wrapper updateWrapper);

// 批量修改插入
boolean saveOrUpdateBatch(Collection entityList);

// 批量修改插入
boolean saveOrUpdateBatch(Collection entityList, int batchSize);

Remove

// 根据 queryWrapper 设置的条件，删除记录
boolean remove(Wrapper queryWrapper);

// 根据 ID 删除
boolean removeById(Serializable id);

// 根据 columnMap 条件，删除记录
boolean removeByMap(Map<String, Object> columnMap);

// 删除（根据ID 批量删除）
boolean removeByIds(Collection<? extends Serializable> idList);

Update

// 根据 UpdateWrapper 条件，更新记录 需要设置sqlset
boolean update(Wrapper updateWrapper);

// 根据 whereWrapper 条件，更新记录
boolean update(T updateEntity, Wrapper whereWrapper);

// 根据 ID 选择修改
boolean updateById(T entity);

// 根据ID 批量更新
boolean updateBatchById(Collection entityList);

// 根据ID 批量更新
boolean updateBatchById(Collection entityList, int batchSize);

Get

// 根据 ID 查询
T getById(Serializable id);

// 根据 Wrapper，查询一条记录。结果集，如果是多个会抛出异常，随机取一条加上限制条件 wrapper.last(“LIMIT 1”)
T getOne(Wrapper queryWrapper);

// 根据 Wrapper，查询一条记录
T getOne(Wrapper queryWrapper, boolean throwEx);

// 根据 Wrapper，查询一条记录
Map<String, Object> getMap(Wrapper queryWrapper);

// 根据 Wrapper，查询一条记录
V getObj(Wrapper queryWrapper, Function<? super Object, V> mapper);

List

// 查询所有
List list();

// 查询列表
List list(Wrapper queryWrapper);

// 查询（根据ID 批量查询）
Collection listByIds(Collection<? extends Serializable> idList);

// 查询（根据 columnMap 条件）
Collection listByMap(Map<String, Object> columnMap);

// 查询所有列表
List<Map<String, Object>> listMaps();

// 查询列表
List<Map<String, Object>> listMaps(Wrapper queryWrapper);

// 查询全部记录
List listObjs();

// 查询全部记录
List listObjs(Function<? super Object, V> mapper);

// 根据 Wrapper 条件，查询全部记录
List listObjs(Wrapper queryWrapper);

// 根据 Wrapper 条件，查询全部记录
List listObjs(Wrapper queryWrapper, Function<? super Object, V> mapper);

Page

// 无条件分页查询
IPage page(IPage page);

// 条件分页查询
IPage page(IPage page, Wrapper queryWrapper);

// 无条件分页查询
IPage<Map<String, Object>> pageMaps(IPage page);

// 条件分页查询
IPage<Map<String, Object>> pageMaps(IPage page, Wrapper queryWrapper);

Count

// 查询总记录数
int count();

// 根据 Wrapper 条件，查询总记录数
int count(Wrapper queryWrapper);

Chain

query

// 链式查询 普通
QueryChainWrapper query();

// 链式查询 lambda 式。注意：不支持 Kotlin
LambdaQueryChainWrapper lambdaQuery();

// 示例：
query().eq(“column”, value).one();
lambdaQuery().eq(Entity::getId, value).list();

update

// 链式更改 普通
UpdateChainWrapper update();

// 链式更改 lambda 式。注意：不支持 Kotlin
LambdaUpdateChainWrapper lambdaUpdate();

// 示例：
update().eq(“column”, value).remove();
lambdaUpdate().eq(Entity::getId, value).update(entity);

Mapper CRUD 接口

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

Insert

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

Delete

// 根据 entity 条件，删除记录
int delete(@Param(Constants.WRAPPER) Wrapper 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 whereWrapper);

// 根据 ID 修改（在调用updateById方法前，需要在T entity（对应的实体类）中的主键属性上加上@TableId注解。）
int updateById(@Param(Constants.ENTITY) T entity);

Select

// 根据 ID 查询
T selectById(Serializable id);

// 根据 entity 条件，查询一条记录
T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper);

// 查询（根据ID 批量查询）
List selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

// 根据 entity 条件，查询全部记录
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);

// 查询（根据 columnMap 条件）
List selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

// 根据 Wrapper 条件，查询全部记录
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);

// 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
List selectObjs(@Param(Constants.WRAPPER) Wrapper queryWrapper);

// 根据 entity 条件，查询全部记录（并翻页）
IPage selectPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);

// 根据 Wrapper 条件，查询全部记录（并翻页）
IPage<Map<String, Object>> selectMapsPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);

// 根据 Wrapper 条件，查询总记录数
Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper);

赠送

最后附上文档地址：https://mybatis.plus/guide/
源码地址：https://gitee.com/baomidou/mybatis-plus、
https://github.com/baomidou/mybatis-plus

欢迎大家点击下方卡片，关注《coder练习生》