GreenDao_3.创建Entity

Modelling entities

创建Entity

第一步在项目中使用greenDAO就是去创建一个你要使用的entity。基于这个entity，greenDAO 会帮你生成其Dao类的java代码。
模型本身是用java代码定义。创建一个基于java的DaoExampleGenerator工程项目是非常容易的。看一下怎么开始使用GreenDao。
插图描绘了元模型。这是用来描述你的特定领域模型的类。

Schema

Entities 属于一个schema。schema是你第一个定义的对象。调用构造方法如下：

//schema version: 1
// default java package:de.greenrobot.daoexample
Schema schema = new Schema(1, "de.greenrobot.daoexample");

默认java包名用于在greenDAO 生成Entity、DAOs和JUnit tests的时候。当在你的项目中这些类都生成了，则你完成这一步骤。
当你想要生成DAO 和tests在默认java 包下时，可以使用一下代码：

schema.setDefaultJavaPackageTest("de.greenrobot.daoexample.test");
schema.setDefaultJavaPackageDao("de.greenrobot.daoexample.dao");

schema 也有两个可以被重写的默认标示。其中一个是表示if entities are active,另一个表示if keep sections should be used。

schema2.enableKeepSectionsByDefault();
schema2.enableActiveEntitiesByDefault();

Entities（实体）

一旦你有了一个schema 对象，你就可以往schema 中添加entity。

Entity user = schema.addEntity("User");

一个entity有好几个你可以改变的设置项，并且你也可以往里面添加属性：

user.addIdProperty();
user.addStringProperty("name");
user.addStringProperty("password");
user.addIntProperty("yearOfBirth");

除了添加属性，你也可以为entity添加一对一、一对多关系 。

Properties and primary keys（属性和主键）

前面的entity部分讲解了怎么去为entity添加属性。调用addXXXProperty这个方法去添加属性，同时该方法会返回一个用于配置属性PropertyBuilder 对象。

现有的主键（PK）的限制：

当前entities 一定要有一个long或Long的属性作为主键。这个在Android和SQLite是被推荐使用的。在将来GreenDao会去处理任何类型作为主键的问题，但是现在你还是要遵循“当前entities 一定要有一个long或Long的属性作为主键“。

Defaults（默认值）

greenDAO 尝试使用合理的默认值，这个不需要开发者去配置。例如，数据库的表和列名称来自entity名称和属性名称。默认的数据库名称以大写使用下划线分隔单词的命名规则，而不是使用java骆驼式命名规则。例如，一个属性名为“creationDate”将成为一个数据库列名“CREATION_DATE”。

Relations（关系）

查看一对一、一对多关系

Inheritance, Interfaces, and Serializable（继承、接口、序列化）

Entity可以从继承自另一个non-entity class。注意，目前不支持Entity可以从继承自另一个Entity class。

myEntity.setSuperclass("MyCommonBehavior");

// 实现接口
entityB.implementsInterface("C");
// 序列化
entityB.implementsSerializable();

JavaDoc and annotations（java注释和注解）

Entity 允许你添加java注释和注解到Entity和属性上面。

// 为Entity添加java注释和注解
// 添加java注释， \n用于换行
myEntity.setJavaDoc("This is an hell of an entity.\nIt represents foos and bars.");
//设置注解 
myEntity.setCodeBeforeClass("@Awesome");

// 为Entity的属性 添加java注释和注解
myEntity.addIntProperty("counter")
//设置注解 
  .codeBeforeField("@SerializedName(\"the-number-of-things\")")
  //添加java注释， \n用于换行
  .javaDocGetterAndSetter("The total count");

在PropertyBuilder中提供了一下方法：codeBeforeField, codeBeforeGetter, codeBeforeGetterAndSetter, codeBeforeSetter, javaDocField, javaDocGetter, javaDocGetterAndSetter 和javaDocSetter。

Triggering generation（代码生成）

当你已经写好你要的Schema、Entity，就可以使用一下代码去生成相关的类。

DaoGenerator daoGenerator = new DaoGenerator();
daoGenerator.generateAll(schema, "../MyProject/src-gen");