版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
greendao 框架数据库升级策略
做了好久项目，数据库的升级一直没做过，小伙伴们都是各自建库，各自建表，今天要整合时才发现好困难。。。。
在网上查了好多资料，确实学到了好多，但是也碰壁不少，加上对SQL 语句不熟悉，走了好多弯路。
在做数据库升级的小伙伴好好看看。
greendao数据库引用默认是
DaoMaster.DevOpenHelper openHelper = new DaoMaster.DevOpenHelper(context, DB_NAME);
可以看到每次在升级时都会走onUpgrade()方法，每次都会把表先移除掉，再去创建，所以很多信息数据是无法保留的，只限在开发时使用。。所以我们要去自己实现。。
/**
* 数据库升级策略 每次升级时
* Created by Han on 2018/3/17
* Email:[email protected]
* CSDN:http://blog.csdn.net/yin13753884368/article
* Github:https://github.com/yin13753884368
*/
public class MyOpenHelper extends DatabaseOpenHelper {
public MyOpenHelper(Context context, String name) {
super(context, name, SCHEMA_VERSION);
}
@Override
public void onCreate(Database db) {
super.onCreate(db);
DaoMaster.createAllTables(db, false);
}
@Override
public void onUpgrade(final Database db, int oldVersion, int newVersion) {
super.onUpgrade(db, oldVersion, newVersion);
//判断之前的版本
switch (oldVersion) {
case 1:
case 2:
//做相应的处理 传入表的class文件即可
Executors.newSingleThreadExecutor().execute(new Runnable() {
@Override
public void run() {
MigrationHelper.getInstance().migrate(db, PersonDao.class);
}
});
}
}
}
MyOpenHelper继承自DatabaseOpenHelper，所有的工具类共用一个类，做成单例，这样就只会初始化一次，需要注意的是在onUpgrade()方法里，switch语句不能有break,数据库只能从1->2, 2->3, 如果从1->3会出错
数据迁移的工具类MigrationHelper 这个需要注意下，如果新表的结构中有Integer 类型需要给默认值，在旧表迁移到新表的过程中默认不会赋值，所以还要把新表中需要Integer类型的字段找到，主动去赋值。具体实现看看代码。
/**
* 数据迁移的策略
* Created by Han on 2018/10/18
* Email:[email protected]
* CSDN:http://blog.csdn.net/yin13753884368/article
* Github:https://github.com/yin13753884368
*/
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 migrationHelper;
private MigrationHelper() {
}
public static MigrationHelper getInstance() {
if (migrationHelper == null) {
synchronized (MigrationHelper.class) {
if (migrationHelper == null) {
migrationHelper = new MigrationHelper();
}
}
}
return migrationHelper;
}
public void migrate(Database db, Class<? extends AbstractDao<?, ?>> daoClasses) {
//1. 备份
generateTempTables(db, daoClasses);
//2. 只删除需要更新的表 DaoMaster.dropAllTables(db, true);
deleteTables(db, daoClasses);
//3. 只创建需要更新的表 DaoMaster.createAllTables(db, false);
createTables(db, daoClasses);
//4. 恢复数据
restoreData(db, daoClasses);
}
/**
* 恢复数据
*
* @param db
* @param daoClasses
*/
private void restoreData(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
String primarykey = null;//约束键 insert 时不能select
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<TableColumn> list = new ArrayList<>();//表中多出的参数
for (int j = 0; j < daoConfig.properties.length; j++) {
String columnName = daoConfig.properties[j].columnName;
if (getColumns(db, tempTableName).contains(columnName)) {
columnName = resultColumnName(columnName);
properties.add(columnName);
if (daoConfig.properties[j].primaryKey) {
primarykey = columnName;
}
} else {
//表中多出的参数
String type = null;
try {
type = getTypeByClass(daoConfig.properties[j].type);
list.add(new TableColumn(columnName, type));
} catch (Exception exception) {
}
}
}
if (properties != null && properties.size() > 0) {
Iterator<String> iterator = properties.iterator();
while (iterator.hasNext()) {
String next = iterator.next();
if (TextUtils.equals(primarykey, next)) {
//(2018.08.06) UNIQUE constraint failed: MSG_TIP_DO_INFO._id 所以删掉_id
iterator.remove();
}
}
}
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);
try {
db.execSQL(insertTableStringBuilder.toString());
db.execSQL(dropTableStringBuilder.toString());
if (list != null && list.size() > 0) {
ArrayList<String> arrayList = new ArrayList<>();
for (int j = 0; j < list.size(); j++) {
TableColumn tableColumn = list.get(j);
if (TextUtils.equals(tableColumn.getTypes(), "INTEGER") || TextUtils.equals(tableColumn.getTypes(), "BOOLEAN")) {
arrayList.add(tableColumn.getColumnName());
}
}
if (arrayList != null && arrayList.size() > 0) {
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append("UPDATE ").append(tableName).append(" SET");
for (int j = 0; j < arrayList.size(); j++) {
String name = arrayList.get(j);
stringBuilder.append(" ");
stringBuilder.append(name);
stringBuilder.append(" = ");
stringBuilder.append(0);
if (j == arrayList.size() - 1) {
stringBuilder.append(";");
} else {
stringBuilder.append(",");
}
}
db.execSQL(stringBuilder.toString());
LogUtils.e("MyOpenHelper ---", "更新语句 stringBuilder ===" + stringBuilder.toString());
if (arrayList.contains("IS_READ_MESSAGE")) {
StringBuilder st = new StringBuilder();
st.append("UPDATE ").append(tableName).append(" SET IS_READ_MESSAGE = 1;");
db.execSQL(st.toString());
LogUtils.e("MyOpenHelper ---", "更新语句 st ===" + st.toString());
}
}
LogUtils.e("MyOpenHelper ---", "添加的参数 list.size =" + list.toString());
}
} catch (Exception e) {
LogUtils.e("MyOpenHelper ---", "错误" + e.getMessage() + " 添加的参数 list.size =" + list.toString());
}
}
LogUtils.e("MyOpenHelper----", "restoreData 恢复数据");
}
/**
* 创建表
*
* @param db
* @param daoClasses
*/
private void createTables(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
String buildType = BuildConfig.BUILD_TYPE;
if (TextUtils.equals(buildType, "debug")) {
for (Class<? extends AbstractDao<?, ?>> daoClass : daoClasses) {
try {
Method method = daoClass.getMethod("createTable", Database.class, boolean.class);
method.invoke(null, db, false);
} catch (Exception e) {
LogUtils.e("MyOpenHelper---- createTables debug e == " + e.getMessage());
e.printStackTrace();
}
}
} else {
for (int i = 0; i < daoClasses.length; i++) {
DaoConfig daoConfig = new DaoConfig(db, daoClasses[i]);
String tableName = daoConfig.tablename;
StringBuilder createTableStringBuilder = new StringBuilder();
createTableStringBuilder.append("CREATE TABLE ").append(tableName).append(" (");
String divider = "";
try {
for (int j = 0; j < daoConfig.properties.length; j++) {
String columnName = daoConfig.properties[j].columnName;
columnName = resultColumnName(columnName);
String type = null;
type = getTypeByClass(daoConfig.properties[j].type);
createTableStringBuilder.append(divider).append(columnName).append(" ").append(type);
if (daoConfig.properties[j].primaryKey) {
createTableStringBuilder.append(" PRIMARY KEY");
}
divider = ",";
}
createTableStringBuilder.append(");");
db.execSQL(createTableStringBuilder.toString());
LogUtils.e("MyOpenHelper ---createTables release sql== " + createTableStringBuilder.toString());
} catch (Exception e) {
LogUtils.e("MyOpenHelper ---createTables release e == " + e.getMessage());
}
}
}
}
/**
* 删除表
*
* @param db
* @param daoClasses
*/
private void deleteTables(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
String buildType = BuildConfig.BUILD_TYPE;
if (TextUtils.equals(buildType, "debug")) {
for (Class<? extends AbstractDao<?, ?>> daoClass : daoClasses) {
try {
Method method = daoClass.getMethod("dropTable", Database.class, boolean.class);
method.invoke(null, db, true);
} catch (Exception e) {
LogUtils.e("MyOpenHelper---- debug deleteTables e == " + e.getMessage());
e.printStackTrace();
}
}
} else {
for (int i = 0; i < daoClasses.length; i++) {
try {
DaoConfig daoConfig = new DaoConfig(db, daoClasses[i]);
StringBuilder dropTableStringBuilder = new StringBuilder();
String tableName = daoConfig.tablename;
dropTableStringBuilder.append("DROP TABLE ").append(tableName);
db.execSQL(dropTableStringBuilder.toString());
LogUtils.e("MyOpenHelper---- release deleteTables sql== " + dropTableStringBuilder.toString());
} catch (Exception e) {
LogUtils.e("MyOpenHelper---- release deleteTables e == " + e.getMessage());
}
}
}
}
/**
* 备份表
*
* @param db
* @param daoClasses
*/
private void generateTempTables(Database db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
String primarykey = null;//约束键 insert 时不能select
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)) {
columnName = resultColumnName(columnName);
properties.add(columnName);
String type = null;
try {
type = getTypeByClass(daoConfig.properties[j].type);
} catch (Exception exception) {
}
createTableStringBuilder.append(divider).append(columnName).append(" ").append(type);
if (daoConfig.properties[j].primaryKey) {
primarykey = columnName;
createTableStringBuilder.append(" PRIMARY KEY");
}
divider = ",";
}
}
createTableStringBuilder.append(");");
try {
db.execSQL(createTableStringBuilder.toString());
LogUtils.e("MyOpenHelper ---", "generateTempTables create sql== " + createTableStringBuilder.toString());
} catch (Exception e) {
LogUtils.e("MyOpenHelper ---", "generateTempTables create e== " + e.getMessage());
}
if (properties != null && properties.size() > 0) {
Iterator<String> iterator = properties.iterator();
while (iterator.hasNext()) {
String next = iterator.next();
if (TextUtils.equals(primarykey, next)) {
iterator.remove();
}
}
}
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(";");
try {
db.execSQL(insertTableStringBuilder.toString());
LogUtils.e("MyOpenHelper ---", "generateTempTables insert sql== " + insertTableStringBuilder.toString());
} catch (Exception e) {
LogUtils.e("MyOpenHelper ---", "generateTempTables insert e== " + e.getMessage());
}
}
}
/**
* 获取列数
*
* @param db
* @param tableName
* @return
*/
private static 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) {
LogUtils.e("MyOpenHelper ---getColumns", e.getMessage());
e.printStackTrace();
} finally {
if (cursor != null)
cursor.close();
}
return columns;
}
private String getTypeByClass(Class<?> type) throws Exception {
if (type.equals(String.class)) {
return "TEXT";
}
if (type.equals(int.class) || type.equals(Long.class) || type.equals(Integer.class) || type.equals(long.class)) {
return "INTEGER";
}
if (type.equals(boolean.class) || type.equals(Boolean.class)) {
return "BOOLEAN";
}
Exception exception =
new Exception(CONVERSION_CLASS_NOT_FOUND_EXCEPTION.concat(" - Class: ").concat(type.toString()));
throw exception;
}
/**
* arr关键字 替换
*
* @param columnName
*/
String[] arr = new String[]{"FROM", "TO", "TIME", "CONTENT", "NAME", "SELECT", "INSERT", "DELETE", "UPDATE", "ADD", "VISIBLE", "TYPE"};
List<String> list = Arrays.asList(arr);
private String resultColumnName(String columnName) {
if (list.contains(columnName)) {
columnName = "`" + columnName + "`";
}
return columnName;
}
}