geenDao使用介绍(一)——如何开始?

本文由本人翻译自greenDao官方文档,转载请注明作者

greenDao简介

greenDao与数据库和Java对象的映射关系

greenDao是一个用于Android的ORM(对象关系映射)工具。它提供了一个面向对象的接口来进行SQlite数据库的操作。greenDao这样的ORM工具可以替你做很多重复的操作,并为你提供一个简单的接口来操作你的数据。

在Gradle中配置greenDao

为了在你的Android项目中使用greenDao,需要在gradle中进行配置并添加依赖库。

// In your root build.gradle file:
buildscript {
    repositories {
        jcenter()
        mavenCentral() // add repository
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.0'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2' // add plugin
    }
}
 
// In your app projects build.gradle file:
apply plugin: 'com.android.application'
apply plugin: 'org.greenrobot.greendao' // apply plugin
 
dependencies {
    compile 'org.greenrobot:greendao:3.2.2' // add library
}

如何开始使用

下面我们通过一个简单的官方项目示例——DaoExample来帮助你开始使用GreenDao。你可以自由克隆这个项目的代码并运行,或者直接在github上查看代码。
DaoExample是一个简单的记录笔记的安卓APP,你可以添加新的笔记,或者点击一个已存在的笔记来删除它。

笔记实体和DAO类(The Note entity and DAO class)

我们直接来看代码,在src目录下你会找到叫Note.java的笔记实体类。这个类包含了一个笔记的所有数据,比如笔记的id,内容,创建时间等信息。

@Entity(indexes = {
    @Index(value = "text, date DESC", unique = true)
})
public class Note {

    @Id
    private Long id;

    @NotNull
    private String text;
    private Date date;
    ...

大致来说,实体类是表示数据库信息的一个类,它的每一个属性,代表了数据库表中相对应的列。
现在开始编译这个项目,比如在Android Studio中使用 Build>Make Project,这会触发greenDao生成DAO(Data Access Object)类,例如这个项目中的NoteDao.java,它可以帮助我们添加笔记到数据库中。

添加和删除笔记

为了学习怎样添加笔记,我们来看NoteActivity.java这个类。首先我们需要为Note这个实体准备一个DAO类,我们在onCreate方法中获取DAO对象。

// get the note DAO
DaoSession daoSession = ((App) getApplication()).getDaoSession();
noteDao = daoSession.getNoteDao();

当用户点击按钮,addNote()方法被执行。在这个方法里,我们创建一个笔记实例,并通过DAO对象的insert()方法将它添加到数据库中。

Note note = new Note();
note.setText(noteText);
note.setComment(comment);
note.setDate(new Date());
note.setType(NoteType.TEXT);
noteDao.insert(note);
Log.d("DaoExample", "Inserted new note, ID: " + note.getId());

在将这个笔记添加到数据库的时候我们没有为其指定id,这种情况下数据库会自动为其设置一个id。
删除一个笔记也非常简单,见NoteClickListener方法:

noteDao.deleteByKey(id);

修改笔记

示例项目中没有修改笔记的操作,不过也非常简单:只要在改变笔记的任何属性之后调用DAO的update方法:

note.setText("This note has changed.");
noteDao.update(note);

除此之外还有其他的一些增、删、改、查的方法,greenDao所有DAO类都继承自the AbstractDao class,可以查看这个类来学习更多的方法。

配置数据库

我们已经学习了DAO类的使用,那么我们是如何初始化greenDao和其内在的数据库呢?一般情况下,我们需要初始化一个DaoSession,通常在项目的the Application class中进行初始化:

DevOpenHelper helper = new DevOpenHelper(this, "notes-db");
Database db = helper.getWritableDb();
daoSession = new DaoMaster(db).newSession();

数据库通过DevOpenHelper这个helper类来创建,这个类由DaoMaster提供,它是DaoMaster中继承自OpenHelper的内部类。它为你做好所有创建数据库的工作,你不需要再写"CREATE TABLE"这样的sql语句。
在activity和fragment中可以通过调用getDaoSession()方法来获得DaoSession并进一步获得实体DAO类,如上面添加和删除笔记那样。

扩展和添加实体类

为了扩展我们的Note类或者创建新的实体类,你只要修改或创建新的java类,然后加上注解,重新Build项目就可以了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,470评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,393评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,577评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,176评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,189评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,155评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,041评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,903评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,319评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,539评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,703评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,417评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,013评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,664评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,818评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,711评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,601评论 2 353

推荐阅读更多精彩内容