【问题标题】:GreenDAO schema update and data migration?GreenDAO 架构更新和数据迁移?
【发布时间】:2017-06-09 20:30:40
【问题描述】:

我正在评估 GreenDAO 以考虑在我将要开发的商业 Android 应用中考虑,并希望确定架构更新的迁移路径。

我是否正确断言我必须编写一个自定义 OpenHelper,它提供 onUpdate() 并根据新模式提取转换和存储数据?这个假设引发了一些关于调用顺序和责任划分的有趣问题。

我找不到任何有关 GreenDAO 架构更新和数据迁移的文档。

这是我写的关于这个主题的大量博客文章:

  1. Review of greenDAO
  2. Part 1 – Schema Generation
  3. Part 2 – Schema Migration
  4. Part 3 – Testing Schema Migration

【问题讨论】:

  • 我遇到了同样的问题。这个助手是你写的吗?
  • 我做到了,但是这些助手的结构与您的解决方案非常紧密地耦合(直接在您的数据库的表和列上工作关于版本更改)所以它不是可重复使用的;对不起。
  • @Syntax 你能告诉我们你把OpenHelper放在哪里了吗?目前 DaoMaster 对象扩展了 SQLiteOpenHelper,但是这个文件是生成的,并不意味着被编辑。还是你只是扩展了道士?谢谢
  • @Tim 我的自定义 UpgradeHelper 扩展了 DaoMaster.OpenHelper,然后我就这样使用它。 "OpenHelper helper = new UpgradeHelper(application, Constants.DB_NAME, null);"
  • 抱歉@MahdiAlkhatib 托管我的解决方案的博客已关闭,托管的说明和文件已被删除。好消息是 web.archive 仍然有副本;我已经更新了上面的链接,它们应该可以工作:) 享受

标签: android greendao


【解决方案1】:

考虑到 pleonasmik 的方法(顺便说一句,谢谢,这真的很有帮助),我创建了一个 MigrationHelper 类。

它是如何工作的:

  1. 类抓住你得到的所有道
  2. 根据旧版本的方案创建临时表(generateTempTables方法)
  3. 将所有数据导入到这个新表中(generateTempTables 方法)
  4. 删除旧版本的所有表(DaoMaster.dropAllTables方法)
  5. 创建新版本的表(DaoMaster.createAllTables方法)
  6. 从临时表中更新新版本的表(restoreData 方法)
  7. 删除所有临时表(restoreData 方法)

迁移助手类:

import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.text.TextUtils;
import android.util.Log;

import com.crashlytics.android.Crashlytics;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import de.greenrobot.dao.AbstractDao;
import de.greenrobot.dao.internal.DaoConfig;
import greendao.DaoMaster;


/**
 * Created by pokawa on 18/05/15.
 */
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(SQLiteDatabase db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
        generateTempTables(db, daoClasses);
        DaoMaster.dropAllTables(db, true);
        DaoMaster.createAllTables(db, false);
        restoreData(db, daoClasses);
    }

    private void generateTempTables(SQLiteDatabase 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) {
                        Crashlytics.logException(exception);
                    }

                    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());
        }
    }

    private void restoreData(SQLiteDatabase 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();

            for (int j = 0; j < daoConfig.properties.length; j++) {
                String columnName = daoConfig.properties[j].columnName;

                if(getColumns(db, tempTableName).contains(columnName)) {
                    properties.add(columnName);
                }
            }

            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()));
        Crashlytics.logException(exception);
        throw exception;
    }

    private static List<String> getColumns(SQLiteDatabase 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;
    }
}

下面是一个在 DaoMaster.java 类中应该如何调用它的示例:

@Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by migrating all tables data");

        MigrationHelper.getInstance().migrate(db,
                UserDao.class,
                ItemDao.class);
    }

【讨论】:

  • 现在这是一个很棒的代码!谢谢分享:)
  • 我非常喜欢这个解决方案,它简短而强大。我遇到的一个问题是,它似乎无法处理添加强制(必需)字段的情况。似乎没有任何一点可以提供默认值等来填充必填字段等中的值(因为迁移代码是通用的),所以除非我错了,否则这个解决方案可能会限制您可以进行的更改类型你的数据库。
  • 我知道在 Stack Overflow 下发布的代码在 Creative Commons 下......但是这个人将代码复制到了他自己的 GitHub 存储库,根本没有记下这个线程:github.com/yuweiguocn/GreenDaoUpgradeHelper/blob/master/library/…
  • 大家好,@EnricoSusatyo 非常感谢您警告我,但没关系,我不会收回它,我真的希望它是免费的,我也不想要学分。不用担心,我希望我能帮助你们,伙计们,再次感谢,伙计。 :D
【解决方案2】:

你猜对了。今天不同模式版本之间没有更改跟踪。因此,在进行架构升级时,您需要自己编写 SQL。

【讨论】:

  • 下面提出的 i thing 解决方案真的很棒,如果您决定将它们添加到 greendao,它会更加完美。
【解决方案3】:

这与 @PedroOkawa 的代码相同,可与 GreenDao 3.+ 一起使用,但已修复错误:

import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.support.annotation.NonNull;
import android.text.TextUtils;

import org.greenrobot.greendao.AbstractDao;
import org.greenrobot.greendao.database.Database;
import org.greenrobot.greendao.database.StandardDatabase;
import org.greenrobot.greendao.internal.DaoConfig;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Createdby PedroOkawa and modified by MBH on 16/08/16.
 */
public final class MigrationHelper {

    public static void migrate(SQLiteDatabase sqliteDatabase, Class<? extends AbstractDao<?, ?>>... daoClasses) {
        StandardDatabase db = new StandardDatabase(sqliteDatabase);
        generateNewTablesIfNotExists(db, daoClasses);
        generateTempTables(db, daoClasses);
        dropAllTables(db, true, daoClasses);
        createAllTables(db, false, daoClasses);
        restoreData(db, daoClasses);
    }

    public static void migrate(StandardDatabase db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
        generateNewTablesIfNotExists(db, daoClasses);
        generateTempTables(db, daoClasses);
        dropAllTables(db, true, daoClasses);
        createAllTables(db, false, daoClasses);
        restoreData(db, daoClasses);
    }

    private static void generateNewTablesIfNotExists(StandardDatabase db, Class<? extends AbstractDao<?, ?>>... daoClasses) {
        reflectMethod(db, "createTable", true, daoClasses);
    }

    private static void generateTempTables(StandardDatabase 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");
            StringBuilder insertTableStringBuilder = new StringBuilder();
            insertTableStringBuilder.append("CREATE TEMP TABLE ").append(tempTableName);
            insertTableStringBuilder.append(" AS SELECT * FROM ").append(tableName).append(";");
            db.execSQL(insertTableStringBuilder.toString());
        }
    }

    private static void dropAllTables(StandardDatabase db, boolean ifExists, @NonNull Class<? extends AbstractDao<?, ?>>... daoClasses) {
        reflectMethod(db, "dropTable", ifExists, daoClasses);
    }

    private static void createAllTables(StandardDatabase db, boolean ifNotExists, @NonNull Class<? extends AbstractDao<?, ?>>... daoClasses) {
        reflectMethod(db, "createTable", ifNotExists, daoClasses);
    }

    /**
     * dao class already define the sql exec method, so just invoke it
     */
    private static void reflectMethod(StandardDatabase db, String methodName, boolean isExists, @NonNull Class<? extends AbstractDao<?, ?>>... daoClasses) {
        if (daoClasses.length < 1) {
            return;
        }
        try {
            for (Class cls : daoClasses) {
                Method method = cls.getDeclaredMethod(methodName, Database.class, boolean.class);
                method.invoke(null, db, isExists);
            }
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }
    }

    private static void restoreData(StandardDatabase 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");
            // get all columns from tempTable, take careful to use the columns list
            List<String> columns = getColumns(db, tempTableName);
            ArrayList<String> properties = new ArrayList<>(columns.size());
            for (int j = 0; j < daoConfig.properties.length; j++) {
                String columnName = daoConfig.properties[j].columnName;
                if (columns.contains(columnName)) {
                    properties.add(columnName);
                }
            }
            if (properties.size() > 0) {
                final String columnSQL = TextUtils.join(",", properties);

                StringBuilder insertTableStringBuilder = new StringBuilder();
                insertTableStringBuilder.append("INSERT INTO ").append(tableName).append(" (");
                insertTableStringBuilder.append(columnSQL);
                insertTableStringBuilder.append(") SELECT ");
                insertTableStringBuilder.append(columnSQL);
                insertTableStringBuilder.append(" FROM ").append(tempTableName).append(";");
                db.execSQL(insertTableStringBuilder.toString());
            }
            StringBuilder dropTableStringBuilder = new StringBuilder();
            dropTableStringBuilder.append("DROP TABLE ").append(tempTableName);
            db.execSQL(dropTableStringBuilder.toString());
        }
    }

    private static List<String> getColumns(StandardDatabase db, String tableName) {
        List<String> columns = null;
        Cursor cursor = null;
        try {
            cursor = db.rawQuery("SELECT * FROM " + tableName + " limit 0", null);
            if (null != cursor && cursor.getColumnCount() > 0) {
                columns = Arrays.asList(cursor.getColumnNames());
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (cursor != null)
                cursor.close();
            if (null == columns)
                columns = new ArrayList<>();
        }
        return columns;
    }

}

而用法是:

@Override
public void onUpgrade(SQLiteDatabase sqLiteDatabase, int oldVersion, int newVersion) {
    MigrationHelper.migrate(new StandardDatabase(sqLiteDatabase),
                UserDao.class,
                ItemDao.class);
    // OR you can use it like this (Dont use both it is example of 2 different usages)
    MigrationHelper.migrate(sqLiteDatabase,
                UserDao.class,
                ItemDao.class);
}

StandardDatabase 可以在 greendao 中找到,这是导入:

import org.greenrobot.greendao.database.StandardDatabase;

再次感谢@PedroOkawa :)

【讨论】:

    【解决方案4】:

    对于那些希望在 greenDAO 3 上更新数据库架构版本的人,请将其添加到应用程序的 build.gradle 依赖项上方的文件中:

    apply plugin: 'org.greenrobot.greendao'
    
    greendao {
        schemaVersion 1
    }
    

    【讨论】:

    • 值得记住的是,这种技术不幸地删除了本地数据库并重新创建它。谢谢。
    【解决方案5】:

    我认为我的answer to a similiar question 可以帮助您采用这种方法。如果您确实需要迁移数据,我建议您,例如,如果您需要处理一些约束更改或 SQLite 不支持的事情,您可以自己编写迁移。例如,迁移器助手的示例(按照我对链接响应所做的方法)可能是:

    public class DBMigrationHelper6 extends AbstractMigratorHelper {
    
    /* Upgrade from DB schema 6 to schema 7 , version numbers are just examples*/
    
    public void onUpgrade(SQLiteDatabase db) {
    
        /* Create a temporal table where you will copy all the data from the previous table that you need to modify with a non supported sqlite operation */
        db.execSQL("CREATE TABLE " + "'post2' (" + //
                "'_id' INTEGER PRIMARY KEY ," + // 0: id
                "'POST_ID' INTEGER UNIQUE ," + // 1: postId
                "'USER_ID' INTEGER," + // 2: userId
                "'VERSION' INTEGER," + // 3: version
                "'TYPE' TEXT," + // 4: type
                "'MAGAZINE_ID' TEXT NOT NULL ," + // 5: magazineId
                "'SERVER_TIMESTAMP' INTEGER," + // 6: serverTimestamp
                "'CLIENT_TIMESTAMP' INTEGER," + // 7: clientTimestamp
                "'MAGAZINE_REFERENCE' TEXT NOT NULL ," + // 8: magazineReference
                "'POST_CONTENT' TEXT);"); // 9: postContent
    
        /* Copy the data from one table to the new one */
        db.execSQL("INSERT INTO post2 (_id, POST_ID, USER_ID, VERSION, TYPE,  MAGAZINE_ID, SERVER_TIMESTAMP, CLIENT_TIMESTAMP, MAGAZINE_REFERENCE, POST_CONTENT)" +
                "   SELECT _id, POST_ID, USER_ID, VERSION, TYPE,  MAGAZINE_ID, SERVER_TIMESTAMP, CLIENT_TIMESTAMP, MAGAZINE_REFERENCE, POST_CONTENT FROM post;");
    
        /* Delete the previous table */
        db.execSQL("DROP TABLE post");
        /* Rename the just created table to the one that I have just deleted */
        db.execSQL("ALTER TABLE post2 RENAME TO post");
    
        /* Add Index/es if you want them */
        db.execSQL("CREATE INDEX " + "IDX_post_USER_ID ON post" +
                " (USER_ID);");
    
       }
    }
    

    【讨论】:

      【解决方案6】:

      Pedro Okawa 的解决方案是正确的,但是您需要编写“UpgradeHelper”来扩展“OpenHelper”,因为每次重新生成 DAO 代码时都会覆盖 DaoMaster。

      例子:

      public class UpgradeHelper extends DaoMaster.OpenHelper {
      
      public UpgradeHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
          super(context, name, factory);
      }
      
      @Override
      public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
      
          Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by migrating all tables data");
      
          MigrationHelper.getInstance().migrate(db,
                  UserDao.class,
                  ItemDao.class,
                  AnotherClassToGenerateDao.class);
      }
      

      }

      【讨论】:

      • 我怎么称呼这个upgradeHelper
      • 您必须创建一个名为“UpgradedHelper”的新类并覆盖该方法
      【解决方案7】:

      如果您只是在寻找一种在不删除用户数据的情况下将新表添加到架构中并且不需要转换任何现有数据的方法,请查看我对 this question 的回答以获取有关如何操作的离散示例用greenDao来做。

      【讨论】:

      • 您好,感谢您的评论。如果您阅读了在我上面的问题的编辑中添加的博客文章,您应该找到比提供的链接中的迁移等问题更全面的解决方案。干杯
      • 在我提出问题之前,我已经阅读了您的所有 4 篇博文。因为我正在寻找的信息隐藏在您正在使用的模式中,所以我想我会提供一个离散的例子,因为似乎没有任何与 greenDao 相关的 SO。我实际上在我的真实应用程序中使用了与您非常相似的模式,但我提出的问题只是如何添加新表,而不是升级架构时使用什么模式。我感谢您的帖子,只是想提供一个更简洁的答案,正如我在回答中的免责声明中所述。
      猜你喜欢
      • 2016-03-17
      • 1970-01-01
      • 2023-03-12
      • 1970-01-01
      • 2015-12-05
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-01-29
      相关资源
      最近更新 更多