使用MyBatis的动态SQL注解实现实体的CRUD操作

使用MyBatis的动态SQL注解实现实体的CRUD操作

  • 1. 引言
  • 2. 准备工作
    • 2.1 创建数据表
    • 2.2 创建实体类 `Book`
    • 2.3 修改Mapper接口 `BookMapper`
  • 3. 测试CRUD操作
    • 3.1 配置日志
    • 3.2 查询操作
    • 3.3 新增操作
    • 3.4 修改操作
    • 3.5 删除操作
  • 4. 与MyBatis Plus的对比
  • 5. 动态SQL注解的适用场景
    • 5.1 动态查询条件
    • 5.2 动态插入和更新
    • 5.3 复杂的业务逻辑
    • 5.4 查询结果动态列的聚合
  • 6. 小结

1. 引言

在使用MyBatis进行数据库操作时，动态SQL注解提供了一种优雅的方式来编写动态SQL语句。MyBatis 3.x 版本提供了以下四个CRUD的高级注解：

  • @SelectProvider：用于构建动态查询SQL。
  • @InsertProvider：用于构建动态新增SQL。
  • @UpdateProvider：用于构建动态更新SQL。
  • @DeleteProvider：用于构建动态删除SQL。

这些注解可以帮助开发者在Mapper接口中动态地构建SQL语句，避免了在XML配置文件中编写大量的SQL代码，使代码更加简洁和易于维护。本文将详细介绍如何使用这些动态SQL注解来实现书籍信息的查询、新增、修改和删除操作。

此外，我们将与MyBatis Plus中的@Select注解进行对比，展示MyBatis动态SQL注解的优势和灵活性。

2. 准备工作

2.1 创建数据表

首先，需要创建一个代表书籍信息的表 tb_book。

-- 判断数据表是否存在，存在则删除
DROP TABLE IF EXISTS tb_book;

-- 创建“书籍信息”数据表
CREATE TABLE IF NOT EXISTS tb_book
(
    book_id INT AUTO_INCREMENT PRIMARY KEY COMMENT '书籍编号',
    book_name VARCHAR(50) NOT NULL COMMENT '书名',
    author VARCHAR(50) NOT NULL COMMENT '作者',
    publisher VARCHAR(50) COMMENT '出版社',
    publish_date DATE COMMENT '出版日期'
) COMMENT = '书籍信息表';

-- 添加数据
INSERT INTO tb_book(book_name, author, publisher, publish_date) VALUES ('书籍1', '作者1', '出版社1', '2023-01-01');

2.2 创建实体类 Book

在 com.zhouquan.entity 包中创建 Book 类，使用 @Data 注解来自动生成getter和setter方法。

package com.zhouquan.entity;
import lombok.Data;
import java.util.Date;

/**
 * 书籍信息实体类
 */
@Data
public class Book {
    /**
     * 书籍编号
     */
    private int bookId;
    
    /**
     * 书名
     */
    private String bookName;
    
    /**
     * 作者
     */
    private String author;
    
    /**
     * 出版社
     */
    private String publisher;
    
    /**
     * 出版日期
     */
    private Date publishDate;
}

2.3 修改Mapper接口 BookMapper

在 com.zhouquan.mapper 包中创建 BookMapper 接口，并使用动态SQL注解来实现CRUD操作。

package com.zhouquan.mapper;

import com.zhouquan.entity.Book;
import org.apache.ibatis.annotations.*;
import org.apache.ibatis.jdbc.SQL;
import org.springframework.stereotype.Repository;

@Mapper
@Repository
public interface BookMapper {

    @SelectProvider(type = BookSqlBuilder.class, method = "buildGetBookByIdSql")
    public Book getBookById(@Param("bookId") int bookId);

    @InsertProvider(type = BookSqlBuilder.class, method = "buildInsertBookSql")
    @Options(useGeneratedKeys = true, keyColumn = "book_id", keyProperty = "bookId")
    public int insertBook(Book book);

    @UpdateProvider(type = BookSqlBuilder.class, method = "buildUpdateBookSql")
    public int updateBook(Book book);

    @DeleteProvider(type = BookSqlBuilder.class, method = "buildDeleteBookSql")
    public int deleteBook(@Param("bookId") int bookId);

    class BookSqlBuilder {
        public String buildGetBookByIdSql(@Param("bookId") int bookId) {
            return new SQL() {{
                SELECT("*");
                FROM("tb_book");
                WHERE("book_id = #{bookId}");
            }}.toString();
        }

        public String buildInsertBookSql(Book book) {
            return new SQL() {{
                INSERT_INTO("tb_book");
                VALUES("book_name", "#{bookName}");
                VALUES("author", "#{author}");
                VALUES("publisher", "#{publisher}");
                VALUES("publish_date", "#{publishDate}");
            }}.toString();
        }

        public String buildUpdateBookSql(Book book) {
            return new SQL() {{
                UPDATE("tb_book");
                SET("book_name = #{bookName}", "author = #{author}", "publisher = #{publisher}", "publish_date = #{publishDate}");
                WHERE("book_id = #{bookId}");
            }}.toString();
        }

        public String buildDeleteBookSql(@Param("bookId") int bookId) {
            return new SQL() {{
                DELETE_FROM("tb_book");
                WHERE("book_id = #{bookId}");
            }}.toString();
        }
    }
}

3. 测试CRUD操作

为了测试CRUD操作，我们将使用JUnit进行单元测试，并通过日志记录操作的结果。

3.1 配置日志

在Maven的pom.xml文件中引入SLF4J和Logback的依赖：

<dependencies>
    <!-- MyBatis 依赖 -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.1.4</version>
    </dependency>
    
    <!-- SLF4J 依赖 -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.30</version>
    </dependency>
  
</dependencies>

3.2 查询操作

import com.zhouquan.entity.Book;
import com.zhouquan.mapper.BookMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class BookMapperTest {

    private static final Logger logger = LoggerFactory.getLogger(BookMapperTest.class);

    @Autowired
    private BookMapper bookMapper;

    /**
     * 根据书籍ID，获取书籍信息
     */
    @Test
    public void getBookById() {
        Book book = bookMapper.getBookById(1);
        logger.info("书籍编号：{}", book.getBookId());
        logger.info("书名：{}", book.getBookName());
        logger.info("作者：{}", book.getAuthor());
        logger.info("出版社：{}", book.getPublisher());
        logger.info("出版日期：{}", book.getPublishDate());
    }
}

3.3 新增操作

@Autowired
private BookMapper bookMapper;

/**
 * 新增书籍，并获取自增主键
 */
@Test
public void insertBook() {
    Book book = new Book();
    book.setBookName("新书");
    book.setAuthor("新作者");
    book.setPublisher("新出版社");
    book.setPublishDate(new Date());
    bookMapper.insertBook(book);
    logger.info("新增书籍ID：{}", book.getBookId());
}

3.4 修改操作

@Autowired
private BookMapper bookMapper;

/**
 * 更新书籍信息
 */
@Test
public void updateBook() {
    Book book = bookMapper.getBookById(1);
    book.setBookName("更新后的书名");
    bookMapper.updateBook(book);
    logger.info("更新后的书名：{}", book.getBookName());
}

3.5 删除操作

@Autowired
private BookMapper bookMapper;

/**
 * 删除书籍
 */
@Test
public void deleteBook() {
    bookMapper.deleteBook(1);
    logger.info("删除书籍ID为1的记录");
}

4. 与MyBatis Plus的对比

MyBatis Plus提供了一种更加简洁的方式来编写SQL语句，例如，使用@Select注解可以直接在Mapper接口中编写SQL语句，而无需单独定义SQL构建器类。

例如，使用MyBatis Plus可以这样定义BookMapper接口：

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.zhouquan.entity.Book;
import org.apache.ibatis.annotations.Select;

public interface BookMapper extends BaseMapper<Book> {

    @Select("SELECT * FROM tb_book WHERE book_id = #{bookId}")
    Book getBookById(int bookId);
}

这种方式相对于MyBatis动态SQL注解而言，更加直接和易读。但是，MyBatis动态SQL注解在处理复杂SQL语句时具有更高的灵活性和可维护性，特别是当需要根据不同条件动态生成SQL时，MyBatis动态SQL注解显得更为强大和适用

5. 动态SQL注解的适用场景

5.1 动态查询条件

在一些应用中，查询条件是动态的，可能根据不同的用户输入或业务逻辑生成不同的查询条件。使用动态SQL注解可以在运行时根据这些条件动态构建查询语句，避免了硬编码查询条件的问题。

public String buildDynamicQuerySql(Map<String, Object> params) {
    return new SQL() {{
        SELECT("*");
        FROM("tb_book");
        if (params.get("author") != null) {
            WHERE("author = #{author}");
        }
        if (params.get("publisher") != null) {
            WHERE("publisher = #{publisher}");
        }
        if (params.get("publishDate") != null) {
            WHERE("publish_date = #{publishDate}");
        }
    }}.toString();
}

5.2 动态插入和更新

在一些情况下，插入或更新的数据字段可能不是固定的，而是根据业务需求动态变化的。使用动态SQL注解可以根据传入的实体对象构建动态插入或更新语句。

public String buildDynamicInsertSql(Book book) {
    return new SQL() {{
        INSERT_INTO("tb_book");
        if (book.getBookName() != null) {
            VALUES("book_name", "#{bookName}");
        }
        if (book.getAuthor() != null) {
            VALUES("author", "#{author}");
        }
        if (book.getPublisher() != null) {
            VALUES("publisher", "#{publisher}");
        }
        if (book.getPublishDate() != null) {
            VALUES("publish_date", "#{publishDate}");
        }
    }}.toString();
}

public String buildDynamicUpdateSql(Book book) {
    return new SQL() {{
        UPDATE("tb_book");
        if (book.getBookName() != null) {
            SET("book_name = #{bookName}");
        }
        if (book.getAuthor() != null) {
            SET("author = #{author}");
        }
        if (book.getPublisher() != null) {
            SET("publisher = #{publisher}");
        }
        if (book.getPublishDate() != null) {
            SET("publish_date = #{publishDate}");
        }
        WHERE("book_id = #{bookId}");
    }}.toString();
}

5.3 复杂的业务逻辑

在一些复杂的业务场景中，SQL语句的构建逻辑可能非常复杂，涉及多个表的联接、多种条件的判断等。使用动态SQL注解可以在Java代码中使用条件逻辑来构建复杂的SQL语句，使代码更加清晰和易于维护。

public String buildComplexQuerySql(Book book) {
    return new SQL() {{
        SELECT("b.*, a.author_name, p.publisher_name");
        FROM("tb_book b");
        JOIN("tb_author a ON b.author_id = a.author_id");
        JOIN("tb_publisher p ON b.publisher_id = p.publisher_id");
        if (book.getBookName() != null) {
            WHERE("b.book_name LIKE CONCAT('%', #{bookName}, '%')");
        }
        if (book.getAuthor() != null) {
            WHERE("a.author_name LIKE CONCAT('%', #{author}, '%')");
        }
        if (book.getPublisher() != null) {
            WHERE("p.publisher_name LIKE CONCAT('%', #{publisher}, '%')");
        }
    }}.toString();
}

5.4 查询结果动态列的聚合

需求类似于下，根据专题聚合出不同的资料类型，select中的列需要动态的拼接，显然MP的mapper对于此种需求的支持并不友好

image-20240621171513659

 /**
     * 资源量统计-根据专题
     * 之所以使用此种方式是因为统计的列是不固定的，所以需要动态拼接select
     *
     * @param resourceTypeNameList 资源名称列表
     * @param resourceTypeSidList  资源sid列表
     * @param start                加工开始时间
     * @param end                  加工结束时间
     * @return
     */
    public String groupTopicDynamicSQL(final List<String> resourceTypeNameList, final List<String> resourceTypeSidList,
                                       final LocalDate start, final LocalDate end) {
        // 构建外部查询
        SQL outerQuery = new SQL();
        outerQuery.SELECT("COALESCE(topic_name, '总计') AS '专题'");

        if (resourceTypeNameList != null && !resourceTypeNameList.isEmpty()) {
            for (String rt : resourceTypeNameList) {
                outerQuery.SELECT(String.format("SUM(CASE WHEN resource_type_name = '%s' THEN count ELSE 0 END) AS " +
                        "'%s'", rt, rt));
            }
        }

        // 构建子查询
        SQL subQuery = new SQL();
        subQuery.SELECT("rt.name AS resource_type_name, t.name AS topic_name, COUNT(*) AS count")
                .FROM("works w")
                .JOIN("works_topic wt ON w.sid = wt.work_sid")
                .JOIN("topic t ON wt.topic_sid = t.sid")
                .JOIN("resource_type rt ON w.type_leaf_sid = rt.sid")
                .WHERE(" w.deleted=0 ");

        if (resourceTypeNameList != null && !resourceTypeNameList.isEmpty()) {
            String joinedResourceTypes = resourceTypeSidList.stream()
                    .map(rt -> "'" + rt + "'")
                    .collect(Collectors.joining(", "));
            subQuery.WHERE("w.type_leaf_sid IN (" + joinedResourceTypes + ")");
        }
        if (start != null) {
            subQuery.WHERE("w.update_time >= #{start}");
        }
        if (end != null) {
            subQuery.WHERE("w.update_time <= #{end}");
        }
        subQuery.GROUP_BY("rt.name, t.name");

        outerQuery.SELECT("SUM(count) AS '总计'")
                .FROM("(" + subQuery + ") AS subQuery")
                .GROUP_BY("topic_name WITH ROLLUP");

        return outerQuery.toString();
    }

/**
 * 统计分析-资源量统计
 *
 * @param resourceTypeNameList
 * @param resourceTypeSidList
 * @param start
 * @param end
 * @return
 */
@SelectProvider(type = WorksSqlProvider.class, method = "groupTopicDynamicSQL")
List<Map<String, Object>> staticByTopic(@Param("resourceTypeNameList") List<String> resourceTypeNameList,
                                        @Param("resourceTypeSidList") List<String> resourceTypeSidList,
                                        @Param("start") LocalDate start,
                                        @Param("end") LocalDate end);

6. 小结

MyBatis动态SQL注解通过提供更加灵活和动态的方式来构建SQL语句，使得代码更加简洁和易于维护。而MyBatis Plus通过简化SQL编写过程，提供了一种更加便捷的方式来进行数据库操作。根据具体项目的需求和复杂度，可以选择适合的工具来实现数据库操作。

通过上述介绍，可以看出动态SQL注解在处理动态查询条件、动态插入和更新以及复杂的业务逻辑时具有明显的优势和适用性。在实际开发中，合理使用动态SQL注解可以提高代码的灵活性和可维护性。

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

CSDN原力值涨分规则

CSDN原力值涨分规则

CSDN的原力值是指用户在CSDN社区中的影响力和贡献程度的评估指标。原力值是根据用户在CSDN平台上的发表文章、获得的点赞和评论数量、参与的社区活动等多个因素综合计算得出的。较高的原力值意味着用户在CSDN社区中的影响力和知名度较高&#xff0c;其发表的文章和回答的问题可…
阅读更多...
虹科技术丨跨越距离障碍：PCAN系列网关在远程CAN网络通信的应用潜力

虹科技术丨跨越距离障碍：PCAN系列网关在远程CAN网络通信的应用潜力

来源&#xff1a;虹科技术丨跨越距离障碍&#xff1a;PCAN系列网关在远程CAN网络通信的应用潜力 原文链接&#xff1a;虹科技术 | 跨越距离障碍&#xff1a;PCAN系列网关在远程CAN网络通信的应用潜力 欢迎关注虹科&#xff0c;为您提供最新资讯&#xff01; #PCAN #网关 #CA…
阅读更多...
Steam夏促史低游戏推荐 Steam夏促哪有游戏值得入手

Steam夏促史低游戏推荐 Steam夏促哪有游戏值得入手

steam夏促来了&#xff0c;作为大型的季节特卖&#xff0c;这次夏促也是有很多不错的游戏&#xff0c;价格优惠也非常到位&#xff0c;想入手游戏的玩家可以抓住这次机会&#xff0c;夏促的时间是6.28到7.12&#xff0c;快去看看有没有心仪的游戏吧&#xff0c;本篇带来steam夏…
阅读更多...
面试-java异常体系

面试-java异常体系

1.java异常体系 error类是指与jvm相关的问题。如系统崩溃&#xff0c;虚拟机错误&#xff0c;内存空间不足。 非runtime异常不处理&#xff0c;程序就没有办法执行。 一旦遇到异常抛出&#xff0c;后面的异常就不会进行。 (1)常见的error以及exception 2.java异常要点分析…
阅读更多...
CAM350如何移动元素？

CAM350如何移动元素？

CAM350如何移动元素&#xff1f; 1、选择菜单栏Edit→Move 2、然后按W键&#xff0c;光标变为下图的形状&#xff0c;然后框选需要移动的元素。 3、框选元素后如下图所示&#xff0c;然后右击&#xff0c;退出框选命令。 4、然后点选一个原点开始移动所选的元素。 移动后如下图…
阅读更多...
MySQL数据库的存储引擎mylsam和innodb

MySQL数据库的存储引擎mylsam和innodb

一、存储引擎概述 1.什么是存储引擎 数据库存储引擎是数据库底层软件组件&#xff0c;数据库管理系统使用数据引擎进行创建、查询、更新和删除数据操作。不同的存储引擎提供不同的存储机制、索引技巧、锁定水平等功能&#xff0c;使用不同的存储引擎还可以获得特定的功能。 …
阅读更多...
关于JVM必备的一些知识

关于JVM必备的一些知识

一、类加载 【加载】 - 【链接】-【初始化】 1.1 加载&#xff08;Loading&#xff09; 加载阶段是类加载过程的第一步&#xff0c;它的主要任务是通过类的全限定名&#xff08;Fully Qualified Class Name&#xff09;来获取类的二进制字节流&#xff08;binary data&#…
阅读更多...
虹科技术丨Linux环境再升级：PLIN驱动程序正式发布

虹科技术丨Linux环境再升级：PLIN驱动程序正式发布

来源&#xff1a;虹科技术丨Linux环境再升级&#xff1a;PLIN驱动程序正式发布 原文链接&#xff1a;https://mp.weixin.qq.com/s/N4zmkYXTPr7xm-h2s7QiLw 欢迎关注虹科&#xff0c;为您提供最新资讯&#xff01; #PLIN #LIN #LIN接口 导读 Linux驱动程序领域再添新成员&am…
阅读更多...
入门机器视觉的正确打开方式——徒手撸一个python+opencv实现的机器视觉简易调试工具（下）

入门机器视觉的正确打开方式——徒手撸一个python+opencv实现的机器视觉简易调试工具（下）

目录 1.引言2.框架思路3.图像处理流程化的实现3.1如何解析图像流程数据结构3.2 使用networkx网络图库3.3 python实现 4.结论5.python源码PS.扩展阅读ps1.六自由度机器人相关文章资源ps2.四轴机器相关文章资源ps3.移动小车相关文章资源 1.引言 在当今AI时代&#xff0c;关于视觉…
阅读更多...
昇思25天学习打卡营第4天|网络构建

昇思25天学习打卡营第4天|网络构建

文章目录 网络构建 网络构建 在打卡第一天就简单演示了网络构建&#xff0c;一个神经网络模型表示为一个Cell&#xff0c;由不同的子Cell构成。使用这样的嵌套结构可以简单地使用面向对象编程的思维&#xff0c;对神经网络结构进行构建和管理。 继承nn.Cell类来定义神经网络&…
阅读更多...
Android 界面库 (二) 之 Data binding 详细介绍

Android 界面库 (二) 之 Data binding 详细介绍

1. 简介 回顾我们在前面文章《Android 界面库 (一) 之 View binding 简单使用》中学习的 View Binding&#xff0c;它旨在简化 View 与代码之间的绑定过程。它会在编译时期为每个 XML 布局文件生成相应的绑定类(Binding class)&#xff0c;该类里包含了布局文件每个有 ID 的 Vi…
阅读更多...
centos7 安装单机MongoDB

centos7 安装单机MongoDB

centos7安装单机 yum 安装 1、配置yum源 vim /etc/yum.repos.d/mongodb.repo [mongodb-org-7.0] nameMongoDB Repository baseurlhttps://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/7.0/x86_64/ gpgcheck1 enabled1 gpgkeyhttps://www.mongodb.org/static/pgp…
阅读更多...
CSS实现文字颜色渐变

CSS实现文字颜色渐变

直接上代码和效果图&#xff1a; <p class"linecolor">文字颜色渐变</p><style type"text/css">.linecolor{font-size: 30px;background-image:-webkit-linear-gradient(bottom,red,#fd8403,yellow);-webkit-background-clip:text;-web…
阅读更多...
Flutter循序渐进==＞基金管理APP首页

Flutter循序渐进==＞基金管理APP首页

目录 查看版本 组件 组件源码学习 做个基金APP首页源代码 效果 查看版本 组件 组件的本质就是个类。 import package:flutter/material.dart;void main() {runApp(const OurFirstApp(),); } OurFirstApp()实例化&#xff0c;就是给runApp用的&#xff0c;runApp就是运行实…
阅读更多...
AST反混淆|某练习平台混淆代码彻底还原及逆向请求

AST反混淆|某练习平台混淆代码彻底还原及逆向请求

关注它&#xff0c;不迷路。 本文章中所有内容仅供学习交流&#xff0c;不可用于任何商业用途和非法用途&#xff0c;否则后果自负&#xff0c;如有侵权&#xff0c;请联系作者立即删除&#xff01; 一.目标地址 https://match.yuanrenxue.cn/match/2 二.代码还原 初次请…
阅读更多...
Java常量、变量、成员内部类

Java常量、变量、成员内部类

文章目录 1.常量2.变量3.成员内部类4.变动 1.常量 实例常量&#xff1a;只用final修饰&#xff0c;是某个具体类的实例 静态常量&#xff1a;finalstatic修饰&#xff0c;属于类&#xff0c;所有实例共享同一个类常量 2.变量 实例变量(成员变量)&#xff1a;定义在类内部但在…
阅读更多...
【motan rpc 懒加载】异常

【motan rpc 懒加载】异常

文章目录 升级版本解决问题我使用的有问题的版本配置懒加载错误的版本配置了懒加载 但是不生效 lazyInit"true" 启动不是懒加载 会报错一次官方回复 升级版本解决问题 <version.motan>1.2.1</version.motan><dependency><groupId>com.weibo…
阅读更多...
Adobe Animate有必要学习AS3脚本吗？

Adobe Animate有必要学习AS3脚本吗？

AdobeAnimate软件已经慢慢的替代Flash系列软件在动画中的地位了&#xff0c;也越来越多的出现在各专业课中。不过还是以动画制作方面的教学为主。 Animate软件从入门到提高系列课程​http://www.bilibili.com/cheese/play/ss1826 也有不少同学知道从Flash系列开始&#xff0c;…
阅读更多...
便携应急气象站设备—实时监测和记录气象数据

便携应急气象站设备—实时监测和记录气象数据

TH-BQX10便携应急气象站设备是一种高度集成、轻便易携的气象观测系统。它采用新型一体化结构设计&#xff0c;能够快速安装和拆卸&#xff0c;适用于各种复杂环境。通过集成多种气象传感器&#xff0c;该设备能够实时监测和记录温度、湿度、风向、风速、降雨量、气压等多种气象…
阅读更多...
新手第一个漏洞复现:MS17-010(永恒之蓝)

新手第一个漏洞复现:MS17-010(永恒之蓝)

文章目录 漏洞原理漏洞影响范围复现环境复现步骤 漏洞原理 漏洞出现在Windows SMB v1中的内核态函数srv!SrvOs2FeaListToNt在处理FEA&#xff08;File Extended Attributes&#xff09;转换时。该函数在将FEA list转换成NTFEA&#xff08;Windows NT FEA&#xff09;list前&am…
阅读更多...
最新文章

Copyright @ 2022~2023