AFNetworkReachabilityManager解析

[TOC]

AFNetworkReachabilityManager解析

使用方法

//建立
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;
        default:
            break;
    }
}];
 
//開始監聽
[manager startMonitoring];
複製代碼

解析

一圖概千言，先有個大體瞭解，後面能夠慢慢品味。

AFNetworkReachabilityManager的建立

AFNetworkReachabilityManager對外提供了兩種建立方式：

+ (instancetype)sharedManager;

+ (instancetype)manager;
複製代碼

從這兩個接口的實現中能夠看出sharedManager是個單例模式，內部使用manager建立了AFNetworkReachabilityManager對象。通常咱們不會只監聽一次網絡狀態，大多都是使用單例模式建立的。

再看看具體的建立過程：

1. 根據不一樣的系統環境，來定義socked地址。而後調用managerForAddress繼續下一步。
   1. iOS9或者macOS10.11.0，使用ipv6的網絡，sockaddr_in6結構體
   2. 低版本使用ipv4網絡，sockaddr_in結構體

+ (instancetype)manager {
#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)
    //基於ipv6
    struct sockaddr_in6 address;
    bzero(&address, sizeof(address));
    address.sin6_len = sizeof(address);
    address.sin6_family = AF_INET6;
#else
    //基於ipv4
    struct sockaddr_in address;
    bzero(&address, sizeof(address));
    address.sin_len = sizeof(address);
    address.sin_family = AF_INET;
#endif
    return [self managerForAddress:&address];
}
複製代碼

2. socked地址只是爲了建立SystemConfiguration框架中的SCNetworkReachabilityRef引用。SCNetworkReachabilityRef纔是AFNetworkReachabilityManager用來監聽網絡狀態的對象。

+ (instancetype)managerForAddress:(const void *)address {
    SCNetworkReachabilityRef reachability = SCNetworkReachabilityCreateWithAddress(kCFAllocatorDefault, (const struct sockaddr *)address);
    
    AFNetworkReachabilityManager *manager = [[self alloc] initWithReachability:reachability];

    CFRelease(reachability);
    
    return manager;
}
複製代碼

3. 初始化並設置默認狀態爲AFNetworkReachabilityStatusUnknown

- (instancetype)initWithReachability:(SCNetworkReachabilityRef)reachability {
    self = [super init];
    if (!self) {
        return nil;
    }

    //去引用這個對象，不會有全部權，若是爲了不這個對象被釋放，能夠經過（CFRetain）去添加引用計數
    _networkReachability = CFRetain(reachability);
    //設置默認狀態
    self.networkReachabilityStatus = AFNetworkReachabilityStatusUnknown;

    return self;
}
複製代碼

監聽網絡狀態

主要仍是使用SCNetworkReachability來進行監聽。

• 建立上下文SCNetworkReachabilityContext：保存回調函數以及相關的一些數據操做

  • typedef struct {
    	CFIndex		version;
    	void *		__nullable info;
    	const void	* __nonnull (* __nullable retain)(const void *info);
    	void		(* __nullable release)(const void *info);
    	CFStringRef	__nonnull (* __nullable copyDescription)(const void *info);
    } SCNetworkReachabilityContext;
    複製代碼

  • 結構體的第一個元素爲版本號：0

  • info：回調函數（用戶調用）

  • 第三個是對info作retain操做的函數

  • 第四個是對info作release操做的函數

  • info函數的描述信息

• 設置回調函數SCNetworkReachabilitySetCallback

  • Boolean
    SCNetworkReachabilitySetCallback		(
    						SCNetworkReachabilityRef			target,
    						SCNetworkReachabilityCallBack	__nullable	callout,
    						SCNetworkReachabilityContext	* __nullable	context
    						)				API_AVAILABLE(macos(10.3), ios(2.0));
    複製代碼

  • target：回調函數callout的調用對象。

  • callout：狀態改變時SCNetworkReachabilityRef調用

  • context：上下文

• 添加主運行循環中執行SCNetworkReachabilityScheduleWithRunLoop

- (void)startMonitoring {
    [self stopMonitoring];

    if (!self.networkReachability) {
        return;
    }

    __weak __typeof(self)weakSelf = self;
    AFNetworkReachabilityStatusBlock callback = ^(AFNetworkReachabilityStatus status) {
        __strong __typeof(weakSelf)strongSelf = weakSelf;

        strongSelf.networkReachabilityStatus = status;
        if (strongSelf.networkReachabilityStatusBlock) {
            strongSelf.networkReachabilityStatusBlock(status);
        }
    };

    SCNetworkReachabilityContext context = {0, (__bridge void *)callback, AFNetworkReachabilityRetainCallback, AFNetworkReachabilityReleaseCallback, NULL};
    SCNetworkReachabilitySetCallback(self.networkReachability, AFNetworkReachabilityCallback, &context);
    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);
        }
    });
}
複製代碼

而後當狀態發生變化時，SCNetworkReachabilityRef就會調用AFNetworkReachabilityCallback進行回調。告訴AFN當前的網絡可達標識和AFN回調給外界的callback（也就是上下文SCNetworkReachabilityContext中的void *info）。

static void AFNetworkReachabilityCallback(SCNetworkReachabilityRef __unused target, SCNetworkReachabilityFlags flags, void *info) {
    AFPostReachabilityStatusChange(flags, (__bridge AFNetworkReachabilityStatusBlock)info);
}
複製代碼

在AFPostReachabilityStatusChange中把SCNetworkReachabilityFlags轉爲AFNetworkReachabilityStatus後回調給外界。