本文由本人翻译自greenDao官方文档,转载请注明作者
greenDao简介
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项目就可以了。