DBFlow是Android開發(fā)中一個很優(yōu)秀的ORM數(shù)據庫框架，基于APT技術實現(xiàn)，擁有很好的性能，本文將會介紹DBFlow如何實現(xiàn)自動更新字段、多用戶數(shù)據庫、多Module開發(fā)。

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

官方提供的更新字段方法

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

從上述的例子可以看到，每當我們修改字段的時候都必須手動編寫升級的方法，做過字段升級的開發(fā)者應該都清楚，這種操作成本太高了，而且容易出錯。

自動更新字段

下面介紹我在公司項目中如何改造DBFlow，實現(xiàn)自動更新字段。

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

image.png

這是我自己修改的庫
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. 實現(xiàn)自動升級

實現(xiàn)原理是，升級版本之后，檢查數(shù)據庫中所有的表的字段，和類中有有@Column的字段進行對比，如果不存在的就添加進來。

@Database(name = AppDatabase.NAME, version = AppDatabase.VERSION)
public class AppDatabase {
    //數(shù)據庫名稱
    public static final String NAME = "AppDatabase";
    //數(shù)據庫版本號
    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<Class<?>> 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. 溫馨提示

建議數(shù)據庫版本號和App的versionCode保持一致，在Application編寫檢查代碼，強提示，避免忘記修改數(shù)據版本號。

多用戶數(shù)據庫

比如類似微信，允許一個賬號A注銷后，登錄另外一個賬號B，注銷后再登錄賬號A，賬號A的數(shù)據庫不會被清空。
如果要實現(xiàn)這種邏輯，我們就要針對不同的用戶進行區(qū)分，不同的數(shù)據使用不同的數(shù)據庫。

    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<? extends DatabaseHolder> databaseHolderClass,Class<? extends BaseDatabase> databaseClass){
        flowConfig.addDatabaseHolder(databaseHolderClass);
        flowConfig.addDatabaseConfig(new DatabaseConfig.Builder(databaseClass).extensionName(MyInfo.getInstance().getUid()+".db").build());
    }

DBFlow 4.x 提供DatabaseConfig給我們對數(shù)據進行配置，可以用來配置數(shù)據庫名。我們可以通過這種方式來實現(xiàn)不同的用戶使用不同的數(shù)據庫。

溫馨提示

1. 切換賬號的時候，必須再次調用以上方法，用于銷毀DBFlow，重新初始化。

多Module開發(fā)

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

apt {
    arguments {
        targetModuleName 'SomeUniqueModuleName'
    }
}

就會生成對應的SomeUniqueModuleNameGeneratedDatabaseHolder類，初始化的時候添加進來即可

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