当前位置： 首页 > news >正文

MyBatis-Plus（Ⅱ）基本CRUD

news 来源：原创 2025/5/1 19:26:32

目录

一、BaseMapper源码解读

二、简单实例

1. 插入操作

代码示例

说明

2. 删除操作

①通过ID删除记录

代码示例

②通过ID批量删除记录

代码示例

③通过Map条件删除记录

代码示例

3. 修改操作

代码示例

4. 查询操作

①根据ID查询用户信息

代码示例

②根据多个ID查询多个用户信息

代码示例

③通过Map条件查询用户信息

代码示例

④查询所有数据

代码示例

说明

5.通用Service

命名规则

泛型使用

自定义Service方法

IService

案例演示

创建Service接口和实现类

UserService

UserServiceImpl

Test测试

查询记录数

批量插入

在上一篇文章中讲解了对MyBatis-Plus插件的最基本的使用，也可以得知MyBatis-Plus的便利之处，今天这篇文章接着讲解MyBatis-Plus中基本CRUD使用。

MyBatis-Plus（Ⅰ）参见：
MyBatis-Plus详解（Ⅰ）-CSDN博客文章浏览阅读96次，点赞2次，收藏4次。在（简称MP）是一个MyBatis的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。Mybatis-Plus提供了通用的Mapper和Service，可以在不编写任何SQL语句的前提下，快速的实现单表的增删改查（CURD），批量，逻辑删除，分页等操作。只要把MyBatis-Plus的特性到优秀插件，以及多数据源的配置进行详细讲解。 https://blog.csdn.net/m0_74977981/article/details/146451419?spm=1001.2014.3001.5501

一、BaseMapper源码解读

源码一览 
package com.baomidou.mybatisplus.core.mapper;

import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Constants;
import com.baomidou.mybatisplus.core.toolkit.ExceptionUtils;
import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
import org.apache.ibatis.annotations.Param;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;

public interface BaseMapper<T> extends Mapper<T> {

    /**
     * 插入一条记录
     *
     * @param entity 实体对象
     * @return 影响的行数
     */
    int insert(T entity);

    /**
     * 根据 ID 删除
     *
     * @param id 主键ID
     * @return 影响的行数
     */
    int deleteById(Serializable id);

    /**
     * 根据实体(ID)删除
     *
     * @param entity 实体对象
     * @return 影响的行数
     * @since 3.4.4
     */
    int deleteById(T entity);

    /**
     * 根据 columnMap 条件，删除记录
     *
     * @param columnMap 表字段 map 对象
     * @return 影响的行数
     */
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    /**
     * 根据 entity 条件，删除记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
     * @return 影响的行数
     */
    int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 删除（根据ID 批量删除）
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     * @return 影响的行数
     */
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

    /**
     * 根据 ID 修改
     *
     * @param entity 实体对象
     * @return 影响的行数
     */
    int updateById(@Param(Constants.ENTITY) T entity);

    /**
     * 根据 whereEntity 条件，更新记录
     *
     * @param entity        实体对象 (set 条件值 ,可以为 null)
     * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
     * @return 影响的行数
     */
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);

    /**
     * 根据 ID 查询
     *
     * @param id 主键ID
     * @return 查询结果
     */
    T selectById(Serializable id);

    /**
     * 查询（根据ID 批量查询）
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     * @return 查询结果
     */
    List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);

    /**
     * 查询（根据 columnMap 条件）
     *
     * @param columnMap 表字段 map 对象
     * @return 查询结果
     */
    List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);

    /**
     * 根据 entity 条件，查询一条记录
     * <p>查询一条记录，例如 qw.last("limit 1") 限制取一条记录 , 注意：多条数据会报异常</p>
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     * @return 查询结果
     */
    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 实体对象封装操作类（可以为 null）
     * @return 总记录数
     */
    Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 entity 条件，查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     * @return 查询结果
     */
    List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     * @return 查询结果
     */
    List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     * <p>注意： 只返回第一个字段的值</p>
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     * @return 查询结果
     */
    List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 entity 条件，查询全部记录（并翻页）
     *
     * @param page         分页查询条件（可以为 RowBounds.DEFAULT）
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     * @return 分页查询结果
     */
    <P extends IPage<T>> P selectPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录（并翻页）
     *
     * @param page         分页查询条件
     * @param queryWrapper 实体对象封装操作类
     * @return 分页查询结果
     */
    <P extends IPage<Map<String, Object>>> P selectMapsPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
}

二、简单实例

数据库信息仍旧用MyBatis-Plus详解（Ⅰ）中的内容，然后接下来逐一演示对BaseMapper中方法的使用。

1. 插入操作

代码示例
@Test
public void testInsert(){
    User user = new User(null, "张三", 23, "zhangsan@qcby.com");
    // 执行插入操作，SQL类似于：INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
    int result = userMapper.insert(user);
    System.out.println("受影响行数：" + result);
    // 输出自动生成的ID
    System.out.println("id自动获取：" + user.getId());
}
说明

插入一条用户记录，ID为自动生成（使用MyBatis-Plus默认的雪花算法策略）。

打印受影响的行数和自动生成的ID。

2. 删除操作

①通过ID删除记录

代码示例
@Test
public void testDeleteById(){
    Long id = 1L;
    // 执行删除操作，SQL类似于：DELETE FROM user WHERE id = ?
    int result = userMapper.deleteById(id);
    System.out.println("受影响行数：" + result);
}

②通过ID批量删除记录

代码示例
@Test
public void testDeleteBatchIds(){
    // 通过多个id批量删除，SQL类似于：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集合中所设置的条件删除记录，SQL类似于：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);
}

3. 修改操作

代码示例
@Test
public void testUpdateById(){
    User user = new User(4L, "admin", 22, null);
    // 执行更新操作，SQL类似于：UPDATE user SET name=?, age=? WHERE id=?
    int result = userMapper.updateById(user);
    System.out.println("受影响行数：" + result);
}

4. 查询操作

①根据ID查询用户信息

代码示例
@Test
public void testSelectById(){
    Long id = 1L;
    // 根据ID查询用户信息，SQL类似于：SELECT * FROM user WHERE id = ?
    User user = userMapper.selectById(id);
    System.out.println(user);
}

②根据多个ID查询多个用户信息

代码示例
@Test
public void testSelectBatchIds(){
    // 根据多个ID查询多个用户信息，SQL类似于：SELECT * FROM user WHERE id IN ( ? , ? , ? )
    List<Long> idList = Arrays.asList(1L, 2L, 3L);
    List<User> users = userMapper.selectBatchIds(idList);
    users.forEach(System.out::println);
}

③通过Map条件查询用户信息

代码示例
@Test
public void testSelectByMap(){
    // 通过map条件查询用户信息，SQL类似于：SELECT id,name,age,email FROM user WHERE name = ? AND age = ?
    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);
}

④查询所有数据

代码示例
@Test
public void testSelectAll(){
    // 查询所有数据
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}
说明

通过观察BaseMapper中的方法，大多数方法中都有Wrapper类型的形参，此为条件构造器，可以针对SQL语句设置不同的条件。

若没有条件，则可以为该形参赋值null，即查询（删除/修改）所有数据。

5.通用Service

MyBatis-Plus框架提供了一种通用的Service层CRUD操作封装方式。这种封装方式采用了特定的前缀命名规则来区分不同的操作，以避免与Mapper层的命名混淆。以下是对这些命名规则和使用方式的详细说明：

命名规则

  • get：用于查询单行记录。

  • remove：用于删除记录。

  • list：用于查询集合记录。

  • page：用于分页查询。

泛型使用

  • 泛型T：表示任意实体对象。这使得Service层的方法更加通用，可以适用于不同的实体类。

自定义Service方法

如果需要添加自定义的通用Service方法，建议创建自己的IBaseService接口，并让它继承MyBatis-Plus提供的基类，这样做可以保持代码的扩展性和灵活性。

IService

MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑，所以现在我们想创建service层的数据，只用将接口的实现类分别继承这两个封装类即可。

案例演示
创建Service接口和实现类
UserService
package com.example.mybatisplus.service;

//UserService继承IService模板提供的基础功能
import com.baomidou.mybatisplus.extension.service.IService;
import com.example.mybatisplus.entity.User;

public interface UserService extends IService<User> {
}
UserServiceImpl
package com.example.mybatisplus.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.mybatisplus.entity.User;
import com.example.mybatisplus.mapper.UserMapper;
import com.example.mybatisplus.service.UserService;
import org.springframework.stereotype.Service;
/**
 * ServiceImpl实现了IService，提供了IService中基础功能的实现
 * 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现 */
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}
Test测试
查询记录数
@Autowired
private UserService userService;

@Test
public void testGetCount(){
    long count = userService.count();
    System.out.println("总记录数：" + count);
}
批量插入
@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 t_user ( username, age ) VALUES ( ?, ? )
    userService.saveBatch(users);
}

相关文章：

  • 用户模块——升级swagger文档更漂亮
  • Git的认识安装及创建配置本地仓库
  • Shebang行的写入
  • qt 对QObject::tr()函数进行重定向
  • 【工程实践/源码阅读】批量文件处理步骤以及如何并行处理
  • Ubuntu下用QEMU模拟运行OpenBMC
  • 解决address already in use报错：如何查看占用某个端口的程序并杀死
  • 【uni-app】引用公共组件
  • 数据预处理流程与关键步骤解析
  • React 开发环境搭建
  • 多个内容滑动轮播图【前端】
  • 第十六次CCF-CSP认证（含C++源码）
  • c++图论(五)之判断图连通
  • 浪潮信息再塑AI+OS格局，联手龙蜥共筑未来
  • 元数据管理系列（一）：元数据管理的前世今生
  • 实战3. 利用Pytorch预写好ResNet-18预测电视剧《辛普森一家》中的人物——图像分类
  • Ceph集群2025（Squid版）导出高可用NFS集群(上集)
  • 第一人称动作识别文献阅读——LSTA：用于自我中心动作识别的长短期注意力机制
  • 第二章 | 智能合约 区块链基础知识{介绍篇}
  • 三、重学C++—C语言内存管理
  • 五一假期，这些短剧值得一刷
  • 美商界报告：全美超86万岗位依赖对华出口，关税将重创美国出口商
  • 金融监管总局修订发布《行政处罚办法》，7月1日起施行
  • 国新办发布《关于新冠疫情防控与病毒溯源的中方行动和立场》白皮书
  • 国有六大行一季度合计净赚超3444亿，不良贷款余额均上升
  • 杨国荣︱学术上的立此存照——《故旧往事，欲说还休》读后