Android数据库ORM框架：GreenDAO使用简介

Android最常用的数据库是SQLite，通常使用SQLite进行CRUD操作需要记住一些常用的SQL语句，这不利于提高开发效率，而且很容易出错。ORM(Object-Relational Mapping)框架的引入使得对数据库的操作也能利用OOP(Object-oriented programming)思想实现。ORM通过将数据库中的一张张表映射成Java的对象，并提供统一的API提供CRUD操作，使得操作数据库变得简单，开发者可以将精力放在处理重要的逻辑，而不是记住SQL语句上。

有几个常用的ORM开源框架，它们的特点比较如下：

其中由GreenRobot公司开源的GreenDAO尤为出色，该开源库体积小，而且由于完全没有使用反射，所以速度很快，本文将介绍GreenDAO的使用。

特点

1. 鲁棒性强, 2011年开始使用
2. 很小, <100k
3. 速度快
4. 安全易用的API
5. 强大的join语句
6. 灵活的属性类型

使用步骤

1. 建立一个java工程，给每张表定义一个对应的Entity，运行工程，生成一系列的输出文件
2. 将这些输出文件拷贝到Android工程里，并在gradle里做相应的配置
3. 可以在Android里通过OOP的方式访问数据库了

首先打开Eclipse，建立一个java工程，引入两个库文件freemarker.jar和greendao-generator-1.3.1.jar，可以开始定义Entity了。

在greenDAO里，一个Entity对应SQLite的一张表，可以给Entity设置Property，Relation和Index，分别代表数据表的属性，关系和索引(一对一，一对多)。

这里的Schema类包含了数据库层面的信息，如数据库版本和名称：

Schema schema = new Schema(1, "me.chunyu.support");

利用Schema，可以给每张表建立一个对应的Entity。Entity包含了Property，Relation和Index。

Property

对Property的设置如下：

public static void addGroupChatRecord(Schema schema) {        
    Entity groupChatRecord = schema.addEntity("GroupChatRecord");     
    groupChatRecord.addStringProperty("messageMD5ID").primaryKey(); // conversation id + message id md5值        
    groupChatRecord.addBooleanProperty("hasRead"); // 是否已读        
    groupChatRecord.addDateProperty("messageTime");        
}

这个Entity命名为GroupChatRecord，记录的是好友群的数据，通过addStringProperty，addBooleanProperty，addDateProperty分别添加类型为String，Boolean和Date的属性，对应数据表里相应的字段，并通过primaryKey()指定messageMD5ID为主键。

Relation

addToOne定义一对一的关系：

Property avatarIdProperty = user.addLongProperty("avatarId").getProperty();
user.addToOne(picture, avatarIdProperty);

上面的代码中，user和picture都是Entity，通过addToOne指定user的头像属性对应picture表里的一条记录。

addToMany定义一对多的关系：

Property customerId = order.addLongProperty("customerId").notNull().getProperty();
ToMany customerToOrders = customer.addToMany(order, customerId);

上面的代码中，通过addToMany指定一个用户(customer)可以对应多个订单(order)。这样，通过customer.getOrders()就可以获取一个用户的所有订单：

List orders = customer.getOrders();

Index

通过给数据表建立索引可以提高检索效率，Index代表数据表的索引，通过addProperty添加索引字段，可以建立独立索引或联合索引。Entity通过addIndex方法添加索引：

Index index = new Index();
index.addProperty(property1);
index.addProperty(property2);
entity.addIndex(index);

定义完Entity后，调用DAOGenerator类的generateAll方法生成DAO文件，参数分布是代表数据库的schema和文件输出路径：

// 生成DAO文件到指定路径
new DaoGenerator().generateAll(schema, "../");

生成的公共文件，包括DaoMaster.java/DaoSession.java，另外每个Entity对应生成两个文件EntityName.java/EntityNameDao.java，文件内容如下：

1. EntityName.java: Entity的各个属性，及get/set方法
2. EntityNameDao.java：Entity的CRUD方法
3. DaoSession.java：提供获取各个EntityNameDao的方法
4. DaoMaster.java：生成DaoSession；进行数据库生成，升级

使用：
首先初始化DaoMaster，然后通过DaoMaster获得DaoSession，样例代码：

public class GreenDaoUtils {    
    private static DaoSession daoSession;    
    private static byte[] _lock = {};    

    /**获取Dao Session**/    
    public static DaoSession getDaoSession(Context context, String dbName) {        
        if (daoSession != null) {            
            return daoSession;        
        }        

        synchronized (_lock) {            
            if (daoSession != null) {                
                return daoSession;            
            }           
            SQLiteDatabase db;            
            DaoMaster daoMaster;            
            
            DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(context, dbName, null);
            db = helper.getWritableDatabase();        
            daoMaster = new DaoMaster(db);        
            daoSession = daoMaster.newSession();      
  
            return daoSession;    
        }
    }
}

代码中getWritableDatabase用于新建或返回数据库，如果第一次执行该代码，新建数据库，以后执行返回已建好的数据库。同时，如果数据库版本升级了，会执行helper的onUpgrade函数，执行升级数据库的操作。

样例代码中helper类型是DaoMaster.DevOpenHelper，该类的onUpgrade函数会删除所有表，再新建所有表，只适用于开发阶段。开发者需要实现自己的OpenHelper，重写onUpgrade函数，指明如何进行数据库的升级。下面是DaoMaster.DevOpenHelper的实现：

public static class DevOpenHelper extends OpenHelper {    
    public DevOpenHelper(Context context, String name, CursorFactory factory) {        
        super(context, name, factory);    
    }    

    @Override    
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {        
        Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables");        
        dropAllTables(db, true);        
        onCreate(db);    
    }
}

使用DAO API进行CRUD操作：

Create:

entityNameDao.insert(newEntity)

Read:

List joes = userDao.queryBuilder()

                    .where(Properties.FirstName.eq("Joe"))

                    .orderAsc(Properties.LastName)

                    .list();

QueryBuilder qb = userDao.queryBuilder();

qb.where(Properties.FirstName.eq("Joe"),

    qb.or(Properties.YearOfBirth.gt(1970),

        qb.and(Properties.YearOfBirth.eq(1970), 
            Properties.MonthOfBirth.ge(10))));

List youngJoes = qb.list();

Update:

entityNameDao.update(newEntity);

Delete:

entityNameDao.deleteByKey(id)
// OR
entityNameDao.delete(note);

执行raw sql语句

除了使用greenDao提供的接口进行增删改查操作，greenDao还提供了执行Sql语句的功能，示例如下：

Query query = userDao.queryBuilder()
    .where(new StringCondition(“_ID IN ” +“(SELECT USER_ID FROM USER_MESSAGE WHERE READ_FLAG = 0)”)
    .build();


Query query = userDao
    .queryRawCreate(  ", GROUP G WHERE G.NAME=? AND T.GROUP_ID=G._ID", "admin");

同时，如果感觉没有得到期望的结果，可以通过下面代码打开greenDao调试功能，输出生成的sql语句进行debug：

QueryBuilder.LOG_SQL = true;
QueryBuilder.LOG_VALUES = true;

参考：
https://github.com/greenrobot/greenDAO
http://greenrobot.org/greendao/documentation/