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<User> 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類 一位大神寫的 直接拿來用即可
地址:https://stackoverflow.com/questions/13373170/greendao-schema-update-and-data-migration/30334668#30334668
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 中的數據也是存在的,只不過 新添加的字段 的值全部為空而已;
提示:如果感覺復雜可以先看看 別人的這篇博客 GreenDao3.0簡單使用 先學基本使用 再來弄版本升級更新也不遲
由於代碼太多,就不一一貼出來了,直接下載源碼即可 源碼點擊下載
不足之處請留言指正!有問題的可以給我留言!謝謝!