OC中自定义对象数组的深拷贝实践

问题

对一个由自定义类型对象组成的数组进行copy操作,得到一个新的数组,如果改变新数组中某个元素的值,原有数组中的对应元素值也会同时被修改。举个例子:

//DCUserInfoModel.h
@interface DCUserInfoModel : NSObject

@property (nonatomic, copy) NSString *name;

@end

//ViewController.m
- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    
    DCUserInfoModel *user1 = [DCUserInfoModel new];
    user1.name = @"user1_name";
    DCUserInfoModel *user2 = [DCUserInfoModel new];
    user2.name = @"user2_name";
    NSArray *usersArray = @[user1, user2];
    
    NSArray *usersArrayNew = [usersArray copy];
    DCUserInfoModel *userNew = [usersArrayNew objectAtIndex:0];
    userNew.name = @"user1_name_new";
    //breakpoint
 }
 断点控制台调试得到结果:
(lldb) po userNew.name
user1_name_new

(lldb) po [[usersArrayNew objectAtIndex:0] name]
user1_name_new

(lldb) po [[usersArray objectAtIndex:0] name]
user1_name_new

但是在一些场景下我们希望即使修改了新生成的数组中的值仍旧不影响原有数组中的数据,这里就需要用到深拷贝。

概念

为了不对数组中的原始数据造成影响,比较好的一种方法是对数组进行拷贝,拷贝可以简单的分为深拷贝和浅拷贝两种形式,在OC中两者的区别如下:

浅拷贝:单纯的拷贝地址,不产生新的对象,只是对原对象的引用计数+1.
深拷贝:分配一块新的存储空间,生成一个新的对象,并且该对象的引用计数置为1.

上面的例子中默认使用的就是浅拷贝,所以对象的值一旦被改变,所有引用他的地方获取到的值都会发生改变。

拷贝的方法

不管是深拷贝/浅拷贝都会涉及到copy 和 mutablecopy这两个方法,在OC中所有的集合类和NSString都支持这两种操作,最常用到的就是下面几种:

NSString, NSMutableString
NSArray, NSMutableArray
NSDictionary, NSMutableDictionary
NSSet, NSMutableSet
...

copy 和 mutablecopy这两个方法的区别:

通过copy得到的是不可变对象.
通过mutablecopy得到的是可变对象.

这里需要注意的是copy/mutablecopy并不和浅拷贝/深拷贝一一对应.简单来说对于系统定义的类型进行copy一定是浅拷贝;但是进行mutablecopy不一定是深拷贝,有可能只是(One-Level-Deep Copy)。这些都是系统类已经定义好的。

重写协议方法,实现深拷贝

对于自定义类型组成的数组,需要做两个步骤实现深拷贝:

1.遵守NSCopying, NSMutableCopying协议,让自定义类型支持深拷贝操作。

系统的集合类和NSString支持copy/mutablecopy操作是因为他们都遵守了NSCopying, NSMutableCopying两个协议。这两个协议形式如下:

@protocol NSCopying

- (id)copyWithZone:(nullable NSZone *)zone;

@end

@protocol NSMutableCopying

- (id)mutableCopyWithZone:(nullable NSZone *)zone;

@end

当基于OC的消息机制向一个对象发送copy/mutablecopy消息时,对象的copyWithZone/mutableCopyWithZone方法就会被调用。对于上面的自定义类型DCUserInfoModel对象,因为还没有遵守协议和重写对应的方法,所以直接发送copy/MutableCopy消息就会导致Crash。在通常情况下实现copyWithZone就可以满足深拷贝的需求了。

//DCUserInfoModel.h
@interface DCUserInfoModel : NSObject<NSCopying>

@property (nonatomic, copy) NSString *name;

@end

//DCUserInfoModel.m
@implementation DCUserInfoModel

-(id)copyWithZone:(NSZone *)zone
{
    DCUserInfoModel* copy = [[[self class] alloc] init];
    //DCUserInfoModel* copy = [[[self class] allocWithZone] init];
    if (copy) {
        copy.name = self.name;
    }
    
    return copy;
}

@end

这里有两个地方需要注意一下:
*在以前开发程序时,会把内存分为不同的区(zone),而对象会创建在某个区里面。现在不用了,每个程序只有一个区:默认区(default zone)。所以说,尽管必须实现copyWithZone:方法,但是不必担心其中的zone参数。
*关于NSMutableCopying,如果自定义类型有对应的mutable版本才需要实现这个方法。

到这里如果直接调用model的copy方法已经不会出现crash,但是数组元素已经实现深拷贝了吗?

 断点控制台调试得到结果:
(lldb) po userNew.name
user1_name_new

(lldb) po [[usersArrayNew objectAtIndex:0] name]
user1_name_new

(lldb) po [[usersArray objectAtIndex:0] name]
user1_name_new

(lldb) po usersArray
<__NSArrayI 0x600000034120>(
<DCUserInfoModel: 0x600000017a60>,
<DCUserInfoModel: 0x600000017be0>
)

(lldb) po usersArrayNew
<__NSArrayI 0x600000034120>(
<DCUserInfoModel: 0x600000017a60>,
<DCUserInfoModel: 0x600000017be0>
)
//可以看到数组的地址以及每一个元素的地址都是一样的,所以并没有实现真正的深拷贝

可以看到数组的地址以及每一个元素的地址都是一样的,所以并没有实现真正的深拷贝

2.调用给定的方法实现数组的深拷贝。

在自定义对象已经定义了copyWithZone之后,可以调用下面的方法实现深拷贝

NSArray *arrayNew = [[NSArray alloc] initWithArray:srcArray copyItems:YES];

现在完成的代码和执行结果是这样的

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    
    DCUserInfoModel *user1 = [DCUserInfoModel new];
    user1.name = @"user1_name";
    DCUserInfoModel *user2 = [DCUserInfoModel new];
    user2.name = @"user2_name";
    NSArray *usersArray = @[user1, user2];
    
    //如果array中的model没有遵守copy协议,这句代码就会导致crash
    NSArray *usersArrayNew = [[NSArray alloc]initWithArray:usersArray copyItems:YES];
    DCUserInfoModel *userNew = [usersArrayNew objectAtIndex:0];
    userNew.name = @"user1_name_new";
 }
//  断点控制台调试得到结果:
(lldb) po  userNew.name
user1_name_new

(lldb) po [[usersArrayNew objectAtIndex:0] name]
user1_name_new

(lldb) po [[usersArray objectAtIndex:0] name]
user1_name

(lldb) po usersArray
<__NSArrayI 0x60c00002b420>(
<DCUserInfoModel: 0x60c000004d60>,
<DCUserInfoModel: 0x60c000004df0>
)

(lldb) po usersArrayNew
<__NSArrayI 0x60c00002b500>(
<DCUserInfoModel: 0x60c000004d90>,
<DCUserInfoModel: 0x60c000004dd0>
)
//可以看到这一次数组地址和每一个元素的地址都不一样了,也正因为这样,新数组中的第一个userNew.name改变之后没有影响到原有数组的值。
 

对于更实际的情况是,可能我们的model中还会带有NSArray类型的Property,这样情况就更复杂了,没有关系,只要对copyWithZone稍加改变就可以了~

//DCUserReadModel.h
@interface DCUserReadModel : NSObject <NSCopying>

@property (nonatomic, copy) NSString *bookName;

@property (nonatomic, copy) NSString *rentTime;

@end

//DCUserReadModel.m
@implementation DCUserReadModel

-(id)copyWithZone:(NSZone *)zone
{
    DCUserReadModel* copy = [[[self class] alloc] init];
    if (copy) {
        copy.bookName = self.bookName;
        copy.rentTime = self.rentTime;
    }
    
    return copy;
}

@end

//DCUserInfoModel.h
@interface DCUserInfoModel : NSObject<NSCopying>

@property (nonatomic, copy) NSString *name;

@property (nonatomic, strong) NSArray *readList;
@end

//DCUserInfoModel.m
@implementation DCUserInfoModel

-(id)copyWithZone:(NSZone *)zone
{
    DCUserInfoModel* copy = [[[self class] alloc] init];
    if (copy) {
        copy.name = self.name;
        copy.readList = [[NSArray alloc]initWithArray:self.readList copyItems:YES];//对于NSArray类型的property采用这种方式实现深拷贝,当然数组包含的元素也需要实现对应的copyWithZone方法。
    }
    
    return copy;
}

-(id)mutableCopyWithZone:(NSZone *)zone
{
    DCUserInfoModel* copy = [[[self class] alloc] init];
    if (copy) {
        copy.name = self.name;
    }
    
    return copy;
}

@end

//ViewController.m
- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    DCUserReadModel *readModel1 = [DCUserReadModel new];
    readModel1.bookName = @"bookname1";
    DCUserReadModel *readModel2 = [DCUserReadModel new];
    readModel2.bookName = @"bookname2";
    NSArray *bookList = @[readModel1,readModel2];
    
    DCUserInfoModel *user1 = [DCUserInfoModel new];
    user1.name = @"user1_name";
    user1.readList = bookList;
    DCUserInfoModel *user2 = [DCUserInfoModel new];
    user2.name = @"user2_name";
    user2.readList = [[NSArray alloc]initWithArray:bookList copyItems:YES];
    NSArray *usersArray = @[user1, user2];
    
    NSArray *usersArrayNew = [[NSArray alloc]initWithArray:usersArray copyItems:YES];
    DCUserInfoModel *userNew = [usersArrayNew objectAtIndex:0];
    NSArray *readListArrayNew = userNew.readList;
    DCUserReadModel *readModelNew = [readListArrayNew objectAtIndex:0];
    readModelNew.bookName = @"bookName1_new";
}

//  断点控制台调试得到结果:
(lldb) po [[[[usersArrayNew objectAtIndex:0] readList] objectAtIndex:0] bookName]
bookName1_new
(lldb)  po [[[[usersArray objectAtIndex:0] readList] objectAtIndex:0] bookName]
bookname1

(lldb) po [[[usersArrayNew objectAtIndex:0] readList] objectAtIndex:0]
<DCUserReadModel: 0x60c00003c720>
(lldb) po [[[usersArray objectAtIndex:0] readList] objectAtIndex:0]
<DCUserReadModel: 0x60c00003c860>

(lldb) po [[usersArrayNew objectAtIndex:0] readList]
<__NSArrayI 0x60c00003c900>(
<DCUserReadModel: 0x60c00003c720>,
<DCUserReadModel: 0x60c00003c960>
)

(lldb) po [[usersArray objectAtIndex:0] readList]
<__NSArrayI 0x60c00003c800>(
<DCUserReadModel: 0x60c00003c860>,
<DCUserReadModel: 0x60c00003ca00>
)
//可以看出usersArray和usersArrayNew的内部元素地址都不一样,值的改变也不会相互影响,所以完成了深拷贝。

小结

直接调用NSArray/NSMutableArray的copy函数系统不会直接进行深拷贝,最直接的原因估计就是为了提高存储的利用率,尽可能减少app的内存消耗;在ARC模式下,直接采用地址拷贝的方式完成复制非常高效可靠;而且在大部分情况下,我们还需要用到这种同步修改的特性,改变了当前的数据之后不用再去去同步修改数据源。但是对于某些确实需要进行数据拷贝的场景,为了保证数据源不被其他操作干扰,使用这种深拷贝的方法还是很有必要的。

Ref:
https://stackoverflow.com/questions/4089238/implementing-nscopying
https://stackoverflow.com/questions/17344611/deep-copy-of-an-nsmutablearray-of-custom-objects-with-nsmutablearray-members
https://juejin.im/entry/57b15244a633bd00570955be iOS 开发之 Copy/MutableCopy |
http://zhangbuhuai.com/copy-in-objective-c/ Objective-C copy那些事儿
https://www.zybuluo.com/MicroCai/note/50592 iOS 集合的深复制与浅复制

推荐阅读更多精彩内容