iOS 數據庫升級數據遷移解決方案頂原薦

背景

很久以前就遇到過數據庫版本升級的引用場景，當時的做法是簡單的刪除舊的數據庫文件，重建數據庫和表結構，這種暴力升級的方式會導致舊的數據的丟失，考慮到數據升級和數據遷移這個問題以後還會遇到，這算是一個常用的場景吧，所以發點時間把這部分做了一個簡單重構，實現了一個簡單的方案。

結果

一番努力之後，終於有了結果
項目的開源地址：YTBaseDBManager
使用 Pod 導入，因爲是開發庫，所以需要指定 :path 參數

pod 'YTBaseDBManager', :path => '../'

客戶端使用的DEMO代碼如下

客戶端使用方法 [self setDBFilePath:DBPath newDBVersion:DB_Version]; 設置數據庫路徑
客戶端重寫模板方法 initTables 執行創建表的邏輯
底層庫會自動分析新表和舊錶，自動進行數據遷移的操作

/** 數據庫保存的緩存目錄 */
static NSString* kDBCache = @"DBCache";
/** 數據庫文件名稱 */
static NSString* DB_NAME = @"YTDB.sqlite";
/** 當前使用的數據庫版本，程序會根據版本號的改變升級數據庫以及遷移舊的數據 */
static NSString* DB_Version = @"1.0.0";

@implementation YTBusinessDBManager

- (instancetype)init {
    self = [super init];
    if (self) {
        // 創建數據庫文件
        NSString* cachePath = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) objectAtIndex:0];
        NSString *DBDir = [cachePath stringByAppendingPathComponent:kDBCache];
        BOOL isDir = NO;
        if (!([[NSFileManager defaultManager] fileExistsAtPath:DBDir isDirectory:&isDir] && isDir)) {
            [[NSFileManager defaultManager] createDirectoryAtPath:DBDir withIntermediateDirectories :YES attributes :nil error :nil];
        }
        NSString* DBPath = [DBDir stringByAppendingPathComponent:DB_NAME];
        
        // 設置數據庫路徑，包含了數據庫升級的邏輯
        [self setDBFilePath:DBPath newDBVersion:DB_Version];
    }
    return self;
}

// 初始化數據表
- (void)initTables {
    [VideoUploadModel createTableIfNotExists];
}

問題分析

理想的情況是：數據庫升級，表結構、主鍵和約束有變化，新的表結構建立之後會自動的從舊的表檢索數據，相同的字段進行映射遷移數據，而絕大多數的業務場景下的數據庫版本升級是隻涉及到字段的增減、修改主鍵約束，所以下面要實現的方案也是從最基本的、最常用的業務場景去做一個實現，至於更加複雜的場景，可以在此基礎上進行擴展，達到符合自己的預期的。

網上搜索了下，並沒有數據庫升級數據遷移簡單完整的解決方案，找到了一些思路

清除舊的數據，重建表
優點：簡單
缺點：數據丟失
在已有表的基礎上對錶結構進行修改
優點：能夠保留數據
缺點：規則比較繁瑣，要建立一個數據庫的字段配置文件，然後讀取配置文件，執行SQL修改表結構、約束和主鍵等等，涉及到跨多個版本的數據庫升級就變得繁瑣並且麻煩了
創建臨時表，把舊的數據拷貝到臨時表，然後刪除舊的數據表並且把臨時表設置爲數據表。
優點：能夠保留數據，支持表結構的修改，約束、主鍵的變更，實現起來比較簡單
缺點：實現的步驟比較多

綜合考慮，第三種方法是一個比較靠譜的方案。

方案的主要步驟

根據這個思路，分析了一下數據庫升級了主要步驟大概如下：

獲取數據庫中舊的表
修改表名,添加後綴“_bak”，把舊的表當做備份表
創建新的表
獲取新創建的表
遍歷舊的表和新表，對比取出需要遷移的表的字段
數據遷移處理
刪除備份表

使用到的SQL語句分析

這些操作都是和數據庫操作有關係的，所以問題的關鍵是對應步驟的SQL語句了，下面分析下用到的主要的SQL語句：

獲取數據庫中舊的表

SELECT * from sqlite_master WHERE type='table'

結果如下，可以看到有type | name | tbl_name | rootpage | sql 這些數據庫字段，我們只要用到name也就是數據庫名稱這個字段就行了

sqlite> SELECT * from sqlite_master WHERE type='table'
   ...> ;
+-------+---------------+---------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type  | name          | tbl_name      | rootpage | sql                                                                                                                                                                                                                   |
+-------+---------------+---------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| table | t_message_bak | t_message_bak | 2        | CREATE TABLE "t_message_bak" (messageID TEXT, messageType INTEGER, messageJsonContent TEXT, retriveTimeString INTEGER, postTimeString INTEGER, readState INTEGER, PRIMARY KEY(messageID))                             |
| table | t_message     | t_message     | 4        | CREATE TABLE t_message (
	messageID TEXT, 
	messageType INTEGER,
	messageJsonContent TEXT, 
	retriveTimeString INTEGER, 
	postTimeString INTEGER, 
	readState INTEGER, 
	addColumn INTEGER,
	PRIMARY KEY(messageID)
) |
+-------+---------------+---------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2 行於數據集 (0.03 秒)

修改表名,添加後綴“_bak”，把舊的表當做備份表

-- 把t_message表修改爲t_message_bak表  
ALTER TABLE t_message RENAME TO t_message_bak

獲取表字段信息

-- 獲取t_message_bak表的字段信息
PRAGMA table_info('t_message_bak')

sqlite> PRAGMA table_info('t_message_bak');
+------+--------------------+---------+---------+------------+------+
| cid  | name               | type    | notnull | dflt_value | pk   |
+------+--------------------+---------+---------+------------+------+
| 0    | messageID          | TEXT    | 0       | NULL       | 1    |
| 1    | messageType        | INTEGER | 0       | NULL       | 0    |
| 2    | messageJsonContent | TEXT    | 0       | NULL       | 0    |
| 3    | retriveTimeString  | INTEGER | 0       | NULL       | 0    |
| 4    | postTimeString     | INTEGER | 0       | NULL       | 0    |
| 5    | readState          | INTEGER | 0       | NULL       | 0    |
+------+--------------------+---------+---------+------------+------+
6 行於數據集 (0.01 秒)

使用子查詢進行數據遷移處理

INSERT INTO t_message(messageID, messageType, messageJsonContent, retriveTimeString, postTimeString, readState) SELECT messageID, messageType, messageJsonContent, retriveTimeString, postTimeString, readState FROM t_message_bak

把t_message_bak表中的messageID, messageType, messageJsonContent, retriveTimeString, postTimeString, readState這些字段的值複製到t_message表中

代碼實現

有了以上的分析，接下來的代碼的實現就很簡單了

主要方法

// 數據庫版本控制主要方法
- (void)versionControlWithNewDBVersion:(NSString*)newDBVersion {
    if (nil == _DBFilePath) {
        return;
    }
    
    // 獲取新舊版本
    NSString * version_old = YTBaseDBManager_ValueOrEmpty([self DBVersion]);
    NSString * version_new = [NSString stringWithFormat:@"%@", newDBVersion];
    NSLog(@"dbVersionControl before: %@ after: %@",version_old,version_new);
    
    // 數據庫版本升級
    if (version_old != nil && ![version_new isEqualToString:version_old]) {
        
        // 獲取數據庫中舊的表
        NSArray* existsTables = [self sqliteExistsTables];
        NSMutableArray* tmpExistsTables = [NSMutableArray array];
        
        // 修改表名,添加後綴“_bak”，把舊的表當做備份表
        for (NSString* tablename in existsTables) {
            [tmpExistsTables addObject:[NSString stringWithFormat:@"%@_bak", tablename]];
            [self.databaseQueue inDatabase:^(FMDatabase *db) {
                NSString* sql = [NSString stringWithFormat:@"ALTER TABLE %@ RENAME TO %@_bak", tablename, tablename];
                [db executeUpdate:sql];
            }];
        }
        existsTables = tmpExistsTables;
        
        // 創建新的表
        [self initTables];
        
        // 獲取新創建的表
        NSArray* newAddedTables = [self sqliteNewAddedTables];
        
        // 遍歷舊的表和新表，對比取出需要遷移的表的字段
        NSDictionary* migrationInfos = [self generateMigrationInfosWithOldTables:existsTables newTables:newAddedTables];
        
        // 數據遷移處理
        [migrationInfos enumerateKeysAndObjectsUsingBlock:^(NSString* newTableName, NSArray* publicColumns, BOOL * _Nonnull stop) {
            NSMutableString* colunmsString = [NSMutableString new];
            for (int i = 0; i<publicColumns.count; i++) {
                [colunmsString appendString:publicColumns[i]];
                if (i != publicColumns.count-1) {
                    [colunmsString appendString:@", "];
                }
            }
            NSMutableString* sql = [NSMutableString new];
            [sql appendString:@"INSERT INTO "];
            [sql appendString:newTableName];
            [sql appendString:@"("];
            [sql appendString:colunmsString];
            [sql appendString:@")"];
            [sql appendString:@" SELECT "];
            [sql appendString:colunmsString];
            [sql appendString:@" FROM "];
            [sql appendFormat:@"%@_bak", newTableName];
            
            [self.databaseQueue inDatabase:^(FMDatabase *db) {
                [db executeUpdate:sql];
            }];
        }];
        
        // 刪除備份表
        [self.databaseQueue inDatabase:^(FMDatabase *db) {
            [db beginTransaction];
            for (NSString* oldTableName in existsTables) {
                NSString* sql = [NSString stringWithFormat:@"DROP TABLE IF EXISTS %@", oldTableName];
                [db executeUpdate:sql];
            }
            [db commit];
        }];
        
        [self setDBVersion:version_new];
        
    } else {
        [self setDBVersion:version_new];
    }
}

提取數據遷移的列

// 遍歷舊的表和新表，對比取出需要遷移的表的字段
- (NSDictionary*)generateMigrationInfosWithOldTables:(NSArray*)oldTables newTables:(NSArray*)newTables {
    NSMutableDictionary<NSString*, NSArray* >* migrationInfos = [NSMutableDictionary dictionary];
    for (NSString* newTableName in newTables) {
        NSString* oldTableName = [NSString stringWithFormat:@"%@_bak", newTableName];
        if ([oldTables containsObject:oldTableName]) {
            // 獲取表數據庫字段信息
            NSArray* oldTableColumns = [self sqliteTableColumnsWithTableName:oldTableName];
            NSArray* newTableColumns = [self sqliteTableColumnsWithTableName:newTableName];
            NSArray* publicColumns = [self publicColumnsWithOldTableColumns:oldTableColumns newTableColumns:newTableColumns];
            
            if (publicColumns.count > 0) {
                [migrationInfos setObject:publicColumns forKey:newTableName];
            }
        }
    }
    return migrationInfos;
}

// 提取新表和舊錶的共同表字段，表字段相同列的才需要進行數據遷移處理
- (NSArray*)publicColumnsWithOldTableColumns:(NSArray*)oldTableColumns newTableColumns:(NSArray*)newTableColumns {
    NSMutableArray* publicColumns = [NSMutableArray array];
    for (NSString* oldTableColumn in oldTableColumns) {
        if ([newTableColumns containsObject:oldTableColumn]) {
            [publicColumns addObject:oldTableColumn];
        }
    }
    return publicColumns;
}

獲取數據庫表的所有列

// 獲取數據庫表的所有的表字段名
- (NSArray*)sqliteTableColumnsWithTableName:(NSString*)tableName {
    __block NSMutableArray<NSString*>* tableColumes = [NSMutableArray array];
    [self.databaseQueue inDatabase:^(FMDatabase *db) {
        NSString* sql = [NSString stringWithFormat:@"PRAGMA table_info('%@')", tableName];
        FMResultSet *rs = [db executeQuery:sql];
        while ([rs next]) {
            NSString* columnName = [rs stringForColumn:@"name"];
            [tableColumes addObject:columnName];
        }
    }];
    return tableColumes;
}

獲取數據庫中的表

// 獲取數據庫中舊的表
- (NSArray*)sqliteExistsTables {
    __block NSMutableArray<NSString*>* existsTables = [NSMutableArray array];
    [self.databaseQueue inDatabase:^(FMDatabase *db) {
        NSString* sql = @"SELECT * from sqlite_master WHERE type='table'";
        FMResultSet *rs = [db executeQuery:sql];
        while ([rs next]) {
            NSString* tablename = [rs stringForColumn:@"name"];
            [existsTables addObject:tablename];
        }
    }];
    return existsTables;
}

// 獲取新創建的表
- (NSArray*)sqliteNewAddedTables {
    __block NSMutableArray<NSString*>* newAddedTables = [NSMutableArray array];
    [self.databaseQueue inDatabase:^(FMDatabase *db) {
        NSString* sql = @"SELECT * from sqlite_master WHERE type='table' AND name NOT LIKE '%_bak'";
        FMResultSet *rs = [db executeQuery:sql];
        while ([rs next]) {
            NSString* tablename = [rs stringForColumn:@"name"];
            [newAddedTables addObject:tablename];
        }
    }];
    return newAddedTables;
}

方案通用化

上面是數據庫升級數據遷移解決方案的核心內容，在此基礎上添加點東西就可以讓這個方案可以通用了。
對於客戶端來說，客戶端關心的問題有以下：

數據庫文件的路徑設置
觸發數據庫升級邏輯
數據表的創建

這些內容在不同的業務場景中都是不可缺少的必要部分，所以對可以對共同的部分做作一個封裝。

注入

對於數據庫文件的路徑設置和觸發數據庫升級邏輯，底層庫只關心對應的參數，客戶端傳遞參數給底層庫，底層庫會進行處理，這也就是注入的部分，可以採用構造注入或者設置注入的方式來解耦這部分。設置注入靈活性更好一些，所以採用設置注入的方式，實現起來很簡單，就是添加一個設置數據庫路徑和數據庫新版本的方法就行了。

設置數據庫文件路徑和版本號的方法，該方法除了設置數據庫文件路徑，還進行了數據庫升級邏輯的操作，這部分對客戶端是隱藏的。

// ！！！設置數據庫文件路徑和版本號
- (void)setDBFilePath:(NSString *)DBFilePath newDBVersion:(NSString*)newDBVersion {
    // 設置數據庫文件路徑
    _DBFilePath = DBFilePath;
    [[NSFileManager defaultManager] setAttributes:[NSDictionary dictionaryWithObject:NSFileProtectionNone forKey:NSFileProtectionKey] ofItemAtPath:_DBFilePath error:NULL];
    
    // 數據庫版本控制
    // 當前的方法如果是放在初始化方法中
    // versionControlWithNewDBVersion 方法調用 initTables 方法 會使用到當前單例對象
    // 因爲初始化未完成，所以會造成死鎖的問題，versionControlWithNewDBVersion 方法調用採用延遲的策略
    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(1 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
        [self versionControlWithNewDBVersion:newDBVersion];
    });
}

模板方法

對於數據表的創建，底層庫不關心具體的表創建邏輯，而只需要用到創建之後的表的名稱和表的字段名稱這些數據，也就是創建表的結果，可以可以把這些內容延遲放置到子類中處理，所以這裏用到了模板方法模式。

#pragma mark - ......::::::: 模板方法，子類重寫 :::::::......

// 初始化數據表
- (void)initTables;

子類重寫該方法執行表創建的邏輯

// 初始化數據表
- (void)initTables {
    // 創建視頻上傳記錄表
    [VideoUploadModel createTableIfNotExists];
}

單例

數據庫操作是資源密集型的操作，創建多個對象會導致資源消耗嚴重，此外多個對象操作同一個數據庫文件也會引入數據不一致等問題，所以這裏使用單例模式。
OC中標準的單例是不支持繼承的，這裏使用標準的方式，所以還是把單例放在子類中進行創建。
多說一句，OC可以使用Runtime的方式達到單例可繼承的目的，但是出於簡單和謹慎考慮沒有這麼做。

.h
// 子類的單例
+ (instancetype)sharedInstance;

.m
// 子類的單例
+ (instancetype)sharedInstance{
    static id instance;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instance = [[self alloc] init];
    });
    return instance;
}

One More Thing

項目的開源地址： YTBaseDBManager

TODO

項目依賴於FMDB，庫的公有屬性暴露給客戶端的是一個FMDatabaseQueue類的對象，所以這裏存在耦合，暫時沒有想到好的辦法解除這個耦合。

iOS 數據庫升級數據遷移解決方案頂原薦

背景

結果

問題分析

方案的主要步驟

使用到的SQL語句分析

代碼實現

主要方法

提取數據遷移的列

獲取數據庫表的所有列

獲取數據庫中的表

方案通用化

注入

模板方法

單例

One More Thing

TODO

iOS使用fastlane實現持續集成的方法教程

iOS自動進行View標記的方法詳解

iOS實現換膚功能的簡單處理框架（附源碼）

iOS使用核心的50行代碼實現一個路由組件頂原薦

iOS 組件化實現的一些思路總結頂原薦

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

iOS 數據庫升級數據遷移解決方案 頂 原 薦

背景

結果

問題分析

方案的主要步驟

使用到的SQL語句分析

代碼實現

主要方法

提取數據遷移的列

獲取數據庫表的所有列

獲取數據庫中的表

方案通用化

注入

模板方法

單例

One More Thing

TODO

iOS 數據庫升級數據遷移解決方案頂原薦