iOS 中如何使用对象的弱引用

简介

我们都知道使用 UIImage imageNamed 创建的 UIImage 对象会被持有(强引用),如果图片太大会占用内存,损耗 APP 的性能,影响用户体验,如果能改造对其的强引用变为弱引用就可以解决问题。

我们可能会有类似上面的场景,有些对象暂时保存起来,可能后面会用到,也有可能不会使用,但是又不想去管理它们的生命周期,如果它们能够自己被销毁就很省事,不需要去关心这些对象到底耗费了多少内存。

今天跟大家聊聊如何在 iOS 开发中保持对对象的弱引用而不是强引用,希望看完之后,能帮助到大家去解决实际问题。

NSObject retainCount

在 iOS 中创建一个对象,该对象的引用计数就会加1,例如下面的例子:

1
2
NSObject *obj = [NSObject alloc] init];
NSLog(@"obj retain count: %zd", [obj retainCount]);

上面的例子输出是1,当然在 ARC 下是无法使用 retainCount 这个方法的,只有在非 ARC 条件下才可以,如果要运行上面的例子,对应的文件需要设置为 -fno-objc-arc.

1
- (NSUInteger)retainCount OBJC_ARC_UNAVAILABLE;

可以在 usr/include/objc/NSObject.h 中查看,retainCountNSObject 协议@protocol NSObject)中定义的一个方法,而 NSObject 类是实现了该协议的,如下:

1
@interface NSObject <NSObject>

所以,任何OC对象都具有 retainCount 方法。另外,你添加一个视图,视图其实也是被容器引用了,其计数也会加1被容器持有其强引用,再例如在数组中添加一个对象,会使对象的引用计数加1,被数组所持有。

NSValue valueWithNonretainedObject

在 iOS 中,NSValue 的类方法 valueWithNonretainedObject 可以保持对对象的弱引用。

1
+ (NSValue *)valueWithNonretainedObject:(nullable id)anObject;

This method is useful if you want to add an object to a Collection but don’t want the collection to create a strong reference to it.

大概意思是,该方法可以不持有对象的强引用,换句话说,只持有对象的弱引用。

举个栗子~

MZDog.h

1
2
3
@interface MZDog : NSObject
@end

MZDog.m

1
2
3
4
5
6
7
8
9
10
#import "MZDog.h"
@implementation MZDog
- (NSString *)description
{
return [NSString stringWithFormat:@"MZDog-obj retain count: %zd", [self retainCount]];
}
@end

这里 MZDog 是设置了非 ARC 的,如图:

在测试文件中使用 MZDog,如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// retainCount -> 1
MZDog *dog = [MZDog new];
NSLog(@"dog: %@", dog);
// 对 dog 使用弱引用,此时其引用计数还是1
NSValue *value = [NSValue valueWithNonretainedObject:dog];
NSLog(@"dog: %@, value: %@", dog, value);
// 获取 value 对应的对象
id obj = value.nonretainedObjectValue;
NSLog(@"obj isKindOfClass MZDog: %i", [obj isKindOfClass:[MZDog class]]);
if (obj == dog) {
NSLog(@"The obj is same dog object.");
}

对应的控制台输出,如下:

1
2
3
4
dog: MZDog-obj retain count: 1
dog: MZDog-obj retain count: 1, value: <308cf600 00600000>
obj isKindOfClass MZDog: 1
The obj is same dog object.

从上面的例子可以看出,valueWithNonretainedObjectMZDog 对象 dog 是没有强应用的。修改代码,示例一下:

1
2
3
4
5
6
7
8
9
10
11
12
// retainCount -> 1
MZDog *dog = [MZDog new];
NSLog(@"dog: %@", dog);
// 对 dog 使用弱引用,此时其引用计数还是1
NSValue *value = [NSValue valueWithNonretainedObject:dog];
NSLog(@"dog: %@, value: %@", dog, value);
// 经过NSValue包装后,可以放到对应的集合对象(如数组,字典等)中,这样这些集合就不会对 dog 进行强引用了
NSArray *array = [NSArray arrayWithObjects:value, nil];
// dog 的引用计数还是1
NSLog(@"dog: %@, array: %@", dog, array);

对应的输出日志:

1
2
3
dog: MZDog-obj retain count: 1
dog: MZDog-obj retain count: 1, value: <40b7a401 00600000>
dog: MZDog-obj retain count: 1, array: ("<40b7a401 00600000>")

方法 valueWithNonretainedObject 等同于

1
NSValue *theValue = [NSValue value:&anObject withObjCType:@encode(void *)];

上面的示例,可以改写一下:

1
2
3
4
5
6
7
8
9
10
11
12
// retainCount -> 1
MZDog *dog = [MZDog new];
NSLog(@"dog: %@", dog);
// 对 dog 使用弱引用,此时其引用计数还是1
NSValue *value = [NSValue value:&dog withObjCType:@encode(void *)];
NSLog(@"dog: %@, value: %@", dog, value);
// 经过NSValue包装后,可以放到对应的集合对象(如数组,字典等)中,这样这些集合就不会对 dog 进行强引用了
NSArray *array = [NSArray arrayWithObjects:value, nil];
// dog 的引用计数还是1
NSLog(@"dog: %@, array: %@", dog, array);

输出日志:

1
2
3
dog: MZDog-obj retain count: 1
dog: MZDog-obj retain count: 1, value: <40568a02 00600000>
dog: MZDog-obj retain count: 1, array: ("<40568a02 00600000>")

此时 dog 的引用计数还是没有增加~

自写弱引用的集合分类

根据上面的理论知识,我们可以使用 NSValue 写出弱引用的集合对象,思路很简单,创建集合类的分类,然后使用 NSValue 来进行包装。看下面的示例代码即可。

NSArray+MZWeak.h

1
2
3
4
5
6
7
8
9
10
11
@interface NSArray (MZWeak)
- (id)mz_weak_objectAtIndex:(NSUInteger)index;
@end
@interface NSMutableArray (MZWeak)
- (void)mz_weak_addObject:(id)obj;
@end

NSArray+MZWeak.m

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#import "NSArray+MZWeak.h"
@implementation NSArray (MZWeak)
- (id)mz_weak_objectAtIndex:(NSUInteger)index
{
NSValue *value = [self objectAtIndex:index];
return value.nonretainedObjectValue;
}
@end
@implementation NSMutableArray (MZWeak)
- (void)mz_weak_addObject:(id)obj
{
NSValue *value = [NSValue valueWithNonretainedObject:obj];
if (nil != value) {
[self addObject:value];
}
}
@end

在文件中使用,示例如下:

1
2
3
4
5
6
7
8
9
10
// retainCount -> 1
MZDog *dog = [MZDog new];
NSLog(@"dog: %@", dog);
NSMutableArray *array = [NSMutableArray arrayWithCapacity:1];
// 弱引用
[array mz_weak_addObject:dog];
// 此时 dog 的引用计数还是1
NSLog(@"dog: %@", dog);

依次类推,对于其他集合类 NSDictionaryNSSet 都可以实现。当然实现方式不止这一种,这里只是举了一个 NSValue 包装对象来实现的例子。

当然你也可以使用 NSProxy 或者 block 来解除对对象的强引用。关于 block 的解除方法,可以参考开源项目 HXImage,另外开源项目 YYWeakProxy 里面使用了 NSProxy 来解除强引用。

那么,除了上面提到的方法,系统类库中有没有现成的类呢?聪明的你一定猜到了,一定有!

是的,往下看。。。

NSPointerArray、NSMapTable、NSHashTable

集合类 NSArrayNSDictionaryNSSet 以及其对应的可变版本,都可以用来存储 OC对象的, 但是对其中的对象都是强引用的。

iOS6.0 版本及以后的版本中,系统给我们提供了 NSPointerArrayNSMapTableNSHashTable 分别对应 NSArrayNSDictionaryNSSet,最大的不同就是,NSPointerArrayNSMapTableNSHashTable 对对象是弱引用而不是强引用。

现在大部分的 iOS APP 或者 iOS 游戏应该都至少在 iOS7 以上了吧,所以可以尽情使用这些系统提供的类库了。

使用 NSPointerArray 保存弱引用的对象,需要使用下面三种方式来创建 NSPointerArray 对象,如下:

1
2
3
4
5
6
7
8
// 创建 NSPointerArray 对象方式一
NSPointerArray *pointerArray = [NSPointerArray weakObjectsPointerArray];
// 创建 NSPointerArray 对象方式二
NSPointerArray *pointerArray1 = [[NSPointerArray alloc] initWithOptions:NSPointerFunctionsWeakMemory];
// 创建 NSPointerArray 对象方式三
NSPointerArray *pointerArray2 = [NSPointerArray pointerArrayWithOptions:NSPointerFunctionsWeakMemory];

那么下面还是以 MZDog 来举例子,如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// retainCount -> 1
MZDog *dog = [MZDog new];
NSLog(@"dog: %@", dog);
// 创建 NSPointerArray 对象方式一
// 注意 weakObjectsPointerArray 而不是 strongObjectsPointerArray
NSPointerArray *pointerArray = [NSPointerArray weakObjectsPointerArray];
[pointerArray addPointer:(__bridge void *)(dog)];
// 创建 NSPointerArray 对象方式二
NSPointerArray *pointerArray1 = [[NSPointerArray alloc] initWithOptions:NSPointerFunctionsWeakMemory];
[pointerArray1 addPointer:(__bridge void *)(dog)];
// 创建 NSPointerArray 对象方式三
NSPointerArray *pointerArray2 = [NSPointerArray pointerArrayWithOptions:NSPointerFunctionsWeakMemory];
[pointerArray2 addPointer:(__bridge void *)(dog)];
// dog 引用计数还是1
NSLog(@"dog: %@", dog);

对应的输出 dog 对象的 retainCount 仍然是 1,其引用计数没有增加。

对应 NSMapTableNSHashTable 的示例如下:

NSMapTable 示例

1
2
3
4
5
6
7
8
9
10
// retainCount -> 1
MZDog *dog = [MZDog new];
NSLog(@"dog: %@", dog);
// 弱应用对象
NSMapTable *map = [NSMapTable weakToWeakObjectsMapTable];
[map setObject:dog forKey:@"first"];
// 引用计数还是1,没变
NSLog(@"dog: %@", dog);

NSHashTable 示例

1
2
3
4
5
6
7
8
9
10
// retainCount -> 1
MZDog *dog = [MZDog new];
NSLog(@"dog: %@", dog);
// 弱应用对象
NSHashTable *hashTable = [NSHashTable weakObjectsHashTable];
[hashTable addObject:dog];
// 引用计数还是1,没变
NSLog(@"dog: %@", dog);

NSPointerArray 与 NULL

NSMutableArray 中添加的对象不可以是 nil,而 NSPointerArray 中却可存储 NULL(nil 经过转换得到C指针为 NULL),也可以用来存储weak对象。weak类型的对象释放之后,NSPointerArray 的对应位置会自动变成 NULL,使用count 属性, 会将 NULL 元素也计算进来,即 NULL 算是它的一员。下面示例可以证明,如下:

1
2
3
4
5
6
7
8
9
10
11
12
MZDog *dog = nil;
NSPointerArray *pointerArray = [NSPointerArray weakObjectsPointerArray];
void *cobj = (__bridge void *)(dog);
NSLog(@"obj: %@", cobj); //NULL
[pointerArray addPointer:cobj];
// 虽然存储的是 NULL,但是 count 仍然是 1
NSLog(@"pointerArray count: %zd", [pointerArray count]);
NSArray *array = [pointerArray allObjects];
NSLog(@"pointerArray allObjects: %@", array);

一般这样删除 NSPointerArray 中的 NULL 元素,如下:

1
2
[pointerArray addPointer:NULL];
[pointerArray compact];

这里要注意,将OC对象转换为C指针要使用 (__bridge void *) 这种方式,不要使用 (__bridge_retained void *) 或者 CFBridgingRetain,这二者会对 dog 对象进行强引用。如下示例:

1
2
3
4
5
6
7
8
9
10
// retainCount -> 1
MZDog *dog = [MZDog new];
NSPointerArray *pointerArray = [NSPointerArray weakObjectsPointerArray];
// 这里会 retain dog 对象,使其引用计数加1,此时retainCount 是 2
[pointerArray addPointer:(__bridge_retained void *)dog];
// 这里会 retain dog 对象,使其引用计数再加1,retainCount 是 3
[pointerArray addPointer:CFBridgingRetain(dog)];
// 此时的 retainCount 是 3
NSLog(@"dog: %@", dog);

如果你对 (__bridge_retained void *) 或者 CFBridgingRetain 感兴趣,可以看看 C 指针与 OC 对象之间的转换 这篇文章。


扫码关注,你我就各多一个朋友~

坚持原创技术分享!