android最佳实践9:greenDao在android studio中的使用

greenDao是一个将对象映射到 SQLite 数据库中的轻量且快速的 ORM 解决方案,性能很不错。

greenDao的特点

  • 精简
  • 性能最大化
  • 不使用注解,使用code generate

android studio中的使用

1 android工程配置[greendao generator]模块

1 .src/main目录新建一个与java目录同层的java-gen目录,用于存放由greenDao生成的Bean,Dao,DaoMaster,DaoSession类

2 app的build.gradle添加sourceSets与dependencies

1
2
3
4
5
6
7
8
9
buildTypes{
...

}
sourceSets {
main{
java.srcDirs = ['src/main/java',src/main/java-gen]
}
}
1
2
3
4
5
6
dependencies {
...
compile 'org.greenrobot:greendao:2.2.1'
compile 'org.greenrobot:greendao-generator:2.2.0'
...
}

2 新建greenDao generator模块,纯java工程

1 file->new->new module->java Library->填写包名类名->finish

然后在新工程的build.gradle中添加

1
2
3
4
5
dependencies{
...
compile 'org.greenrobot:greendao-generator:2.2.0'
...
}

2 编写【ExampleDaoGenerator】类,注意: 我们的 Java 工程只有一个类,它的内容决定了「GreenDao Generator」的输出,你可以在这个类中通过对象、关系等创建数据库结构,

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
public class ExampleDaoGenerator {
public static void main(String args[]){
// 正如你所见的,你创建了一个用于添加实体(Entity)的模式(Schema)对象。
// 两个参数分别代表:数据库版本号与自动生成代码的包路径。
Schema schema = new Schema(1, "com.hammer.example");
//当然,如果你愿意,你也可以分别指定生成的 Bean 与 DAO 类所在的目录,只要如下所示:
// 一旦你拥有了一个 Schema 对象后,你便可以使用它添加实体(Entities)了。
addNote(schema);
// 最后我们将使用 DAOGenerator 类的 generateAll() 方法自动生成代码,此处你需要根据自己的情况更改输出目录(既之前创建的 java-gen)。
// 其实,输出目录的路径可以在 build.gradle 中设置,有兴趣的朋友可以自行搜索,这里就不再详解。
try {
new DaoGenerator().generateAll(schema, "E:/androidSpace/android-lesson/BaseLesson/src/main/java-gen");
} catch (Exception e) {
e.printStackTrace();
}
}

/**
* @param schema
*/
private static void addNote(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");
}
}

3 执行run main函数,生成如图4个文件

在android工程进行数据库操作

1 考虑到application的生命周期,把DaoMaster跟DaoSession的实例放到application中,避免重复创建

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

public DaoMaster getDaoMaster(Context context){
if (daoMaster == null){
daoMaster = new DaoMaster(getSQLDB(context));
}
return daoMaster;
}

public SQLiteDatabase getSQLDB(Context context){
if (sqlDB == null){
DaoMaster.OpenHelper helper = new DaoMaster.DevOpenHelper(context, "zlot-db", null);
sqlDB = helper.getWritableDatabase();
}
return sqlDB;
}

public DaoSession getDaoSession(Context context){
if (daoSession == null)
{
if (daoMaster == null)
{
daoMaster = getDaoMaster(context);
}
daoSession = daoMaster.newSession();
}
return daoSession;
}

2 考虑到松耦合性,新增一个Dao的中间层,用来切换不同的Dao实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
public class NoteDaoMiddle {
private NoteDao noteDao;
private ILessonSixActvity lessonSixActvity;
public ArrayList<Note> notes = new ArrayList<>();

public NoteDaoMiddle(ILessonSixActvity lessonSixActvity, DaoSession daoSession){
this.lessonSixActvity = lessonSixActvity;
this.noteDao = daoSession.getNoteDao();
}


public void add(Note note){
Observable.create(subscriber->{
noteDao.insert(note);
notes.add(note);
subscriber.onCompleted();
}).subscribeOn(Schedulers.io()) //指定 subscribe() 发生在 IO 线程
.observeOn(AndroidSchedulers.mainThread()) //指定 Subscriber 的回调发生在主线程
.subscribe(getUpdateSubScriber());
}

public void search(String title){
Observable.create(subscriber->{
//为空
if (TextUtils.isEmpty(title)){
// Query 类代表了一个可以被重复执行的查询
Query<Note> query = noteDao.queryBuilder()
.orderAsc(NoteDao.Properties.Date)
.build();
// 查询结果以 List 返回
notes = (ArrayList<Note>) query.list();
}
else{
Query query = noteDao.queryBuilder()
.where(NoteDao.Properties.Text.eq(title))
.orderAsc(NoteDao.Properties.Date)
.build();
notes = (ArrayList<Note>) query.list();
}

// 在 QueryBuilder 类中内置两个 Flag 用于方便输出执行的 SQL 语句与传递参数的值
QueryBuilder.LOG_SQL = true;
QueryBuilder.LOG_VALUES = true;
subscriber.onCompleted();
})
.subscribeOn(Schedulers.io()) //指定 subscribe() 发生在 IO 线程
.observeOn(AndroidSchedulers.mainThread()) //指定 Subscriber 的回调发生在主线程
.subscribe(getUpdateSubScriber());
}


private Subscriber<Object> getUpdateSubScriber(){

return new Subscriber<Object>() {
@Override
public void onCompleted() {
lessonSixActvity.onUpdateList(notes);
LogUtil.Debug("onCompleted");
}
@Override
public void onError(Throwable e) {
LogUtil.Debug("onError:"+e.toString());
}

@Override
public void onNext(Object o) {
}
};
}
}

3 响应view层的增删查改操作

新建NoteDaoMiddle实例

1
2
3
4
5
6
7
8
9
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
...
daoSession = MyApplication.getIns().getDaoSession(this);
noteDaoMiddle = new NoteDaoMiddle(this,daoSession);

'''
}

响应add search按钮

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
private void addNote(){
//如果新增为空,弹出
if (TextUtils.isEmpty(editText.getText())){
Toast.makeText(this,"add不能为空",Toast.LENGTH_SHORT);
return;
}

'''
// 插入操作,简单到只要你创建一个 Java 对象
Note note = new Note(null, noteText, comment, new Date());
noteDaoMiddle.add(note);

}

private void search(String title) {
noteDaoMiddle.search(title);
}

通过回调或者接口响应查询结果,并通知listview刷新视图

1
2
3
4
5
@Override
public void onUpdateList(ArrayList<Note> notes) {
sixAdapter.setData(notes);
sixAdapter.notifyDataSetChanged();
}

参考

Android ORM 框架 greenDAO 使用经验总结