Java书签 #MyBatis之批量插入并返回自增主键id

楔子：当然，世上有很多优秀的女性，我也会被她们吸引。这对男人来说是理所当然的。但目光被吸引和内心被吸引是截然不同的。- 东野圭吾《黎明之街》

1.今日书签

通过 mybatis 框架，实现 SQL 批量插入并返回每条数据的主键id。
 

2.山重水复

通过使用 MyBatis，在插入单条数据的时候有两种方式返回自增主键id：

1. 对于支持生成自增主键的数据库：<insert> 标签属性增加 useGenerateKeys 和 keyProperty。
2. 对于不支持生成自增主键的数据库：在SQL语句中使用 <selectKey> 标签。

案例详见链接：Java书签 #MyBatis返回插入/更新记录的id，及selectKey标签的巧用
 

3.柳暗花明

MyBatis 是支持批量插入时返回每条数据自增主键id的。需要注意有四点：

1. 升级 MyBatis 依赖版本到 3.3.1 或以上。因为官方在这个版本中加入了批量新增返回主键id的功能。
2. 要操作的表的主键id设置的是自增。
3. 在 DAO interface 接口入参中不要乱用 @param 注解。如果使用，请先确保 @param 注解的参数名与 SQL 接收的参数名都为 list。否则，会出现异常：
   org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.binding.BindingException: Parameter 'list' not found. Available parameters are [couponCodeList, param1]
4. Mapper.xml 中的批量插入SQL入参对象变量名一定要使用 list 变量名，<insert> 标签参数类型用 parameterType="java.util.List" 接收 DAO 接口中的参数集合。否则，会出现异常：
   org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.binding.BindingException: Parameter 'couponCodeList' not found. Available parameters are [collection, list]

3.1.代码示例

1）mybatis jar 包依赖

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.3.1</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>1.2.0</version>
</dependency>

2）mapper xml 示例

<insert id="saveBatch" parameterType="java.util.List" useGeneratedKeys="true" keyProperty="couponId">
    INSERT INTO
        t_coupon (activity_id, coupon_code, use_status, create_user, create_time)
    VALUES
    <foreach collection="list" item="item" index="index" separator=",">
        (#{item.activityId}, #{item.couponCode}, 0, 'meiwei', NOW())
    </foreach>
</insert>

3）DAO 接口示例

public interface TCouponMapper {

    int saveBatch(List<TCoupon> couponCodeList);
}

这里的 keyProperty="couponId" 对应的是取插入表的自增id字段，入参对象定义的自增id字段名须与其保持严格一致。示例代码入参对象这里使用的自增id是别名 couponId，所以 keyProperty 的返回字段严格保持一致，也为 couponId。
 
一般情况下，入参对象的主键属性定义为 id，使用 keyProperty="id" 即可。
 

3.2.单元测试

批量插入数据前，每条数据自增id为空：

批量插入数据后，每条数据自增id已经通过入参对象列表返回：