基于DBFlow实现数据表自动升级、多用户、多Module开发

DBFlow是Android开发中一个很优秀的ORM数据库框架，基于APT技术实现，拥有很好的性能，本文将会介绍DBFlow如何实现自动更新字段、多用户数据库、多Module开发。

DBFlow托管地址：
https://github.com/Raizlabs/DBFlow

官方提供的更新字段方法

@Database(version = 2)
public class AppDatabase {
    @Migration(version = 2, database = AppDatabase.class)
    public class Migration2 extends AlterTableMigration {
        public Migration2(Class table) {
            super(table);
        }
        @Override
        public void onPreMigrate() {
            addColumn(SQLiteType.TEXT, "myColumn");
            addColumn(SQLiteType.REAL, "anotherColumn");
        }
    }
}

从上述的例子可以看到，每当我们修改字段的时候都必须手动编写升级的方法，做过字段升级的开发者应该都清楚，这种操作成本太高了，而且容易出错。

自动更新字段

下面介绍我在公司项目中如何改造DBFlow，实现自动更新字段。

1. 修改源代码DBFlow，重新打包

image.png

唯一的修改就是把 @Column改成 @Retention(RetentionPolicy.SOURCE)，如果是RUNTIME类型，编译成class文件后，注解就消失了，因为我这个方案是通过 @Column来实现字段的升级。

这是我自己修改的库
https://github.com/joyrun/DBFlow
引用方式：

compile "com.github.joyrun.DBFlow:dbflow-core:4.2.5"
compile "com.github.joyrun.DBFlow:dbflow:4.2.5"
apt "com.github.joyrun.DBFlow:dbflow-processor:4.2.5"

2. 实现自动升级

实现原理是，升级版本之后，检查数据库中所有的表的字段，和类中有有@Column的字段进行对比，如果不存在的就添加进来。

@Database(name = AppDatabase.NAME, version = AppDatabase.VERSION)
public class AppDatabase {
    //数据库名称
    public static final String NAME = "AppDatabase";
    //数据库版本号
    public static final int VERSION = 200;
    @Migration(version = AppDatabase.VERSION, database = AppDatabase.class)
    public static class DatabaseAutoUpdate extends BaseDatabaseAutoUpdate {
        @Override
        protected String getDatabaseName() {
            return AppDatabase.NAME;
        }
    }
    public static abstract class BaseDatabaseAutoUpdate extends BaseMigration {
        protected abstract String getDatabaseName();
        @Override
        public void migrate(DatabaseWrapper database) {
            try {
                List> classes = FlowManager.getDatabase(getDatabaseName()).getModelClasses();
                for (Class c : classes) {
                    try {
                        Cursor cursor = database.rawQuery("SELECT * FROM " + c.getSimpleName(), null);
                        Field[] fields = c.getDeclaredFields();
                        for (Field field : fields) {
                            if (field.isAnnotationPresent(Column.class)) {
                                if (cursor.getColumnIndex(field.getName()) < 0) {
                                    //缺少的字段
                                    QueryBuilder queryBuilder = new QueryBuilder().append("ALTER")
                                            .appendSpaceSeparated("TABLE")
                                            .appendSpaceSeparated(c.getSimpleName())
                                            .appendSpaceSeparated("ADD COLUMN")
                                            .appendSpaceSeparated(QueryBuilder.quoteIfNeeded(field.getName()));
                                    String sql = queryBuilder.getQuery();
                                    database.execSQL(sql);
                                }
                            }
                        }
                        cursor.close();
                    } catch (Exception e) {
                        RxJavaPluginUtils.handleException(e);
                    }
                }
            } catch (InvalidDBConfiguration e) {
                e.printStackTrace();
            }
        }
    }
}

3. 温馨提示

建议数据库版本号和App的versionCode保持一致，在Application编写检查代码，强提示，避免忘记修改数据版本号。

多用户数据库

比如类似微信，允许一个账号A注销后，登录另外一个账号B，注销后再登录账号A，账号A的数据库不会被清空。
如果要实现这种逻辑，我们就要针对不同的用户进行区分，不同的数据使用不同的数据库。

    public static void initDBFlow() {
        FlowManager.close();
        FlowConfig.Builder flowConfig = new FlowConfig.Builder(getContext()).openDatabasesOnInit(false);
        addDatabase(flowConfig,MarathonGeneratedDatabaseHolder.class,MarathonDatabase.class);
        addDatabase(flowConfig,AdvertGeneratedDatabaseHolder.class,AdvertDatabase.class);
        FlowManager.init(flowConfig.build());
    }
    private static void addDatabase(FlowConfig.Builder flowConfig,Class databaseHolderClass,Class databaseClass){
        flowConfig.addDatabaseHolder(databaseHolderClass);
        flowConfig.addDatabaseConfig(new DatabaseConfig.Builder(databaseClass).extensionName(MyInfo.getInstance().getUid()+".db").build());
    }

DBFlow 4.x 提供DatabaseConfig给我们对数据进行配置，可以用来配置数据库名。我们可以通过这种方式来实现不同的用户使用不同的数据库。

温馨提示

1. 切换账号的时候，必须再次调用以上方法，用于销毁DBFlow，重新初始化。

多Module开发

只要在Module的build.gradle增加配置，不同的Module需要配置不同的名称。

apt {
    arguments {
        targetModuleName 'SomeUniqueModuleName'
    }
}

就会生成对应的SomeUniqueModuleNameGeneratedDatabaseHolder类，初始化的时候添加进来即可

public void initialize(Context context) {
  FlowManager.init(FlowConfig.builder(context)
    .addDatabaseHolder(SomeUniqueModuleNameGeneratedDatabaseHolder.class)
    .build());
}