Android 中資料庫框架GreenDao與LitePal對比、整合、使用詳解,greendao與原生SQLite效能對比
2.LitePal框架詳解。【操作非常簡單,適合於資料庫操作較少的專案】
3.greendao重要的3個類【GreenDaoManager管理類 MigrationHelper資料庫升級合併類 MyOpenHelper資料庫升級操作類】【greendao快取問題】
5.greendao與原生SQLite效能對比
LitePal是使用反射的方式完成的資料庫表的建立
整合步驟如下:
第一步:新增依賴 詳見GitHub地址,Android Studio新增依賴:compile 'org.litepal.android:core:1.4.1'
第二步:建立assets資料夾,並在其中新建一個xml檔案,命名為:litepal.xml 【litepal.xml 中的內容如下
第三步:建立類繼承DataSupport,如下程式碼段【記得將該類的完整地址:包名+.類名配置進litepal檔案中】
第四步:在自定義的Application的onCreate方法中新增:LitePal.initialize(this);//初始化public class User extends DataSupport { int id; //transient緊在gson生成物件時忽略,litePal不會忽略還是會建立表 private transient String telephone; private transient String pwd; private transient String email; private transient String department; //公司id private String companyId;
第五步:增刪改查,新增欄位,新增表
新增:User user = gson.fromJson(result.getData(), User.class);
user.save();
多條件查詢:
List<MyPapersQuestion> questions = DataSupport.where("examineBatchId = ? and userTel = ?"//後面的引數對應這裡的"?" , bean.getExamineBatchId() , UserUtils.getPhone(this)) .find(MyPapersQuestion.class);
新增欄位:直接在類中操作,結束後,在litepal.xml中將版本號的value修改,執行就可以了
新增表格:定義類繼承DataSupport在litepal.xml中配置好,並將版本號的value修改,執行就可以了
3.GreenDao框架詳解。【操作比litepal複雜一些,查詢,插入效率比litepal好很多,適合於大量操作資料庫的專案】【暫不支援繼承實體類】
關於greendao的整合,請看GitHub中的介紹,這裡只說一個容易出問題的地方:完成GitHub上的配置後需在app的build.gradle中配置,如下圖【
其中schemaVersion是版本號,會在make project是同步到DaoMaster中的SCHEMA_VERSION值。//當類需要新增欄位、新增表時,需要修改版本號。
daoPackage是dao檔案存放的包名,
targetGenDir是dao包放置的位置】【可以直接搬到你的專案中使用】
greendao {
schemaVersion 1
daoPackage 'com.koma.greendao.gen'
targetGenDir 'src/main/java'
}
greendao使用詳解:
① 自定義實體類Student如下:【預設表名是類名(大寫)可以在@Entity(nameInDb = "Student") 來定義類在資料庫中的名字】
② ctrl+f9或者點選“Build”下的“Make Project”【開發工具:Android studio】,這時你會在上文配置的daoPackage中看到多了幾個類:DaoMaster,DaoSession,StudentDao,以及本身的變化——自動生成了對應的get,set方法和建構函式,效果圖如下:【id如果是自增,在插入資料時可以傳null】
③ 到這裡你已經可以進行增刪改查的操作了,但是最好還加入2個幫助類來處理版本更新,表新增欄位,新增表的問題。
第一步:自定義MyOpenHelper類,用於表格新增欄位,新增表等操作。
public class MyOpenHelper extends DaoMaster.OpenHelper {
public MyOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
super(context, name, factory);
}
public MyOpenHelper(Context context, String name) {
this(context, name, null);
}
//當build.gradle中配置的版本號提升時,會執行下面方面
@Override
public void onUpgrade(Database db, int oldVersion, int newVersion) {
super.onUpgrade(db, oldVersion, newVersion);
//版本升級——建立新表格DOG【不會刪除其他表格資料】
DogDao.createTable(db,true);//ifNotExists = true表示不存在則建立新表,falase表示不管存不存在都建立表【如果原來有表,則會刪除後重新建立】
//版本升級——新增欄位“grade”
DoctorDao.createTable(db,true);
db.execSQL("ALTER TABLE DOCTOR ADD grade INTEGER");
}
}
第二步:自定義GreenDaoManager類,用來獲取當前版本對應的DaoSession.
public class GreenDaoManager {
private static volatile GreenDaoManager mInstance = null;
public static final String DB_NAME = "test.db";
private GreenDaoManager(Context context) {}
//單例模式
public static GreenDaoManager getInstance(Context context) {
if (mInstance == null) {
synchronized (GreenDaoManager.class) {
if (mInstance == null) {
mInstance = new GreenDaoManager(context);
}
}
}
return mInstance;
}
//第一次釋出app不需要升級資料庫正常使用DevOpenHelper獲取daosession
public DaoSession getSession(Context context) {
DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(context, DB_NAME, null);
DaoMaster daoMaster = new DaoMaster(helper.getWritableDb());
return daoMaster.newSession();
}
//再次app需要升級資料庫時 獲取daosession
public DaoSession getUpdateSession(Context context) {
MyOpenHelper dbHelper = new MyOpenHelper(context,DB_NAME);
DaoMaster daoMaster = new DaoMaster(dbHelper.getWritableDb());
return daoMaster.newSession();
}
}
第三步:增刪改查,給表格新增欄位,新增表(類)/** 第一步 獲取daosession */
DaoSession session = GreenDaoManager.getInstance(this).getUpdateSession(this);
/** 第二步 獲取dao */
DoctorDao doctorDao = session.getDoctorDao();
/** 模糊查詢——條件查詢 */
List<Doctor> doctors = doctorDao.queryBuilder().where(DoctorDao.Properties.Name.like("%1%")).build().list();
/** 查詢醫生名==“小花”的醫生——條件查詢 */
List<Doctor> doctors1 = doctorDao.queryBuilder().where(DoctorDao.Properties.Name.eq("小花")).build().list();
for (int i = 0; i < doctors.size(); i++) {
String s = doctors.get(i).getName() + " 年齡_" + queryDataList.get(i).getId();
/** 刪除單條記錄 */
doctorDao.delete(doctors.get(i));
/** 刪除表中所有記錄 */
doctorDao.deleteAll();
}
doctorDao.insert(dataList.get(i));//插入資料
/** 更新表格資料——依據是id */
doctorDao.update(new Doctor(1l, "李白", 1, "國子監"));
表新增欄位:
① 在實體類中新增一個欄位如:private String grade;
② 在自定義的MyOpenHelper類中新增:見上面的註釋
③ 在配置檔案中將版本號改為2:schemaVersion 2
完成。
新增表格:與新增欄位步驟類似,先建立一個實體類,在修改MyOpenHelper中程式碼,再升級版本號。
greendao快取問題
如果資料庫資料已修改 → 搜尋資料庫後得到的是老資料【恭喜你 遇到了greendao快取問題】
處理:只需在搜尋前呼叫DaoSession.clear()方法清理所有快取即可;
以下是3個greendao中的重要類:【最新版】
【管理類】【呼叫:GreenDaoManager.getInstance().getSession()、資料庫升級時需掉一次getUpdateSession】
public class GreenDaoManager {
private static volatile GreenDaoManager mInstance = null;
public static final String DB_NAME = "ecosurvey.db";
private GreenDaoManager() {
}
//單例模式
public static GreenDaoManager getInstance() {
if (mInstance == null) {
synchronized (GreenDaoManager.class) {
if (mInstance == null) {
mInstance = new GreenDaoManager();
}
}
}
return mInstance;
}
//第一次釋出app不需要升級資料庫正常使用DevOpenHelper獲取daosession
public DaoSession getSession(Context context) {
DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(context, DB_NAME, null);
DaoMaster daoMaster = new DaoMaster(helper.getWritableDb());
return daoMaster.newSession();
}
//再次app需要升級資料庫時 獲取daosession
public DaoSession getUpdateSession(Context context) {
MyOpenHelper dbHelper = new MyOpenHelper(context, DB_NAME);
DaoMaster daoMaster = new DaoMaster(dbHelper.getWritableDb());
return daoMaster.newSession();
}
}
public class MyOpenHelper extends DaoMaster.OpenHelper {
public MyOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
super(context, name, factory);
}
public MyOpenHelper(Context context, String name) {
this(context, name, null);
}
@Override
public void onUpgrade(Database db, int oldVersion, int newVersion) {
super.onUpgrade(db, oldVersion, newVersion);
//之前的資料不重要,直接刪除舊錶
JDLogDao.dropTable(db, true);
JDLogDao.createTable(db, true);【應當呼叫MigrationHelper.getInstance().createTable(db,true);防止使用者部分資料庫升級時未升級,部分表格找不到】
//需要把舊錶的資料新增到新表
MigrationHelper.getInstance().migrate(db, SampleInfoDao.class);
}
}
【資料庫升級時呼叫,在MyOpenHelper中呼叫】【將舊錶資料新增到新表】
import android.database.Cursor;
import android.text.TextUtils;
import android.util.Log;
import com.adas.jdbasevisitor.greendao.dao.DaoMaster;
import org.greenrobot.greendao.AbstractDao;
import org.greenrobot.greendao.database.Database;
import org.greenrobot.greendao.internal.DaoConfig;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
public class MigrationHelper {
private static final String CONVERSION_CLASS_NOT_FOUND_EXCEPTION = "MIGRATION HELPER - CLASS DOESN'T MATCH WITH THE CURRENT PARAMETERS";
private static MigrationHelper instance;
public static MigrationHelper getInstance() {
if (instance == null) {
instance = new MigrationHelper();
}
return instance;
}
public void migrate(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
generateTempTables(db, daoClasses);
DaoMaster.dropAllTables(db, true);
DaoMaster.createAllTables(db, false);
restoreData(db, daoClasses);
}
/**
* 生成臨時列表
*
* @param db
* @param daoClasses
*/
private void generateTempTables(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
for (int i = 0; i < daoClasses.length; i++) {
DaoConfig daoConfig = new DaoConfig(db, daoClasses[i]);
String divider = "";
String tableName = daoConfig.tablename;
String tempTableName = daoConfig.tablename.concat("_TEMP");
ArrayList<String> properties = new ArrayList<>();
StringBuilder createTableStringBuilder = new StringBuilder();
createTableStringBuilder.append("CREATE TABLE ").append(tempTableName).append(" (");
for (int j = 0; j < daoConfig.properties.length; j++) {
String columnName = daoConfig.properties[j].columnName;
if (getColumns(db, tableName).contains(columnName)) {
properties.add(columnName);
String type = null;
try {
type = getTypeByClass(daoConfig.properties[j].type);
} catch (Exception exception) {
exception.printStackTrace();
}
createTableStringBuilder.append(divider).append(columnName).append(" ").append(type);
if (daoConfig.properties[j].primaryKey) {
createTableStringBuilder.append(" PRIMARY KEY");
}
divider = ",";
}
}
createTableStringBuilder.append(");");
db.execSQL(createTableStringBuilder.toString());
StringBuilder insertTableStringBuilder = new StringBuilder();
insertTableStringBuilder.append("INSERT INTO ").append(tempTableName).append(" (");
insertTableStringBuilder.append(TextUtils.join(",", properties));
insertTableStringBuilder.append(") SELECT ");
insertTableStringBuilder.append(TextUtils.join(",", properties));
insertTableStringBuilder.append(" FROM ").append(tableName).append(";");
db.execSQL(insertTableStringBuilder.toString());
}
}
/**
* 儲存新的資料庫表 以及資料
*
* @param db
* @param daoClasses
*/
private void restoreData(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
for (int i = 0; i < daoClasses.length; i++) {
DaoConfig daoConfig = new DaoConfig(db, daoClasses[i]);
String tableName = daoConfig.tablename;
String tempTableName = daoConfig.tablename.concat("_TEMP");
ArrayList<String> properties = new ArrayList();
ArrayList<String> propertiesQuery = new ArrayList();
for (int j = 0; j < daoConfig.properties.length; j++) {
String columnName = daoConfig.properties[j].columnName;
if (getColumns(db, tempTableName).contains(columnName)) {
properties.add(columnName);
propertiesQuery.add(columnName);
} else {
try {
//如果新增的欄位有integer型別,需要新增預設值【不然會報錯】
if (getTypeByClass(daoConfig.properties[j].type).equals("INTEGER")) {
propertiesQuery.add("0 as" + columnName);
properties.add(columnName);
}
//float型 也不能為空 新增預設值
if (getTypeByClass(daoConfig.properties[j].type).equals("REAL")) {
propertiesQuery.add("0.0 as" + columnName);
properties.add(columnName);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
StringBuilder insertTableStringBuilder = new StringBuilder();
insertTableStringBuilder.append("INSERT INTO ").append(tableName).append(" (");
insertTableStringBuilder.append(TextUtils.join(",", properties));
insertTableStringBuilder.append(") SELECT ");
insertTableStringBuilder.append(TextUtils.join(",", properties));
insertTableStringBuilder.append(" FROM ").append(tempTableName).append(";");
StringBuilder dropTableStringBuilder = new StringBuilder();
dropTableStringBuilder.append("DROP TABLE ").append(tempTableName);
db.execSQL(insertTableStringBuilder.toString());
db.execSQL(dropTableStringBuilder.toString());
}
}
private String getTypeByClass(Class<?> type) throws Exception {
if (type.equals(String.class)) {
return "TEXT";
}
if (type.equals(Long.class) || type.equals(Integer.class) || type.equals(long.class)) {
return "INTEGER";
}
if (type.equals(Boolean.class)) {
return "BOOLEAN";
}
Exception exception = new Exception(CONVERSION_CLASS_NOT_FOUND_EXCEPTION.concat(" - Class: ").concat(type.toString()));
exception.printStackTrace();
throw exception;
}
private List<String> getColumns(Database db, String tableName) {
List<String> columns = new ArrayList<>();
Cursor cursor = null;
try {
cursor = db.rawQuery("SELECT * FROM " + tableName + " limit 1", null);
if (cursor != null) {
columns = new ArrayList<>(Arrays.asList(cursor.getColumnNames()));
}
} catch (Exception e) {
Log.v(tableName, e.getMessage(), e);
e.printStackTrace();
} finally {
if (cursor != null)
cursor.close();
}
return columns;
}
//建立表格
public void createTable(Database db, boolean ifNotExists) {
DaoMaster.createAllTables(db, ifNotExists);
}
}
5.greendao與原生的SQLite效能對比(看下圖)
可以得出結果:
備註:
1.這裡的查詢資料:greendao查詢時每次都使用了daoSession.clear()清理了greendao快取【不清理時:第一次查詢與表中一樣,從第二次開始以後查詢相同的資料都比原生的查詢耗時少一半】
2.更新的時候greendao需要查詢出來後逐個修改,之後再dao.update,這是耗時差距很大的原因之一