用 MyBatis + MySQL 实现高效的批量 Upsert

原创于 2025-07-31 17:08:59 发布 · 567 阅读

11 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis #mysql #数据库

mysql 专栏收录该内容

4 篇文章

订阅专栏

在日常开发中，我们经常遇到这样的场景：需要将一个来自外部 API 或文件的数据列表，同步到我们的数据库中。这个列表里，既有需要新增的记录，也有需要更新的记录。接下来介绍一种方法，可以只用一次数据库交互，就完成这所有的新增和更新操作。

核心：MySQL 的 INSERT ... ON DUPLICATE KEY UPDATE

INSERT INTO table_name (column1, column2, ...)
VALUES (value1, value2, ...);
ON DUPLICATE KEY UPDATE
    column1 = new_value1,
    column2 = new_value2,
    ...;

工作原理：

它首先尝试执行 INSERT 操作。
如果 INSERT 因为主键或唯一索引冲突而失败，它不会报错。
相反，它会立即跳转去执行 ON DUPLICATE KEY UPDATE 后面的 UPDATE 逻辑，对那条已存在的记录进行更新。

为了在 UPDATE 部分引用到 VALUES 中的新值，MySQL 提供了一个特殊的 VALUES(column_name) 函数。

结合 MyBatis：实现批量自动化

单独的 UPSERT 语句只能处理一条数据，要实现批量处理，就需要借助 MyBatis 强大的动态 SQL 功能，特别是 <foreach> 标签。下面，我们来构建一个通用的、批量的 Upsert Mapper 方法。

1. Mapper 接口定义

首先，在MyBatis Mapper 接口中定义一个接收 List 的方法：

// DataProductMapper.java
public interface DataProductMapper {
    /**
     * 批量更新或插入数据产品
     * @param productList 需要同步的数据产品列表
     * @return 影响的行数
     */
    int batchUpsert(List<DataProduct> productList);
}

2. Mapper XML 实现 (核心代码)

在对应的 DataProductMapper.xml 文件中，来编写sql语句

<insert id="batchUpsert" parameterType="java.util.List">
    <!-- 1. INSERT 部分：定义要操作的表和所有字段 -->
    INSERT INTO data_product (
        product_id, supplier_subject_name, product_name, 
        product_type, product_desc, ...
    )
    <!-- 2. VALUES 部分：使用 <foreach> 动态生成多组值 -->
    VALUES
    <foreach collection="list" item="item" separator=",">
        (
            #{item.productId}, #{item.supplierSubjectName}, #{item.productName},
            #{item.productType}, #{item.productDesc}, ...
        )
    </foreach>
    <!-- 3. ON DUPLICATE KEY UPDATE 部分：定义冲突时的更新规则 -->
    ON DUPLICATE KEY UPDATE
        supplier_subject_name = VALUES(supplier_subject_name),
        product_name = VALUES(product_name),
        product_type = VALUES(product_type),
        product_desc = VALUES(product_desc),
        ...
</insert>

<insert> 标签: 虽然我们的功能包含 UPDATE，但因为 SQL 语句以 INSERT 开头，所以必须使用 <insert> 标签。
<foreach collection="list" ...>: 这是实现批量的关键。它会遍历你传入的 productList（在MyBatis中默认名为 list），并为列表中的每一个 item（DataProduct 对象），都生成一组 (...) 的值。
separator=",": 在每组值之间自动加上逗号，完美地构造出 VALUES (...), (...), (...) 的标准多行插入语法。
ON DUPLICATE KEY UPDATE ...: 这是整个 Upsert 逻辑的核心。
column = VALUES(column): 这句的意思是：“如果发生主键冲突，请将数据库中已存在记录的 column 字段，更新为我在 VALUES 部分为这条记录提供的那个新值。”