ReactNative-RCTNetInfo

2017-06-15 本文已影响167人康牙123

以下内容仅为做笔记之用。
最近在看ReactNative源码，发现逐字细节看，总是不久后就遗忘掉，就准备用简书的笔记功能，做下笔记，以备不时翻看。
刚好看到ReactNative的网络模块，就从这里开始好了。
在JS中看到NetInfo模块可以监听网络状态，因此就到对应的RCTNetInfoOC模块看看内部实现。

    RCTNetInfo.h

#import <SystemConfiguration/SystemConfiguration.h>

#import <React/RCTEventEmitter.h>

@interface RCTNetInfo : RCTEventEmitter

- (instancetype)initWithHost:(NSString *)host;

@end

发现引入了两个库，一个是系统SystemConfiguration库，System Configuration框架可用于确定设备的网络配置。你可以使用该框架判断Wifi或者蜂窝连接是否正在使用中，也可以判断某个主机服务是否可以使用。具体细节可以在这里查看。
另一个是Facebook官方实现的<React/RCTEventEmitter.h>, RCTEventEmitter 是一个基础类，用于向JS传递被监测的事件。我们主要关心RCTEventEmitter3个方法：

   - (NSArray<NSString *> *)supportedEvents;
   - (void)startObserving;
   - (void)stopObserving;

在官方注释中,这三个方法都要被子类重写，而RCTNetInfo继承自RCTEventEmitter.
supportedEvent被用来返回支持事件名称。
startObserving 在获取到第一个监听者将被调用。
stopObserving在最后一个监听者被移除的时候被调用。
startObserving和stopObserving在RCTEventEmitter的子类开始／结束发送事件的时候需要被重写。

   RCTNetInfo.m

在看具体代码之前，我们先了解几个概念。
SCNetworkReachablility是SystemConfiguration下的一个网络服务。SCNetworkReachability 编程接口允许应用来确定当前系统的网络状况和目标主机是否可连接。具体文档可以看这里。

SCNetworkReachabilityCreateWithName(CFAllocator?, UnsafePointer<Int8>)可以创建一个网络连接测试，返回该连接测试的引用。它有两个参数：

第一个是内存分配器，是一个CFAllocator对象，默认为kCFAllocatorDefault。
第二个是测试的主机域名。

测试网络连接，需要在网络变化时，接受相关信息，下面是SCNetworkReachability上下文对象:
SCNetworkReachabilityContext指向一个结构体类型。

version：第一个参数是要一个向SCDynamicStorecreate 功能传递的版本号， SCDynamicStorecreate 提供一个存储配置信息和当前网络信息的键值对,不同的结构体使用不同的版本号，该结构体使用版本号0。
info：第二个参数是一个C指针,指向特定的数据块
retain 第三个参数: 是一个对info字段进行retain操作的callback。
release 第四个参数: 是一个对info字段进行release操作的callback。
copyDescription 第五个参数通常是一个对info字段进行描述的callback。
后3个参数可以为空。

为网络连接变化提供回调
SCNetworkReachabilitySetCallback该函数用于监听网络状态变化

target 第一个参数是一个SCNetworkReachabilityRef类型的结构体。即为刚才创建的测试连接。
callout 当网络状况变化时进行的回调。
context 跟回调相关的连接上下文。
Return Value true: 通知服务被正确设置，否则，返回false。

将网络连接测试放入runLoop中
Boolean SCNetworkReachabilityScheduleWithRunLoop(SCNetworkReachabilityRef target, CFRunLoopRef runLoop, CFStringRef runLoopMode);

target 网络测试连接
runLoop 测试连接所在的runLoop
runLoopMode 测试连接所在的runLoop Mode
Return Value true: 测试连接被成功分配到runLoop中，否则，返回false。

下面这段代码就是网络监测的主要流程：

  - (void)startObserving
{
  _status = RCTReachabilityStateUnknown;
  _reachability = SCNetworkReachabilityCreateWithName(kCFAllocatorDefault, _host.UTF8String ?: "apple.com");
  SCNetworkReachabilityContext context = { 0, ( __bridge void *)self, NULL, NULL, NULL };
  SCNetworkReachabilitySetCallback(_reachability, RCTReachabilityCallback, &context);
  SCNetworkReachabilityScheduleWithRunLoop(_reachability, CFRunLoopGetMain(), kCFRunLoopCommonModes);
}

上面这段代码在网络变化时，总是回调用RCTReachabilityCallback
static void RCTReachabilityCallback(__unused SCNetworkReachabilityRef target, SCNetworkReachabilityFlags flags, void *info)
的实现中有这么一段代码：

  if (![status isEqualToString:self->_status]) {
    self->_status = status;
    [self sendEventWithName:@"networkStatusDidChange" body:@{@"network_info": status}];
  }

sendEventWithName是ReactNative中OC端主动向JS端
发送事件的一个方法。其中的EventName networkStatusDidChange 可以在supportedEvents中找到：

- (NSArray<NSString *> *)supportedEvents
{
  return @[@"networkStatusDidChange"];
}

   stopObserving

至于去除监听如下：

- (void)stopObserving
{
  if (_reachability) {
    SCNetworkReachabilityUnscheduleFromRunLoop(_reachability, CFRunLoopGetMain(), kCFRunLoopCommonModes);
    CFRelease(_reachability);
  }
}

上面这段代码就是判断是否有网络测试连接，有则从RunLoop中取消。因为SCNetworkReachability的功能遵循Core Foundation naming conventions. 一个函数名称中包含有 "Create" or "Copy"，其返回的引用必须用CFRelease释放。

ReactNative-RCTNetInfo

猜你喜欢

热点阅读