背景
在编码过程中，有时候会手误给对象类型的property设置assign修饰符，如果这个指针所指向的对象被系统释放，它不会被自动置nil而是变成野指针，产生crash的风险。
因此我们就需要一个工具能够在开发阶段将这些误用的地方检测出来及时进行修复。
原理
在App运行的时候我们可以通过rumtime来读取每个property的attribute（例如T@"NSString",N,V_descriptionText），通过attribute可以判断这个属性是否是对象、是否使用了assign修饰符。
对于这些attribute的含义，可以在Apple官方文档 Declared Properties 和 Type Encodings 中查看具体的解释。
实现
我们先获取到可执行文件中的所有类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#import <objc/runtime.h>
#import <dlfcn.h>
#import <mach-o/ldsyms.h>
@implementation NSBundle (JX)
+ (NSArray<Class> *)jx_bundleOwnClassesInfoWithExcludeClassNames:(NSArray<NSString *> *)exclueClassNames {
NSMutableArray *resultArray = [NSMutableArray array];
unsigned int classCount;
const char **classes;
Dl_info info;
dladdr(&_mh_execute_header, &info);
classes = objc_copyClassNamesForImage(info.dli_fname, &classCount);
for (int index = 0; index < classCount; index++) {
NSString *className = [NSString stringWithCString:classes[index] encoding:NSUTF8StringEncoding];
if ([exclueClassNames containsObject:className]) {
continue;
}
Class class = NSClassFromString(className);
[resultArray addObject:class];
}
free(classes);
return resultArray.copy;
}
然后遍历每个类的每个属性
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
#import "JXAssignDetector.h"
#import "ASRuntimeUtil.h"
#import "NSBundle+JX.h"
@implementation JXAssignDetector
+ (NSArray<NSDictionary<NSString *, NSString *> *> *)detectAndPrint {
NSArray *excludes = @[@"TXPicture"];
NSArray *classes = [NSBundle jx_bundleOwnClassesInfoWithExcludeClassNames:excludes];
NSMutableArray *infos = [NSMutableArray new];
for (Class class in classes) {
NSMutableArray *propertyNames = [NSMutableArray new];
NSMutableArray *propertyAttributes = [NSMutableArray new];
[ASRuntimeUtil getPropertyNames:propertyNames propertyAttributes:propertyAttributes class:class];
for (int i = 0; i < propertyNames.count; i++) {
NSString *name = propertyNames[i];
NSString *attribute = propertyAttributes[i];
// 由于assign是默认的标志，因此排除其他类型内存管理的标志W（weak）、&（strong或retain）、C（copy）、R（readonly）剩下的就是assign和unsafe_unretained
if ([attribute hasPrefix:@"T@"]) {
NSArray *components = [attribute componentsSeparatedByString:@","];
if (![components containsObject:@"W"] &&
![components containsObject:@"&"] &&
![components containsObject:@"C"] &&
![components containsObject:@"R"]) {
NSLog(@"%@ - %@ - %@", class, name, attribute);
[infos addObject:@{@"class": NSStringFromClass(class),
@"property": name,
@"attribute": attribute
}];
}
}
}
}
return infos;
}
注意点
- 由于
assign和unsafe_unretained在attribute里面的表示相同（都是空），两者的意义也是一样的，区别在于unsafe_unretained是开发者显示指定为这种类型的，开发者会自己管理它的内存，检测结果中会同时包含这两种类型，在代码排查时注意区分。 - 由于是检测整个App二进制文件中的类名，所以结果会包含第三方库中的内容，可以酌情忽略或者提供给第三方进行解决。