李林超博客
首页
归档
留言
友链
动态
关于
归档
留言
友链
动态
关于
首页
Java
正文
03.MyBatis-Plus基本CRUD
Leefs
2022-12-10 PM
1438℃
0条
[TOC] ### 一、BaseMapper + 通用 CRUD 封装BaseMapper接口，为 `Mybatis-Plus` 启动时自动解析实体表关系映射转换为 `Mybatis` 内部对象注入容器 + 泛型 `T` 为任意实体对象 + 参数 `Serializable` 为任意类型主键 `Mybatis-Plus` 不推荐使用复合主键约定每一张表都有自己的唯一 `id` 主键 + 对象 `Wrapper` 为 条件构造器 ```java 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 条件，查询一条记录 * <p>查询一条记录，例如 qw.last("limit 1") 限制取一条记录, 注意：多条数据会报异常</p> * * @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 条件，查询全部记录 * <p>注意： 只返回第一个字段的值</p> * * @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); } ``` ### 二、插入 > 向User表中插入一条用户数据 > > SQL：INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? ) + User实体类中加入`@AllArgsConstructor`注解，生成包含类中所有字段的构造方法 ```java @Test public void testInsert() { User user = new User(null, "张三", 23, "zhangsan@163.com"); int result = userMapper.insert(user); System.out.println("受影响行数：" + result); //1601527304443998210 System.out.println("id自动获取：" + user.getId()); } ``` **运行结果** ``` ==> Preparing: INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? ) ==> Parameters: 1601527304443998210(Long), 张三(String), 23(Integer), zhangsan@163.com(String) <== Updates: 1 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@33a3c44a] 受影响行数：1 id自动获取：1601527304443998210 ``` > 最终执行的结果，所获取的id为1601527304443998210 > > 这是因为MyBatis-Plus在实现插入数据时，会默认基于雪花算法的策略生成id ### 三、删除 #### 3.1 通过id删除记录 > 删除id为1601527304443998210的用户数据 > > SQL：DELETE FROM user WHERE id=? ```java @Test public void testDeleteById() { //通过id删除用户信息 int result = userMapper.deleteById(1601527304443998210L); //ID为long类型，后面需要跟L进行标识 System.out.println("受影响行数：" + result); } ``` **运行结果** ``` ==> Preparing: DELETE FROM user WHERE id=? ==> Parameters: 1601527304443998210(Long) <== Updates: 1 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@33a3c44a] 受影响行数：1 ``` #### 3.2 通过id批量删除记录 > 批量删除id为1，2，3的用户数据 > > SQL：DELETE FROM user WHERE id IN ( ? , ? , ? ) ```java @Test public void testDeleteBatchIds() { //通过多个id批量删除 List<Long> idList = Arrays.asList(1L, 2L, 3L); int result = userMapper.deleteBatchIds(idList); System.out.println("受影响行数：" + result); } ``` **运行结果** ``` ==> Preparing: DELETE FROM user WHERE id IN ( ? , ? , ? ) ==> Parameters: 1(Long), 2(Long), 3(Long) <== Updates: 3 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@5fcfca62] 受影响行数：3 ``` #### 3.3 通过map条件删除记录 > 通过姓名和年龄来删除用户 > > SQL：DELETE FROM user WHERE name = ? AND age = ? ```java @Test public void testDeleteByMap(){ //根据map集合中所设置的条件删除记录 Map<String, Object> map = new HashMap<>(); map.put("name", "张三"); map.put("age", 23); int result = userMapper.deleteByMap(map); System.out.println("受影响行数："+result); } ``` **运行结果** ``` ==> Preparing: DELETE FROM user WHERE name = ? AND age = ? ==> Parameters: 张三(String), 23(Integer) <== Updates: 1 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@28501a4b] 受影响行数：1 ``` ### 四、修改 > 通过id修改用户的姓名和年龄 > > SQL：UPDATE user SET name=?, age=? WHERE id=? ```java @Test public void testUpdateById(){ User user = new User(4L, "admin", 22, null); int result = userMapper.updateById(user); System.out.println("受影响行数："+result); } ``` **运行结果** ``` ==> Preparing: UPDATE user SET name=?, age=? WHERE id=? ==> Parameters: admin(String), 22(Integer), 4(Long) <== Updates: 1 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@cf67838] 受影响行数：1 ``` ### 五、查询 #### 5.1 根据id查询用户信息 > 查询id为4的用户信息 > > SQL：SELECT id,name,age,email FROM user WHERE id=? ```java @Test public void testSelectById(){ //根据id查询用户信息 User user = userMapper.selectById(4L); System.out.println(user); } ``` **运行结果** ``` ==> Preparing: SELECT id,name,age,email FROM user WHERE id=? ==> Parameters: 4(Long) <== Columns: id, name, age, email <== Row: 4, admin, 22, test4@baomidou.com <== Total: 1 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@33a3c44a] User(id=4, name=admin, age=22, email=test4@baomidou.com) ``` #### 5.2 根据多个id查询多个用户信息 > 查询id为4、5的用户信息 > > SQL：SELECT id,name,age,email FROM user WHERE id IN ( ? , ? ) ```java @Test public void testSelectBatchIds(){ //根据多个id查询多个用户信息 List<Long> idList = Arrays.asList(4L, 5L); List<User> list = userMapper.selectBatchIds(idList); list.forEach(System.out::println); } ``` **运行结果** ``` ==> Preparing: SELECT id,name,age,email FROM user WHERE id IN ( ? , ? ) ==> Parameters: 4(Long), 5(Long) <== Columns: id, name, age, email <== Row: 4, admin, 22, test4@baomidou.com <== Row: 5, Billie, 24, test5@baomidou.com <== Total: 2 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@24934262] User(id=4, name=admin, age=22, email=test4@baomidou.com) User(id=5, name=Billie, age=24, email=test5@baomidou.com) ``` #### 5.3 通过map条件查询用户信息 > 查询用户名称为admin并且年龄为22的员工信息 > > SQL：SELECT id,name,age,email FROM user WHERE name = ? AND age = ? ```java @Test public void testSelectByMap(){ //通过map条件查询用户信息 Map<String, Object> map = new HashMap<>(); map.put("age", 22); map.put("name", "admin"); List<User> list = userMapper.selectByMap(map); list.forEach(System.out::println); } ``` **运行结果** ``` ==> Preparing: SELECT id,name,age,email FROM user WHERE name = ? AND age = ? ==> Parameters: admin(String), 22(Integer) <== Columns: id, name, age, email <== Row: 4, admin, 22, test4@baomidou.com <== Total: 1 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@24934262] User(id=4, name=admin, age=22, email=test4@baomidou.com) ``` #### 5.4 查询所有数据 > 查询所有用户信息 > > SQL：SELECT id,name,age,email FROM user ```java @Test public void testSelectList(){ //查询所有用户信息 List<User> list = userMapper.selectList(null); list.forEach(System.out::println); } ``` **运行结果** ``` ==> Preparing: SELECT id,name,age,email FROM user ==> Parameters: <== Columns: id, name, age, email <== Row: 4, admin, 22, test4@baomidou.com <== Row: 5, Billie, 24, test5@baomidou.com <== Total: 2 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@24934262] User(id=4, name=admin, age=22, email=test4@baomidou.com) User(id=5, name=Billie, age=24, email=test5@baomidou.com) ``` 通过观察BaseMapper中的方法，大多方法中都有Wrapper类型的形参，此为条件构造器，可针对于SQL语句设置不同的条件，若没有条件，则可以为该形参赋值null，即查询（删除/修改）所有数据。 ### 六、自定义功能 MyBatis-Plus 中默认读取的 `XxxMapper.xml` 的位置是在 `src/main/resources/mapper` 下的所有 xml 文件(可以包含任意层目录)，所以可以不用自己设定 `XxxMapper.xml` 的位置。 #### 6.1 查询用户信息 > 根据id查询用户信息 > > SQL：select id,name,age,email from user where id = ? + **UserMapper.java** ```java @Repository public interface UserMapper extends BaseMapper<User> { /** * 根据id用户信息为map集合 * @param id * @return */ Map<String,Object> selectMapById(long id); } ``` + **UserMapper.xml** ```xml <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.lilinchao.mybatisplusdemo.mapper.UserMapper"> <!--Map<String, Object> selectMapById(Long id);--> <select id="selectMapById" resultType="map"> select id,name,age,email from user where id = #{id} </select> </mapper> ``` + **测试** ```java @Test public void selectMapById(){ Map<String, Object> map = userMapper.selectMapById(4L); System.out.println(map); } ``` **运行结果** ``` ==> Preparing: select id,name,age,email from user where id = ? ==> Parameters: 4(Long) <== Columns: id, name, age, email <== Row: 4, admin, 22, test4@baomidou.com <== Total: 1 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4554de02] {name=admin, id=4, age=22, email=test4@baomidou.com} ``` ### 七、通用Service - 通用 Service CRUD 封装IService接口，进一步封装 CRUD 采用 `get 查询单行`、 `remove 删除` 、`list 查询集合`、 `page 分页` 前缀命名方式区分 `Mapper` 层避免混淆 - 泛型 `T` 为任意实体对象 - 建议如果存在自定义通用 Service 方法的可能，请创建自己的 `IBaseService` 继承 `Mybatis-Plus` 提供的基类 - 对象 `Wrapper` 为条件构造器 + 官网地址：https://baomidou.com/pages/49cc81/#service-crud-%E6%8E%A5%E5%8F%A3 *注：BaseMapper不支持批量操作，IBaseService支持批量操作* #### 7.1 IService MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑 详情查看源码IService和ServiceImpl ##### IService方法 **（1）save（增）** ```java // 插入一条记录（选择字段，策略插入） boolean save(T entity); // 插入（批量） boolean saveBatch(Collection<T> entityList); // 插入（批量） boolean saveBatch(Collection<T> entityList, int batchSize); ``` **（2）SaveOrUpdate（增或改）** ```java // TableId 注解存在更新记录，否插入一条记录 boolean saveOrUpdate(T entity); // 根据updateWrapper尝试更新，否继续执行saveOrUpdate(T)方法 boolean saveOrUpdate(T entity, Wrapper<T> updateWrapper); // 批量修改插入 boolean saveOrUpdateBatch(Collection<T> entityList); // 批量修改插入 boolean saveOrUpdateBatch(Collection<T> entityList, int batchSize); ``` **（3）Remove（删）** ```java // 根据 entity 条件，删除记录 boolean remove(Wrapper<T> queryWrapper); // 根据 ID 删除 boolean removeById(Serializable id); // 根据 columnMap 条件，删除记录 boolean removeByMap(Map<String, Object> columnMap); // 删除（根据ID 批量删除） boolean removeByIds(Collection<? extends Serializable> idList); ``` **（4）Update（改）** ```java // 根据 UpdateWrapper 条件，更新记录 需要设置sqlset boolean update(Wrapper<T> updateWrapper); // 根据 whereEntity 条件，更新记录 boolean update(T entity, Wrapper<T> updateWrapper); // 根据 ID 选择修改 boolean updateById(T entity); // 根据ID 批量更新 boolean updateBatchById(Collection<T> entityList); // 根据ID 批量更新 boolean updateBatchById(Collection<T> entityList, int batchSize); ``` **（5）Get（按条件查）** ```java // 根据 ID 查询 T getById(Serializable id); // 根据 Wrapper，查询一条记录。结果集，如果是多个会抛出异常，随机取一条加上限制条件 wrapper.last("LIMIT 1") T getOne(Wrapper<T> queryWrapper); // 根据 Wrapper，查询一条记录 T getOne(Wrapper<T> queryWrapper, boolean throwEx); // 根据 Wrapper，查询一条记录 Map<String, Object> getMap(Wrapper<T> queryWrapper); // 根据 Wrapper，查询一条记录 <V> V getObj(Wrapper<T> queryWrapper, Function<? super Object, V> mapper); ``` **（6）List（查）** ```java // 查询所有 List<T> list(); // 查询列表 List<T> list(Wrapper<T> queryWrapper); // 查询（根据ID 批量查询） Collection<T> listByIds(Collection<? extends Serializable> idList); // 查询（根据 columnMap 条件） Collection<T> listByMap(Map<String, Object> columnMap); // 查询所有列表 List<Map<String, Object>> listMaps(); // 查询列表 List<Map<String, Object>> listMaps(Wrapper<T> queryWrapper); // 查询全部记录 List<Object> listObjs(); // 查询全部记录 <V> List<V> listObjs(Function<? super Object, V> mapper); // 根据 Wrapper 条件，查询全部记录 List<Object> listObjs(Wrapper<T> queryWrapper); // 根据 Wrapper 条件，查询全部记录 <V> List<V> listObjs(Wrapper<T> queryWrapper, Function<? super Object, V> mapper); ``` **（7）Page（分页查）** ```java // 无条件分页查询 IPage<T> page(IPage<T> page); // 条件分页查询 IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper); // 无条件分页查询 IPage<Map<String, Object>> pageMaps(IPage<T> page); // 条件分页查询 IPage<Map<String, Object>> pageMaps(IPage<T> page, Wrapper<T> queryWrapper); ``` **（8）Count（查记录数）** ```java // 查询总记录数 int count(); // 根据 Wrapper 条件，查询总记录数 int count(Wrapper<T> queryWrapper); ``` **（9）Chain（链式）** + **query（链式查询）** ```java // 链式查询 普通 QueryChainWrapper<T> query(); // 链式查询 lambda 式。注意：不支持 Kotlin LambdaQueryChainWrapper<T> lambdaQuery(); // 示例： query().eq("column", value).one(); lambdaQuery().eq(Entity::getId, value).list(); ``` + **update（链式更改）** ```java // 链式更改 普通 UpdateChainWrapper<T> update(); // 链式更改 lambda 式。注意：不支持 Kotlin LambdaUpdateChainWrapper<T> lambdaUpdate(); // 示例： update().eq("column", value).remove(); lambdaUpdate().eq(Entity::getId, value).update(entity); ``` ##### 参数说明 **下面列举前面出现的参数说明：** | 参数名称 | 类型 | 描述 | | ------------- | ---------------------------------- | -------------------------------- | | id | Serializable | 主键ID | | entity | T | 实体对象 | | entityList | Collection | 实体对象集合 | | batchSize | int | 插入批次数量 | | page | IPage | 翻页对象 | | wrapper | Wrapper | 实体对象封装操作类 | | updateWrapper | Wrapper | 实体对象封装操作类 UpdateWrapper | | queryWrapper | Wrapper | 实体对象封装操作类 QueryWrapper | | mapper | Function<? super Object, V> | 转换函数 | | idList | Collection<? extends Serializable> | 主键ID列表 | | columnMap | Map<String, Object> | 表字段 map 对象 | | throwEx | boolean | 有多个 result 是否抛出异常 | #### 7.2 创建Service接口和实现类 + **创建UserService接口** > UserService接口继承IService模板提供的基础功能 ```java public interface UserService extends IService<User> { } ``` + **创建ServiceImpl类** > + ServiceImpl实现了IService，提供了IService中基础功能的实现 > + 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现 > + 因为UserService继承了IService，IService中所有的方法都要继承给UserService，所以需要重写方法，但不需要把所有的方法进行重写，因为IService有自己的实现类，所以只需要继承当前MP所提供的实现类即可 ```java //第一个参数:表示当前要操作的mapper接口的类型 //第二个参数:是要操作的实体类 @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService { } ``` > **注意** > > 如果要使用通用Service，建议自己创建Service，这个时候既可以用通用service的功能，也可以用自定义的功能。 #### 7.2 测试查询记录数 > 查询用户表中，用户总条数 > > SQL：SELECT COUNT( * ) FROM user; ```java @SpringBootTest public class MyBatisPlusServiceTest { @Autowired private UserService userService; @Test public void testGetCount(){ long count = userService.count(); System.out.println("总记录数:"+count); } } ``` **运行结果** ``` ==> Preparing: SELECT COUNT( * ) FROM user ==> Parameters: <== Columns: COUNT( * ) <== Row: 2 <== Total: 1 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@57402ba1] 总记录数:2 ``` #### 7.3 测试批量插入 > 向用户表中批量插入五条数据 > > SQL：INSERT INTO user ( id, name, age ) VALUES ( ?, ?, ? ) ```java @Test public void testSaveBatch(){ // SQL长度有限制，海量数据插入单条SQL无法实行， // 因此MP将批量插入放在了通用Service中实现，而不是通用Mapper ArrayList<User> users = new ArrayList<>(); for (int i = 0; i < 5; i++) { User user = new User(); user.setName("LLC" + i); user.setAge(20 + i); users.add(user); } userService.saveBatch(users); } ``` **运行结果** ``` ==> Preparing: INSERT INTO user ( id, name, age ) VALUES ( ?, ?, ? ) ==> Parameters: 1601549675645157378(Long), LLC0(String), 20(Integer) ==> Parameters: 1601549675724849154(Long), LLC1(String), 21(Integer) ==> Parameters: 1601549675724849155(Long), LLC2(String), 22(Integer) ==> Parameters: 1601549675724849156(Long), LLC3(String), 23(Integer) ==> Parameters: 1601549675724849157(Long), LLC4(String), 24(Integer) ``` ### 总结 **Mybatis-plus提供了2个接口1个类**： + BaseMapper 接口针对dao层的方法封装 CRUD + `IService<T>` 接口针对业务逻辑层的封装需要指定Dao层类和对应的实体类是在BaseMapper基础上的加强 + `ServiceImpl<M extends BaseMapper<T>, T>` 类针对业务逻辑层的实现 **比较** - BaseMapper 针对dao层的方法封装 CRUD - IService 针对业务逻辑层的封装，需要指定Dao层类和对应的实体类，是在BaseMapper基础上的加强 - ServiceImpl 针对业务逻辑层的实现 *附参考文章链接* *《尚硅谷MyBatisPlus教程》*
标签:
MyBatis
,
MyBatis-Plus
非特殊说明，本博所有文章均为博主原创。
如若转载，请注明出处：
https://lilinchao.com/archives/2679.html
上一篇
02.MyBatis-Plus入门案例
下一篇
04.MyBatis-Plus常用注解
评论已关闭
栏目分类
随笔
2
Java
326
大数据
229
工具
31
其它
25
GO
47
NLP
4
标签云
Spring
Hbase
MyBatis
Eclipse
栈
Http
前端
ClickHouse
并发编程
JavaSE
Tomcat
Java阻塞队列
RSA加解密
MySQL
Filter
队列
Spark Core
VUE
gorm
Elastisearch
排序
Jquery
Quartz
稀疏数组
Python
人工智能
哈希表
高并发
Spark RDD
线程池
友情链接
申请
范明明
庄严博客
Mx
陶小桃Blog
虫洞
评论已关闭