起因是这样的,公司的项目之前一直是使用sqlite的,不过重构后,就改用realm了(Kontlin对Realm的封装将在后续文章中实现),多OO哦,后来要集成一个Cordova的项目,Cordova中使用了sqlite实现了收藏、下载等功能,而Cordova的sqlite插件不支持二进制流的存储,所以,需要自定义个Cordova插件,进行实现,这时就需要对sqlite进行操作,greendao是一个将对象映射到SQLite数据库中的轻量且快速的ORM解决方案,同时,在2.2之后增加了对sqlcipher的支持,这里我就描述下greendao集成和简单的应用,毕竟我也只是使用了几天:
3.0之前,greendao需要重新建个项目,但是3.0之后,采用注解的方式来定义实体类,通过gradle插件生成相应的代码;
首先在项目的build.gradle中添加依赖:
buildscript {
ext.kotlin_version = '1.0.5-2'
ext.greendao_version = '3.2.1'
repositories {
jcenter()
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.1.2'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
classpath "org.greenrobot:greendao-gradle-plugin:$greendao_version"
}
}
allprojects {
repositories {
jcenter()
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
然后在appmodulebuild.gradle中添加如下:
apply plugin: 'org.greenrobot.greendao'
dependencies {
compile 'org.greenrobot:greendao:3.2.0'
}
如果想自定义路径,则可以在上述文件中添加:
greendao {
schemaVersion 1
daoPackage 'com.vslimit.kotlindemo.dao'
targetGenDir 'src/main/java'
}
但是,请注意但是,前两项设置no problem,但是最后一项添加后,编译gradle始终失败,原因未明;所以,目前,我一直没有添加最后一项;
如果按照官方的教程,这个时候应该build下项目,就应该能看到DaoSession,DaoMaster等类,就可以直接code了,但是,事实上,我编译了很多次,也没有看到生成的DaoSession,DaoMaster等,只是在gradle插件中看到了greendao而已,如图:
这时,需要实现数据库对应的实体类,我们这实现一张User表,字段有id,name,password:
package com.vslimit.kotlindemo.mvp.data;
import org.greenrobot.greendao.annotation.Entity;
import org.greenrobot.greendao.annotation.Id;
import org.greenrobot.greendao.annotation.Generated;
/**
* Created by vslimit on 17/1/21.
*/
@Entity
public class User {
@Id
private Long id;
private String name;
private String password;
@Generated(hash = 1691991404)
public User(Long id, String name, String password) {
this.id = id;
this.name = name;
this.password = password;
}
@Generated(hash = 586692638)
public User() {
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
这时重新编译,就会生成对应的dao等,如下图:
有了这些代码,我们就可以来写我们的实现了:
首先,在App中初始化数据库:
package com.vslimit.kotlindemo
import android.app.Application
import android.content.Context
import android.support.multidex.MultiDex
import com.android.volley.RequestQueue
import com.android.volley.toolbox.HurlStack
import com.android.volley.toolbox.Volley
import com.facebook.stetho.Stetho
import com.squareup.okhttp.OkHttpClient
import com.squareup.okhttp.OkUrlFactory
import com.vslimit.kotlindemo.mvp.data.DaoMaster
import com.vslimit.kotlindemo.mvp.data.DaoSession
import java.io.IOException
import java.net.HttpURLConnection
import java.net.URL
import kotlin.properties.Delegates
class App : Application() {
companion object {
var instance: App by Delegates.notNull()
var queue: RequestQueue? = null
}
private var daoSession: DaoSession? = null
override fun onCreate() {
super.onCreate()
instance = this
queue = initQueue()
Stetho.initializeWithDefaults(this);
initDao()
}
fun initDao() {
val helper = DaoMaster.DevOpenHelper(this, "user")
val db = helper.writableDb
daoSession = DaoMaster(db).newSession()
}
override fun attachBaseContext(base: Context) {
super.attachBaseContext(base)
MultiDex.install(this)
}
fun initQueue(): RequestQueue {
val factory = OkUrlFactory(OkHttpClient())
val hurlStack = object : HurlStack() {
@Throws(IOException::class) override fun createConnection(url: URL): HttpURLConnection {
return factory.open(url)
}
}
return Volley.newRequestQueue(this, hurlStack)
}
open fun getDaoSession(): DaoSession {
return daoSession!!
}
}
如果是使用sqlcipher,只需要将其中的initDao()修改,下面是官方的demo中的代码:
DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this,ENCRYPTED ? "notes-db-encrypted" : "notes-db");
Database db = ENCRYPTED ? helper.getEncryptedWritableDb("super-secret") : helper.getWritableDb();
daoSession = new DaoMaster(db).newSession();
接着,我们在ActivityExtentions.kt进行下扩展:
fun BaseActivity.loadDaoSession() = (application as App).getDaoSession()
然后,我们在UserFragment实现了简单的查询,如果结果集为空,则添加5条数据,否则展示5条数据,代码架构依然是上次说的mvp,这里我就不重复实现了,只贴出查询代码:
override fun loadUsers() {
val qb = mUserDao!!.queryBuilder()
val list = qb.list()
if (list.isEmpty() || list.size <= 0) {
for (i in 0..5) {
val user:User = User()
user.name = "aaa$i"
user.password = i.toString()
list.add(user)
}
mUserDao!!.insertInTx(list)
}
processUsers(list)
}
这样,我就把greendao整合到我们的项目中来了,现在我们可以看看数据库,如图:
这里有一个地方需要注意下,就是我们建表对应的实体类时,需要使用Java来实现,即使通过插件生成对应操作类,最好也不要将Java实现的实体类转为Kotlin,一是没必要,更主要的是,如果哪天我们修改了表结构,以及对应的实体,那么,插件无法对Kotlin实现的实体类,生成对应的操作类,切记切记。
其实,Kotlin实现Android的anko库中,也有对sqlite的封装操作,下一篇考虑就用anko中的方法对sqlite进行封装,不过好像不支持sqlcipher,具体的等下篇文章中详述。
最后再叨一句,在真实项目中整合greendao,还遇到了一些问题,包括编译的问题,运行的问题,有些还在解决中;对了,还有个问题,就是在sqlite中存文件如果超过1m,将读取失败,查了下,说是CursorWindow对Cursor中的内容大小有限制,限制为10241024也就是1M,明天看看能不能用Realm*替代实现下。
本文中的所有代码已经提交到git上了,大家如果喜欢就去git下star下吧。
下期预告:anko实现sqlite的封装
greendao的代码详见:https://github.com/vslimit/kotlindemo