Swift自定义Codable协议实现copy,保存。结构体和类、枚举嵌套的处理

在开发中,会经常遇到拷贝数据对象的情况,也会遇到保存数据到本地的情况,
如果是用OC的话,无论是copyWithZone还是归档解档,用runtime都可以很好地解决这个问题
在Swift中,不直接用runtime该怎么实现呢?
答案就是Codable
typealias Codable = Decodable & Encodable
Codable其实就是Decodable和Encodable

让需要实现解归档的类遵循Codable协议
然后用JSONEncoder来实现解归档
class TestClassAAA: Codable {
    var a = 0
    func copy() -> Self {
        let encoder = JSONEncoder()
        guard let data = try? encoder.encode(self) else {
            fatalError("encode failed")
        }
        let decoder = JSONDecoder()
        guard let target = try? decoder.decode(Self.self, from: data) else {
            fatalError("decode failed")
        }
        return target
    }
}

如果我们用很多对象都需要实现Codable呢?

可以用通用协议及默认实现

protocol ATCodable: Codable {
    func copy() -> Self
}

extension ATCodable {
    func copy() -> Self {
        let encoder = JSONEncoder()
        guard let data = try? encoder.encode(self) else {
            fatalError("encode failed")
        }
        let decoder = JSONDecoder()
        guard let target = try? decoder.decode(Self.self, from: data) else {
            fatalError("decode failed")
        }
        return target
    }
}

这样只需要遵循该协议即可实现copy、解归档了

这只是开始,实际项目中会有各种各样的异常情况

一、枚举

如果类或者结构体里有枚举属性,再去遵循Codable协议,则会报错,因为枚举是默认未遵循Codable
这里我们需要去兼容下枚举类型
同样去写个通用协议去遵循Codable

protocol CodableEnumeration: RawRepresentable, Codable where RawValue: Codable {
    static var defaultCase: Self { get }
}

extension CodableEnumeration {
    public init(from decoder: Decoder) throws {
        let container = try decoder.singleValueContainer()
        do {
            let decoded = try container.decode(RawValue.self)
            self = Self.init(rawValue: decoded) ?? Self.defaultCase
        } catch {
            self = Self.defaultCase
        }
    }
    public func encode(to encoder: Encoder) throws {
        var container = encoder.singleValueContainer()
        try container.encode(rawValue)
    }
}

然后所有需要遵循Codable的枚举去遵循CodableEnumeration并填上默认值defaultCase即可
系统枚举或者第三方库的枚举也同样适用

二、结构体

结构体分为自己写的和别人写的
自己写的结构体就很简单了,直接遵循ATCodable即可
如果是别人写的,比如第三方库的struct或者系统的struct
直接遵循ATCodable会报错 "Implementation of 'Decodable' cannot be automatically synthesized in an extension in a different file to the type"
也就是不能在extension或其他文件里去自动实现Codable
这种情况,我们只能去重写Codable的实现了

extension XXXRect: ATCodable {
    private enum CodingKeys:String,CodingKey{
        case left
        case right
        case bottom
        case top
    }
    public func encode(to encoder: Encoder) throws {
      var container = encoder.container(keyedBy:CodingKeys.self)
      try container.encode(left,forKey:.left)
      try container.encode(right,forKey:.right)
      try container.encode(bottom,forKey:.bottom)
      try container.encode(top,forKey:.top)
        }

    public init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        let left = try container.decode(Float.self,forKey:.left)
        let right = try container.decode(Float.self,forKey:.right)
        let bottom = try container.decode(Float.self,forKey:.bottom)
        let top = try container.decode(Float.self,forKey:.top)
        self = NvsRect(left: left, right: right, bottom: bottom, top: top)
    }
}

如果类中或者结构体中并不是所有属性都需要解归档,那就只把需要解归档的属性写在CodingKeys里,然后手动去实现即可

三、class

同样,如果是自己写的class,直接遵循ATCodable即可
但如果是别人写的,比如第三方库的class或者系统的class,也无法直接遵循ATCodable,而且也无法去实现
比如我们的class里有个UIImage属性,该怎么处理呢?
要么就是重写Codable

private enum CodingKeys : String, CodingKey {
        case thumImage
    }
    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        if let data = try? container.decode(Data.self, forKey: .thumImage) {
            thumImage = UIImage(data: data)
        }
    }
    public func encode(to encoder: Encoder) throws {
    var container = encoder.container(keyedBy: CodingKeys.self)
    if let image = thumImage {
        try container.encode(image.pngData(), forKey: .thumImage)
    }
}

如果自己实现了CodingKeys,则JsonDecoder是只会帮你解归档CodingKeys里的key的属性,其余的会忽略
如果不实现,则会默认解归档所有属性

所以这样同样有弊端,为了兼容一个UIImage,其他属性都得手动去实现Codable

那就换一个思路,可以将该image改造成计算属性,重新加一个默认实现Codable的Data来代替其去解归档

 var thumImage: UIImage? {
        get {
            UIImage(data: thumImageData ?? Data())
        }
        set {
            thumImageData = newValue?.pngData()
        }
    }
var thumImageData: Data?

其他的class也可以用同样的方式,比如PHAsset用其localIdentifier代替,UIColorInt代替等等

四、其它

一些基础数据类型Int,Float,Bool自然是直接就能解归档,字符串也一样

数组也是只要其element遵循Codable协议即可

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

推荐阅读更多精彩内容