app.myoss.cloud.mybatis.table.annotation

Annotation Type SequenceKey

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

用于 GenerationType.SEQUENCE_KEY 策略，使用 Sequence 接口实现类来生成，由 SequenceKeyGenerator 触发调用

Since:

2018年4月30日 下午10:47:11

Author:

Jerry.Chen

See Also:

Sequence, SequenceKeyGenerator

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends Sequence>	sequenceClass Sequence 接口实现类。可以设置为: Sequence.class，然后使用 sequenceClassName() 覆盖

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 (Optional) KeyGenerator 在 INSERT 之前/之后执行
String	sequenceBeanName (Optional) sequenceClass 对应的 Spring Bean instance name
String	sequenceClassName Sequence 接口实现类。sequenceClass() 优先级高于 sequenceClassName()，可用于二方库中规避找不到 class 问题
String	sequenceName (Optional) The name of the database sequence object from which to obtain primary key values.

Element Detail

sequenceClass

public abstract Class<? extends Sequence> sequenceClass

Sequence 接口实现类。可以设置为: Sequence.class，然后使用 sequenceClassName() 覆盖

Returns:

序列的实现类

keyProperty

public abstract String[] keyProperty

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

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

Returns:

主键属性字段名

Default:

{}

keyColumn

public abstract String[] keyColumn

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

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

Returns:

序列结果中取哪几个字段名

Default:

{}

sequenceClassName

public abstract String sequenceClassName

Sequence 接口实现类。sequenceClass() 优先级高于 sequenceClassName()，可用于二方库中规避找不到 class 问题

Returns:

序列的实现类

See Also:

sequenceClass()

Default:

""

sequenceBeanName

public abstract String sequenceBeanName

(Optional) sequenceClass 对应的 Spring Bean instance name

Returns:

序列的 Spring Bean 实例名称

See Also:

TableMetaObject.getSequenceBean(String)

Default:

""

sequenceName

public abstract String sequenceName

(Optional) The name of the database sequence object from which to obtain primary key values.

Defaults to a provider-chosen value.

Returns:

序列名称

Default:

""

order

public abstract SequenceGenerator.Order order

(Optional) KeyGenerator 在 INSERT 之前/之后执行

Returns:

在 INSERT 之前/之后执行

Default:

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