AFNetWorking 源码学习笔记 ☞ Reachabili
2018-11-29 本文已影响24人
RiverSea
AFNetWorking 源码学习笔记.png
一、前言
本文是 AFNetWorking 源码学习笔记的第五篇，本篇将介绍第四部分 -- Reachability 目录下的类，也就是 AFNetworkReachabilityManager。
虽然之前经历的几个项目里边都是对苹果提供的 Reachability 进行了一次封装，不过，还是有必要学习一下 AFNetWorking 中监听网络状态的类 AFNetworkReachabilityManager，也就是本文的重点。
AFNetWorking-Reachability.png
二、使用示例
先来看一个使用示例：
AFNetworkReachabilityManager *manager = [AFNetworkReachabilityManager sharedManager];
[manager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
switch (status) {
case AFNetworkReachabilityStatusUnknown:
NSLog(@"网络状态未知");
break;
case AFNetworkReachabilityStatusNotReachable:
NSLog(@"无网络");
break;
case AFNetworkReachabilityStatusReachableViaWWAN:
NSLog(@"手机自带网络");
break;
case AFNetworkReachabilityStatusReachableViaWiFi:
NSLog(@"WiFi");
break;
}
}];
[manager startMonitoring];
运行后发现，状态改变时会有相应的输出，在模拟器上可能不太准确，断网后再连网，监测不到，不过真机是正常的。
2018-11-28 16:42:40.825948+0800 HHAFNetworkingStudy[5703:831886] WiFi
2018-11-28 16:42:51.052528+0800 HHAFNetworkingStudy[5703:831886] 无网络
三、正文
现在开始查看源码，点开 AFNetworkReachabilityManager 的头文件，首先是 4 个属性：
@property (readonly, nonatomic, assign) AFNetworkReachabilityStatus networkReachabilityStatus; // 标识网络状态的枚举值
@property (readonly, nonatomic, assign, getter = isReachable) BOOL reachable; // 网络是否可用
@property (readonly, nonatomic, assign, getter = isReachableViaWWAN) BOOL reachableViaWWAN; // 手机自带网络是否可用
@property (readonly, nonatomic, assign, getter = isReachableViaWiFi) BOOL reachableViaWiFi; // Wifi是否可用
后 3 个属性的 getter 如下，我们发现，他们都是通过第一个属性 networkReachabilityStatus 的值来做判断的。
- (BOOL)isReachable {
return [self isReachableViaWWAN] || [self isReachableViaWiFi];
}
- (BOOL)isReachableViaWWAN {
return self.networkReachabilityStatus == AFNetworkReachabilityStatusReachableViaWWAN;
}
- (BOOL)isReachableViaWiFi {
return self.networkReachabilityStatus == AFNetworkReachabilityStatusReachableViaWiFi;
}
下方所示是创建及初始化方法，其中 new 和 init 方法被标识为不可用，查看实现文件得知，如果调用他们，会直接 crash。
+ (instancetype)sharedManager; // 单例
+ (instancetype)manager; // 针对默认地址（零地址）
+ (instancetype)managerForDomain:(NSString *)domain; // 针对域名
+ (instancetype)managerForAddress:(const void *)address; // 针对地址
- (instancetype)initWithReachability:(SCNetworkReachabilityRef)reachability NS_DESIGNATED_INITIALIZER; // 最终调用的方法
+ (instancetype)new NS_UNAVAILABLE; // 不可用
- (instancetype)init NS_UNAVAILABLE; // 不可用
// 如果直接或间接调用此方法会抛出异常 crash
- (instancetype)init {
@throw [NSException exceptionWithName:NSGenericException
reason:@"`-init` unavailable. Use `-initWithReachability:` instead"
userInfo:nil];
return nil;
}
其他创建方法最终调用的都是 initWithReachability: ，实现如下，给 _networkReachability 和 networkReachabilityStatus 赋初值。对于其中的 _networkReachability，提供了 2 种创建方法，见下方 2 个创建 manager 的类方法。
- (instancetype)initWithReachability:(SCNetworkReachabilityRef)reachability {
self = [super init];
if (!self) {
return nil;
}
// 网络连接的对象
_networkReachability = CFRetain(reachability);
// 初始状态为未知
self.networkReachabilityStatus = AFNetworkReachabilityStatusUnknown;
return self;
}
// 2 个创建 manager 的类方法
+ (instancetype)managerForDomain:(NSString *)domain {
// 创建网络连接的对象：根据传入的域名创建网络连接引用
SCNetworkReachabilityRef reachability = SCNetworkReachabilityCreateWithName(kCFAllocatorDefault, [domain UTF8String]);
AFNetworkReachabilityManager *manager = [[self alloc] initWithReachability:reachability];
CFRelease(reachability);
return manager;
}
+ (instancetype)managerForAddress:(const void *)address {
// 创建网络连接的对象：根据传入的地址创建网络连接的引用
SCNetworkReachabilityRef reachability = SCNetworkReachabilityCreateWithAddress(kCFAllocatorDefault, (const struct sockaddr *)address);
AFNetworkReachabilityManager *manager = [[self alloc] initWithReachability:reachability];
CFRelease(reachability);
return manager;
}
其中，根据地址创建网络连接的对象 reachability 时，地址的创建在 + (instancetype)manager; 这个类方法的实现里。
+ (instancetype)manager
{
// 创建零地址，0.0.0.0 的地址表示查询本机的网络连接状态
#if (defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 90000) || (defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101100)
struct sockaddr_in6 address;
bzero(&address, sizeof(address));
address.sin6_len = sizeof(address);
address.sin6_family = AF_INET6;
#else
struct sockaddr_in address;
bzero(&address, sizeof(address));
address.sin_len = sizeof(address);
address.sin_family = AF_INET;
#endif
return [self managerForAddress:&address];
}
接下来是控制网络状态监听开启/关闭的 2 个方法，以及 2 个辅助方法，详见注释。
// 开启监听
- (void)startMonitoring;
// 关闭监听
- (void)stopMonitoring;
// 返回一个描述网络状态的本地化字符串，即将不同的网络状态转变成对应的文字描述后输出
- (NSString *)localizedNetworkReachabilityStatusString;
// 设置网络状态发生变化时的回调，用户自定义，实际会将这个 block 赋值给内部的一个 block 属性，当状态发生改变时执行这个 block。
- (void)setReachabilityStatusChangeBlock:(nullable void (^)(AFNetworkReachabilityStatus status))block;
接下来，我们重点研究一下 - (void)startMonitoring; 这个方法，先贴上图和代码，然后我们按照图示顺序依次讨论各个环节。
AFNetWorking-Reachability.png
- (void)startMonitoring {
// 1.停止已经存在的监听
[self stopMonitoring];
if (!self.networkReachability) {
return;
}
// 2.构建 block：AFNetworkReachabilityStatusBlock callback
__weak __typeof(self)weakSelf = self;
AFNetworkReachabilityStatusBlock callback = ^(AFNetworkReachabilityStatus status) {
__strong __typeof(weakSelf)strongSelf = weakSelf;
strongSelf.networkReachabilityStatus = status;
if (strongSelf.networkReachabilityStatusBlock) {
strongSelf.networkReachabilityStatusBlock(status);
}
};
// 3.构建结构体 SCNetworkReachabilityContext context
SCNetworkReachabilityContext context = {
0,
(__bridge void *)callback,
AFNetworkReachabilityRetainCallback,
AFNetworkReachabilityReleaseCallback,
NULL
};
// 4.设置回调
// AFNetworkReachabilityCallback => 监听到网络状态变化时需要执行的 block
SCNetworkReachabilitySetCallback(self.networkReachability, AFNetworkReachabilityCallback, &context);
// 5.启动：将监听任务添加到 mainRunloop 的 CommonModes 里边
SCNetworkReachabilityScheduleWithRunLoop(self.networkReachability, CFRunLoopGetMain(), kCFRunLoopCommonModes);
// 测试
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0),^{
SCNetworkReachabilityFlags flags;
// 这个函数用来获得测试连接的状态，第一个参数为之前建立的测试连接的引用，第二个参数用来保存获得的状态，如果能获得状态则返回TRUE，否则返回FALSE
if (SCNetworkReachabilityGetFlags(self.networkReachability, &flags)) {
AFPostReachabilityStatusChange(flags, callback);
}
});
}
1.结束之前已经存在的网络状态监听 [self stopMonitoring];。
- (void)stopMonitoring {
if (!self.networkReachability) {
return;
}
// Unschedules the specified target from the specified run loop and mode.
SCNetworkReachabilityUnscheduleFromRunLoop(self.networkReachability, CFRunLoopGetMain(), kCFRunLoopCommonModes);
}
2.创建一个 block (AFNetworkReachabilityStatusBlock)，用于在网络状态发生改变时，以 status 为参数，执行之前用户设置的 block。
__weak __typeof(self)weakSelf = self;
AFNetworkReachabilityStatusBlock callback = ^(AFNetworkReachabilityStatus status) {
__strong __typeof(weakSelf)strongSelf = weakSelf;
// 为 networkReachabilityStatus 赋新值
strongSelf.networkReachabilityStatus = status;
// 执行用户定义的 block
if (strongSelf.networkReachabilityStatusBlock) {
strongSelf.networkReachabilityStatusBlock(status);
}
};
3.创建一个网络状态上下文对象 (结构体)，内含上一步创建的 block，用于下一步设置 callback。
SCNetworkReachabilityContext context = {
0,
(__bridge void *)callback, // 第 2 步创建的 block
AFNetworkReachabilityRetainCallback,
AFNetworkReachabilityReleaseCallback,
NULL
};
4.为 networkReachability 设置回调，即当网络状态发生改变的时候，会执行对应的 block。
SCNetworkReachabilitySetCallback(self.networkReachability, AFNetworkReachabilityCallback, &context);
5.启动监听，即将监听任务添加到 mainRunloop 的 commonModes 里边。至此，启动了对网络状态的监听。
// Schedules the specified network target with the specified run loop and mode.
SCNetworkReachabilityScheduleWithRunLoop(self.networkReachability, CFRunLoopGetMain(), kCFRunLoopCommonModes);
- 当状态发生改变时，首先会执行
AFNetworkReachabilityCallback()
static void AFNetworkReachabilityCallback(SCNetworkReachabilityRef __unused target, SCNetworkReachabilityFlags flags, void *info) {
AFPostReachabilityStatusChange(flags, (__bridge AFNetworkReachabilityStatusBlock)info);
}
7.内部又调用了 AFPostReachabilityStatusChange(flags, (__bridge AFNetworkReachabilityStatusBlock)info);，其中 info 就是第 2 步时创建的那个 block。
static void AFPostReachabilityStatusChange(SCNetworkReachabilityFlags flags, AFNetworkReachabilityStatusBlock block) {
AFNetworkReachabilityStatus status = AFNetworkReachabilityStatusForFlags(flags);
dispatch_async(dispatch_get_main_queue(), ^{
// 1.执行 block, 即外边传进来的 info
if (block) {
block(status);
}
// 2.发送网络状态改变的通知
NSNotificationCenter *notificationCenter = [NSNotificationCenter defaultCenter];
NSDictionary *userInfo = @{ AFNetworkingReachabilityNotificationStatusItem: @(status) };
[notificationCenter postNotificationName:AFNetworkingReachabilityDidChangeNotification object:nil userInfo:userInfo];
});
}
小结
这是《AFNetWorking 源码学习笔记》的最后一篇，算是将源码大概看了一遍，不过由于本人所知甚少，而且时间有限，难免出现粗浅错漏之处，后期会及时纠正。
