admin/mybatis-flex
1
0
Fork 0
mirror of https://gitee.com/mybatis-flex/mybatis-flex.git synced 2025-12-08 01:28:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

style: 更新 Id 注释。

Browse Source
This commit is contained in:
Suomm 2023-06-19 11:13:08 +08:00
parent 65ca516efb
commit 0e38416481
1 changed files with 25 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/Id.java
View File

@ -1,50 +1,53 @@
/**
* Copyright (c) 2022-2023, Mybatis-Flex (fuhai999@gmail.com).
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
/*
* Copyright (c) 2022-2023, Mybatis-Flex (fuhai999@gmail.com).
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mybatisflex.annotation;
import java.lang.annotation.*;
/**
* 数据库表中的列信息注解。
*/
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Id {
/**
* ID 生成策略，默认为 none
* ID 生成策略，默认为 {@link KeyType#None}。
*
* @return 生成策略
*/
KeyType keyType() default KeyType.None;
/**
* 若 keyType 类型是 sequence， value 则代表的是
* sequence 序列的 sql 内容
* <p>若 keyType 类型是 sequence， value 则代表的是
* sequence 序列的 sql 内容。
* 例如：select SEQ_USER_ID.nextval as id from dual
*
* 若 keyType 是 Generator，value 则代表的是使用的那个 keyGenerator 的名称
*
* <p>若 keyType 是 Generator，value 则代表的是使用的那个 keyGenerator 的名称。
*/
String value() default "";
/**
* sequence 序列执行顺序
* 是在 entity 数据插入之前执行，还是之后执行，之后执行的一般是数据主动生成的 id
* <p>sequence 序列执行顺序。
*
* <p>是在 entity 数据插入之前执行，还是之后执行，之后执行的一般是数据主动生成的 id。
*
* @return 执行之前还是之后
*/
boolean before() default true;
}