从Xcode8开始,Apple在Xcode数据模型编辑器中添加了新的Codegen设置,以帮助开发人员管理和维护其NSManagedObject子类。 Codegen设置包含3种可能的配置
- Manual/None
- Class Definition
- Category/Extension
最初,这3种配置可能看起来有些混乱,我发现实际上很难找到一篇很好的文章来解释每种配置之间的区别以及使用哪种配置。
在本文中,我将详细介绍每种配置,并分析每种配置之间的差异,并提出一些建议,说明应该在核心数据项目中使用哪种配置以及如何使用它。事不宜迟,让我们开始吧!
Manual/None
这是Xcode8之前的默认行为,开发人员必须手动创建和维护NSManagedObject子类的更改。
TestEntity+CoreDataClass.swift
TestEntity+CoreDataProperties.swift
生成这两个文件后,您应该可以在项目中使用TestEntity。尝试将以下代码行复制到您的应用程序委托中,您的项目应编译没有任何错误。
let _ = TestEntity(context: persistentContainer.viewContext)
Class Definition
在数据模型编辑器中创建实体时,此配置是默认的Codegen配置。使用此配置,Xcode将自动生成所需的NSManagedObject子类,作为项目派生数据的一部分。
现在,不用手动创建TestEntity + CoreDataClass.swift和TestEntity + CoreDataProperties.swift)。但是请注意,这两个文件均不在您的Xcode项目中,实际上它们都位于Xcode的“Derived Data”文件夹中。
切勿编辑自动生成的文件,因为它们由Xcode管理,因此,每次构建项目时,它们都会被Xcode覆盖。
Category/Extension
可以在“类定义”和“手动/无”之间描述此配置。 Xcode只会自动为您生成TestEntity + CoreDataProperties.swift,而您将必须自己管理和维护TestEntity + CoreDataClass.swift。
请告诉我使用哪个
希望上面的解释可以使您对每个Codegen配置的工作方式有一个更清晰的了解。但是,您应该在下一个CoreData项目中使用哪一个呢?
Class Definition
此配置非常适合开发简单的应用程序或在原型开发阶段。在编辑数据模型时,您不必担心更新或维护NSManagedObject子类,Xcode会为您解决。但是,您对NSManagedObject子类没有任何控制权,因此导致此配置使用起来不太灵活。Category/Extension
此配置适用于大多数核心数据应用程序。大多数情况下,更新数据模型时无需执行任何操作。但是,您可以灵活地将所需的任何自定义函数添加到NSManagedObject子类中。让我们看一下以下用例:
假设您的TestEntity有一个名为base64的属性,它表示图像的base64编码字符串。通过使用Category / Extension配置,可以通过添加名为image的计算属性和有助于执行base64编码/解码操作的自定义函数来定制iseTestEntity + CoreDataClass.swift。这是TestEntity + CoreDataClass.swift的示例
import Foundation
import CoreData
import UIKit
@objc(TestEntity)
public class TestEntity: NSManagedObject {
var image: UIImage {
set {
base64 = base64(from: image)
}
get {
return image(from: base64!)
}
}
}
extension TestEntity {
func base64(from image: UIImage) -> String {
// ************************************** //
// UIImage to base64 encoding logic here! //
// ************************************** //
return "base64-encoded-string"
}
func image(from base64: String) -> UIImage {
// ************************************** //
// base64 to UIImage decoding logic here! //
// ************************************** //
return UIImage()
}
}
要将值设置为base64,您只需要两行代码即可:
let entity = TestEntity(context: persistentContainer.viewContext)
entity.image = UIImage(named: "sample-image")!
- Manual/None
在大多数情况下,类别/扩展配置足以满足您的核心数据应用程序的需求。但是,如果您需要更全面的掌控系统,则可以使用“手动/无”配置将其更进一步。让我们重新看一下以前的base64示例,看看如何从那里改进。
由于您的代码仅访问TestEntity的图像,因此应通过将base64属性设置为私有来对其进行封装。此外,如果您知道base64绝不能为nil,也可以将base64设为非可选属性
要实现此目的,请从TestEntity + CoreDataProperties.swift中删除base64声明,并在TestEntity + CoreDataClass.swift中添加一个非可选的私有base64声明。
import Foundation
import CoreData
extension TestEntity {
@nonobjc public class func fetchRequest() -> NSFetchRequest<TestEntity> {
return NSFetchRequest<TestEntity>(entityName: "TestEntity")
}
}
import Foundation
import CoreData
import UIKit
@objc(TestEntity)
public class TestEntity: NSManagedObject {
@NSManaged private var base64: String
var image: UIImage {
set {
base64 = base64(from: image)
}
get {
return image(from: base64)
}
}
}
extension TestEntity {
func base64(from image: UIImage) -> String {
// ************************************** //
// UIImage to base64 encoding logic here! //
// ************************************** //
return "base64-encoded-string"
}
func image(from base64: String) -> UIImage {
// ************************************** //
// base64 to UIImage decoding logic here! //
// ************************************** //
return UIImage()
}
}
功能强大,责任重大……通过使用“手动/无代码生成”配置,Xcode不再为您维护NSManagedObject子类,因此,每次对数据模型进行更改时,您都必须手动对其进行更新。
总结
如果您不熟悉核心数据,则可以从“类定义”配置开始。熟悉核心数据并希望对NSManagedObject类有更多控制后,您可以随时切换项目以使用其他适合您项目需求的Codegen配置。
技术交流
QQ:3365059189
SwiftUI技术交流QQ群:518696470
- 请关注我的专栏icloudend, SwiftUI教程与源码