iOS 网络监控框架 - Reachability 源码解读

2,403 阅读5分钟

Reachability 项目是 Apple 提供的一个官方 Demo, 用于演示如何使用 System Configuration framework 来监控 iOS 设备的网络状态。值得注意的是 Reachability 仅仅能检测到数据包是否可以离开本设备,而不能检测到数据包是否能达到目的地。也就是说不能把它当成 Ping 来使用。Reachability 使用起来也特别的简单,接下来我们来看看如何使用 Reachability。

Reachability 使用

设置欲检测的域名,启动网络状态监控,Reachability 会在设备的网络状态发生变化的时候会发出一个名为 kReachabilityChangedNotification 的通知,我们可以通过接收这个通知,然后根据设备的网络状态做业务应对处理。

// 接收 kReachabilityChangedNotification 通知
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(reachabilityChanged:) name:kReachabilityChangedNotification object:nil];

// 检测某个域名是否可达
self.hostReachability = [Reachability reachabilityWithHostName:remoteHostName];

// 开始监控
[self.hostReachability startNotifier];

// 收到 kReachabilityChangedNotification 通知
- (void) reachabilityChanged:(NSNotification *)note
{
	Reachability* curReach = [note object];
	NSParameterAssert([curReach isKindOfClass:[Reachability class]]);
      // 做业务应对处理 
}

Reachability 的组成

Reachability 项目仅仅由一个 Reachability.h 和 Reachability.m 文件组成。麻雀虽小,五脏俱全。Reachability 也是这样的。Reachability 的接口提供了以下的能力:

  1. 检测一个域名是否可达,使用 reachabilityWithHostName: 方法。
  2. 检测一个 IP 是否可达,使用 reachabilityWithAddress: 方法。
  3. 检测设备网络的可到达性,使用 reachabilityForInternetConnection 方法。
  4. 开始监控网络状况,使用 startNotifier 方法。
  5. 停止监控网络状况,使用 stopNotifier 方法。与 startNotifier 方法配合使用。
  6. 获取当前的网络连接方式,使用 currentReachabilityStatus 方法。
  7. 判断设备的网络是否是按需连接方式,使用 connectionRequired 方法。
@interface Reachability : NSObject

/*!
 * Use to check the reachability of a given host name.
 */
+ (instancetype)reachabilityWithHostName:(NSString *)hostName;

/*!
 * Use to check the reachability of a given IP address.
 */
+ (instancetype)reachabilityWithAddress:(const struct sockaddr *)hostAddress;

/*!
 * Checks whether the default route is available. Should be used by applications that do not connect to a particular host.
 */
+ (instancetype)reachabilityForInternetConnection;

/*!
 * Start listening for reachability notifications on the current run loop.
 */
- (BOOL)startNotifier;
- (void)stopNotifier;

- (NetworkStatus)currentReachabilityStatus;

/*!
 * WWAN may be available, but not active until a connection has been established. WiFi may require a connection for VPN on Demand.
 */
- (BOOL)connectionRequired;

@end

Reachability 的实现

Reachability 的实现依赖于系统的 SCNetworkReachability 类,SCNetworkReachability 允许应用程序获取当前系统的网络配置情况,也可以用来判断一个 target host 的可达性。值得注意的是,当应用程序可以将一个 data packet 发送到 network stack,并且该 data packet 可以离开本地设备,这个时候 SCNetworkReachability 就会判断网络是可达的。正是由于这个原因,Reachability 不能保证 data packet 会被送到 target host 。SCNetworkReachability 的使用分为同步模式和异步模式

异步模式

我们先从异步模式开始解读,这毕竟是比较常用的模式!

第一步 我们从 startNotifier 方法开始。把 SCNetworkReachabilityRef 放到当前 runloop 的 kCFRunLoopDefaultMode 模式,当网络连接状态发生变化,SCNetworkReachabilityRef 会执行通过 SCNetworkReachabilitySetCallback 方法设定好的 ReachabilityCallback 方法。

- (BOOL)startNotifier
{
	BOOL returnValue = NO;
	SCNetworkReachabilityContext context = {0, (__bridge void *)(self), NULL, NULL, NULL};

    if (SCNetworkReachabilitySetCallback(_reachabilityRef, ReachabilityCallback, &context))
	{
        //把 SCNetworkReachabilityRef 放到当前 runloop 的 kCFRunLoopDefaultMode 模式
        //当 SCNetworkReachabilityRef 判断到网络状态发生变化,会执行 ReachabilityCallback 回调
		if (SCNetworkReachabilityScheduleWithRunLoop(_reachabilityRef, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode))
		{
			returnValue = YES;
		}
	}
    
	return returnValue;
}

第二步 接下来看 ReachabilityCallback 回调方法,在这里主要是发送一个 名为 kReachabilityChangedNotification 通知,并将 Reachability 对象作为参数,将网络连接状态通知应用程序。

static void ReachabilityCallback(SCNetworkReachabilityRef target, SCNetworkReachabilityFlags flags, void* info)
{
#pragma unused (target, flags)
	NSCAssert(info != NULL, @"info was NULL in ReachabilityCallback");
	NSCAssert([(__bridge NSObject*) info isKindOfClass: [Reachability class]], @"info was wrong class in ReachabilityCallback");
    // 发送 kReachabilityChangedNotification 通知,并将 Reachability 作为参数
    Reachability* noteObject = (__bridge Reachability *)info;
    // Post a notification to notify the client that the network reachability changed.
    [[NSNotificationCenter defaultCenter] postNotificationName: kReachabilityChangedNotification object: noteObject];
}

第三步 startNotifier 和 stopNotifier 方法是配合使用的。stopNotifier 的主要任务是对 startNotifier 做的操作进行逆向处理。把 SCNetworkReachabilityRef 从当前 runloop 的 kCFRunLoopDefaultMode 模式移除。

- (void)stopNotifier
{
	if (_reachabilityRef != NULL)
	{
		SCNetworkReachabilityUnscheduleFromRunLoop(_reachabilityRef, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
	}
}

第四步 上面主要是主流程解读,解读 Reachability 开始网络监控,网络状态发生变化处理,到停止网络监控的流程。这过程 Reachability 都 依赖于 SCNetworkReachabilityRef 的对象,接下来我们来说说 Reachability 怎么创建 SCNetworkReachabilityRef 对象。SCNetworkReachabilityRef 对象的创建依赖于 IP 或者域名。依赖于域名使用 SCNetworkReachabilityCreateWithName 方法,依赖于 IP 使用 SCNetworkReachabilityCreateWithAddress 方法。

// 通过域名创建 SCNetworkReachabilityRef 对象
+ (instancetype)reachabilityWithHostName:(NSString *)hostName
{
	Reachability* returnValue = NULL;
	SCNetworkReachabilityRef reachability = SCNetworkReachabilityCreateWithName(NULL, [hostName UTF8String]);
	if (reachability != NULL)
	{
		returnValue= [[self alloc] init];
		if (returnValue != NULL)
		{
			returnValue->_reachabilityRef = reachability;
		}
        else {
            CFRelease(reachability);
        }
	}
	return returnValue;
}

// 通过 IP 创建 SCNetworkReachabilityRef 对象
+ (instancetype)reachabilityWithAddress:(const struct sockaddr *)hostAddress
{
	SCNetworkReachabilityRef reachability = SCNetworkReachabilityCreateWithAddress(kCFAllocatorDefault, hostAddress);

	Reachability* returnValue = NULL;

	if (reachability != NULL)
	{
		returnValue = [[self alloc] init];
		if (returnValue != NULL)
		{
			returnValue->_reachabilityRef = reachability;
		}
        else {
            CFRelease(reachability);
        }
	}
	return returnValue;
}

以上是异步模式的解读,Reachability 的异步模式顾名思义就是网络连接发生了变化,Reachability 发通知告知应用程序。而同步模式呢? 那就是应用程序主动找 Reachability 获取当前的网络连接状态。

同步模式

应用程序主动找 Reachability 获取当前的网络连接状态,使用 currentReachabilityStatus 方法。Reachability 能够实现同步模式依赖于 SCNetworkReachabilityRef 的 SCNetworkReachabilityGetFlags 方法。SCNetworkReachabilityGetFlags 方法使用同步模式获取设备的网络连接状态。

- (NetworkStatus)currentReachabilityStatus
{
	NSAssert(_reachabilityRef != NULL, @"currentNetworkStatus called with NULL SCNetworkReachabilityRef");
	NetworkStatus returnValue = NotReachable;
	SCNetworkReachabilityFlags flags;
        // 同步模式获取网络连接状态
	if (SCNetworkReachabilityGetFlags(_reachabilityRef, &flags))
	{
        returnValue = [self networkStatusForFlags:flags];
	}
    
	return returnValue;
}

总结

Reachability 可以用来检测网络状态变化和网络的可达性的一个框架。但是 Reachability 仅仅能检测到数据包是否可以离开本设备,而不能检测到数据包是否能达到目的地,也就是说不能把它当成 Ping 来使用。

参考

  1. Reachability 的代码和 Demo https://developer.apple.com/library/content/samplecode/Reachability/Introduction/Intro.html
  2. SCNetworkReachability 参考 https://developer.apple.com/documentation/systemconfiguration/scnetworkreachability-g7d