Android GreenDao常用注解

@Entity -- 实体注解

public @interface Entity {

    /**
     * 在数据库中表的名称，默认为实体的类名 
     */
    String nameInDb() default "";

    /**
     *  定义索引，可以跨越多个列(默认为实体类成员变量的个数) 
     */
    Index[] indexes() default {};

    /**
     * 标记创建数据库表 
     * 若一个表映射多个实体类或者创建表外应的GreenDao,设置为false 
     */
    boolean createInDb() default true;

    /**
     *  告知GreenDao当前实体属于哪个schema 
     */
    String schema() default "default";

    /**
     *  实体活动状体标志位(默认为false) 
     *  若设置为true，实体有更新、删除和刷新方法 
     */
    boolean active() default false;
  }

@NotNull-- 设置表中当前列的值不可为空
@Convert-- 指定自定义类型(@link PropertyConverter)

public @interface Convert {  
    /** 转换类*/  
    Class converter();  
  
    /** 
     * 在数据库中持久化的列 
     * 此受限于GreenDao所支持的类 
     */  
    Class columnType();  
}

@Generated-- GreenDao运行所产生的构造函数或者方法，被此标注的代码可以变更或者下次运行时清除

public @interface Generated {  
    int hash() default -1;  
}

@Id-- 主键 Long型，可以通过@Id(autoincrement = true)设置自增长。通过这个注解标记的字段必须是Long，数据库中表示它就是主键，并且默认是自增的。

public @interface Id {  
    /** 
      * 设置是否为自增长，默认为false 
      */  
    boolean autoincrement() default false;  
}

@Index-- 使用@Index作为一个属性来创建一个索引；定义多列索引(@link Entity#indexes())

public @interface Index {  
    /** 
     * 通过逗号间隔创建表的属性索引，例如 “propertyA，propertyB，propertyC” 
     * 若要指定排序, 需在列明以后添加 ASC(升序) 或者DESC(降序) ,  例如 "propertyA DESC, propertyB ASC" 
     *  只有实体类中使用 {@link Entity#indexes()} 才可设置 
     */  
    String value() default "";  
  
    /** 
     * 表的可选索引 
     * 默认为实体类中的成员变量 
     */  
    String name() default "";  
  
    /** 
     * 是否为属性设置唯一属性，默认为false 
     */  
    boolean unique() default false;  
}

@JoinEntity-- 定义表连接关系

public @interface JoinEntity {  
    /** 添加的实体类 */  
    Class entity();  
  
    /** 源表的列索引 */  
    String sourceProperty();  
  
    /** 连接表内拥有源实体的属性*/  
    String targetProperty();  
}

@JoinProperty-- 定义名称和引用名称属性关系

public @interface JoinProperty {  
    /** 实体中的名称，对应于引用的名称 */  
    String name();  
  
    /** 引用的名称 */  
    String referencedName();  
}

@Keep-- 注解的代码段在GreenDao下次运行时保持不变
1.注解实体类：默认禁止修改此类
2.注解其他代码段，默认禁止修改注解的代码段
@OrderBy-- 指定排序

public @interface OrderBy {  
    /** 
     * 通过逗号间隔创建表的属性索引，例如 “propertyA，propertyB，propertyC” 
     * 若要指定排序, 需在列明以后添加 ASC(升序) 或者DESC(降序) ,  例如 "propertyA DESC, propertyB ASC" 
     *  默认按升序排序 
     *  若不设置默认根据主键排序 
     */  
    String value() default "";  
}

@Property-- 设置一个非默认关系映射所对应的列名，默认是的使用字段名举例：@Property (nameInDb="name")

public @interface Property {  
    /** 
     * 默认是的使用字段名 
     */  
    String nameInDb() default "";  
}

@ToMany-- 定义与多个实体对象的关系

public @interface ToMany {  
    /** 
     * 目标实体持有源实体的名称 
     * 此必须设置，否则有 {@link JoinProperty} or {@link JoinEntity} 指定 
     */  
    String referencedJoinProperty() default "";  
  
    /** 
     * 将源表列索引->目标列 
     * 此必须设置，否则有 {@link JoinProperty} or {@link JoinEntity} 指定 
     */  
    JoinProperty[] joinProperties() default {};  
}

@ToOne-- 定义与另一个实体（一个实体对象）的关系

public @interface ToOne {  
    /** 
     * 表中相关实体的属性名称 
     * 如果该参数不存在，则附加列会自动创建保存密钥 
     */  
    String joinProperty() default "";  
}

@Transient-- 添加次标记之后不会生成数据库表的列
@Unique-- 向数据库列添加了一个唯一的约束

Android GreenDao常用注解

你可能感兴趣的:(Android GreenDao常用注解)