/* * Copyright (c) 2011-2020, baomidou (jobob@qq.com). *

* 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 *

* https://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.baomidou.mybatisplus.annotation; import org.apache.ibatis.mapping.ParameterMapping; import org.apache.ibatis.mapping.ResultMapping; import org.apache.ibatis.type.JdbcType; import org.apache.ibatis.type.TypeHandler; import org.apache.ibatis.type.UnknownTypeHandler; import java.lang.annotation.*; /** * 表字段标识 * * @author hubin sjy tantan * @since 2016-09-09 */ @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface TableField { /** * 字段值(驼峰命名方式,该值可无) */ String value() default ""; /** * 当该Field为类对象时, 可使用#{对象.属性}来映射到数据表. *

支持:@TableField(el = "role, jdbcType=BIGINT) 推荐使用{@link TableField#jdbcType()}

*

支持:@TableField(el = "role, typeHandler=com.baomidou.springcloud.typehandler.PhoneTypeHandler") 推荐使用{@link TableField#typeHandler()}

*/ @Deprecated String el() default ""; /** * 是否为数据库表字段 *

默认 true 存在,false 不存在

*/ boolean exist() default true; /** * 字段 where 实体查询比较条件 *

默认 `=` 等值

*/ String condition() default ""; /** * 字段 update set 部分注入, 该注解优于 el 注解使用 *

例如:@TableField(.. , update="%s+1") 其中 %s 会填充为字段

*

输出 SQL 为:update 表 set 字段=字段+1 where ...

*

例如:@TableField(.. , update="now()") 使用数据库时间

*

输出 SQL 为:update 表 set 字段=now() where ...

*/ String update() default ""; /** * 字段验证策略 *

默认追随全局配置

* * @since deprecated v_3.1.2 @2019-5-7 * @deprecated v_3.1.2 please use {@link #insertStrategy} and {@link #updateStrategy} and {@link #whereStrategy} */ @Deprecated FieldStrategy strategy() default FieldStrategy.DEFAULT; /** * 字段验证策略之 insert: 当insert操作时,该字段拼接insert语句时的策略 * IGNORED: 直接拼接 insert into table_a(column) values (#{columnProperty}); * NOT_NULL: insert into table_a(column) values (#{columnProperty}) * NOT_EMPTY: insert into table_a(column) values (#{columnProperty}) * * @since added v_3.1.2 @2019-5-7 */ FieldStrategy insertStrategy() default FieldStrategy.DEFAULT; /** * 字段验证策略之 update: 当更新操作时,该字段拼接set语句时的策略 * IGNORED: 直接拼接 update table_a set column=#{columnProperty}, 属性为null/空string都会被set进去 * NOT_NULL: update table_a set column=#{columnProperty} * NOT_EMPTY: update table_a set column=#{columnProperty} * * @since added v_3.1.2 @2019-5-7 */ FieldStrategy updateStrategy() default FieldStrategy.DEFAULT; /** * 字段验证策略之 where: 表示该字段在拼接where条件时的策略 * IGNORED: 直接拼接 column=#{columnProperty} * NOT_NULL: column=#{columnProperty} * NOT_EMPTY: column=#{columnProperty} * * @since added v_3.1.2 @2019-5-7 */ FieldStrategy whereStrategy() default FieldStrategy.DEFAULT; /** * 字段自动填充策略 */ FieldFill fill() default FieldFill.DEFAULT; /** * 是否进行 select 查询 *

大字段可设置为 false 不加入 select 查询范围

*/ boolean select() default true; /** * 是否保持使用全局的 Format 的值 *

只生效于 既设置了全局的 Format 也设置了上面 {@link #value()} 的值

*
  • 如果是 false , 全局的 Format 不生效
  • * * @since 3.1.1 */ boolean keepGlobalFormat() default false; /** * JDBC类型(该默认值不代表会按照该值生效) * *
  • {@link ResultMapping#jdbcType}
  • *
  • {@link ParameterMapping#jdbcType}
  • * * @return JDBC类型 * @since 3.1.2 */ JdbcType jdbcType() default JdbcType.UNDEFINED; /** * 类型处理器(该默认值不代表会按照该值生效) * *
  • {@link ResultMapping#typeHandler}
  • *
  • {@link ParameterMapping#typeHandler}
  • * * @return 类型处理器 * @since 3.1.2 */ Class> typeHandler() default UnknownTypeHandler.class; }