# MyBatis-Plus-SpringBoot
**Repository Path**: yzfhly/my-batis-plus-spring-boot
## Basic Information
- **Project Name**: MyBatis-Plus-SpringBoot
- **Description**: No description available
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-02
- **Last Updated**: 2022-06-15
## Categories & Tags
**Categories**: Uncategorized
**Tags**: mybatis-plus
## README
# 一、**Mybatis-Plus简介**
## **1、简介**
**MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。**
## **2、特性**
- **无侵入**：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
- **损耗小**：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
## **3、支持数据库**
>**任何能使用** **MyBatis** **进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下，如果不在下列表查看分页部分教程 PR 您的支持。**
- **MySQL**，**Oracle**，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb
- **达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库**
## **4、框架结构**
## 5、Maven依赖
**SpringBoot**
~~~xml
com.baomidou
mybatis-plus-boot-starter
3.5.1
~~~
**spring**
~~~xml
com.baomidou
mybatis-plus
3.5.1
~~~
>注意：
>
>引入MyBatis-Plus之后请不要再次引入MyBatis以及MyBatis-Spring，以避免因版本差异导致的问题。
## 6、配置
**SpringBoot**
- **配置MapperScan注解**
~~~java
@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
~~~
**Spring**
- **配置MapperScan**
~~~xml
~~~
- **配置SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory**
~~~xml
~~~
# 二、CRUD接口
## 1、Service CRUD 接口
>说明:
>
>通用 Service CRUD 封装IService (opens new window)接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆，
>
>泛型 T 为任意实体对象
>
>建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类
>
>对象 Wrapper 为 条件构造器
### Save
~~~java
// 插入一条记录（选择字段，策略插入）
boolean save(T entity);
// 插入（批量）
boolean saveBatch(Collection entityList);
// 插入（批量）
boolean saveBatch(Collection entityList, int batchSize);
~~~
#### 参数说明
| 类型 | 参数名 | 描述 |
| ---------- | ---------- | ------------ |
| T | entity | 实体对象 |
| Collection | entityList | 实体对象集合 |
| int | batchSize | 插入批次数量 |
### SaveOrUpdate
~~~java
// TableId 注解存在更新记录，否插入一条记录
boolean saveOrUpdate(T entity);
// 根据updateWrapper尝试更新，否继续执行saveOrUpdate(T)方法
boolean saveOrUpdate(T entity, Wrapper updateWrapper);
// 批量修改插入
boolean saveOrUpdateBatch(Collection entityList);
// 批量修改插入
boolean saveOrUpdateBatch(Collection entityList, int batchSize);
~~~
#### 参数说明
| 类型 | 参数名 | 描述 |
| ---------- | ------------- | -------------------------------- |
| T | entity | 实体对象 |
| Wrapper | updateWrapper | 实体对象封装操作类 UpdateWrapper |
| Collection | entityList | 实体对象集合 |
| int | batchSize | 插入批次数量 |
### Remove
~~~java
// 根据 entity 条件，删除记录
boolean remove(Wrapper queryWrapper);
// 根据 ID 删除
boolean removeById(Serializable id);
// 根据 columnMap 条件，删除记录
boolean removeByMap(Map columnMap);
// 删除（根据ID 批量删除）
boolean removeByIds(Collection idList)
~~~
#### 参数说明
| 类型 | 参数名 | 描述 |
| ------------ | ------------ | ----------------------- |
| Wrapper | queryWrapper | 实体包装类 QueryWrapper |
| Serializable | id | 主键 ID |
| Map | columnMap | 表字段 map 对象 |
| Collection | idList | 主键 ID 列表 |
### Update
```java
// 根据 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);
```
#### 参数说明
| 类型 | 参数名 | 描述 |
| ---------- | ------------- | -------------------------------- |
| Wrapper | updateWrapper | 实体对象封装操作类 UpdateWrapper |
| T | entity | 实体对象 |
| Collection | entityList | 实体对象集合 |
| int | batchSize | 更新批次数量 |
### Get
```java
// 根据 ID 查询
T getById(Serializable id);
// 根据 Wrapper，查询一条记录。结果集，如果是多个会抛出异常，随机取一条加上限制条件 wrapper.last("LIMIT 1")
T getOne(Wrapper queryWrapper);
// 根据 Wrapper，查询一条记录
T getOne(Wrapper queryWrapper, boolean throwEx);
// 根据 Wrapper，查询一条记录
Map getMap(Wrapper queryWrapper);
// 根据 Wrapper，查询一条记录
V getObj(Wrapper queryWrapper, Function mapper);
```
#### 参数说明
| 类型 | 参数名 | 描述 |
| ------------ | ------------ | ------------------------------- |
| Serializable | id | 主键 ID |
| Wrapper | queryWrapper | 实体对象封装操作类 QueryWrapper |
| boolean | throwEx | 有多个 result 是否抛出异常 |
| T | entity | 实体对象 |
| Function | mapper | 转换函数 |
### List
```java
// 查询所有
List list();
// 查询列表
List list(Wrapper queryWrapper);
// 查询（根据ID 批量查询）
Collection listByIds(Collection idList);
// 查询（根据 columnMap 条件）
Collection listByMap(Map columnMap);
// 查询所有列表
List> listMaps();
// 查询列表
List> listMaps(Wrapper queryWrapper);
// 查询全部记录
List