安卓數據庫 greenDAO3 使用之一項目配置、增刪改查及升級

博客： 安卓之家
掘金： jp1017
微博： 追風917
CSDN： 蔣朋的家
簡書： 追風917

每日一景

Build Status

配置

---

喜訊：如今greenDAO升級到了3.0版本，不須要java項目了

強烈建議升級到3.0版本，該版本採用註解的方式經過編譯生成Java數據對象和DAO對象，配置更簡單

以前2.0版本的配置也寫過，參考這裏：Android SQLite ORM框架greenDAO在Android Studio中的配置與使用

1 添加依賴

---

項目的gradle腳本：

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.1'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.1.0'
    }
}複製代碼

module的gradle：

apply plugin: 'com.android.application'
apply plugin: 'org.greenrobot.greendao'

android {
    compileSdkVersion 24
    buildToolsVersion "24.0.3"

    defaultConfig {
        applicationId "com.inst.greendao3_demo"
        minSdkVersion 14
        targetSdkVersion 24
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

//greendao配置
greendao {
    schemaVersion 1                             //版本號，升級時可配置
    daoPackage'com.inst.greendao3_demo.dao'     //包名
    targetGenDir'src/main/java'                 //生成目錄
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile 'org.greenrobot:greendao:3.1.1'
}複製代碼

能夠看到，3.0多了個greendao插件，直接在這裏配置實體及DAO生成目錄，個人配置是：

greendao {
    schemaVersion 1                             //版本號，升級時可配置
    daoPackage'com.inst.greendao3_demo.dao'     //包名
    targetGenDir'src/main/java'                 //生成目錄
}複製代碼

這三個字段的意思是：

schemaVersion： 數據庫schema版本，可在這裏升級數據庫版本
daoPackage：設置DaoMaster、DaoSession、Dao包名
targetGenDir：設置DaoMaster、DaoSession、Dao目錄

配置好後，同步下，而後編譯，就會生成 Dao。

2 添加實體類

---

我這裏的是Student實體類，和普通的bean有個區別，添加 @Entity 註解

@Entity
public class Student {

    @Id
    public Long id;
    public String name;
    public String age;
    public String number;
    public String score;
}複製代碼

注意到，變量 id 添加了 @Id 註解，這個就是主鍵了

生成DAO

---

上面配置好後，同步，編譯，便可自動生成DAO, 並自動補全實體類 Student 的getter setter 等方法。

增刪改查

---

上面的操做就完成了數據庫的建立，下面開始對數據庫操做，經常使用的增刪改查。

這裏對基本操做封裝下，參考這裏：Android ORM系列之GreenDao最佳實踐

1 編寫一個核心輔助類DbCore, 用於獲取DaoMaster和DaoSession

public static DaoMaster getDaoMaster() {
    if (daoMaster == null) {
        //此處不可用 DaoMaster.DevOpenHelper, 那是開發輔助類，咱們要自定義一個，方便升級
        DaoMaster.OpenHelper helper = new MyOpenHelper(mContext, DB_NAME);
        daoMaster = new DaoMaster(helper.getWritableDatabase());
    }
    return daoMaster;
}複製代碼

這裏須要注意的是 getDaoMaster 時的 helper 不可用 DaoMaster.DevOpenHelper，咱們須要自定義一個：

由於該類這樣提示咱們：

/* WARNING: Drops all table on Upgrade! Use only during development. /
public static class DevOpenHelper extends OpenHelper

也就是開發中使用的助手，自定義也很簡單：

public class MyOpenHelper extends DaoMaster.OpenHelper {
    public MyOpenHelper(Context context, String name) {
        super(context, name);
    }
}複製代碼

2 基礎的泛型 BaseDbHelper, 封裝基本增刪改查方法，具體看代碼吧

3 實現類，有幾個實體類就有幾個實現類，這裏是 StudentHelper, 僅僅一個構造方法便可

4 一個工具類 DbUtils 得到 Helper

5 在 application 裏初始化

public class DaoApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        //初始化數據庫
        DbCore.init(this);
    }
}複製代碼

6 測試

方法就很簡單了，獲取 helper， 而後 add remove update query

StudentHelper mHelper = DbUtil.getDriverHelper();
//增長一個數據
mFastAdapter.add(stu);
//刪除一個數據
mFastAdapter.remove(stu);
//更新一個數據
mFastAdapter.update(stu);
//查找全部數據
mFastAdapter.queryAll();
//查找數據庫中age大於20的數據
Query<Student> query = mHelper.queryBuilder()
    .where(StudentDao.Properties.Age.ge("20"))
    .build();
dbStudents = query.list();複製代碼

運行程序，添加幾個數據，咱們看下界面及數據庫內容：

數據庫升級

---

今天研究了下升級，掌握方法了仍是蠻簡單的，這裏對數據庫的升級，僅僅是添加字段，添加表。對於刪除，修改字段這裏很少講，由於sqlite數據庫不適合此操做：

SQLite supports a limited subset of ALTER TABLE. The ALTER TABLE command in SQLite allows the user to rename a table or to add a new column to an existing table. It is not possible to rename a column, remove a column, or add or remove constraints from a table.

簡單講就是 SQlite 數據庫僅能重命名錶及增長字段，其餘不支持，若是您必定要操做，也是能夠的，來這裏吧：

SQLite如何刪除，修改、重命名列

1 升級版本號

---

上面咱們說到，在 gradle 裏修改 schemaVersion 便可，如今咱們設置爲2，編譯下，咱們能夠看到 DaoMaster 裏的schema變爲2：

public static final int SCHEMA_VERSION = 2;

2 實體添加字段

---

好比咱們的 Student 添加一個 score 字段， 這個能夠直接寫到 Student 裏：

public String score;複製代碼

編譯後便可生成完整的 Student 實體及 DAO

3 重寫onUpgrade方法升級

---

這個就是重寫 MyOpenHelper 的 onUpgrade 方法，該方法只在 schema 升級時執行一次.

在該方法裏添加 score 字段便可

@Override
public void onUpgrade(Database db, int oldVersion, int newVersion) {
    KLog.w("db version update from " + oldVersion + " to " + newVersion);

    switch (oldVersion) {
        case 1:
            //不能先刪除表，不然數據都木了
// StudentDao.dropTable(db, true);
            StudentDao.createTable(db, true);
            // 加入新字段 score
            db.execSQL("ALTER TABLE 'STUDENT' ADD 'SCORE' TEXT;");

            break;
    }

}複製代碼

4 測試

---

運行代碼後，再添加三個數據，咱們看下界面及數據庫內容：

代碼已上傳至 GitHub：GreenDAO3_Demo

最後，很是感謝您的閱讀，有任何疑問，能夠後面評論，謝謝！

神奇的安卓開發網站：androidcat.com/

安卓開源庫收集整理：github.com/XXApple/And…

分享是一種美德，更是一種生活方式！！

也許你會說我是一個夢想者，但我不是惟一的一個。

悅分享，越快樂^_^

歡迎交流，轉載請註明出處，謝謝！