MyBatis-Plus 核心功能

news2025/4/14 19:48:57

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档

文章目录

  • 一、条件构造器
    • 1、核心 Wrapper 类型
    • 基础查询示例
      • SQL 查询
      • 使用 QueryWrapper 实现查询
    • 更新操作示例
      • 场景一:基础更新
        • SQL 查询
        • 使用 QueryWrapper 实现更新
      • 场景二:复杂更新
        • SQL 查询
        • 使用 UpdateWrapper 实现更新
    • 2、Lambda 表达式优化
      • 改造查询示例
  • 二、自定义 SQL 整合
    • 场景说明
      • Mapper 接口定义
      • XML 映射文件
      • 业务层调用
  • 三、Service 接口
    • 1. 基础接口定义继承 IService
    • 2. 服务实现类规范
    • 3. 结构优势说明
    • 4. 方法调用示例
    • MP的Service接口使用流程是怎样的?
      • 1. 自定义 Service 接口继承 IService 接口
      • 2. 实现自定义 Service 接口并继承Servicelmpl类
      • 3. Mapper 接口的定义
      • 4. 配置 Mapper 扫描
      • 5. 在 Controller 组件中使用 Service
      • 总结:完整流程
  • 四、QueryWrapper 查询方法与 UpdateWrapper 更新方法对照手册
    • QueryWrapper
      • 核心方法
      • 其他常用方法
      • 示例
    • UpdateWrapper
      • 核心方法
      • 示例


一、条件构造器

MyBatis-Plus 提供强大的 Wrapper 类体系,支持通过链式调用构建复杂查询条件,覆盖日常开发中各类 SQL 场景需求。

1、核心 Wrapper 类型

类型适用场景特点
QueryWrapper构建 SELECT/UPDATE/DELETE 条件字段名硬编码
LambdaQueryWrapper构建 SELECT/UPDATELambda 表达式,避免硬编码
UpdateWrapper特殊 SET 语句构建支持复杂 SET 逻辑
LambdaUpdateWrapper特殊 SET 语句构建Lambda 表达式优化

Wrapper构造复杂SQL
在这里插入图片描述

基础查询示例

在这里插入图片描述
查询用户名包含 “o” 且余额 ≥1000 的用户,返回指定字段。

SQL 查询

SELECT id, username, info, balance 
FROM user 
WHERE username LIKE '%o%' AND balance >= 1000;

使用 QueryWrapper 实现查询

@Test
void testQueryWrapper() {
    // 1. 构建条件构造器(字段硬编码方式)
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.select("id", "username", "info", "balance") // 指定返回字段
          .like("username", "o")                      // 模糊查询:username LIKE '%o%'
          .ge("balance", 1000);                       // 范围查询:balance >= 1000

    // 2. 执行查询
    List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}

更新操作示例

场景一:基础更新

将用户名为 “jack” 的用户余额设为 2000。

SQL 查询
UPDATE user 
SET balance = 2000 
WHERE username = 'jack';
使用 QueryWrapper 实现更新
@Test
void testUpdateByQueryWrapper() {
    // 1. 准备更新实体(SET 字段)
    User updateEntity = new User();
    updateEntity.setBalance(2000);

    // 2. 构建条件构造器
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("username", "jack"); // 精确匹配条件

    // 3. 执行更新
    userMapper.update(updateEntity, wrapper);
}

场景二:复杂更新

对 ID 为 1、2、4 的用户执行余额扣减 200 操作。

SQL 查询
UPDATE user 
SET balance = balance - 200 
WHERE id IN (1, 2, 4);
使用 UpdateWrapper 实现更新
@Test
void testUpdateWrapper() {
    // 1. 定义操作参数
    List<Long> targetIds = Arrays.asList(1L, 2L, 4L);
    int deductionAmount = 200;

    // 2. 构建 UpdateWrapper(支持复杂 SET 语句)
    UpdateWrapper<User> wrapper = new UpdateWrapper<>();
    wrapper.setSql("balance = balance - 200" ) 
          .in("id", id);  

    // 3. 执行更新(传入 null 表示不通过实体类设置字段)
    userMapper.update(null, wrapper);
}

条件构造器的用法:

  1. QueryWrapperLambdaQueryWrapper通常用来构建selectdeleteupdatewhere条件部分
  2. UpdateWrapperLambdaUpdateWrapper通常只有在set语句比较特殊才使用
  3. 尽量使用LambdaQueryWrapperLambdaUpdateWrapper,避免硬编码

2、Lambda 表达式优化

通过 Lambda 表达式消除字段硬编码,提升代码可维护性。

改造查询示例

@Test
void testLambdaQueryWrapper() {
    // 1. 构建 Lambda 条件构造器
    LambdaQueryWrapper<User> lambdaWrapper = new LambdaQueryWrapper<>();
    lambdaWrapper.select(User::getId, User::getUsername, 
                        User::getInfo, User::getBalance)  // 指定查询的字段
                .like(User::getUsername, "o")   // username LIKE '%o%'
                .ge(User::getBalance, 1000);    // balance >= 1000

    // 2. 执行查询
    List<User> users = userMapper.selectList(lambdaWrapper);
    users.forEach(System.out::println);
}

二、自定义 SQL 整合

结合条件构造器与自定义 SQL 片段处理复杂业务场景。

可以利用MyBatisPlusWrapper来构建复杂的Where条件,然后自己定义SQL语句中剩下的部分

场景说明

对指定 ID 的用户进行余额扣减操作,同时通过 Wrapper 动态构建条件。
在这里插入图片描述

Mapper 接口定义

public interface UserMapper extends BaseMapper<User> {
    // 使用 @Param(Constants.WRAPPER) 注解绑定 Wrapper
    void updateBalanceByIds(@Param(Constants.WRAPPER) QueryWrapper<User> wrapper, 
                           @Param("amount") int amount);
}

XML 映射文件

<update id="updateBalanceByIds">
    UPDATE user
    SET balance = balance - #{amount}
    WHERE id IN
    <foreach collection="ids" separator="," item="id" open="(" close=")">
        #{id}
    </foreach>
</update>

在这里插入图片描述

业务层调用

@Test
void testCustomSqlUpdate() {
    // 1. 定义要更新的 ID 列表
    List<Long> ids = List.of(1L, 2L, 4L);
    // 2. 定义减少的金额
    int amount = 200;
    // 3. 构建条件
    LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<User>()
        .in(User::getId, ids); // 条件:id IN (1, 2, 4)
    // 4. 自定义 SQL 方法调用
    userMapper.updateBalanceByIds(wrapper, amount);
}

三、Service 接口

1. 基础接口定义继承 IService

通过继承 IService<T> 接口获得 MyBatis-Plus 内置的通用 CRUD 方法

public interface IUserService extends IService<User> {

    /**
     * 根据用户名查询用户详细信息(自定义扩展方法)
     * @param username 用户名
     * @return 用户完整信息(包含关联实体)
     */
    UserVO getUserDetailByUsername(String username);

    /**
     * 批量更新用户状态(自定义业务方法)
     * @param ids 用户ID集合
     * @param status 新状态值
     * @return 是否更新成功
     */
    boolean updateUserStatus(List<Long> ids, Integer status);
}

2. 服务实现类规范

继承 ServiceImpl<M, T> 并实现自定义接口,通过组合方式实现功能

@Service
public class UserServiceImpl 
       extends ServiceImpl<UserMapper, User>  // 继承MP提供的基类
       implements IUserService {              // 实现自定义接口

    @Autowired
    private AccountService accountService;    // 可注入其他服务

    // ================= 实现自定义方法 =================
    @Override
    @Transactional(rollbackFor = Exception.class)
    public UserVO getUserDetailByUsername(String username) {
        // 1. 查询基础信息
        LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
        wrapper.eq(User::getUsername, username);
        User user = this.getOne(wrapper);

        // 2. 获取关联账户信息
        Account account = accountService.getByUserId(user.getId());

        // 3. 组装VO
        return UserVO.builder()
                .user(user)
                .account(account)
                .build();
    }

    @Override
    @Transactional(rollbackFor = Exception.class)
    public boolean updateUserStatus(List<Long> ids, Integer status) {
        // 批量更新操作
        return this.update(new LambdaUpdateWrapper<User>()
                .set(User::getStatus, status)
                .in(User::getId, ids));
    }

    // ================= 可覆盖基类方法 =================
    @Override
    public boolean save(User entity) {
        // 自定义保存逻辑(如密码加密)
        entity.setPassword(encrypt(entity.getPassword()));
        return super.save(entity);
    }
}

3. 结构优势说明

组件功能说明
IService<T>提供 20+ 通用 CRUD 方法(saveBatch、page、lambdaQuery 等)
ServiceImpl<M,T>实现 IService 的默认方法,提供 baseMapper 快速访问 DAO 层
自定义接口扩展业务相关方法,保持接口语义清晰
事务控制通过 @Transactional 注解保证业务操作原子性

4. 方法调用示例

// 自动注入服务
@Autowired
private IUserService userService;

// 使用通用方法
User user = userService.getById(1L);
Page<User> page = userService.page(new Page<>(1, 10), queryWrapper);

// 调用自定义方法
UserVO userVO = userService.getUserDetailByUsername("mike");
boolean result = userService.updateUserStatus(Arrays.asList(1L,2L), 2);

MP的Service接口使用流程是怎样的?

1. 自定义 Service 接口继承 IService 接口

首先,你需要创建一个自定义的 Service 接口,并继承 MP 提供的通用 IService 接口。

public interface IUserService extends IService<User> {
    // 可以在这里定义额外的业务方法
}
  • IService<T> 是 MyBatis-Plus 提供的通用服务接口,包含了许多常用的 CRUD 方法。
  • 如果有额外的业务需求,可以在 IUserService 中定义自己的方法。

2. 实现自定义 Service 接口并继承Servicelmpl类

创建一个实现类来实现自定义的 Service 接口,并继承 MP 提供的 ServiceImpl 类。

@Service // 使用 Spring 的注解将该类注册为 Bean
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
    // 实现自定义的业务方法
}
  • ServiceImpl<M, T> 是 MyBatis-Plus 提供的通用服务实现类:
    • M 是 Mapper 接口的类型(例如 UserMapper)。
    • T 是实体类的类型(例如 User)。
  • @Service 注解是 Spring 的注解,用于将该实现类注册为 Spring 容器中的 Bean,方便后续注入和使用。

3. Mapper 接口的定义

确保你已经定义了对应的 Mapper 接口,并继承 MP 提供的 BaseMapper

public interface UserMapper extends BaseMapper<User> {
    // 可以在这里定义额外的查询方法
}
  • BaseMapper<T> 是 MyBatis-Plus 提供的通用 Mapper 接口,包含了基本的 CRUD 方法。
  • 如果有额外的查询需求,可以在 UserMapper 中定义自己的方法。

4. 配置 Mapper 扫描

确保在 Spring Boot 的启动类或配置类上添加了 @MapperScan 注解,用于扫描 Mapper 接口。

@SpringBootApplication
@MapperScan("com.example.mapper") // 替换为你的 Mapper 接口所在的包路径
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

5. 在 Controller 组件中使用 Service

最后在需要使用的地方(如 Controller)通过依赖注入的方式使用自定义的 Service。

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private IUserService userService;

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Long id) {
        return userService.getById(id); // 调用 MP 提供的通用方法
    }

    @PostMapping
    public boolean addUser(@RequestBody User user) {
        return userService.save(user); // 调用 MP 提供的通用方法
    }
}

总结:完整流程

  1. 定义自定义 Service 接口,继承 IService
  2. 创建自定义 Service 实现类,继承 ServiceImpl 并实现自定义接口。
  3. 定义对应的 Mapper 接口,继承 BaseMapper
  4. 配置 @MapperScan 注解,确保 Mapper 被正确扫描。
  5. 在需要的地方(如 Controller)注入并使用自定义 Service

通过这种方式可以充分利用 MyBatis-Plus 提供的通用方法,同时也可以根据业务需求扩展自己的功能。


基于Restful风格实现下面的接口:
在这里插入图片描述

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

@Data // 自动生成 getter/setter、toString 等方法
@ApiModel(description = "用户V0实体") // Swagger 注解,描述实体类
public class UserV0 {

    @ApiModelProperty("用户id") // Swagger 注解,描述字段
    private Long id;

    @ApiModelProperty("用户名")
    private String username;

    @ApiModelProperty("详细信息")
    private String info; // 原来的 "string" 应为 "String"

    @ApiModelProperty("使用状态(1正常 2冻结)")
    private Integer status;

    @ApiModelProperty("账户余额")
    private Integer balance;
}

四、QueryWrapper 查询方法与 UpdateWrapper 更新方法对照手册

QueryWrapper

核心方法

方法描述SQL 示例
eq等于 =WHERE username = 'Tom'
ne不等于 <>WHERE age <> 18
gt大于 >WHERE price > 100
between范围查询WHERE date BETWEEN ? AND ?
like模糊匹配WHERE name LIKE '%T%'
orderByAsc升序排序ORDER BY price ASC
orderByDesc降序排序ORDER BY weight DESC

其他常用方法

方法描述示例
orOR 条件拼接.eq("A",1).or().eq("B",2)
inIN 查询.in("status", 1, 2, 3)
apply自定义 SQL 片段.apply("date_format(date,'%Y-%m') = '2023-01'")

示例

@Test  
public void testQueryWrapperExample() {  
    // 构建查询条件
    QueryWrapper<User> qw = new QueryWrapper<User>();  
    qw.eq("username", "Tom")  
      .like("email", "qq.com")  
      .gt("age", 30);  

    // 查询符合条件的用户列表
    List<User> userList = userMapper.selectList(qw);  
    for (User user : userList) {  
        logger.info("User: {}", user);  
    }  

    // 多条件更新(示例)
    User updateUser = new User();
    updateUser.setName("newName");
    updateUser.setEmail("newEmail");
    int updateResult = userMapper.update(updateUser, qw);  
    logger.info("Update affected rows: {}", updateResult);

    // 多条件删除(示例)
    int deleteResult = userMapper.delete(qw);  
    logger.info("Delete affected rows: {}", deleteResult);
}

代码功能说明

  • QueryWrapper<User>:用于构建查询条件。
  • eq("username", "Tom"):表示查询 username 等于 "Tom" 的记录。
  • like("email", "qq.com"):表示查询 email 字段中包含 "qq.com" 的记录。
  • gt("age", 30):表示查询 age 大于 30 的记录。
  • userMapper.selectList(qw):执行查询并返回符合条件的用户列表。
  • 多条件更新和删除:注释掉的代码展示了如何根据条件进行更新或删除操作。

UpdateWrapper

核心方法

方法描述SQL 示例
set设置更新字段SET name = 'Tom'
setSql直接写更新表达式SET price = price + 10
lambdaLambda 条件构造.eq(User::getId, 1)

示例

@Test
public void testUpdateWrapper() {
//创建一个UpdateWrapper对象,用于构建更新操作的查询条件。
UpdateWrapper uw = new UpdateWrapper();
//字段是"name",值是"Tom"。
uw.set("name", "Tom");

//使用set方法设置另一个字段"age"的值为35。
uw.set("age", 35);

//使用gt方法设置一个大于条件,即"salary"字段的值必须大于3000。
uw.gt("salary", 3000);

//使用lt方法设置一个小于条件,即"salary"字段的值必须小于10000。
uw.lt("salary", 10000);

//使用like方法设置一个模糊匹配条件,即"name"字段的值必须以"T"开头。
uw.like("name", "T%");

int result = employeeMapper.update(null, uw);
System.out.println(result);
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2333896.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Day22 -php开发01--留言板+知识点(超全局变量 文件包含 数据库操作 第三方插件)

环境要求&#xff1a;php7.0.9 小皮 navicat phpstorm24.1 知识点&#xff1a;会写&#xff08;留言板 留言板后台&#xff09; 超全局变量 三方插件的使用 文件包含 1、开启小皮并利用navicat新建一个数据库 注意&#xff1a;本地的服务mysql关闭后 才可打开小皮。属…

Java工具类-assert断言

我们可能经常在项目的单元测试或者一些源码中看到别人在使用assert关键字&#xff0c;当然也不只是Java语言&#xff0c;很多编程语言也都能看到&#xff0c;我们大概知道断言可以用于测试中条件的校验&#xff0c;但却不经常使用&#xff0c;本文总结了Java中该工具类的使用。…

人工智能、机器学习与深度学习-AI基础Day2

核心概念与技术全景解析 近年来&#xff0c;人工智能&#xff08;AI&#xff09;技术飞速发展&#xff0c;逐渐渗透到生活的方方面面。然而&#xff0c;对于许多人来说&#xff0c;AI、机器学习&#xff08;ML&#xff09;、深度学习&#xff08;DL&#xff09;以及生成式人工…

GGML源码逐行调试(上)

目录 前言1. 简述2. 环境配置3. ggml核心概念3.1 gguf3.2 ggml_tensor3.3 ggml_backend_buffer3.4 ggml_context3.5 backend3.6 ggml_cgraph3.7 ggml_gallocr 4. 推理流程整体梳理4.1 时间初始化与参数设置4.2 模型加载与词汇表构建4.3 计算图与内存分配4.4 文本预处理与推理过…

SpringCloud-OpenFeign

前言 1.存在问题 远程调用可以像Autowired一样吗 服务之间的通信⽅式,通常有两种:RPC和HTTP. 在SpringCloud中,默认是使⽤HTTP来进⾏微服务的通信,最常⽤的实现形式有两种&#xff1a; RestTemplate OpenFeign RPC&#xff08;RemoteProcedureCall&#xff09;远程过程调⽤&…

撰写学位论文Word图表目录的自动生成

第一步&#xff1a;为图片和表格添加题注 选中图片或表格 右键点击需要编号的图片或表格&#xff0c;选择 【插入题注】&#xff08;或通过菜单栏 引用 → 插入题注&#xff09;。 设置题注标签 在弹窗中选择 标签&#xff08;如默认有“图”“表”&#xff0c;若无需自定义标…

Web 项目实战:构建属于自己的博客系统

目录 项目效果演示 代码 Gitee 地址 1. 准备工作 1.1 建表 1.2 引入 MyBatis-plus 依赖 1.3 配置数据库连接 1.4 项目架构 2. 实体类准备 - pojo 包 2.1 dataobject 包 2.2 request 包 2.3 response 包 2.3.1 统一响应结果类 - Result 2.3.2 用户登录响应类 2.3.3…

【随行付-注册安全分析报告-无验证方式导致隐患】

前言 由于网站注册入口容易被黑客攻击&#xff0c;存在如下安全问题&#xff1a; 1. 暴力破解密码&#xff0c;造成用户信息泄露 2. 短信盗刷的安全问题&#xff0c;影响业务及导致用户投诉 3. 带来经济损失&#xff0c;尤其是后付费客户&#xff0c;风险巨大&#xff0c;造…

什么是原型、原型链?

一、原型 每个函数都有一个prototype属性&#xff0c;称之为原型&#xff0c;也称为原型对象。 原型可以放一些属性和方法&#xff0c;共享给实例对象使用。原型可以用作继承 二、原型链 对象都有_proto_属性&#xff0c;这个属性指向它的原型对象&#xff0c;原型对象也是…

ChatGPT的GPT-4o创建图像Q版人物提示词实例展示

最近感觉GPT-4o发布的新功能真的强大&#xff0c;所以总结了一些提示词分享给大家&#xff0c;大家可以去试试&#xff0c;玩法多多&#xff0c;可以用GPT-4o生成图片&#xff0c;然后用可灵进行图生视频&#xff0c;就能去发布视频了&#xff01;接下来和笔者一起来试试&#…

StringBuffer类基本使用

文章目录 1. 基本介绍2. String VS StringBuffer3. String和StringBuffer相互转换4. StringBuffer类常见方法5. StringBuffer类测试 1. 基本介绍 java.lang.StringBuffer 代表可变的字符序列&#xff0c;可以对字符串内容进行增删很多方法与String相同&#xff0c;但StringBuf…

基于 Maven 构建的 Thingsboard 3.8.1 项目结构

一、生命周期&#xff08;Lifecycle&#xff09; Maven 的生命周期定义了项目构建和部署的各个阶段&#xff0c;图中列出了标准的生命周期阶段&#xff1a; clean&#xff1a;清理项目&#xff0c;删除之前构建生成的临时文件和输出文件。validate&#xff1a;验证项目配置是否…

为啥物联网用MQTT?

前言 都说物联网用MQTT&#xff0c;那分别使用Http和Mqtt发送“Hello”&#xff0c;比较一下就知道啦 HTTP HTTP请求报文由请求行、头部字段和消息体组成。一个最简单的HTTP POST请求如下&#xff1a; POST / HTTP/1.1 Host: example.com Content-Length: 5 Content-Type: …

小甲鱼第004讲:变量和字符串(下)| 课后测试题及答案

问答题: 0. 请问下面代码有没有毛病&#xff0c;为什么? 请问下面代码为什么会出错&#xff0c;应该如何解决&#xff1f; 答:这是由于在字符串中&#xff0c;反斜杠()会与其随后的字符共同构成转义字符。 为了避免这种不测情况的发生&#xff0c;我们可以在字符串的引号前面…

MergeX亮相GTC2025:开启全球广告流量交易新篇章

全球流量盛宴GTC2025深圳启幕&#xff0c;共探出海新蓝海 2025年4月24日至25日&#xff0c;GTC2025全球流量大会将在深圳福田会展中心9号馆隆重召开。作为跨境出海领域内规模最大、资源最丰富、产业链最完备的年度盛会&#xff0c;此次大会将汇聚众多行业精英&#xff0c;共同探…

STM32(基于标准库)

参考博客&#xff1a;江科大STM32笔记 Stm32外设 一、GPIO 基础 GPIO位结构 I/O引脚的保护二极管是对输入电压进行限幅的上面的二极管接VDD, 3.3V,下面接VSS, 0V&#xff0c;当输入电压 >3.3V 那上方这个二极管就会导通&#xff0c;输入电压产生的电流就会大部分充入VD…

国家优青ppt美化_青年科学基金项目B类ppt案例模板

国家优青 国家优青&#xff0c;全称“国家优秀青年基金获得者”。2025改名青年科学基金B类。 作为自然基金人才资助类型&#xff0c;支持青年学者在基础研究方面自主选择研究方向开展创新研究。它是通往更高层次科研荣誉的重要阶梯&#xff0c;是准杰青梯队。 / WordinPPT /…

解决 ECharts 图表无数据显示问题

问题&#xff1a; 在开发项目时&#xff0c;后端明明已经成功返回了数据&#xff0c;但在展示手账发布数量趋势和树洞帖子发布数量趋势的 ECharts 图表中&#xff0c;却只有坐标轴&#xff0c;没有任何数据显示。 以我的VUE项目开发可视化面板为例&#xff0c;下面将详细分析可…

spacy安装失败报错

报错 使用命令pip install spacy安装spacy时总是报错&#xff08;python -m pip install spacy方式安装同样报错&#xff09; 解决办法 使用conda安装&#xff0c;conda能够避免很多不必要的依赖包。 命令&#xff1a;conda install spacy 安装成功列表展示

C++在Linux上生成动态库并调用接口测试

加减乘除demo代码 项目结构 CPP/ ├── calculator.cpp ├── calculator.h ├── main.cpp 头文件 #ifndef CALCULATOR_H #define CALCULATOR_H#ifdef __cplusplus extern "C" {#endifdouble add(double a, double b);double subtract(double a, double b…