在AndroidStudio中使用GreenDAO

GreenDAO是一个移动开发的ORM框架，是当前最火的一个数据库开源框架。本文介绍如何在Android Studio中引入GreenDAO。

1.配置工程

1）在./src/main下面创建一个与java同级的java-gen文件夹

2）在build.gradle中加入

sourceSets {
    main {
        java.srcDirs = ['src/main/java', 'src/main/java-gen']
    }
}

这句话是为了把java-gen文件夹下的java文件也归入到srcDir中，程序就是通过这个文件夹下的几个java里的函数来操作数据库。

3）在dependencies中加入

compile 'de.greenrobot:greendao:1.3.7'

结果如图：

2.下载示例程序

地址：示例程序

1）将这个工程里的MyDaoGenerator文件夹拷贝到与app文件夹同层的目录里。在setting.gradle中修改内容：

include':app',':MyDaoGenerator'

这是为了把MyDaoGenerator include到工程中。

2）Clean Project。此时MyDaoGenerator.java已经显示正确引入到工程中（文件右下角没有红色的标志）。

3）打开MyDaoGenerator的build.gradle文件，配置outputDir，路径就是存放自动生成的java的那个包的路径，如：

def outputDir = "../app/src/main/java-gen"

此时完成所有GreenDAO环境的配置。

3.创建DAO.java等文件

1）

打开MyDaoGenerator工程中的MyDaoGenerator.java：

public class MyDaoGenerator {

    public static void main(String args[]) throws Exception {
        // 正如你所见的，你创建了一个用于添加实体（Entity）的模式（Schema）对象。
        // 两个参数分别代表：数据库版本号与自动生成代码的包路径。
        Schema schema = new Schema( 1, "com.example.bean");

        //schema.setDefaultJavaPackageDao("com.example.dao");
        // DaoMaster.java、DaoSession.java、BeanDao.java会放到/java-gen/com/example/dao中

        // 上面这两个文件夹路径都可以自定义，也可以不设置

        initNote(schema); // 初始化表了

        new DaoGenerator().generateAll(schema, args[0]);// 自动创建(这里的args[0]就是调用刚才设定的目录）
    }
    private static void initNote(Schema schema){
        // 一个实体（类）就关联到数据库中的一张表，此处表名为「Note」（即类名）
        Entity note = schema.addEntity("Note");
        // 你也可以重新给表命名
        // note.setTableName("NODE");

        // greenDAO 会自动根据实体类的属性值来创建表字段，并赋予默认值
        // 接下来你便可以设置表中的字段：
        note.addIdProperty();
        note.addStringProperty("text").notNull();
        // 与在 Java 中使用驼峰命名法不同，默认数据库中的命名是使用大写和下划线来分割单词的。
        // For example, a property called “creationDate” will become a database column “CREATION_DATE”.
        note.addStringProperty("comment");
        note.addDateProperty("date");
    }

}

2）此时在AndroidStudio的Gradel面板中执行run任务：（如果显示nothing to show，点击这个刷新按钮）

可以在消息栏里看到：

此时在java-gen下面可以看到已经自动生成了4个java文件：

DaoMaster：一看名字就知道它是Dao中的最大的官了。它保存了sqlitedatebase对象以及操作DAO classes（注意：不是对象）。其提供了一些创建和删除table的静态方法，其内部类OpenHelper和DevOpenHelper实现了SQLiteOpenHelper并创建数据库的框架。

DaoSession：会话层。操作具体的DAO对象（注意：是对象），比如各种getter方法。

XXXDao：实际生成的某某DAO类，通常对应具体的java类，比如NoteDao等。其有更多的权限和方法来操作数据库元素。

XXXEntity：持久的实体对象。通常代表了一个数据库row的标准java properties。

4.在Android程序中调用

1）在继承自Application中的java文件中取到DaoMaster对象：（官方推荐将取得DaoMaster对象的方法放到Application层这样避免多次创建生成Session对象，在Application实现得到DaoMaster和DaoSession的方法）：

helper = new DaoMaster.DevOpenHelper(this, "Note", null);
db = helper.getWritableDatabase();
// 注意：该数据库连接属于 DaoMaster，所以多个 Session 指的是相同的数据库连接。
daoMaster = new DaoMaster(db);
daoSession = daoMaster.newSession();

2）在Activity中利用Dao进行插入，搜索，删除等操作：

Note note = new Note(null, noteText, comment, new Date());
getNoteDao().insert(note);

 

Query query = getNoteDao().queryBuilder()
        .where(NoteDao.Properties.Text.eq(noteText))
        .orderAsc(NoteDao.Properties.Date)
        .build();
// 查询结果以 List 返回
List notes = query.list();
ToastUtils.show(getApplicationContext(), "There have " + notes.size() + " records");

 

getNoteDao().deleteByKey(id);

注：生成的db文件可以root后用Root Explorer在data-data文件夹下找到对应的包名，在databases里看到。

最后附上整个程序：Example