iOS数据库升级

最近重新处理了一下项目中数据库升级的部分，把思路和实现稍微记录一下。

关于数据库升级，首先我们需要一个常量，来标识我的数据库版本号应该是多少

//2017年7月1号第1版 (指定的一个数据库的版本号）
static int kDBVersion = 2017070101;

好了，程序第一次运行，程序会复制数据库，并把2017070101这个版本号写入到数据库中。

- (void)initializeFXDB {
    NSString *path = [NSString stringWithFormat:@"%@fenxiao.db",[GlobalVariables getCustomResourcePath]];
    if (![[NSFileManager defaultManager] fileExistsAtPath:path]) {
        [self copyFile2Documents:@"fenxiao.db"];
    }
}

如果你的程序版本号未进行升级，仍然是当前版本的话，其实就没有其他逻辑了。

如果我的程序有数据库更新，这时就需要升级我程序中的数据库版本号：

指定到需要升级到的数据库版本
static int kDBVersion = 2018010101;

新的程序执行依然去检查数据库，没有就复制目录中的数据库到沙盒中，并写入2018010101版本号；要是沙盒中有数据库文件，就取出数据库的版本号，来比较大小。
如果发现数据的版本号小于当前程序的版本，将数据库升级到当前版本，把程序的数据库版本号2018010101 写入数据库。

- (void)initializeFXDB {
    NSString *path = [NSString stringWithFormat:@"%@fenxiao.db",[GlobalVariables getCustomResourcePath]];
    if (![[NSFileManager defaultManager] fileExistsAtPath:path]) {
        [self copyFile2Documents:@"fenxiao.db"];
    }
    if ([self getDatabaseVersion] == 0) {
        [self setDatabaseVersion:kDBVersion];
    } else {
        //读取数据中的版本号，与程序中的VERSION_CODE 进行比较，如果相等，就什么都不做，如果小于，也不做，直接把数据版本号写入数据库。
        if ([self getDatabaseVersion] <= kDBVersion) {
            [self onUpgradeWithOldVesion:[self getDatabaseVersion] newVersion:kDBVersion];
            kDBVersion = [self getDatabaseVersion];
        } else {
            [self setDatabaseVersion:kDBVersion];
        }
    }
}

升级的逻辑非常简单，现在来写一下具体的升级的方法。

首先看一下脚本文件的目录

image.png

我们需要读取所有的升级脚本文件，按照名称进行排序，把文件名称转换成数字，大于数据版本号的升级脚本都执行一遍。

//升级数据库版本方法
- (void)onUpgradeWithOldVesion:(int)oldVersion newVersion:(int)newVersion{
    [self executeMigrationsWithOldVesion:oldVersion newVersion:newVersion];
}

//顺序执行每个脚本文件
- (BOOL)executeMigrationsWithOldVesion:(int)oldVersion newVersion:(int)newVersion{
    BOOL migrationExecuted = false;
    @try {
        NSString *path = [[NSBundle mainBundle] bundlePath];
        NSFileManager *fileManger = [NSFileManager defaultManager];
        NSArray *files = [fileManger contentsOfDirectoryAtPath:[NSString stringWithFormat:@"%@/Migrations",path] error:nil];
        
        for (NSString *file in files) {
            @try {
                int version = [[file replace:@".sql" withStr:@""] intValue];
                if (version > oldVersion && version <= newVersion) {
                    [self executeSqlScript:db file:file];
                    migrationExecuted = true;
                }
            } @catch (NSException *exception) {
                FXLog(@"%@",exception);
            }
        }
    } @catch (NSException *exception) {
        FXLog(@"%@",exception);
    }
    return migrationExecuted;
}

//逐行读取sql语句，拼接后运行每个脚本文件的sql语句
- (void)executeSqlScript:(FMDatabase *)db file:(NSString *)file{
    @try {
        NSString *path = [[NSBundle mainBundle] pathForResource:[NSString stringWithFormat:@"Migrations/%@",file] ofType:nil];
        NSFileHandle *fh = [NSFileHandle fileHandleForReadingAtPath:path];
        NSData *data = [fh readDataToEndOfFile];
        NSString *string = [[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding];
        
        NSArray *array = [string componentsSeparatedByString:@"\n"];
        NSString *line = @"";
        NSString *sb = @"";
        for (int i = 0; i<array.count; i++) {
            line = array[i];
            if (line.length > 0) {
                if ([[line substringFromIndex:(line.length -1)] isEqualToString:@";"]) {
                    sb = [sb stringByAppendingString:line];
                } else {
                    sb = [sb stringByAppendingString:[NSString stringWithFormat:@"%@ ",line]];
                }
            }
        }
        //使用FMDB的话，此处需要使用executeStatements：方法，因为更新语句中可能存在重复语句，应当跳过去继续执行，弱否则语句不能继续执行下去。
        [[FXFMDB_DBTool dbTool].dbQueue inTransaction:^(FMDatabase * _Nonnull db, BOOL * _Nonnull rollback) {
            [db executeStatements:sb];
        }];
        //每次升级完成脚本后 设置数据库版本号
        [self setDatabaseVersion:[[file replace:@".sql" withStr:@""] intValue]];
    } @catch (NSException *exception) {
        FXLog(@"%@",exception);
        @throw exception;
    }
}

整个数据库升级过程就完成了，现在将上述过程中获取数据库版本等方法补充上,根据实现功能自行百度也可。

//将数据库文件从资源库剪切到Documents目录，由于在沙盒里只有Documents目录是可读写的
- (NSString *)copyFile2Documents:(NSString*)fileName
{
    NSFileManager *fileManager = [NSFileManager defaultManager];
    NSError *error;
    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory,NSUserDomainMask, YES);
    NSString *documentsDirectory = [paths objectAtIndex:0];
    
    NSString *destPath =[documentsDirectory stringByAppendingPathComponent:fileName];
//    NSString *path = [[NSBundle mainBundle] pathForResource:[NSString stringWithFormat:@"Migrations/%@",fileName] ofType:nil];
    //  如果目标目录也就是(Documents)目录没有数据库文件的时候，才会复制一份，否则不复制
    if(![fileManager fileExistsAtPath:destPath]){
        NSString *sourcePath = [[NSBundle mainBundle] pathForResource:fileName ofType:nil];
        if (!sourcePath) {
            FXLog(@"sourcepath 为空！");
            @throw [NSException exceptionWithName:@"sourcepath 为空" reason:@"sourcepath 为空！" userInfo:nil];
            return @"";
        }
        [fileManager copyItemAtPath:sourcePath toPath:destPath error:&error];
    }
    return destPath;
}
//获取数据库版本号
- (int)getDatabaseVersion {
    __block int r = 0;
    NSArray<GXLinkedDictionary *> *arr = [[FXFMDB_DBTool dbTool] executeQuery:@"pragma user_version ; "];
    if (!arr || arr.count == 0) {
        return 0;
    }    
    GXLinkedDictionary *dict = arr[0];
    if (!dict || dict.count == 0) {
        return 0;
    }  
    [dict gxEnumerateKeysAndObjectsUsingBlock:^(id  _Nonnull key, id  _Nonnull obj, BOOL * _Nonnull stop) {
        r = (int)[obj longLongValue];
    }];
    return r;
}
//设置数据库版本号
- (void)setDatabaseVersion:(int)version {
    NSString *query = [NSString stringWithFormat:@"pragma user_version = %d", version];
    NSArray<GXLinkedDictionary *> *arr = [[FXFMDB_DBTool dbTool] executeQuery:query];
    if (arr.count) {
        FXLog(@"设置版本号为%d",version);
    }
}