Swift- 使用codable为class实现完美的copy方法

背景

有时候我们会遇到需要使用一个数据对象副本的情况. 在OC中因为每一个类都是继承NSObject, 调用对应copy方法, 实现copyWithZone就好.

但是Swift中使用struct居多, class没有特殊情况并不会继承NSObjec. 而且想copy一个对象就要去实现以下copyWithZone对每一个属性赋值而且还要考虑属性中是否有引用的问题(大部分情况下我们是需要完全深拷贝的)

OC中想拷贝一个对象需要这样

@interface Person : NSObject<NSCopying>

- (nonnull id)copyWithZone:(nullable NSZone *)zone {
    Person * person = [[[self class] allocWithZone:zone] init];
    person.name = self.name;
    person.age = self.age;
    person.man = self.man;
    return person;
}

注意这样的赋值其实是拷贝对象的引用.

@interface Man: NSObject<NSCopying>

@property (assign) int height;
@property (strong) NSString * colleage;

@end

如果我接下来修改copy出来的person.manheight或者colleage, 同样也会修改之前person对象的man
所以我们一般要在copyWithZone的方法里赋值时, 再要将引用类型都copy一下.

这样问题也是很明显的
这个类要conform NSCopingNSCoding的协议.. 而且还要实现NSCoding要求的归档解档方法. 最终, 调用的这个copy才能达到目的.
如果我还有一个类也要实现copy方法. 可能需要重复上面步骤了. 好像也没有好的办法进行复用.

Swift的类我们需要自己写一个copy方法了.
当然要声明一个协议, 供所有想进行copy的类调用

protocol Copyable: class {
    func copy() -> Self
}

对于结构体struct每次赋值都是一个新副本, 所以不存在拷贝问题, 我们用class表示这个协议只能让类来conform.

class Person: Copyable {

    var name: String = ""
    var age = 3
    var man: Man?

    func copy() -> Person {
        let newPerson = Person()
        newPerson.name = self.name
        newPerson.age = self.age
        newPerson.man = self.man
    }
}

这当然不是我们想要达到的目的, 跟上面OC版本面临同样的问题.

解决方案

一开始我想到就是要为copy提供默认实现, 想要进行copy的类直接conform协议就具备了copy功能, 而不是每一个class都去实现它.

extension Copyable {
    /// 使用extension 提供默认实现
    func copy() -> Self {
    
    }
}

虽然在协议中通过Self知道当前类名, 通过反射可以拿到属性与对应的值, 但是不通过KVC还是没办法给一个新实例赋值的..
在这里想到了Swift4出来的codable, 可以把一个对象值encode编码, 得到的data再进行decode解码, 得到的肯定是这个对象的副本. 而且我们不需要知道具体属性值.

所以, 我们需要让Copyable再conform一下Codable

protocol Copyable: class, Codable {
    func copy() -> Self
}

extension Copyable {

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

测试一下

let person = Person()
person.name = "aa"
person.man = Man()
person.man.height = 30

let person2 = person.copy()
person2.name = "bb"
person2.man.height = 40

person.name // "aa"
person.man.height // 30
person2.name  // "bb"
person2.man.height // 40

可以看到person的copy完全是一次深拷贝.
而且这个协议可以为任意class添加copy方法, 无需多余的实现代码.

Codable的强大

也是多亏了Codable, 我们做的只是用一个方法封装了一下.
public typealias Codable = Decodable & Encodable

Encodable实现了 public func encode(to encoder: Encoder) throws 方法, 把一个模型进行编码.
Decodable实现了public init(from decoder: Decoder) throws方法, 把一串data解码为一个目标模型

所以遵循了Codable的类或结构体可以直接从一段json字符串进行构造.

 let jsonString = """
        {"name": "aaa",
         "age": 3,
         "level": 33,
         "man":
             {"height": 100}
        }
        """
        
let decoder = JSONDecoder()
let jsonData = jsonString.data(using: .utf8)!
let person = try! decoder.decode(Person.self, from: jsonData)
        
print(person.name, person.man.height) /// "aaa" 100

看起来我们的Copyable还多了一个从字符串转模型的方法..稍加封装甚至可以作为网络请求完毕后数据转模型的部分呢..

如果json字符串中的键值与属性名称不匹配就需要重写一下协议中规定的方法了.

class Person: Copyable {

    var name: String = ""
    var age = 3
    var level = 30
    var man = Man()
    
    enum CodingKeys: CodingKey {
        case na
        case a
        case level
        case man
    }
    
    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        self.name = try container.decode(String.self, forKey: .na)
        self.age = try container.decode(Int.self, forKey: .a)
        self.level = try container.decode(Int.self, forKey: .level)
        self.man = try container.decode(Man.self, forKey: .man)
    }
    
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(self.name, forKey: .na)
        try container.encode(self.age, forKey: .a)
        try container.encode(self.level, forKey: .level)
        try container.encode(self.man, forKey: .man)
    }
}

EncoderDecoder需要一个遵循了Codingkey的可以提供映射关系的类型. 我们这里直接用枚举的case作为键值即可.

以上代码Github地址

你可能越来越惊讶于这个Codable竟然能做这么多事情.
笔者水平有限. 更感兴趣的朋友可以戳下方了解更多.(如果我有时间学到更多会更新新的一篇来分析一下这个协议具体做的事情)

Swift-JSONEncoder源码

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

推荐阅读更多精彩内容

  • 本文为转载: 作者:zyydeveloper 链接:http://www.jianshu.com/p/5f776a...
    Buddha_like阅读 873评论 0 2
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,096评论 1 32
  • 307、setValue:forKey和setObject:forKey的区别是什么? 答:1, setObjec...
    AlanGe阅读 1,545评论 0 1
  • 昏昏沉沉的几日过去了,我整日里瘫在床上,连坐起来的力气也没有。只是琉璃一日三四次的换我起来吃东西喝药,我才会含混不...
    沈白_阅读 299评论 0 0
  • 秋光热烈闪耀 云彩忽明忽暗 人们成群结队地交谈着欢呼着争吵着 如果天上忽然出现彩虹 没人会惊叹 世界真的很好 我在...
    木三白阅读 206评论 0 0