coredata数据库升级

在真实开发中&＃xff0c;因为需求是不断变化的&＃xff0c;说不定什么时候就需要往模型里添加新的字段&＃xff0c;添加新的模型&＃xff0c;甚至是大规模的重构&＃xff1b;所以数据的迁移就显得尤为重要了。
CoreData 中&＃xff0c;数据迁移本质就是把旧的 SQLite 数据库里的内容&＃xff0c;复制到新的 SQLite 数据库里去&＃xff0c;让新的数据库作为默认的数据存储。伴随着模型版本的变化&＃xff0c;新旧两个数据库的实体结构当然也是不同的。这就是说在迁移过程中必须知道新旧两个数据库的模型对应关系&＃xff0c;旧数据库里的数据该怎么复制到新的数据库中。这在 CoreData 中是由 MappingModel 映射模型来决定的。我们所需要做的就是创建 MappingModel 文件&＃xff0c;指定好实体不同版本间的映射&＃xff0c;CoreData 就会自动帮我们完成数据迁移。当然如果模型版本的变化比较小&＃xff0c;CoreData 是可以自动推断出映射模型的。下面就来详细的介绍一下 CoreData 里常用的几种迁移。

创建模型版本

在介绍数据迁移之前&＃xff0c;先来看如何创建新的模型版本&＃xff0c;在 Xcode 里模型是通过 .xcdatamodeld 文件来创建的&＃xff0c;实际上这个文件就是一个包&＃xff0c;里面可以包含不同的模型版本。选中这个文件&＃xff0c;然后点击 Editor->Add Model Version... 就可以添加一个新的模型版本。

add-model-version-w400

然后会弹出下面这个对话框&＃xff0c;默认的新的模型会在原来的基础上增加一个数字&＃xff0c;来标识不同的模型版本。这个数字也是可以更改的&＃xff0c;你可以按照自己的喜好更改成 v2 或者其他的。

version-name-w600

点击 finish 后就会看到现在的 LearnCoreData.xcdatamodeld文件可以展开了&＃xff0c;里面包含了所有的模型版本文件&＃xff0c;它们是 xcdatamodel 格式的。在右侧的 File Inspector 面板中可以指定当前的模型版本,然后程序打包后就会把选中的模型版本作为当前的默认版本。

model-version-w300

自动推断映射模型

上面说到对于一些较小的变化&＃xff0c;CoreData 是可以自动推断映射模型的&＃xff0c;从而帮助我们自动地完成数据迁移。针对下面这些改动&＃xff0c;CoreData 都可以自动的进行推断&＃xff1a;

• 添加一个属性
• 移除一个属性
• 非空的属性变成可以为空的
• 可以为空的属性变成非空属性并设置一个默认值
• 重命名实体或者属性&＃xff08;需要设置 renaming identifier&＃xff09;
• 添加/删除 RelationShip
• 重命名 RelationShip&＃xff08;需要设置 renaming identifier&＃xff09;
• 把一个 RelationShip 从 对一改成对多&＃xff0c;或者把非排序的改成排序的。&＃xff08;反过来也是可以的&＃xff09;

上面说到的 renaming identifier 可以在 Model Inspector 进行设置&＃xff0c;对不同版本的对应实体/属性设置相同的 Renaming ID&＃xff0c;CoreData 就可以自动推断出对应的映射模型。

renaming-identifier-w600

除此之外&＃xff0c;在向 persistentStoreCoordinator 调用 addPersistentStoreWithType:configuration:URL:options:error: 添加 persistentStore时&＃xff0c;需要将 options 的 NSMigratePersistentStoresAutomaticallyOption 和 NSInferMappingModelAutomaticallyOption 两个 key 设置为 YES&＃xff0c;CoreData 才会自动推断。

注意 &＃xff1a;这里的renamingid何时使用呢&＃xff1f;就是如果说原来的字段比如叫做A, 新的数据库想把名字改为B,但是值还是之前的&＃xff0c;那么就需要在新的数据库中设置这个renamingid的值&＃xff0c;如果原来的对应的字段没有设置renamingid&＃xff0c;那么默认就需要在新的数据库字段的renamingid一栏写成原来数据库对应的字段的名字。如果原来的字段也设置了renamingid&＃xff0c;那么就需要在新的里面也要写上这个renamingid&＃xff0c;即新的数据库和旧的数据库同一字段的renamingid也一致&＃xff0c;才能达到只改字段名字的效果。

下面我们来看一下&＃xff0c;怎么使用自动推断。这是初始版本的 StudentEntity 实体的结构&＃xff1a;

StudentEntity-1-w600

下面我们再创建一个 Model Version&＃xff0c;把原来的 StudentEntity、ClassEntity、CourseEntity 的 EntityName 分别修改成 Student、Clazz、Course&＃xff1b;Student 里面的字段修改成 name、id 和 age&＃xff0c;另外再添加一个 BOOL 字段 sex&＃xff0c;表示性别&＃xff0c;默认值设置为 YES。

StudentEntity-2-w600

然后为两个版本中修改过的实体名字和属性字段名字设置相同的 renaming identifier。以 Student 的 name 字段为例&＃xff0c;旧版的模型中&＃xff1a;

studentName-RenamingID-w600

然后新版本的模型中&＃xff1a;

new-name-w600

修改好后&＃xff0c;暂时我们先不切换到新版本的模型中&＃xff0c;先用旧的数据库生成一些测试数据&＃xff0c;然后在沙盒的 Library/Application Support/ 目录里复制出里边的三个文件&＃xff0c;然后用 SQLite 工具打开 .sqlite 的数据库文件查看数据库的的结构&＃xff0c;和刚存进去的内容。

sqlite-w600

这是打开后的 StudentEntity 表&＃xff0c;里面随机插入了 300 条数据&＃xff0c;注意到现在由我们创建的几个字段分别是 ZSTUDENTID、ZSTUDENTCLASS、ZSTUDENTNAME。

StudentEntity-v1-w600

现在我们把数据库切换到新版中&＃xff0c;然后再运行一次程序&＃xff0c;重新打开新生成的数据库文件&＃xff0c;就会看到新版的数据库的结构&＃xff1a;

StudentEntity-v2-w600

现在 StudentEntity 已经变成了 Student&＃xff0c;每个字段也都变成了新的字段名&＃xff0c;而且里面也多了我们添加的 sex 字段。这就说明 CoreData 的自动推断成功了。

自定义映射模型

大多数情况下自动推断就能帮我们完成数据的迁移&＃xff0c;但当数据的变化更复杂时&＃xff0c;例如如果我们把 Student 里的一个字段提取出来放到一个新的字段中去。就得靠我们手动创建 mapping model 了。例如我们现在想把上面 Clazz 表删除&＃xff0c;原来的 Student 中的 clazz 字段用 clazzName 字段来代替。那么这种情况下就需要手动来创建 mapping model 了。
在这之前我们先用旧版的数据模型插入一些示例的数据&＃xff0c;这是插入的 Student 数据&＃xff1a;

Student-data-w600

Clazz 数据&＃xff1a;

Clazz-data-w600

Course 数据&＃xff1a;

Course-data-w600

因为 Course 和 Student 是多对多的关系&＃xff0c;所以还会有一张关联表&＃xff1a;

SCoursesStudents-data-w600

这是插入示例数据的代码&＃xff1a;

1. - (void)insertManyStudents {
2. NSSet *science &＃61; [self scienceCourses];
3. NSSet *art &＃61; [self artCourses];
4. Clazz *clazz1 &＃61; [[Clazz alloc] initWithContext:self.persistentContainer.viewContext];
5. clazz1.clazzName &＃61; &＃64;"文科一班";
6. clazz1.classId &＃61; 1;
8. Clazz *clazz2 &＃61; [[Clazz alloc] initWithContext:self.persistentContainer.viewContext];
9. clazz2.clazzName &＃61; &＃64;"理科一班";
10. clazz2.classId &＃61; 2;
11. for (NSUInteger i &＃61; 0; i <300; i&＃43;&＃43;) {
12. NSString *name &＃61; [NSString stringWithFormat:&＃64;"student-%u", arc4random_uniform(100000)];
13. int16_t age &＃61; (int16_t)arc4random_uniform(10) &＃43; 10;
14. int16_t stuId &＃61; (int16_t)arc4random_uniform(INT16_MAX);
15. Student *student &＃61; [NSEntityDescription insertNewObjectForEntityForName:&＃64;"Student" inManagedObjectContext:self.persistentContainer.viewContext];
16. student.name &＃61; name;
17. student.age &＃61; age;
18. student.id &＃61; stuId;
19. if (i % 2 &＃61;&＃61; 0) {
20. student.clazz &＃61; clazz1;
21. student.courses &＃61; art;
22. } else {
23. student.clazz &＃61; clazz2;
24. student.courses &＃61; science;
25. }
27. }
28. NSError *error;
31. [self.persistentContainer.viewContext save:&error];
32. }
34. - (NSSet *)scienceCourses {
36. Course *physics &＃61; [[Course alloc] initWithContext:self.persistentContainer.viewContext];
37. physics.courseName &＃61; &＃64;"物理";
38. physics.courseId &＃61; 1;
39. physics.courseChapterCount &＃61; 5;
41. Course *chemistry &＃61; [[Course alloc] initWithContext:self.persistentContainer.viewContext];
42. chemistry.courseName &＃61; &＃64;"化学";
43. chemistry.courseId &＃61; 2;
44. chemistry.courseChapterCount &＃61; 9;
46. Course *biology &＃61; [[Course alloc] initWithContext:self.persistentContainer.viewContext];
47. biology.courseName &＃61; &＃64;"生物";
48. biology.courseId &＃61; 3;
49. biology.courseChapterCount &＃61; 10;
51. NSSet *courses &＃61; [NSSet setWithObjects:physics, chemistry, biology, nil];
52. return courses;
53. }
55. - (NSSet *)artCourses {
56. Course *chinese &＃61; [[Course alloc] initWithContext:self.persistentContainer.viewContext];
57. chinese.courseName &＃61; &＃64;"语文";
58. chinese.courseId &＃61; 4;
59. chinese.courseChapterCount &＃61; 12;
61. Course *history &＃61; [[Course alloc] initWithContext:self.persistentContainer.viewContext];
62. history.courseName &＃61; &＃64;"历史";
63. history.courseId &＃61; 5;
64. history.courseChapterCount &＃61; 19;
66. Course *geography &＃61; [[Course alloc] initWithContext:self.persistentContainer.viewContext];
67. geography.courseName &＃61; &＃64;"地理";
68. geography.courseId &＃61; 6;
69. geography.courseChapterCount &＃61; 21;
71. return [NSSet setWithObjects:chinese, geography, history, nil];
72. }

然后我们再来看一下 新创建的 v3 版本的数据模型的结构&＃xff1a;
Student 表

Student-table-w600

Course 表

Course-table-w600

这一次我们不再创建 Clazz 表了&＃xff0c;因为它要被 Student 表里的 clazzName 字段代替。

接下来创建 Mapping Model 文件

Mapping-Model-w600

创建过程中需要选择 Source data model 和 Destination data model,也就是迁移的旧版和新版数据模型版本&＃xff0c;分别选择 v2 和 v3 版本&＃xff1a;

Source-data-model-w600

Target-data-model-w600

最后保存的文件名建议按一定的规则来命名&＃xff0c;后期也方便查找&＃xff1a;

Save-mapping-model-w600

然后我们来认识一下 mapping model 的用法&＃xff0c;创建好后&＃xff0c;mapping model 还是会自动推断出大多数的字段映射&＃xff0c;例如 Student 表中除新添加的 clazzName 字段外&＃xff0c;其他的都可以正确的推断出来&＃xff1b;

StudentToStudent-mapping-w600

当然&＃xff0c;如果字段名修改过的话&＃xff0c;同样是不能推断出来的&＃xff0c;如 Course 表的字段&＃xff1a;

CourseToCourse-mapping-w600

另外每个 Entity Mapping 的名字的命名规则是以 SourceEntityNameToDestinationEntityName 来命名的&＃xff0c;这个可以在右侧的面板中修改&＃xff1a;

Entity-Mapping-name-w600

下面来介绍 mapping model 中会用到的几个对象&＃xff1a;

• $source - 对应着 NSMigrationSourceObjectKey&＃xff0c;可以理解为 Source Model 的一个实体对象
• $manager - 对应着 NSMigrationManagerKey&＃xff0c;它代表的是 NSMigrationManager 对象&＃xff0c;正是这个对象在迁移过程中发挥着作用&＃xff0c;它管理着源对象和目标对象之间的关联

除了这两个&＃xff0c;还有几个不常用的&＃xff1a;

• $destination -- NSMigrationDestinationObjectKey
• $entityMapping -- NSMigrationEntityMappingKey
• $propertyMapping -- NSMigrationPropertyMappingKey
• $entityPolicy -- NSMigrationEntityPolicyKey

在 mapping model 中可以通过 \$ 加对应的名字&＃xff0c;直接访问这几个对象。例如上面图中 \$source.name 就代表源对象的 name 属性。同样的我们就可以把其他未推断出来的填上&＃xff1a;

-w600

-w600

然后再来看 Relationship Mapping 映射&＃xff1a;

对于这种关联到外部表的字段&＃xff0c;相对于普通字段会复杂一些&＃xff0c;我们需要通过右侧的面板来进行配置&＃xff0c;Name 代表 RelationShip 的字段名&＃xff1b;Key Path 代表这个字段对应的源对象上的字段&＃xff0c;对于 courses 来说就是 $source.courses&＃xff1b;然后是 Mapping Name&＃xff0c;它代表这个 RelationShip 所关联的外部表的 Entity Mapping&＃xff0c;对于 courses 来说就是 Course 的 Entity Mapping 也就是 CourseToCourse。配置好这些后&＃xff0c;Xcode 会生成一段长长的 Value Expression 表达式&＃xff1a;

FUNCTION($manager, "destinationInstancesForEntityMappingNamed:sourceInstances:" , "CourseToCourse", $source.courses)

意思就是调用 $manager 对象的 destinationInstancesForEntityMappingNamed:sourceInstances: 方法 CourseToCourse 和 \$source.courses 分别是两个传入参数。 它会根据 CourseToCourse 的映射规则生成$source.courses 的目标对象。
同样的&＃xff0c;我们可以据此来配置 Course 里的 students 关系&＃xff1a;

-w600

所有字段都配置完后&＃xff0c;就可以把 模型版本切换都 v3 然后运行程序。程序在运行时发现当前的 v3 版本数据模型和本地存储的 v2 数据库版本不一致&＃xff0c;就会自动从 bundle 里寻找对应 v2 到 v3 的 Mapping Model&＃xff0c;依据自定义的 Mapping Model&＃xff0c;数据就会自动迁移完成。
下面来看一下迁移完成的 v3 版本数据库。
Student 表&＃xff1a;

Student-table-v3-w600

Course 表&＃xff1a;

Course-table-v3-w600

自动生成的 Course 和 Student 之间的关联表&＃xff1a;

Students-table-v3-w600

可以看到 Student 表中的 clazz 字段已经被 clazzName 替换了。同时其他的数据也都没有丢失。