【Mybatis-Plus 详解（速成版）】
目录
- 前言
- 一、Mybatis-Plus是什么？ 与Mybatis的区别是什么
- 二、使用Mybatis-Plus
-
- 1.引入依赖
- 2.BaseMapper接口
-
- 3.IService接口
- 4.开发中如何使用
- 三、Mybatis-Plus 语法
-
- Mybatis-Plus注解
- Mybatis-Plus 类与方法
前言
Mybatis 在Spring系列开发项目中占据重要的地位,但有一款框架提供的功能比他更强,那就是MyBatis Plus,但他与Mybatis 有何不同,又如何使用呢，本文目的意在拥有Mybatis框架的使用基础上,如何学习并过度到Mybatis-Plus
官方文档：https://baomidou.com/guides/advanced-features/
一、Mybatis-Plus是什么？ 与Mybatis的区别是什么
MyBatis-Plus 和 MyBatis 都是用于 Java 的持久层框架，它们都用于处理数据库操作，但是两者之间存在一些关键的区别
Mybatis-Plus是一个Mybatis（opens new window）的增强工具，在Mybatis的基础上只做增强不做改变，为简化开发，提高效率而生。也就是说，所有能在Mybatis上使用的方式，都可用于Mybatis-Plus上。
二、使用Mybatis-Plus
1.引入依赖
<!--mybatis-plus-->
com.baomidou
mybatis-plus-boot-starter
3.0.5
或者
>
>com.baomidou >
>mybatis-plus-boot-starter >
>最新版本号 >
>
2.BaseMapper接口
BaseMapper接口是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，继承该接口，能有效减少编写多个mapper的工作量
（该Mapper 支持 id 泛型）
增删改返回影响数据条数的Integer
public interface BaseMapper<T> {
/**
*
* 插入一条记录
*
*
* @param entity 实体对象
*/
int insert(T entity);
/**
*
* 根据 ID 删除
*
*
* @param id 主键ID
*/
int deleteById(Serializable id);
/**
*
* 根据 columnMap 条件，删除记录
*
*
* @param columnMap 表字段 map 对象
*/
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
/**
*
* 根据 entity 条件，删除记录
*
*
* @param queryWrapper 实体对象封装操作类（可以为 null）
*/
int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/**
*
* 删除（根据ID 批量删除）
*
*
* @param idList 主键ID列表(不能为 null 以及 empty)
*/
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> 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 条件，查询一条记录
*
*
* @param queryWrapper 实体对象
*/
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/**
*
* 根据 Wrapper 条件，查询总记录数
*
*
* @param queryWrapper 实体对象
*/
Integer 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）
*/
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
/**
*
* 根据 Wrapper 条件，查询全部记录（并翻页）
*
*
* @param page 分页查询条件
* @param queryWrapper 实体对象封装操作类
*/
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}
注意：selectMapsPage、selectPage等分页方法，必须要引入分页插件的依赖
<!--pagehelper-->
com.github.pagehelper
pagehelper-spring-boot-starter
1.4.1
3.IService接口
IService接口进一步封装CRUD的方法增删改返回是否操作成功的boolean
（泛型 T 为任意实体对象）
public interface IService<T> {
/**
*
* 插入一条记录（选择字段，策略插入）
*
*
* @param entity 实体对象
*/
boolean save(T entity);
/**
*
* 插入（批量），该方法不适合 Oracle
*
*
* @param entityList 实体对象集合
*/
default boolean saveBatch(Collection<T> entityList) {
return saveBatch(entityList, 30);
}
/**
*
* 插入（批量）
*
*
* @param entityList 实体对象集合
* @param batchSize 插入批次数量
*/
boolean saveBatch(Collection<T> entityList, int batchSize);
/**
*
* 批量修改插入
*
*
* @param entityList 实体对象集合
*/
boolean saveOrUpdateBatch(Collection<T> entityList);
/**
*
* 批量修改插入
*
*
* @param entityList 实体对象集合
* @param batchSize 每次的数量
*/
boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize);
/**
*
* 根据 ID 删除
*
*
* @param id 主键ID
*/
boolean removeById(Serializable id);
/**
*
* 根据 columnMap 条件，删除记录
*
*
* @param columnMap 表字段 map 对象
*/
boolean removeByMap(Map<String, Object> columnMap);
/**
*
* 根据 entity 条件，删除记录
*
*
* @param queryWrapper 实体包装类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
boolean remove(Wrapper<T> queryWrapper);
/**
*
* 删除（根据ID 批量删除）
*
*
* @param idList 主键ID列表
*/
boolean removeByIds(Collection<? extends Serializable> idList);
/**
*
* 根据 ID 选择修改
*
*
* @param entity 实体对象
*/
boolean updateById(T entity);
/**
*
* 根据 whereEntity 条件，更新记录
*
*
* @param entity 实体对象
* @param updateWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper}
*/
boolean update(T entity, Wrapper<T> updateWrapper);
/**
*
* 根据ID 批量更新
*
*
* @param entityList 实体对象集合
*/
default boolean updateBatchById(Collection<T> entityList) {
return updateBatchById(entityList, 30);
}
/**
*
* 根据ID 批量更新
*
*
* @param entityList 实体对象集合
* @param batchSize 更新批次数量
*/
boolean updateBatchById(Collection<T> entityList, int batchSize);
/**
*
* TableId 注解存在更新记录，否插入一条记录
*
*
* @param entity 实体对象
*/
boolean saveOrUpdate(T entity);
/**
*
* 根据 ID 查询
*
*
* @param id 主键ID
*/
T getById(Serializable id);
/**
*
* 查询（根据ID 批量查询）
*
*
* @param idList 主键ID列表
*/
Collection<T> listByIds(Collection<? extends Serializable> idList);
/**
*
* 查询（根据 columnMap 条件）
*
*
* @param columnMap 表字段 map 对象
*/
Collection<T> listByMap(Map<String, Object> columnMap);
/**
*
* 根据 Wrapper，查询一条记录
*
*
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
default T getOne(Wrapper<T> queryWrapper) {
return getOne(queryWrapper, false);
}
/**
*
* 根据 Wrapper，查询一条记录
*
*
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
* @param throwEx 有多个 result 是否抛出异常
*/
T getOne(Wrapper<T> queryWrapper, boolean throwEx);
/**
*
* 根据 Wrapper，查询一条记录
*
*
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
Map<String, Object> getMap(Wrapper<T> queryWrapper);
/**
*
* 根据 Wrapper，查询一条记录
*
*
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
Object getObj(Wrapper<T> queryWrapper);
/**
*
* 根据 Wrapper 条件，查询总记录数
*
*
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
int count(Wrapper<T> queryWrapper);
/**
*
* 查询列表
*
*
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
List<T> list(Wrapper<T> queryWrapper);
/**
*
* 翻页查询
*
*
* @param page 翻页对象
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);
/**
*
* 查询列表
*
*
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper);
/**
*
* 根据 Wrapper 条件，查询全部记录
*
*
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
List<Object> listObjs(Wrapper<T> queryWrapper);
/**
*
* 翻页查询
*
*
* @param page 翻页对象
* @param queryWrapper 实体对象封装操作类 {@link com.baomidou.mybatisplus.core.conditions.query.QueryWrapper}
*/
IPage<Map<String, Object>> pageMaps(IPage<T> page, Wrapper<T> queryWrapper);
}
4.开发中如何使用
// 首先得有实体类
@Data
public class User {
private Integer id;
private String email;
private String password;
private String username;
private String phone;
private String image;
}
//继承BaseMapper
@Repository
public interface UserMapper extends BaseMapper<User> {
// 省略mapper方法
}
//继承IService
public interface UserService extends IService<User> {
boolean login(String user,String password); // 示例方法
}
// ServiceImpl 实现login方法
@Service
@Transactional
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
@Autowired
private UserMapper userMapper;
@Override
public boolean login(String username, String password) {
// 基础用法
QueryWrapper<User>qw=new QueryWrapper<>();
qw.eq("username",username);
User user = userMapper.selectOne(qw);
if (user==null){
return false;
}
String userPwd = user.getPassword();
if (Objects.equals(userPwd,password)){
return true;
}else {
return false;
}
}
}
三、Mybatis-Plus 语法
Mybatis-Plus注解
- @TableName 对应表名
- @TableId 默认情况下 long uid为主键枚举值
IdType属性
IdType.AUTO 数据库ID自增；该类型请确保数据库设置了ID自增，否则无效
IdType.INPUT 用户输入ID；该类型可以通过自己注册自动填充插件进行填充
IdType.ASSIGN_ID（默认） 主键类型为number或string的雪花算法；只有当插入对象ID 为空，才自动填充
IdType.ASSIGN_UUID 主键类型为string，UUID.replace(“-”,“”)；只有当插入对象ID 为空，才自动填充
IdType.NONE 没有设置主键类型；跟随全局；全局的主键策略如果没有设置，默认是雪花算法
- @TableField
如果数据库和实体类的字段名不一致，可以使用@TableField注解指定数据库表中字段名
如果数据库表中不存在字段，在实体类中使用@TableField注解指定。
如果不想被查询出来该字段，可以使用@TableField注解来隐藏该字段的查询结果。
- @TableLogic
物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据
逻辑删除：假删除，将对应数据中代表是否被删除字段的状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录
详细可查看此处
Mybatis-Plus 类与方法
Wrapper：条件构造抽象类，最顶端父类
AbstractWrapper：用于查询条件封装，生成sql的where条件
QueryWrapper：查询条件封装
UpdateWrapper：update条件封装
AbstractLambdaWrapper：使用Lambda语法
LambdaQueryWrapper：用于Lambda语法使用的查询Wrapper
LambdaUpdateWrapper：用于Lambda语法更新Wrapper
转载自：https://blog.csdn.net/ZHI_YUE/article/details/140324226
如有侵权，请联系