SwiftUI数据之Codegen 三种模式该如何选择

从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

https://www.jianshu.com/c/7b3e3b671970

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容

  • ————日常1:起床 “哦,天~已经是中午了要吃什么呢?啊,太阳好大。”埼玉转个身却看到一张大脸。 “老师,中午好...
    珊瑚赫阅读 448评论 0 1
  • 今天上午在家看一部电影《我们诞生在中国》,这部电影讲述的是关于动物世界的故事。在这部电影中有一只小猴子,当我看到这...
    尘若婵阅读 413评论 0 1
  • “你对我到底是什么感觉?”温阳终于鼓起勇气再次问了这个问题。 温阳在等乔木回复的时候,并不觉得忐忑。这一个多月,乔...
    只有我知道012阅读 637评论 0 0