GreenDao回顧

GreenDao 介紹:
greenDAO是一個對象關系映射(ORM)的框架,能夠提供一個接口通過操作對象的方式去操作關系型數(shù)據(jù)庫,它能夠讓你操作數(shù)據(jù)庫時更簡單、更方便。如下圖所示:


官網(wǎng)地址:http://greenrobot.org/greendao/
github:https://github.com/greenrobot/greenDAO
GreenDao 優(yōu)點:
性能高,號稱Android最快的關系型數(shù)據(jù)庫

內存占用小
庫文件比較小,小于100K,編譯時間低,而且可以避免65K方法限制

支持數(shù)據(jù)庫加密 greendao支持SQLCipher進行數(shù)據(jù)庫加密 有關SQLCipher可以參考這篇博客Android數(shù)據(jù)存儲之Sqlite采用SQLCipher數(shù)據(jù)庫加密實戰(zhàn)

簡潔易用的API

GreenDao 3.0改動:
使用過GreenDao的同學都知道,3.0之前需要通過新建GreenDaoGenerator工程生成Java數(shù)據(jù)對象(實體)和DAO對象,非常的繁瑣而且也加大了使用成本。
GreenDao 3.0最大的變化就是采用注解的方式通過編譯方式生成Java數(shù)據(jù)對象和DAO對象。

三大改變就是:1.換包名 2.實體注解 3.加密支持的優(yōu)化

本文里面會遇到一些代碼示例,就摘了官方文檔和demo里的例子了,因為他們的例子已經(jīng)寫的很好了。

一、GreenDao3的配置
3.0相比2.0的配置較為方便,不用新建Module等一系列操作,可以直接在build.gradle里配置并新建實體用添加注解的方式生成

步驟1/2

build.gradle下添加這些配置(v7包下面的3個是greendao的)

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'org.greenrobot:greendao-gradle-plugin:3.0.0'
    }
}
  
apply plugin: 'org.greenrobot.greendao'
  
dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    testCompile 'junit:junit:4.12'
    compile 'com.android.support:appcompat-v7:23.4.0'
    compile 'org.greenrobot:greendao:3.0.1'
    compile 'org.greenrobot:greendao-generator:3.0.0'
    compile 'net.zetetic:android-database-sqlcipher:3.5.2'
}
  
greendao {
    targetGenDir 'src/main/java'
    daoPackage 'com.XXXX.dao.db'
}

步驟2/2

2.2版本是在maingen里使用addEntity,addProperty等方法,3.0只需要手動創(chuàng)建一個實體類加上注解即可(下面會詳細說)

build項目,自動生成DaoMaster,Daosession,UserDao等文件,接下來就可以在代碼中正常使用了。

二、實體注解
大部分的注解都能找到之前與2.0對應的語法

2.1常用注解

@Entity
public class User {
    @Id(autoincrement = true)
    private Long id;
  
    @Property(nameInDb = "USERNAME")
    private String name;
  
    @NotNull
    private int repos;
  
    @Transient
    private int tempUsageCount;
  
    ...
}

其中

@Entity 用于標識這是一個需要Greendao幫我們生成代碼的bean

@Id 標明主鍵,括號里可以指定是否自增 相當于2.2版本的

Entity entity = schema.addEntity("User");
entity.addLongProperty("id").primaryKey().autoincrement();
@Property 用于設置屬性在數(shù)據(jù)庫中的列名(默認不寫就是保持一致)

@NotNull 非空

@Transient 標識這個字段是自定義的不會創(chuàng)建到數(shù)據(jù)庫表里 相當于2.2版本的

schema.enableKeepSectionsByDefault();

會生成下列代碼
// KEEP INCLUDES - put your custom includes here
// KEEP INCLUDES END

// KEEP FIELDS - put your custom fields here
// KEEP FIELDS END

// KEEP METHODS - put your custom methods here
// KEEP METHODS END
之前想自定義的屬性和其getset方法需要寫在注釋中,現(xiàn)在這個注解就能代替作用

2.2實體類注解

@Entity(
        schema = "myschema",
 
        active = true,
         
        nameInDb = "AWESOME_USERS",
         
        indexes = {
                @Index(value = "name DESC", unique = true)
        },
         
        createInDb = false
)
public class User {
  ...
}

其中

schema是一個項目中有多個schema時 標明要讓這個dao屬于哪個schema

active 是標明是否支持實體類之間update,refresh,delete等操作 相當于2.2版本的

1
schema.enableActiveEntitiesByDefault();
nameInDb 就是寫個存在數(shù)據(jù)庫里的表名(不寫默認是一致)

indexes 定義索引,這里可跨越多個列

CreateInDb 如果是有多個實體都關聯(lián)這個表,可以把多余的實體里面設置為false避免重復創(chuàng)建(默認是true)

2.3索引注解

@Entity
public class User {
    @Id private Long id;
    @Index(unique = true)
    private String name;
}
 
@Entity
public class User {
    @Id private Long id;
    @Unique private String name;
}

其中

@Index 通過這個字段建立索引

@Unique 添加唯一約束,上面的括號里unique=true作用相同

2.4關系注解

@Entity
public class Order {
    @Id private Long id;
  
    private long customerId;
  
    @ToOne(joinProperty = "customerId")
    private Customer customer;
}
  
@Entity
public class Customer {
    @Id private Long id;
}

@ToOne 是將自己的一個屬性與另一個表建立關聯(lián),相當于2.2版本的

1
Property property = entity.addLongProperty("customerId").getProperty();
entity.addToOne(Customer, property);
@ToMany 的使用場景有些多,下面的代碼默認折疊起來

  • View Code
    @ToMany的屬性referencedJoinProperty,類似于外鍵約束。

@JoinProperty 對于更復雜的關系,可以使用這個注解標明目標屬性的源屬性。

@JoinEntity 如果你在做多對多的關系,有其他的表或實體參與,可以給目標屬性添加這個額外的注解(感覺不常用吧)

2.5派生注解

Paste_Image.png

@Generated 這個是build后greendao自動生成的,這個注解理解為防止重復,每一塊代碼生成后會加個hash作為標記。 官方不建議你去碰這些代碼,改動會導致里面代碼與hash值不符。

三、數(shù)據(jù)庫加密
在Greendao的迭代流程中可以看到這么一個庫

1
compile 'org.greenrobot:greendao-generator-encryption:3.0.0beta3'
Greendao3 與下面這個加密庫合作,encryption:3.0.0beta-3相當于一個適配層,之后迭代中并入greendao主庫的3.0.1版本,對database相關的api進行了統(tǒng)一。

1
compile 'net.zetetic:android-database-sqlcipher:3.5.2'
之前的版本也是支持加密的,但是可以理解為在相互api傳遞數(shù)據(jù)的時候面臨各種類型轉換,3.0將其統(tǒng)一,使用更加流暢。

可以直接看寫代碼使用

User man1 = new User();
man1.setId(10001);
man1.setName("kobe");
 
DaoMaster.DevOpenHelper a = new DaoMaster.DevOpenHelper(this,"database_name",null);
try {
    daoSession = new DaoMaster(a.getEncryptedWritableDb(MY_PWD)).newSession();
    daoSession.getUserDao().insert(man1);
 
}catch (Exception e){
    Log.d("e", String.valueOf(e));
}

// 若干代碼邏輯后。。。

DaoSession normalSession = new DaoMaster(a.getWritableDb()).newSession();
Log.d("無法取數(shù)據(jù)",normalSession.getUserDao().loadAll().toString());

DaoSession encryptedSession = new DaoMaster(a.getEncryptedWritableDb(MY_PWD)).newSession();
Log.d("可以取數(shù)據(jù)",encryptedSession.getUserDao().loadAll().toString());
如上方代碼所示,相比于之前的方法getWriteableDb,加密的方法是用了getEncryptedWritableDb。 并在得到DB并getSession時需要輸入密鑰。 其他的步驟和之前類似。

在取數(shù)據(jù)時使用的session必須也是使用相同的密鑰new出來的,否則只能看到空數(shù)據(jù)。

07-27 /com.XXX.dsx.testgreendao3 D/無法取數(shù)據(jù): []
07-27 /com.XXX.dsx.testgreendao3 D/可以取數(shù)據(jù): [com.XXX.dsx.testgreendao3.User@2ae5190]
上面的那個MY_PWD是一個靜態(tài)變量,建議使用本設備的唯一標識類似于UUID的字段做個加密獲得,這樣每個機器的密鑰是不同的,并且不會發(fā)生改變。

如果把加密后的數(shù)據(jù)庫的本地文件扒出來,也是查不到內容的, 使用dump僅僅可以看到表結構和列名。

如果覺得還不滿意,可以對列名再進行加密。在建表時就對列名加密,后續(xù)使用可能會比較麻煩,建議加密一些關鍵表如USER,ACCOUNT。

Gradle 插件配置
比如上面想指定生成DaoMaster 、DaoSession、Dao位置
greendao { targetGenDir 'src/main/java'}

schemaVersion: 數(shù)據(jù)庫schema版本,也可以理解為數(shù)據(jù)庫版本號
daoPackage:設置DaoMaster 、DaoSession、Dao包名
targetGenDir:設置DaoMaster 、DaoSession、Dao目錄
targetGenDirTest:設置生成單元測試目錄
generateTests:設置自動生成單元測試用例

4.)實體@Entity注解
schema:告知GreenDao當前實體屬于哪個schema
active:標記一個實體處于活動狀態(tài),活動實體有更新、刪除和刷新方法
****nameInDb:****在數(shù)據(jù)中使用的別名,默認使用的是實體的類名
******indexes:******定義索引,可以跨越多個列
********createInDb:******標記創(chuàng)建數(shù)據(jù)庫表**

5.)基礎屬性注解
@Id :主鍵 Long型,可以通過@Id(autoincrement = true)設置自增長
@Property:設置一個非默認關系映射所對應的列名,默認是的使用字段名 舉例:@Property (nameInDb="name")
@NotNul:設置數(shù)據(jù)庫表當前列不能為空
@Transient :添加次標記之后不會生成數(shù)據(jù)庫表的列

6.)索引注解
@Index:使用@Index作為一個屬性來創(chuàng)建一個索引,通過name設置索引別名,也可以通過unique給索引添加約束
@Unique:向數(shù)據(jù)庫列添加了一個唯一的約束

7.)關系注解
@ToOne:定義與另一個實體(一個實體對象)的關系
@ToMany:定義與多個實體對象的關系

出處
http://www.cnblogs.com/dsxniubility/archive/2016/07/28/5699543.html

使用參考

step1 創(chuàng)建表對象

@Entity
public class User {
    @Id
    private Long id;
    private String name;
    private int age;
    //下面省去了 setter/getter

}

step3 創(chuàng)建DB幫助類

public class DBManager {
    private final static String dbName = "test_db";
    private static DBManager mInstance;
    private  DaoMaster.DevOpenHelper openHelper;
    private Context context;

    public DBManager(Context context) {
        this.context = context;
        openHelper = new  DaoMaster.DevOpenHelper(context, dbName, null);
    }

    /**
     * 獲取單例引用
     *
     * @param context
     * @return
     */
    public static DBManager getInstance(Context context) {
        if (mInstance == null) {
            synchronized (DBManager.class) {
                if (mInstance == null) {
                    mInstance = new DBManager(context);
                }
            }
        }
        return mInstance;
    }
    /**
     * 獲取可讀數(shù)據(jù)庫
     */
    private SQLiteDatabase getReadableDatabase() {
        if (openHelper == null) {
            openHelper = new  DaoMaster.DevOpenHelper(context, dbName, null);
        }
        SQLiteDatabase db = openHelper.getReadableDatabase();
        return db;
    }
    /**
     * 獲取可寫數(shù)據(jù)庫
     */
    private SQLiteDatabase getWritableDatabase() {
        if (openHelper == null) {
            openHelper = new  DaoMaster.DevOpenHelper(context, dbName, null);
        }
        SQLiteDatabase db = openHelper.getWritableDatabase();
        return db;
    }
    /**
     * 插入一條記錄
     *
     * @param user
     */
    public void insertUser(User user) {
         DaoMaster daoMaster = new  DaoMaster(getWritableDatabase());
         DaoSession daoSession = daoMaster.newSession();
         UserDao userDao = daoSession.getUserDao();
        userDao.insert(user);
    }

    /**
     * 插入用戶集合
     *
     * @param users
     */
    public void insertUserList(List<User> users) {
        if (users == null || users.isEmpty()) {
            return;
        }
         DaoMaster daoMaster = new  DaoMaster(getWritableDatabase());
         DaoSession daoSession = daoMaster.newSession();
         UserDao userDao = daoSession.getUserDao();
        userDao.insertInTx(users);
    }
    /**
     * 刪除一條記錄
     *
     * @param user
     */
    public void deleteUser(User user) {
         DaoMaster daoMaster = new  DaoMaster(getWritableDatabase());
         DaoSession daoSession = daoMaster.newSession();
         UserDao userDao = daoSession.getUserDao();
        userDao.delete(user);
    }
    /**
     * 更新一條記錄
     *
     * @param user
     */
    public void updateUser(User user) {
         DaoMaster daoMaster = new  DaoMaster(getWritableDatabase());
         DaoSession daoSession = daoMaster.newSession();
         UserDao userDao = daoSession.getUserDao();
        userDao.update(user);
    }
    /**
     * 查詢用戶列表
     */
    public List<User> queryUserList() {
         DaoMaster daoMaster = new  DaoMaster(getReadableDatabase());
         DaoSession daoSession = daoMaster.newSession();
         UserDao userDao = daoSession.getUserDao();
        QueryBuilder<User> qb = userDao.queryBuilder();
        List<User> list = qb.list();
        return list;
    }

    /**
     * 查詢用戶列表
     */
    public List<User> queryUserList(int age) {
         DaoMaster daoMaster = new  DaoMaster(getReadableDatabase());
         DaoSession daoSession = daoMaster.newSession();
         UserDao userDao = daoSession.getUserDao();
        QueryBuilder<User> qb = userDao.queryBuilder();
        qb.where( UserDao.Properties.Age.gt(age)).orderAsc( UserDao.Properties.Age);
        List<User> list = qb.list();
        return list;
    }
}

step2 調用db幫助類,測試GreenDao框架

DBManager dbManager = DBManager.getInstance(this);
    for (int i = 0; i < 5; i++) {
        User user = new User();
        user.setId((long) i);
        user.setAge(i * 3);
        user.setName("第" + i + "人");
        dbManager.insertUser(user);
    }
    List<User> userList = dbManager.queryUserList();
    for (User user : userList) {
        Log.e("TAG", "queryUserList--before-->" + user.getId() + "--" + user.getName() +"--"+user.getAge());
        if (user.getId() == 0) {
            dbManager.deleteUser(user);
        }
        if (user.getId() == 3) {
            user.setAge(10);
            dbManager.updateUser(user);
        }
    }
    userList = dbManager.queryUserList();
    for (User user : userList) {
        Log.e("TAG", "queryUserList--after--->" + user.getId() + "---" + user.getName()+"--"+user.getAge());
    }
}
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,646評論 6 533
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,595評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,560評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,035評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,814評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,224評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,301評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,444評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,988評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,804評論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,998評論 1 370
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,544評論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,237評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,665評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,927評論 1 287
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,706評論 3 393
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,993評論 2 374

推薦閱讀更多精彩內容

  • GreenDao 介紹:greenDAO是一個對象關系映射(ORM)的框架,能夠提供一個接口通過操作對象的方式去操...
    小董666閱讀 739評論 0 1
  • 一、關于greenDAO greenDAO應該算是當前最火的數(shù)據(jù)庫開源框架了,它是一個將對象映射到SQLite數(shù)據(jù)...
    當幸福來敲門58閱讀 13,891評論 3 19
  • 序言 (寫分享前的序言)大家好.很高興能為大家分享Android之GreenDao筆記,也希望能和大家一起學習進步...
    王黎聰閱讀 1,100評論 4 11
  • greenDAO greenDAO 是一個將對象映射到 SQLite 數(shù)據(jù)庫中的輕量且快速的 ORM 解決方案。它...
    蕉下孤客閱讀 16,112評論 18 104
  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,785評論 18 139