概述
AFNetworking 这个框架是非常流行的，基本上大部分项目都会使用这个框架。作为一个优秀的框架，当然我们有必要去学习它，而不是仅仅停留在使用的层面上，作为一个iOS开发者是很有必要去研究其内部实现的，下面介绍AFNetworkReachabilityManager管理类。
介绍 AFNetworkReachabilityManager
AFNetworkReachabilityManager是一个网络监测的类，常用场景是当手机的网络状态发送变化后，界面会做相应的处理，提示用户。
实现 AFNetworkReachabilityManager
在AFNetworkReachabilityManager.h中可以看到引用一个<SystemConfiguration/SystemConfiguration.h>头文件，进入头文件可以看到下图
由此可见iOS提供了网络监测
SCNetworkReachability和连接类SCNetworkConnection的APIs,
SCNetworkReachability.h
在这个类中可以看到
typedef const struct CF_BRIDGED_TYPE(id) __SCNetworkReachability * SCNetworkReachabilityRef;
其本质是一个 struct __SCNetworkReachability 类型的结构体,SCNetworkReachabilityRef 是const struct __SCNetworkReachability *类型的指针变量。
如何初始化
API中提供了三种初始化的方式，在AFNetWorking中用到了前两种，
这里由于这个类并不是开源的，并不知道内部的实现原理，但是只要会使用这套API就行。
/**
初始化方式一：
从这个接口可以得知，需要两个传入的参数,
所有需要对这两个参数进行初始化，传入接口中。
@param allocator 推荐使用默认 kCFAllocatorDefault
@param address 套接字的地址结构
@return SCNetworkReachabilityRef 这个类的实例
*/
SCNetworkReachabilityRef __nullable
SCNetworkReachabilityCreateWithAddress (
CFAllocatorRef __nullable allocator, //创建对指定网络的引用地址。 此引用可以在以后用于监视目标主机的可达性。
const struct sockaddr *address // 本地主机地址
) API_AVAILABLE(macos(10.3), ios(2.0));
// 初始化方式二：
SCNetworkReachabilityRef __nullable
SCNetworkReachabilityCreateWithName (
CFAllocatorRef __nullable allocator,
const char *nodename // 域名或者ip地址
) API_AVAILABLE(macos(10.3), ios(2.0));
// 初始化方式三：
SCNetworkReachabilityRef __nullable
SCNetworkReachabilityCreateWithAddressPair (
CFAllocatorRef __nullable allocator,
const struct sockaddr * __nullable localAddress,
const struct sockaddr * __nullable remoteAddress
)
这里提供一个初始化的例子。
// 使用ipv4的套接字地址
struct sockaddr_in address;
// 初始化
bzero(&address, sizeof(address));
address.sin_family = AF_INET;// IPv4地址族
address.sin_len = sizeof(address);
SCNetworkReachabilityRef reachability = SCNetworkReachabilityCreateWithAddress(kCFAllocatorDefault, (const struct sockaddr *)&address);
// 注意：
// 在AF中当这个结构创建初始化后再传递的时候Retain了一份作为管类进行全局使用
// 在delloc中对自己Retain的 进行释放 Release
/** 可以查看AF源码找到对应的操作
-initWithReachability:
_networkReachability = CFRetain(reachabillity);
- (void)dealloc
CFRelease(_networkReachability);
*/
// 释放，自己管理内存
CFRelease(reachability);
如何启动监听
当我们对结构体初始完成后，接下来就是如何启动监听了。在这套API中需要启动一个运行循环。
// 启动运行循环
Boolean
SCNetworkReachabilityScheduleWithRunLoop (
SCNetworkReachabilityRef target,
CFRunLoopRef runLoop,
CFStringRef runLoopMode
) API_AVAILABLE(macos(10.3), ios(2.0));
// 结束运行循环
Boolean
SCNetworkReachabilityUnscheduleFromRunLoop (
SCNetworkReachabilityRef target,
CFRunLoopRef runLoop,
CFStringRef runLoopMode
) API_AVAILABLE(macos(10.3), ios(2.0));
AF中的代码示例
// 启动循环
SCNetworkReachabilityScheduleWithRunLoop(self.networkReachability, CFRunLoopGetMain(), kCFRunLoopCommonModes);
// 停止循环
SCNetworkReachabilityUnscheduleFromRunLoop(self.networkReachability, CFRunLoopGetMain(), kCFRunLoopCommonModes);
当网络状态发送变化后如何接收回调？
当网络状态发送变化后，这套API中也提供了设置回调的接口。
/*!
@function SCNetworkReachabilitySetCallback
@discussion Assigns a client to a target, which receives callbacks
when the reachability of the target changes.
@param target The network reference associated with the address or
name to be checked for reachability.
@param callout The function to be called when the reachability of the
target changes. If NULL, the current client for the target
is removed.
@param context The SCNetworkReachabilityContext associated with
the callout. The value may be NULL.
@result Returns TRUE if the notification client was successfully set.
*/
Boolean
SCNetworkReachabilitySetCallback (
SCNetworkReachabilityRef target,
// 函数指针
SCNetworkReachabilityCallBack __nullable callout,
// 该值和callout是有关联的，该参数是可以为空的，如果设置为NULL 也不影响函数的回调
SCNetworkReachabilityContext * __nullable context
) API_AVAILABLE(macos(10.3), ios(2.0));
// 函数类型
typedef void (*SCNetworkReachabilityCallBack) (
SCNetworkReachabilityRef target,
SCNetworkReachabilityFlags flags,
// 指针，指向一块内存区域
void * __nullable info
);
对回调函数类型进行分析
1.参数target是SCNetworkReachabilityRef的实例
2.参数flags 网络状态的标志位
3.参数info 是一个空指针类型
前两个参数我们可以知道，返回给我们进行使用。那么第三个参数void* info 该指针指向何处，如何使用？（这也是AF封装非常巧妙的地方）
追更溯源我们可以得知 在设置回调函数时，需要传入一个 SCNetworkReachabilityContext 类型的地址，在该头文件中我们可以知道SCNetworkReachabilityContext是一个结构体。
typedef struct {
// 版本信息
CFIndex version;
// 指针类型，指向了一块内存地址
void * __nullable info;
// 函数指针，对于iOS,RAC,相当于增加了一个引用计数，对于内存来说，相当于对这块内存进行拷贝
const void * __nonnull (* __nullable retain)(const void *info);
// 对上出内存拷贝进行释放
void (* __nullable release)(const void *info);
// 描述信息
CFStringRef __nonnull (* __nullable copyDescription)(const void *info);
} SCNetworkReachabilityContext;
在调用SCNetworkReachabilitySetCallback 这个回调函数时 可以得知第三个参数context是一个传入参数，而context是一个结构体，info是内部成员，由此可见，为什么回调函数SCNetworkReachabilityCallBack会给我们返回void* info类型的数据，info是我们初始化context后传入的，在callback中进行使用。
所以，context 和 callback 是有关联的。由此可见这套API接口的灵活性是很高的，对于程序来说定制性也很高。
针对SCNetworkReachabilityContext这个结构体提出两个疑问？
疑问一：为何要设计 void * __nullable info;？
疑问二：为何要 提供 retain 和 release 的函数指针类型？
针对第一个疑问：
info 是一个空指针类型，可以指向任何类似的数据的地址，这个可以由调用者自行决定。
针对第二个疑问：
为何要 提供 retain 和 release 的函数指针类型？
如果 info 指针指向的是一块局部的变量，那么这个快内存出了方法体会很快被释放， 而 info 需要在callout回调函数中去使用。所以提供了 retain 需要对info指向的内存进行拷贝返回给 这套API的内部进行使用传递。当设置回调函数后retain回调函数将会被调用。
针对第二个疑问提出 为什么不用全局变量进行传递？
因为在回调函数中是异步，当在使用全局变量时，指针指向的不一定是同一块内存区域
通过上述的介绍在来看AFNetworkReachabilityManager的封装，他就是这样去设计的，这里贴出 startMonitoring函数进行分析
// 这个回调何时回调用
__weak __typeof(self)weakSelf = self;
AFNetworkReachabilityStatusCallback callback = ^(AFNetworkReachabilityStatus status) {
__strong __typeof(weakSelf)strongSelf = weakSelf;
// 当外层的block 被调用后 内部的block才会被调用
strongSelf.networkReachabilityStatus = status;
if (strongSelf.networkReachabilityStatusBlock) {
strongSelf.networkReachabilityStatusBlock(status);
}
return strongSelf;
};
// 初始化结构体
// 第二个参数是一个指针指向的一个数据块
SCNetworkReachabilityContext context = {0, (__bridge void *)callback, AFNetworkReachabilityRetainCallback, AFNetworkReachabilityReleaseCallback, NULL};
// 上面的第二参数会传递到 AFNetworkReachabilityCallback中去
SCNetworkReachabilitySetCallback(self.networkReachability, AFNetworkReachabilityCallback, &context);
// callback 会在 AFNetworkReachabilityCallback 这个回调函数中调用
// 启动循环进行检测 SCNetworkReachabilityScheduleWithRunLoop(self.networkReachability, CFRunLoopGetMain(), kCFRunLoopCommonModes);
// 调度的优先级很低 在所有优先级较高的队列之后调用
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0),^{
SCNetworkReachabilityFlags flags;
if (SCNetworkReachabilityGetFlags(self.networkReachability, &flags)) {
AFPostReachabilityStatusChange(flags, callback);
}
});
针对AF中的源码可以得知info 指向的是 callback的地址，那么需要考虑的是，info指向的内存何时会被使用，或者说callback 这个代码块何时会被使用，下面看AF的源码
static void AFPostReachabilityStatusChange(SCNetworkReachabilityFlags flags, AFNetworkReachabilityStatusCallback block) {
AFNetworkReachabilityStatus status = AFNetworkReachabilityStatusForFlags(flags);
dispatch_async(dispatch_get_main_queue(), ^{
AFNetworkReachabilityManager *manager = nil;
if (block) {
// 代码块开始被调用
manager = block(status);
}
NSNotificationCenter *notificationCenter = [NSNotificationCenter defaultCenter];
NSDictionary *userInfo = @{ AFNetworkingReachabilityNotificationStatusItem: @(status) };
[notificationCenter postNotificationName:AFNetworkingReachabilityDidChangeNotification object:manager userInfo:userInfo];
});
}
由上述代码得知，这样设计的目的就是让callback中的代码片段推迟到网络状态发生变化后执行而info起的作用相当于一个全局的变量，用来保存代码块。
👨💻(程序员) ---->用A 来表示；
callback ----> 用c表示；
void* info ----> 用B来表示 ；
A对B说我产生了一个代码块c,但是这个代码块我不立即执行，我先定义好,等到状态状态发生变化AFPostReachabilityStatusChange这个回调函数调用的时候帮我去执行。
在callback代码块中我们可以发现内部还有一个全局的代码块networkReachabilityStatusBlock 这个代码块的执行是依赖callback的调用。
那为什么要这样设计呢？
-
AFNetworkReachabilityManager这个类提供block回调的方式通知外界，另外还提供了通知的方式通知外界。
2.networkReachabilityStatusBlock这个是全局的外界可以直接使用，另外外界也可以将该回调设置为nil,不进行接收，或者接收一次后将其设置为nil，下次不再进行接收网络状态变化的回调。所以这样设计是有好处的。在AF也提供了这样的例子可以自行查看AFNetworkReachabilityManagerTests.m
函数调用的图解
总结：
1.通过对SCNetworkReachability 内部API的解析，可以看到设计之巧妙。
2.AFNetWorking对AFNetworkReachabilityManager的封装也是非常巧妙的，尤其是对参数void*info的利用
3.一句话概括，用心去体会，一个字 妙！
4.AFNetWorking对AFNetworkReachabilityManager的封装，我们也可以模仿去实现自己的NetworkReachabilityManager。
