com.mybatisflex.annotation.Table Maven / Gradle / Ivy
/*
* Copyright (c) 2022-2025, Mybatis-Flex ([email protected]).
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.*;
/**
* 数据库表信息注解。
*
* @author Michael Yang
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
//@Inherited 需要注释，否则会在 vo 等继承 model 的实体类中，生成多余的、或冲突的 tableDef
public @interface Table {
/**
* 显式指定表名称。
*/
String value();
/**
* 数据库的 schema（模式）。
*/
String schema() default "";
/**
* 默认为 驼峰属性 转换为 下划线字段。
*/
boolean camelToUnderline() default true;
/**
* 默认使用哪个数据源，若系统找不到该指定的数据源时，默认使用第一个数据源。
*/
String dataSource() default "";
/**
* 数据库表注释，在 AI 时代，注释的内容往往可用于 AI 辅助对话
*/
String comment() default "";
/**
* 监听 entity 的 insert 行为。
*/
Class[] onInsert() default {};
/**
* 监听 entity 的 update 行为。
*/
Class[] onUpdate() default {};
/**
* 监听 entity 的查询数据的 set 行为，用户主动 set 不会触发。
*/
Class[] onSet() default {};
/**
* 在某些场景下，我们需要手动编写 Mapper，可以通过这个注解来关闭 APT 的 Mapper 生成。
*/
boolean mapperGenerateEnable() default true;
}