greendao3.2 数据库增加字段

greenDAO 3.2 生成的字段添加了非空约束。

字段类型为基本类型默认会添加非空约束，字段类型设置为对象类型默认不会添加非空约束，而且最终生成的sql会使用对象类型。

https://github.com/greenrobot/greenDAO/issues/17

关于greenDao的使用

第一篇How to get started ?

原文地址：http://greendao-orm.com/documentation/how-to-get-started/

该教程会带你浏览一个简单的greenDao示例工程。地址：https://github.com/greenrobot/greenDAO，该工程包含两个子工程：

DaoExample和DaoExampleGenerator。你可以clone到本地，运行或者直接在github上直接浏览。

如果你从git仓储中检出了DaoExample，可以直接像Android应用一样运行它。正如你所看到的，它就是一个简单的笔记本。可以添加新的note，

或者点击已存在的note进行删除。

预生成代码和创建表

在src-gen目录下，你可以找到一些已经生成的文件

1）Note.java 一个包含一个Note所有数据的java类。

2）NoteDao.java 一个DAO类，是 *** 作Note 对象的接口。

你可以通过DaoExampleGenerator工程再次生成Note和NoteDao。

使用DaoMaster类可以获得一个方便的SQLiteOpenHelper:

new DaoMaster.DevOpenHelper(this, "notes-db", null)

你不必编写“CREATE TABLE” SQL语句，greenDao会为你完成。

插入和删除Note对象

创建了Note表后，就可以存储一些note到数据库里了。这是在NoteActivity类里完成的。在onCreate方法里，我们准备了一个DAO对象：

1 2 3daoMaster = new DaoMaster(db)daoSession = daoMaster.newSession()noteDao = daoSession.getNoteDao()

添加一个新的note到数据库中：

1 2 3Note note = new Note(null, noteText, comment, new Date())noteDao.insert(note)Log.d("DaoExample", "Inserted new note, ID: " + note.getId())

该示例只是创建并插入了一个java对象。但insert方法返回的时候，数据库的ID已经分发到了刚插入的Note对象上了。在log中可以看到。

删除一条note：非常简单明，在onListItemClick方法中可以看到

1noteDao.deleteByKey(id)

你也可以看一下其它的DAO方法：loadAll、update。

数据模型化和代码的生成

为了扩展note或者创建新的实体，你可以看一下DaoExampleGenerator工程。它包含了一个单例的类，该类中包含了数据模型的定义代码。

1 2 3 4 5 6 7Schema schema = new Schema(1, "de.greenrobot.daoexample")Entity note= schema.addEntity("Note")note.addIdProperty()note.addStringProperty("text").notNull()note.addStringProperty("comment")note.addDateProperty("date")new DaoGenerator().generateAll("../DaoExample/src-gen", schema)

正如你所看到的，你可以创建一个Schema对象，通过它你可以添加实体，一个实体连接了一张数据库表。

一个实体包含一些属性，它们可以被映射到数据库的columns。

一旦schema定义完成，你可以触发代码生成器，Note.java和NoteDao.java文件就是这样被创建的。

下一步：

对greenDao有了初步的了解，你可以自己动手试试了。当然，请查看下文档http://greendao-orm.com/documentation/，

如果没有找到你想要的，可以使用support options

第二篇 介绍

GreenDao是一个用于Android开发的对象/关系映射(ORM)工具。它向SQLite数据库提供了一个对象导向的接口。像GreenDao这样的ORM工具不仅为你省去了很多的重复工作，而且提供了更简便的 *** 作接口。

代码生成的工程结构图

为了在你的Android项目中使用GreenDao，你需要创建一个二级工程：“generator project”，它的任务就是为你的domain生成具体的代码。这个生成器工程就是一个普通的java工程。确保greenDao 的greenDao-generator.jar和 freemarker.jar 在classpath中。创建一个可执行的java类，构建你的实体模型并触发代码生成器，更多细节，可以参看 modelling文档。

核心类

一旦生成了指定的代码，就可以在你的android工程中使用greenDao了。别忘记在你的android工程中引入greenDao的核心jar包：greenDao.jar。以下是GreenDao的一些必要接口。

DaoMaster：

daomaster以一定的模式持有数据库对象（SQLiteDatabase）并管理一些DAO类（而不是对象）。

有一个静态的方法创建和drop数据库表。它的内部类OpenHelper和DevOpenHelper是SQLiteOpenHelper的实现类，用于创建SQLite数据库的模式。

DaoSession：

管理指定模式下所有可用的DAO对象，你可以通过某个get方法获取到。DaoSession提供一些通用的持久化方法，比如对实体进行插入，加载，更新，刷新和删除。最后DaoSession对象会跟踪identity scope，更多细节，可以参看 session文档。

DAOs（Data access objects）:

数据访问对象，用于实体的持久化和查询。对于每一个实体，greenDao会生成一个DAO，相对于DaoSession它拥有更多持久化的方法，比如：加载全部，插入（insertInTx，语境不明了，暂且简单的翻译成插入）。

实体

可持久化的对象。通常，实体可以被生成，不用手动去写。在数据库的行中，使用的都是标准的java对象的属性（比如POJO或者JavaBean）。

1 2 3 4user.addIdProperty()user.addStringProperty("name")user.addStringProperty("password")user.addIntProperty("yearOfBirth")

在示例中有一个Note实体，通过它的DAO，我们可以对指定的实体进行持久化的 *** 作。

第三篇 实体的模型化

使用greenDao的第一步：创建一个代表持久化数据的实体模型。greenDao会依赖该模型为Dao生成java代码。

该模型本身是用java代码定义的，很简单：在DaoExampleGenerator工程的基础上创建一个java对象。具体你可以参看：

http://greendao-orm.com/documentation/how-to-get-started/

下面的插图描绘了元模型，展示了一些用于描述domain具体模型的类。

Schema

实体数据schema是你定义的第一个对象，通过schema的版本和缺省的java包调用构造器。

1Schema schema = new Schema(1, "de.greenrobot.daoexample")

这个缺省的java包会在greenDao生成实体、DAOs、和JUnit测试的时候使用。如果那些缺省值是正确的，那么就完成了第一步。

如果你希望将DAO和测试类创建到不同的包中，可以重新定义schema的定义代码：

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

对于实体，该schema也有两个缺省的标记，它们是可以被复写的。这些标记可以区分实体是否是激活状态，是否应该使用sections。这些特性在文档里并没有，你可以看一下发布源码中的测试工程。

1 2schema2.enableKeepSectionsByDefault()schema2.enableActiveEntitiesByDefault()

实体

一旦你拥有了一个schema对象，你就可以使用它去添加实体了。

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

一个实体有不同的可变更设置，更重要的是，你可以添加一些属性到实体。

1 2 3 4user.addIdProperty()user.addStringProperty("name")user.addStringProperty("password")user.addIntProperty("yearOfBirth")

除了实体，还可以添加，一对一和一对多的关系。

属性和主键

以上的实体部分展示了如何给一个实体添加属性，实体的addXXXProperty方法返回一个PropertyBuilder对象，可以用于配制属性，

例如，使用columnName去复写缺省的或者你提供的column name。在ProperyBuilder对象上调用getProperty方法去访问属性对象，

对于指数（indices ）和关系的创建是有必要的。

创建主键的约束

现在实体必须拥有一个long或者Long类型的属性作为它们的主键，这是Android和SQLite推荐的实践方式。因为，在将来，greenDao要准备处理很多主键的脚本，但并不是每件事都能完全实现。为了解决这个问题，你可以使用一个long类型的键并且使用一个唯一的下标去处理这个预期的key属性。

缺省

greenDao会尝试以合理的缺省值进行工作，所以开发者不用单个的配置它们。比如，表和其列名是从实体和属性名中获取到的，而不是java中的驼峰。缺省的数据库名是大写的，单词间用下划线分隔开。比如：属性“creationDate”在数据库列中的映射为“CREATION_DATE”，

关系

一对多和多对多的关系在http://greendao-orm.com/documentation/relations/中有注释。

继承、接口、序列化

实体可以从其他非实体类继承，其父类可以通过setSuperclass(String)方法指定，注意：它可能会有其它的实体作为父类（但这里没有多态查询）。

比如：

1myEntity.setSuperclass("MyCommonBehavior")

通常，使用接口作为实体属性和行为的通用基类是比较好的。比如：一个实体A和B共享了一套属性，这些属性可以定义在C中。下面是一个序列化B的列子：

1 2 3entityA.implementsInterface("C")entityB.implementsInterface("C")entityB.implementsSerializable()

触发生成器

一旦你的实体schema放置好了，你可以触发代码生成器进行处理。在generator工程中，你可以实例化DaGenerator并调用generateAll中的一个方法：

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

你所需要的就是schema对象和目标文件夹，通常该文件夹就是你android工程的资源文件夹。如果你想把这些测试类放到其他目录下，可以把目的文件夹作为第三个参数传入。

保持独立性（Keep sections 保持自定义的代码不会被覆盖）

实体类在每一次生成器运行的时候都会被覆盖。greenDao允许添加自定义的代码到实体，通过“keep” ，可以满足它们。在schema中使用enableKeepSectinsByDefault()，或者setHasKeepSections(true)在选中的实体中。一旦使用，3个独立的部分会在实体中生成：

1 2 3 4 5 6 7 8// KEEP INCLUDES - put your custom includes here // KEEP INCLUDES END ... // KEEP FIELDS - put your custom fields here // KEEP FIELDS END ... // KEEP METHODS - put your custom methods here // KEEP METHODS END

现在，你可以在 KEEP [...] and KEEP [...] END.中写入你的代码。注意，不要修改KEEP注释。在该范围的代码会在代码重新生成的时候不被覆盖。对于备份或者提交代码时出现的意外错误，这是一个不错的选择解决方案。

一.下载GreenDao

要使用肯定要先下载他的软件包了，官网上有它的连接，对于marven和gradle环境直接到serarch.maven.org上下载jar包就好了。

下载的jar导入到工程里面就可以了，通常都是/libs目录下。

上面那个下载地址下载解压后有三个文件如下图

首先我们要创建java generator工程greendao-generator-1.3.0.jar 和 freemarker-2.3.20.jar是我们创建java generator工程时生成Dao文件需要用到的（什么是我说的Dao文件，往下看就会知道）

greendao-1.3.7.jar是Android开发中需要用到的

二.创建generator工程（用来生成GreenDao开发过程中需要的java文件）

（1）创建Java工程（非Android工程） 

（2）导入greenDao-generator.jar和freemarker.jar两个包。freemarker是一个用java写的模板引擎，它能够基于模板来生成文本输出。应该就是用来自动生成DAO文件的。eclipse下面就是在properties –>Java build path –>libraries下面导入jar包。 

（3）创建一个包javagreendao 

（4）创建一个类，类名为ExampleDaoGenerator，类的定义如下：

package javagreendao

import de.greenrobot.daogenerator.DaoGenerator

import de.greenrobot.daogenerator.Entity

import de.greenrobot.daogenerator.Property

import de.greenrobot.daogenerator.Schema

import de.greenrobot.daogenerator.ToMany

/**

* Generates entities and DAOs for the example project DaoExample.

*

* Run it as a Java application (not Android).

*

* @author Markus

*/

public class ExampleDaoGenerator

{

   //总之main函数就执行了下面几个函数                                                                                                                                                                                                                                             

   public static void main(String[] args) throws Exception

   {

   // 参数3是数据库版本号，“com.cn.speedchat.greendao”是包名，也就是说生成的Dao文件会在这个包下，可以将Schema理解为数据库上下文吧

        Schema schema = new Schema(3, "com.cn.speedchat.greendao")

        //addNote() addSession() addReplay()这三个函数相当于建立了三个表，表名你都可以不用管了会自动生成

       addNote(schema)     

       addSession(schema)

       addReplay(schema)

       addCustomerOrder(schema)

   //这个是生成Dao文件的路径的位置，这个代表当前工程的上一级目录的javagreendao的src-gen文件夹里面，其实就是跟src同一级目录，所以你自己要在src同一级目录下新建一个src-gen文件夹待会要生成的文件

       new DaoGenerator().generateAll(schema, "../javagreendao/src-gen")   

   }

     //这个是一个Note表,然后后面的node.add***是表的字段名以及属性                                                                                                                                                                                          

   private static void addNote(Schema schema)                

   {

       //"MqttChatEntity"相当于是表的类名，用MqttChatEntity生成对象就可以访问这个表属性了，也就是这个表对应了这个类，待会使用你就会明白了

       Entity note = schema.addEntity("MqttChatEntity")   

       note.addIdProperty().autoincrement()

       note.addIntProperty("mode").notNull()

       note.addStringProperty("sessionid").notNull()

       note.addStringProperty("from").notNull()

       note.addStringProperty("to").notNull()

       note.addStringProperty("v_code")

       note.addStringProperty("timestamp").notNull()

       note.addStringProperty("platform")

       note.addStringProperty("message")

       note.addBooleanProperty("isread").notNull()

       note.addLongProperty("gossipid")

       note.addStringProperty("gossip")

       note.addIntProperty("chattype").notNull()

       note.addStringProperty("imagepath")

       note.addStringProperty("base64image")

   }

   //这个是一个Session表,然后后面的node.add***是表的字段名以及属性（这是我写的会话的一个表）

   private static void addSession(Schema schema)    

   {

       Entity note = schema.addEntity("SessionEntity")

       note.addIdProperty().autoincrement()

       note.addStringProperty("sessionid").notNull().unique()

       note.addStringProperty("from").notNull()

       note.addStringProperty("to").notNull()

       note.addLongProperty("gossipid").notNull()

       note.addStringProperty("gossip")

       note.addIntProperty("sessiontype").notNull()

       note.addBooleanProperty("asdasd").notNull()

   }

 //这个是一个Replay表,然后后面的node.add***是表的字段名以及属性（这是我写的回复的一个表）

   private static void addReplay(Schema schema)

   {

       //ReplayEntity对应的类名

       Entity note = schema.addEntity("ReplayEntity")   

       note.addIdProperty().autoincrement()

       note.addIntProperty("mode").notNull()

       note.addStringProperty("from").notNull()

       note.addStringProperty("to").notNull()

       note.addStringProperty("v_code")

       note.addStringProperty("timestamp").notNull()

       note.addStringProperty("platform")

       note.addStringProperty("message")

       note.addIntProperty("msgtype").notNull()

       note.addBooleanProperty("isread").notNull()

   }

   //这个不用管了，照抄吧

   private static void addCustomerOrder(Schema schema)    

   {

       Entity customer = schema.addEntity("Customer")

       customer.addIdProperty()

       customer.addStringProperty("name").notNull()

       Entity order = schema.addEntity("Order")

       order.setTableName("ORDERS")// "ORDER" is a reserved keyword

       order.addIdProperty()

       Property orderDate = order.addDateProperty("date").getProperty()

       Property customerId = order.addLongProperty("customerId").notNull().getProperty()

       order.addToOne(customer, customerId)

       ToMany customerToOrders = customer.addToMany(order, customerId)

       customerToOrders.setName("orders")

       customerToOrders.orderAsc(orderDate)

   }                                                                                                                                                                                                                                                                                                              

}

1）增加表如果你自己想加一些其他的表的话，你可以自己按照addSession，addNote ,addReplay三个函数的方式加，类名、字段名可以自己随便取比如说，比我我要加一个用户表，字段包括name,age,sex三个，我可以这样做

 private static void addUser(Schema schema)  

   {

       Entity note = schema.addEntity("UserEntity")   

       note.addIdProperty().autoincrement()

       note.addStringProperty("name").notNull()

       note.addIntProperty("age").notNull()

       //true代表男，false代表女

       note.addBooleanProperty("sex").notNull()   

   }

然后在main函数里面做如下调用

   public static void main(String[] args) throws Exception

   {

       Schema schema = new Schema(3, "com.cn.speedchat.greendao")   

       addNote(schema)       

       addSession(schema)

       addReplay(schema)

       addUser(schema)

       addCustomerOrder(schema)

       new DaoGenerator().generateAll(schema, "../javagreendao/src-gen")

   }

2）删除表当然一些不需要的表你可以不用，删掉就行，比如说你不须要addReplay，你就在main函数里面别调用addReplay(schema)就行

总之呢，这就是一个基于greenDao-generator.jar和freemarker.jar两个包的java工程

然后运行该工程，控制台打印出如下结果：

greenDAO Generator Copyright 2011-2013 Markus Junginger,

greenrobot.de. Licensed under GPL V3. This program comes with

ABSOLUTELY NO WARRANTY Processing schema version 3… Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/MqttChatEntityDao.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/MqttChatEntity.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/SessionEntityDao.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/SessionEntity.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/ReplayEntityDao.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/ReplayEntity.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/CustomerDao.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/Customer.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/OrderDao.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/Order.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/DaoMaster.java

Written

/home/csm/workspace/javagreendao/src-gen/com/cn/speedchat/greendao/DaoSession.java

Processed 5 entities in 189ms

这代表成功的生成了Dao文件，然后我们按F5刷新该工程，在查看src-gen目录文件，自动生成了很多java文件，这就是我们要的，我这里截图给大家看

但是有很多错误是不是，没关系，这个工程识别不了这些文件，这些文件是基于greendao-1.3.7.jar包的，是Android工程里面要用到的。先不管这个java工程了。

---