程序包 cn.zhxu.bs.bean

Annotation Interface DbField

@Retention(RUNTIME) @Target(FIELD) public @interface DbField
用于注解一个可检索 bean 的属性 来指定属性对应数据库的哪张表的哪个字段，可与 SearchBean 配合使用 不可与 DbIgnore 在同一字段上使用 v3.0.0 后该注解可以缺省，缺省时, 如果 @SearchBean 注解同时缺省 tables 或指定了 autoMapTo，则根据 DbMapping 自动映射到表字段
从以下版本开始:
v1.0.0
作者:
Troy.Zhou @ 2017-03-20

  • 可选元素概要

    可选元素
    修饰符和类型
    可选元素
    说明
    String
    alias
    用于指定字段别名，不指定时将自动生成
    Cluster
    cluster
    用于指定该字段是否是聚合字段
    boolean
    conditional
     
    String
    mapTo
    用于指定该字段映射到哪张表
    String
    name
    字段属性名，用于衍生字段参数，不指定时，默认为实体类的属性名
    Class<? extends FieldOp>[]
    onlyOn
    用于指定该字段只允许接受的运算符，为空时，表示任意运算符都接受
    DbType
    type
    数据库字段类型，当被该注解标记的字段作为检索条件时，该属性用于对用户传入的字段值进行转换
    String
    value
    用于指定属性对应数据库的哪张表的哪个字段，例如: u.username 别名 u 由 @SearchBean 注解的 tables 值指定 v3.0.0 后可空，为空时以字段名映射列名

  • 元素详细资料

    • name

      String name
      字段属性名，用于衍生字段参数，不指定时，默认为实体类的属性名
      返回:
      字段属性名
      从以下版本开始:
      v4.1.0
      默认值:
      ""

    • value

      String value
      用于指定属性对应数据库的哪张表的哪个字段，例如: u.username 别名 u 由 @SearchBean 注解的 tables 值指定 v3.0.0 后可空，为空时以字段名映射列名
      返回:
      数据库字段
      默认值:
      ""

    • mapTo

      String mapTo
      用于指定该字段映射到哪张表
      返回:
      数据库表名 或 别名
      从以下版本开始:
      v4.1.0
      默认值:
      ""

    • conditional

      boolean conditional
      返回:
      该字段是否可以被作为检索条件
      从以下版本开始:
      v3.0.0
      默认值:
      true

    • onlyOn

      Class<? extends FieldOp>[] onlyOn
      用于指定该字段只允许接受的运算符，为空时，表示任意运算符都接受
      返回:
      Operator[]
      从以下版本开始:
      v3.0.0
      默认值:
      {}

    • alias

      String alias
      用于指定字段别名，不指定时将自动生成
      返回:
      字段别名
      从以下版本开始:
      v3.5.0
      默认值:
      ""

    • type

      DbType type
      数据库字段类型，当被该注解标记的字段作为检索条件时，该属性用于对用户传入的字段值进行转换
      返回:
      DbType
      从以下版本开始:
      v3.8.0
      默认值:
      UNKNOWN

    • cluster

      Cluster cluster
      用于指定该字段是否是聚合字段

      如果是聚合字段，当字段传入条件，则在分组（groupBy）查询时，该条件会放入 having 语句中。

      返回:
      FieldType
      从以下版本开始:
      v4.1.0
      默认值:
      AUTO