GreenDAO簡單使用和升級配置
GreenDAO是一款非要流行的Android平臺上的資料庫框架,效能優秀,程式碼簡潔;是一個將物件對映到SQLite資料庫中的輕量且快速的ORM解決方案。
GreenDAO 優勢
1、一個精簡的庫
2、效能最大化
3、記憶體開銷最小化
4、易於使用的 APIs
5、對 Android 進行高度優化
首先先新增相關配置檔案,依賴庫
compile ‘org.greenrobot:greendao:3.+’
並在庫檔案頂部新增:
apply plugin: ‘org.greenrobot.greendao’
庫檔案下定義路徑
greendao {
schemaVersion 1//指定資料庫版本號,更新操作會用到;
daoPackage ‘com.zhangqie.greendao.gen’//自動生成的dao的包名,包名預設是entity所在的包;
targetGenDir ‘src/main/java’//生成資料庫檔案的目錄
}
在build.gradle檔案中新增配置
buildscript {
repositories {
jcenter()
}
dependencies {
classpath ‘com.android.tools.build:gradle:2.2.3’
classpath ‘org.greenrobot:greendao-gradle-plugin:3.2.1’
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
通過以上操作就完成我們的基本配置了;
建立一個類User
@Entity
public class User {
@Id(autoincrement = true)
private Long id;//主鍵 自增長
@NotNull //不許為空
private String name;
private String age;
private String content;
}
編譯執行專案,User實體類會自動編譯,生成get、set方法並且會在com.zhangqie.greendao.gen目錄下生成三個檔案;
建立Application類 以下是GreenDao的基本的用法 註釋了的 自定義Helper類包含了版本升級更新
public class GreenApplication extends Application {
private DaoMaster.DevOpenHelper mHelper;
//private Helper mHelper;
private SQLiteDatabase db;
private DaoMaster mDaoMaster;
private DaoSession mDaoSession;
public static GreenApplication instances;
@Override public void onCreate() {
super.onCreate();
instances = this;
setDatabase();
}
public static GreenApplication getInstances(){
return instances;
}
/**
* 設定greenDao
*/
private void setDatabase() {
// 通過 DaoMaster 的內部類 DevOpenHelper,你可以得到一個便利的 SQLiteOpenHelper 物件。
// 可能你已經注意到了,你並不需要去編寫「CREATE TABLE」這樣的 SQL 語句,因為 greenDAO 已經幫你做了。
// 注意:預設的 DaoMaster.DevOpenHelper 會在資料庫升級時,刪除所有的表,意味著這將導致資料的丟失。
// 所以,在正式的專案中,你還應該做一層封裝,來實現資料庫的安全升級。
//mHelper = new Helper(new GreenDaoUtils(this));
mHelper = new DaoMaster.DevOpenHelper(this, “notes-db”, null);
db = mHelper.getWritableDatabase();
// 注意:該資料庫連線屬於 DaoMaster,所以多個 Session 指的是相同的資料庫連線。
mDaoMaster = new DaoMaster(db);
mDaoSession = mDaoMaster.newSession();
}
public DaoSession getDaoSession() {
return mDaoSession;
}
public SQLiteDatabase getDb() {
return db;
}
}
MainActivity中
UserDao userDao= GreenApplication.getInstances().getDaoSession().getUserDao();
//獲取物件來完成 增刪改查
1:新增
User user2=new User();
user2.setName("白子畫");
user2.setAge("18");
user2.setContent("我是");long a=userDao.insert(user2); //新增 a>0新增成功
2:刪除
userDao.deleteByKey(1);//id
3:修改
User user3=new User((long)2,”花千骨”,”19”,”你是”);//修改Id=2的一列
userDao.update(user3);
4:查詢
複製程式碼
List users = userDao.loadAll();
String username = “”;
for (int i = 0; i < users.size(); i++) {
username += users.get(i).getId() + “—”+users.get(i).getName() +”\n”;
}
textView.setText(username);
複製程式碼
相關的條件查詢,可下載原始碼檢視;執行效果如下:
版本升級更新
比如需要在實體類加一個欄位 或者 改變欄位屬性等 就需要版本更新來儲存以前的資料了;
我的案例中是加了一個 times的欄位;
1:需要一個MigrationHelper.java類 一位大神寫的 直接拿來用即可
2:接下來就是我們 GreenApplication 類裡的 Helper類了
複製程式碼
public class Helper extends DaoMaster.OpenHelper{
private static DaoMaster daoMaster;
private static DaoSession daoSession;
public static final String DBNAME = "greendao.db";
public Helper(Context context){
super(context,DBNAME,null);
}
@Override
public void onUpgrade(Database db, int oldVersion, int newVersion) {
super.onUpgrade(db, oldVersion, newVersion);
Log.i("version", oldVersion + "---先前和更新之後的版本---" + newVersion);
if (oldVersion < newVersion) {
Log.i("version", oldVersion + "---先前和更新之後的版本---" + newVersion);
MigrationHelper.getInstance().migrate(db, UserDao.class);
//更改過的實體類(新增的不用加) 更新UserDao檔案 可以新增多個 XXDao.class 檔案
// MigrationHelper.getInstance().migrate(db, UserDao.class,XXDao.class);
}
}
/**
* 取得DaoMaster
*
* @param context
* @return
*/
public static DaoMaster getDaoMaster(Context context) {
if (daoMaster == null) {
DaoMaster.OpenHelper helper = new DaoMaster.DevOpenHelper(context,
DBNAME, null);
daoMaster = new DaoMaster(helper.getWritableDatabase());
}
return daoMaster;
}
/**
* 取得DaoSession
*
* @param context
* @return
*/
public static DaoSession getDaoSession(Context context) {
if (daoSession == null) {
if (daoMaster == null) {
daoMaster = getDaoMaster(context);
}
daoSession = daoMaster.newSession();
}
return daoSession;
}
}
完成相關操作之後;還要改資料庫版本
greendao {
schemaVersion 2//改版本號為2
daoPackage ‘com.zhangqie.greendao.gen’;
targetGenDir ‘src/main/java’
}
編譯執行,可以去實體類和UserDao檢視 增加的欄位相關資訊自動生成完成;
當然先前的版本1 中的資料也是存在的,只不過 新新增的欄位 的值全部為空而已;