app.myoss.cloud.mybatis.table.annotation

Annotation Type SelectKey

@Target(value=FIELD)
 @Retention(value=RUNTIME)
 @Documented
public @interface SelectKey

用于 GenerationType.SELECT_KEY 策略，使用 SelectKeyGenerator 来实现。

实现 Mapper.xml 中如下的功能：

 <selectKey keyProperty="id" keyColumn="id" resultType="java.lang.Long" order="BEFORE">
   SELECT LAST_INSERT_ID()
 </selectKey>
 

Since:

2018年4月30日 下午10:44:30

Author:

Jerry.Chen

See Also:

SelectKeyGenerator

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	sql 使用自定义 select sql 语句生成字段的值

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	keyColumn 从 KeyGenerator 中获取到的返回值，和 keyProperty() 的映射关系。绝大多数情况下，如果 KeyGenerator 返回的的值是单一的列，则不需要设置 keyColumn 可以设置多个字段 可选属性 默认会从对应的 keyProperty 字段中获取"数据库字段名"
String[]	keyProperty 从 KeyGenerator 中获取到的返回值，要设置到哪几个的属性字段中 可以设置多个字段 此字段仅用于 KeyGenerator 实现类中 如果 SequenceGenerator 注解不是放在 Field 上面，则需要设置。 如果 SequenceGenerator 注解放在 Field 上面则，取此字段的属性名。
SequenceGenerator.Order	order SelectKeyGenerator 在 INSERT 之前/之后执行
Class<?>	resultType 从 KeyGenerator 中获取到的返回值 Java 类型，和 keyColumn() 的映射关系 可选属性 默认会从对应的 keyProperty 字段中获取"Java类型"
org.apache.ibatis.mapping.StatementType	statementType 自定义 select sql 语句类型

Element Detail

sql

public abstract String sql

使用自定义 select sql 语句生成字段的值

Returns:

select sql

keyProperty

public abstract String[] keyProperty

从 KeyGenerator 中获取到的返回值，要设置到哪几个的属性字段中

• 可以设置多个字段
• 此字段仅用于 KeyGenerator 实现类中
• 如果 SequenceGenerator 注解不是放在 Field 上面，则需要设置。
• 如果 SequenceGenerator 注解放在 Field 上面则，取此字段的属性名。

Returns:

主键属性字段名

Default:

{}

keyColumn

public abstract String[] keyColumn

从 KeyGenerator 中获取到的返回值，和 keyProperty() 的映射关系。绝大多数情况下，如果 KeyGenerator 返回的的值是单一的列，则不需要设置 keyColumn

• 可以设置多个字段
• 可选属性
• 默认会从对应的 keyProperty 字段中获取"数据库字段名"

Returns:

SELECT SQL中取哪几个字段名

Default:

{}

resultType

public abstract Class<?> resultType

从 KeyGenerator 中获取到的返回值 Java 类型，和 keyColumn() 的映射关系

• 可选属性
• 默认会从对应的 keyProperty 字段中获取"Java类型"

Returns:

主键Java类型

Default:

java.lang.Class.class

statementType

public abstract org.apache.ibatis.mapping.StatementType statementType

自定义 select sql 语句类型

Returns:

select sql statement type

Default:

org.apache.ibatis.mapping.StatementType.PREPARED

order

public abstract SequenceGenerator.Order order

SelectKeyGenerator 在 INSERT 之前/之后执行

Returns:

在 INSERT 之前/之后执行

Default:

app.myoss.cloud.mybatis.table.annotation.SequenceGenerator.Order.BEFORE