@Insert 注解

注解说明

用来标记在接口方法上，它接受一个字符串参数或字符串数组表示执行一个 INSERT 语句。

示例：新增一条用户记录

@SimpleMapper
public interface UserMapper {
    @Insert({ "insert into users (",                       // 1. 定义 SQL 语句
              "    id, name, age, create_time",            //
              ") values (",                                //
              "    #{id}, #{name}, #{age}, #{createTime})",//
              ")" })
    int saveUser(UserDTO user);                            // 2. user 对象为参数
}

属性清单

属性名	描述
value	必选 将要被执行的查询语句。
statementType	可选 表示查询类型，表示 JDBC 查询使用何种方式。默认值为 PREPARED - STATEMENT 对应 java.sql.Statement - PREPARED 对应 java.sql.PreparedStatement - CALLABLE 对应 java.sql.CallableStatement
timeout	可选 通过设置一个大于 0 时会被设置到 java.sql.Statement.setQueryTimeout(int) 可以让查询在执行时候设置一个超时时间，单位是秒，默认值为 -1
useGeneratedKeys	可选 是否使用自增属性。 - 如果同时配置了 SelectKeySql 注释，如果同时配置了 SelectKey 注解该配置将会失效。
keyProperty	可选 当 useGeneratedKeys 设置为 true 后，用于回填自增后属性值的 Bean 属性名。如果同时配置了 SelectKey 注解该属性将会失效。
keyColumn	可选 当 useGeneratedKeys 设置为 true 后，回填自增属性值时候选择的查询结果列名。如果同时配置了 SelectKey 注解该属性将会失效。

小提示

keyColumn 属性为空时，将会选择返回结果集的第一个列值作为回填结果。

@SelectKeySql 注解

注解说明

有时候新增一条数据不仅仅要知道是否插入成功，因为后面的逻辑可能还需要这条新增数据的主键。这时候可以使用 SelectKeySql 注释，获取自增主键，从而避免再次查询数据库。 另外，有些业务需要自定义数据表的主键，这个时候也可以使用 SelectKeySql 注释来实现，它可以随意的设置生成主键的方式。

该注解用来标记在接口方法上，需要与 Insert 注解配合使用。

示例：新增一条用户记录

//create table users (
//  id          bigint auto_increment primary key,
//  name        varchar(255),
//  age         int,
//  create_time datetime
//);

@SimpleMapper
public interface UserMapper {
    @Insert({ "insert into users (",                // 1. 定义 SQL 语句
              "    name, age, create_time",         //
              ") values (",                         //
              "    #{name}, #{age}, #{createTime})",//
              ")" })
    // 在 Insert 语句执行后使用 MySQL last_insert_id() 函数获取自增 ID，并回填参数对象的 id 属性中
    @SelectKeySql(value = "select last_insert_id()", keyProperty = "id", order = Order.After)
    int saveUser(UserDTO user);
}

UserMapper mapper = ...;
UserDTO user = ...

mapper.saveUser(user);

long afterId = user.getId();

属性清单

属性名	描述
value	必选 将要被执行的获取自增主键 SQL 查询语句。
keyProperty	必选 用于回填自增后属性值的 Bean 属性名。
keyColumn	可选 用于回填自增属性值时候选择的查询结果列名。
order	必选 可以选择 Before 或者 After，表示用于获取自增主键的 SQL 执行时机是在 INERT 操作之前还是之后。
statementType	可选 表示查询类型，表示 JDBC 查询使用何种方式。默认值为 PREPARED - STATEMENT 对应 java.sql.Statement - PREPARED 对应 java.sql.PreparedStatement - CALLABLE 对应 java.sql.CallableStatement
timeout	可选 通过设置一个大于 0 时会被设置到 java.sql.Statement.setQueryTimeout(int) 可以让查询在执行时候设置一个超时时间，单位是秒，默认值为 -1
fetchSize	可选 通过设置一个大于 0 时会被设置到 java.sql.Statement.setFetchSize(int)，用于为 JDBC 驱动程序提供一个提示。它提示此查询生成的 ResultSet 对象需要更多行时应该从数据库获取的行数。默认值是 256
resultSetType	可选 当通过 java.sql.Connection 创建查询 statement 时候，该值决定了 resultSetType 参数的具体值。 - 可选值列表： FORWARD_ONLY、SCROLL_INSENSITIVE、SCROLL_SENSITIVE 和 DEFAULT。默认值为 DEFAULT 相当于未设置。 - statementType 为 STATEMENT 时对应 java.sql.Connection.createStatement(int, int) 方法第一个参数。 - statementType 为 PREPARED 时对应 java.sql.Connection.prepareStatement(java.lang.String, int, int)方法第二个参数。 - statementType 为 CALLABLE 时对应 java.sql.Connection..prepareCall(java.lang.String, int, int)方法第二个参数。