文章目录
baseMapper
Mapper 继承该接口后,无需编写 mapper.xml 文件,即可获得CRUD功能
接口如下:
package com.baomidou.mybatisplus.core.mapper;
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);
}
插入
//插入数据
@Test
public void testInsert() {
User user = new User(null, "sss", 35, "wangwu@qcby.com");
//INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
int result = userMapper.insert(user);
System.out.println("受影响行数:" + result);
System.out.println("id自动获取:" + user.getId());
}
默认使用的是雪花算法的策略生成id
删除
通过id删除记录
@Test
public void testDeleteById() {
//通过id删除用户信息
//DELETE FROM user WHERE id=?
int result = userMapper.deleteById(5L);
System.out.println("受影响行数:" + result);
}
通过id批量删除记录
@Test
public void testDeleteBatchIds() {
//通过多个id批量删除
//DELETE FROM user WHERE id IN ( ? , ? , ? )
List<Long> idList = Arrays.asList(1L, 2L, 3L);
int result = userMapper.deleteBatchIds(idList);
System.out.println("受影响行数:" + result);
}
通过map条件删除记录
@Test
public void testDeleteByMap() {
//根据map集合中所设置的条件删除记录
//DELETE FROM user WHERE name = ? AND age = ?
Map<String, Object> map = new HashMap<>();
map.put("age", 23);
map.put("name", "张三");
int result = userMapper.deleteByMap(map);
System.out.println("受影响行数:" + result);
}
修改
//修改
@Test
public void testUpdateById() {
User user = new User(4L, "admin", 22, null,0);
//UPDATE user SET name=?, age=? WHERE id=?
int result = userMapper.updateById(user);
System.out.println("受影响行数:" + result);
}
查询
根据id查询用户信息
@Test
public void testSelectById() {
//根据id查询用户信息
//SELECT id,name,age,email FROM user WHERE id=?
User user = userMapper.selectById(5L);
System.out.println(user);
}
根据多个id查询多个用户信息
@Test
public void testSelectBatchIds() {
//根据多个id查询多个用户信息
//SELECT id,name,age,email FROM user WHERE id IN ( ? , ? )
List<Long> idList = Arrays.asList(4L, 5L);
List<User> list = userMapper.selectBatchIds(idList);
list.forEach(System.out::println);
}
通过map条件查询用户信息
@Test
public void testSelectByMap() {
//通过map条件查询用户信息
//SELECT id,name,age,email FROM user WHERE name = ? AND age = ?
Map<String, Object> map = new HashMap<>();
map.put("age", 32);
map.put("name", "CCCC");
List<User> list = userMapper.selectByMap(map);
list.forEach(System.out::println);
}
查询所有数据
@Test
public void testSelectList() {
//selectList()根据MP内置的条件构造器查询一个list集合,null表示没有条件,即查询所有
//查询所有用户信息
//SELECT id,name,age,email FROM use
userMapper.selectList(null).forEach(System.out::println);
}
通用Service
说明:
通用 Service CRUD 封装IService接口,进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆,
泛型 T 为任意实体对象
建议如果存在自定义通用 Service 方法的可能,请创建自己的 IBaseService 继承
Mybatis-Plus 提供的基类
官网地址: 持久层接口 | MyBatis-Plus
创建Service接口和实现类
/**
* UserService继承IService模板提供的基础功能
*/
public interface UserService extends IService<User>{
}
/**
* ServiceImpl实现了IService,提供了IService中基础功能的实现
* 若ServiceImpl无法满足业务需求,则可以使用自定的UserService定义方法,并在实现类中实现 */
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper,User> implements UserService{
}
save
// 插入一条记录(选择字段,策略插入)
boolean save(T entity);
// 插入(批量)
boolean saveBatch(Collection<T> entityList);
// 插入(批量)
boolean saveBatch(Collection<T> entityList, int batchSize);
示例sava 插入一条记录
@Test
public void testSave() {
User user = new User();
user.setAge(33);
user.setName("xixi");
userService.save(user);
}
示例saveBatch 插入(批量)
//测试批量插入
@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("szy" + i);
user.setAge(20 + i);
users.add(user);
}
//SQL:INSERT INTO user ( name, age ) VALUES ( ?, ? )
userService.saveBatch(users);
}
示例saveBatch 插入(批量)使用批次大小进行批量插入
//测试批量插入(批次数量)
//每两条一批插入
@Test
public void testSaveBatch01() {
ArrayList<User> users = new ArrayList<>();
for (int i = 0; i < 3; i++) {
User user = new User();
user.setName("szy" + i);
user.setAge(20 + i);
users.add(user);
}
userService.saveBatch(users, 2);
saveOrUpdate
// 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);
示例(saveOrUpdate)添加或更新
//单条数据的插入或更新(如果有这个主键则修改 如果没有这个主键则插入)
@Test
public void testSaveOrUpdate() {
User user = new User();
user.setUid(19L);
user.setName("hhhh");
user.setAge(20);
boolean result = userService.saveOrUpdate(user);
System.out.println("操作结果:" + result);
}
示例(saveOrUpdate)添加或更新 根据updateWrapper尝试更新
@Test
public void testSaveOrUpdate01() {
User user = new User();
user.setUid(19L);//要更新 id 为 1 的用户
user.setName("Updated Name");
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper.eq("age", 25); // 当 age 为 25 时更新
boolean result = userService.saveOrUpdate(user,updateWrapper);
System.out.println("操作结果:" + result);
}
示例(saveOrUpdateBatch)批量修改插入
//批量插入或更新
@Test
public void testSaveOrUpdateBatch() {
List<User> users = new ArrayList<>();
User user1 = new User();
user1.setName("zz");
user1.setUid(16L);
User user2 = new User();
user2.setName("ww");
user2.setUid(null);
users.add(user1);
users.add(user2);
boolean result = userService.saveOrUpdateBatch(users);
System.out.println("操作结果:" + result);
}
示例(saveOrUpdateBatch)批量修改插入 指定批次大小
@Test
public void testSaveOrUpdateBatch01() {
// 假设有一组 User 实体对象
List<User> users = Arrays.asList(
new User(4L, "David", 23, "David@qq.com"),
new User(5L, "Eve", 33, "eve@example.com"),
new User(6L, "Frank", 44, "frank@example.com")
);
// 指定批次大小为 2进行批量修改插入
boolean result = userService.saveOrUpdateBatch(users, 2); // 调用 saveOrUpdateBatch 方法,指定批次大小
if (result) {
System.out.println("Users updated or saved successfully.");
} else {
System.out.println("Failed to update or save users.");
}
}
remove
// 根据 queryWrapper 设置的条件,删除记录
boolean remove(Wrapper<T> queryWrapper);
// 根据 ID 删除
boolean removeById(Serializable id);
// 根据 columnMap 条件,删除记录
boolean removeByMap(Map<String, Object> columnMap);
// 删除(根据ID 批量删除)
boolean removeByIds(Collection<? extends Serializable> idList);
//根据 entity 条件,删除记录
@Test
public void testRemove() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("username", "Sandy");
boolean result = userService.remove(queryWrapper);
System.out.println("操作结果:" + result);
}
//通过id删除
@Test
public void testRemoveById() {
boolean result = userService.removeById(1);
System.out.println("操作结果:" + result);
}
//根据 columnMap 条件,删除记录
@Test
public void testRemoveByMap() {
Map<String, Object> columnMap = new HashMap<>();
columnMap.put("username", "jack");
boolean result = userService.removeByMap(columnMap);
System.out.println("操作结果:" + result);
}
//删除(根据ID 批量删除)
@Test
public void testRemoveByIds() {
List<Long> list = new ArrayList<>();
list.add(14L);
list.add(15L);
boolean result = userService.removeByIds(list);
System.out.println("操作结果:" + result);
}
update
// 根据 UpdateWrapper 条件,更新记录 需要设置sqlset
boolean update(Wrapper<T> updateWrapper);
// 根据 whereWrapper 条件,更新记录
boolean update(T updateEntity, Wrapper<T> whereWrapper);
// 根据 ID 选择修改
boolean updateById(T entity);
// 根据ID 批量更新
boolean updateBatchById(Collection<T> entityList);
// 根据ID 批量更新
boolean updateBatchById(Collection<T> entityList, int batchSize);
//根据 UpdateWrapper 条件,更新记录
@Test
public void testUpdate() {
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper
.eq("uid", 8L)
.set("username", "kkkk");
boolean result = userService.update(updateWrapper);
System.out.println("操作结果:" + result);
}
//根据 whereEntity 条件,更新记录
@Test
public void testUpdate01() {
User user = new User();
user.setEmail("kkkk@qq.com");
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper
.eq("uid", 8L);
boolean result = userService.update(user, updateWrapper);
System.out.println("操作结果:" + result);
}
//修改
@Test
public void testUpdateById() {
User user = new User();
user.setUid(18L);
user.setAge(52);
boolean result = userService.updateById(user);
System.out.println("操作结果:" + result);
}
//通过id多条数据修改
@Test
public void testUpdateBatchById() {
List<User> users = new ArrayList<>();
User user1 = new User();
user1.setName("lisi");
user1.setUid(19L);
User user2 = new User();
user2.setName("zhaosi");
user2.setUid(20L);
users.add(user1);
users.add(user2);
boolean result = userService.updateBatchById(users);
System.out.println("操作结果:" + result);
}
//根据ID 批量更新
@Test
public void testUpdateBatchById01() {
List<User> users = new ArrayList<>();
User user1 = new User();
user1.setName("lisi");
user1.setUid(19L);
User user2 = new User();
user2.setName("zhaosi");
user2.setUid(20L);
users.add(user1);
users.add(user2);
boolean result = userService.updateBatchById(users, 2);
System.out.println("操作结果:" + result);
}
get
// 根据 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);
//根据 ID 查询
@Test
public void testGetById() {
User user = userService.getById(16L);
System.out.println(user);
}
//根据 Wrapper,查询一条记录
@Test
public void testGetOne01() {
LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(User::getName, "lisi");
User user = userService.getOne(queryWrapper);
System.out.println("查询结果:" + user);
}
//查询一条数据 如果有多条 显示第一条数据
@Test
public void testGetOne() {
LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(User::getName, "lisi");
User user = userService.getOne(queryWrapper, true);
System.out.println("查询结果:" + user);
}
//查询并返回键值对形式
@Test
public void testGetMap() {
LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(User::getName, "lisi");
Map<String, Object> result = userService.getMap(queryWrapper);
System.out.println("查询结果为 Map:" + result);
}
//测试 getObj 方法
@Test
public void testGetObj() {
LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
queryWrapper.eq(User::getName, "lisi").select(User::getEmail);
//调用 getObj 方法
String email = userService.getObj(queryWrapper, obj -> (String) obj);
System.out.println("查询结果的 email:" + email);
}
list
// 查询所有
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);
//查询所有
@Test
public void testList01() {
List<User> list = userService.list();
list.forEach(System.out::println);
}
//查询列表
@Test
public void testList() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.eq("age", 24);
List<User> list = userService.list(queryWrapper);
list.forEach(System.out::println);
}
//根据 ID 查询
@Test
public void testListByIds() {
List<Long> list = new ArrayList<>();
list.add(18L);
list.add(19L);
list.add(20L);
userService.listByIds(list);
list.forEach(System.out::println);
}
//查询(根据 columnMap 条件)
@Test
public void testListByMap() {
Map<String, Object> columnMap = new HashMap<>();
columnMap.put("age", 24);
List<User> list = userService.listByMap(columnMap);
list.forEach(System.out::println);
}
//查询所有列表
@Test
public void testListMaps01() {
List<Map<String, Object>> list = userService.listMaps();
list.forEach(System.out::println);
}
//查询列表
@Test
public void testListMaps() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.eq("age", 24);
List<Map<String, Object>> list = userService.listMaps(queryWrapper);
list.forEach(System.out::println);
}
//查询全部记录
@Test
public void testListObjs() {
List<Object> list = userService.listObjs();
list.forEach(System.out::println);
}
//查询全部记录 转换函数
@Test
public void testListObjs01() {
// 定义转换逻辑:提取用户名
Function<Object, String> mapper = obj -> {
if (obj instanceof User) {
return ((User) obj).getName();
}
return null;
};
// 执行查询
List<String> usernames = userService.listObjs(mapper);
usernames.forEach(System.out::println);
}
//根据 Wrapper 条件,查询全部记录
@Test
public void testListObjs02() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.eq("age", 24);
List<Object> list = userService.listObjs(queryWrapper);
list.forEach(System.out::println);
}
//根据 Wrapper 条件,查询全部记录
@Test
public void testListObjs03() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.eq("age", 24);
// 定义转换逻辑:提取用户名
Function<Object, String> mapper = obj -> {
if (obj instanceof User) {
return ((User) obj).getName(); // 确保 User 类有 getName 方法
}
return null;
};
List<String> list = userService.listObjs(queryWrapper, mapper);
list.forEach(System.out::println);
}
page
// 无条件分页查询
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);
//无条件翻页查询
@Test
public void testPage01() {
Page<User> page = new Page<>(1, 3);
IPage<User> userIPage = userService.page(page);
System.out.println("总记录数:" + userIPage.getTotal());
System.out.println("总页数:" + userIPage.getPages());
List<User> userList = userIPage.getRecords();
userList.forEach(System.out::println);
}
//条件分页查询
@Test
public void testPage() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.like("username", "s");
Page<User> page = new Page<>(1, 3);
IPage<User> userIPage = userService.page(page, queryWrapper);
System.out.println("总记录数:" + userIPage.getTotal());
System.out.println("总页数:" + userIPage.getPages());
List<User> userList = userIPage.getRecords();
userList.forEach(System.out::println);
}
//无条件翻页查询
@Test
public void testPageMaps01() {
Page<Map<String, Object>> page = new Page<>(1, 3);
IPage<Map<String, Object>> userIPage = userService.pageMaps(page);
System.out.println("总记录数:" + userIPage.getTotal());
System.out.println("总页数:" + userIPage.getPages());
// 输出分页记录
System.out.println("分页记录:");
List<Map<String, Object>> records = userIPage.getRecords();
records.forEach(System.out::println);
}
//翻页查询
@Test
public void testPageMaps() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.gt("age", 20);
Page<Map<String, Object>> page = new Page<>(1, 3);
IPage<Map<String, Object>> userIPage = userService.pageMaps(page, queryWrapper);
System.out.println("总记录数:" + userIPage.getTotal());
System.out.println("总页数:" + userIPage.getPages());
// 输出分页记录
System.out.println("分页记录:");
List<Map<String, Object>> records = userIPage.getRecords();
records.forEach(System.out::println);
}
count
// 查询总记录数
int count();
// 根据 Wrapper 条件,查询总记录数
int count(Wrapper<T> queryWrapper);
//测试查询记录数
@Test
public void testGetCount() {
long count = userService.count();
System.out.println("总记录数:" + count);
}
//根据 Wrapper 条件,查询总记录数
@Test
public void testGetCount01() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.eq("age", 24);
long count = userService.count(queryWrapper);
System.out.println("总记录数:" + count);
}