Mybatis中saveOrUpdateBatch实现

小蓝 • 2024-11-26 21:07 • 编程

一、saveOrUpdateBatch介绍

saveOrUpdateBatch是Mybatis框架中提供的一种批量新增或批量更新数据的方法，相比于单条新增或更新的操作，使用saveOrUpdateBatch可以大幅度提高数据操作的效率。

saveOrUpdateBatch方法可以接收一个集合参数，根据集合中的数据状态进行新增或更新操作，如果数据的主键已存在，则执行更新操作，否则执行新增操作。

相比于Mybatis的原生操作，saveOrUpdateBatch在提高操作效率的同时，也可以避免手动判断主键是否存在的繁琐操作。

二、使用方法

以下是saveOrUpdateBatch的使用方法：


/**
 * 批量新增或更新数据
 * @param list
 */
void saveOrUpdateBatch(List<T> list);

其中，T为实体类的类型。在使用saveOrUpdateBatch的时候，需要注意以下几点：

实体类需要有主键字段，并且主键字段需要标注为@Id和@GeneratedValue注解
需要在Mapper.xml中编写相应的sql语句
需要在Mapper接口的方法中添加@Param注解，指定传入的参数名为list

三、实现示例

1. 实体类定义

以用户信息为例，定义一个User实体类，主键为id：


public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String password;

    // 省略getter和setter方法
}

2. Mapper.xml配置

在Mapper.xml中编写相应的sql语句，如下所示：


<mapper namespace="com.example.mapper.UserMapper">
    <!-- 批量新增或更新用户信息 -->
    <insert id="saveOrUpdateBatch">
        INSERT INTO user (id, name, password)
        VALUES
        <foreach collection="list" item="item" separator=",">
            (#{item.id}, #{item.name}, #{item.password})
        </foreach>
        ON DUPLICATE KEY UPDATE
        <foreach collection="list" item="item" separator=",">
            name = VALUES(name),
            password = VALUES(password)
        </foreach>
    </insert>
</mapper>

其中，ON DUPLICATE KEY UPDATE语句表示在主键冲突的情况下执行更新操作，VALUES(name)表示更新name字段为当前插入的name值，VALUES(password)表示更新password字段为当前插入的password值。

3. Mapper接口定义

定义一个UserMapper接口，在接口中添加saveOrUpdateBatch方法，如下所示：


public interface UserMapper extends BaseMapper<User> {
    /**
     * 批量新增或更新用户信息
     * @param userList 用户信息列表
     */
    void saveOrUpdateBatch(@Param("list") List<User> userList);
}

4. Java代码调用

在Java代码中调用saveOrUpdateBatch方法，实现批量新增或批量更新，如下所示：


@Autowired
private UserMapper userMapper;

public void batchSaveOrUpdate(List<User> userList) {
    userMapper.saveOrUpdateBatch(userList);
}

四、总结

使用Mybatis的saveOrUpdateBatch方法可以快速实现批量新增或批量更新数据，提高数据操作的效率。虽然在使用过程中需要注意一些细节问题，如主键字段的设置、Mapper.xml中sql语句的编写和Mapper接口方法上的@Param注解等，但总的来说，saveOrUpdateBatch方法的使用是非常方便的，值得推荐。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/185753.html