React Native OC源码阅读—RCTBundleProvider

从最外层源代码来看,React Native初始化过程分为两步:获取JS代码包的URL和创建RCTRootView实例,如下所示。

#import "AppDelegate.h"

#import "RCTBundleURLProvider.h"
#import "RCTRootView.h"

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  NSURL *jsCodeLocation;

  jsCodeLocation = [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index.ios" fallbackResource:nil];

  RCTRootView *rootView = [[RCTRootView alloc] initWithBundleURL:jsCodeLocation
                                                      moduleName:@"AwesomeProject"
                                               initialProperties:nil
                                                   launchOptions:launchOptions];
}

@end

其中,JS代码包URL的获取是通过RCTBundleProvider这个类实现的。JS代码包的URL有两种可能结果,一种是Packager Server URL,一种是本地JS代码包的文件路径。通过jsCodeLocation = [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index.ios" fallbackResource:nil];去获取JS代码包URL时,会首先检查是否有正在运行的Packager Server,如果有则返回相应Packager Server中JS代码包的绝对路径;如果没有正在运行的Packager Server,则会返回一个本地JS代码包的文件路径,不传递fallbackResource参数时,默认返回 本地main.jsbundle的文件路径。

接下来,我们具体分析一下RCTBundleProvider的工作原理。首先看看RCTBundleProvider提供的几个重要方法。

serverRootWithHost

static NSURL *serverRootWithHost(NSString *host)
{
  return [NSURL URLWithString:
          [NSString stringWithFormat:@"http://%@:%lu/",
           host, (unsigned long)kRCTBundleURLProviderDefaultPort]];
}

该方法会根据传进去的host返回相应的Packager Server URL。例如,当传入的host为localhost时,返回的URL为http://localhost:8081/,其中8081是默认端口号,存储在常量kRCTBundleURLProviderDefaultPort中。

isPackagerRunning

- (BOOL)isPackagerRunning:(NSString *)host
{
  NSURL *url = [serverRootWithHost(host) URLByAppendingPathComponent:@"status"];
  NSURLRequest *request = [NSURLRequest requestWithURL:url];
  NSURLResponse *response;
  NSData *data = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:NULL];
  NSString *status = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
  return [status isEqualToString:@"packager-status:running"];
}

该方法会判断指定host上的Packager Server是否在运行。首先,通过serverRootWithHost方法获取该host的Packager Server URL,然后在Packager Server URL的末尾加上路径status构成新的URL,访问该URL,如果返回结果等于packager-status:running,则证明指定host上的Packager Server正在运行。例如,当传入的host为localhost时,访问http://localhost:8081/status,如果请求返回结果为packager-status:running,则证明localhost上的Packager Server在运行状态。

guessPackagerHost

- (NSString *)guessPackagerHost
{
  static NSString *ipGuess;
  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    NSString *ipPath = [[NSBundle mainBundle] pathForResource:@"ip" ofType:@"txt"];
    ipGuess = [[NSString stringWithContentsOfFile:ipPath encoding:NSUTF8StringEncoding error:nil]
               stringByTrimmingCharactersInSet:[NSCharacterSet newlineCharacterSet]];
  });

  NSString *host = ipGuess ?: @"localhost";
  if ([self isPackagerRunning:host]) {
    return host;
  }
  return nil;
}

这个方法比较有意思,顾名思义,就是猜测Packager Server的host。第一次访问该方法的时候,它会首先尝试读取本地的ip.txt文件,并把文件内容存进静态变量ipGuess中。如果最后得到的ipGuess的值不为空,则使用ipGuess作为host,否则默认使用localhost作为host。最后,还需要通过isPackagerRunning方法判断得到的host上是否有Packager Server在运行,如果有才返回该host作为Packager Host,否则返回nil
ip.txt文件是在项目编译运行的时候通过react-native-xcode.sh脚本生成的。在Debug模式下,react-native-xcode.sh脚本会自动获取电脑网卡en0的ip地址并存进ip.txt,如下所示。

if [[ "$CONFIGURATION" = "Debug" && "$PLATFORM_NAME" != "iphonesimulator" ]]; then
  PLISTBUDDY='/usr/libexec/PlistBuddy'
  PLIST=$TARGET_BUILD_DIR/$INFOPLIST_PATH
  IP=$(ipconfig getifaddr en0)
  $PLISTBUDDY -c "Add NSAppTransportSecurity:NSExceptionDomains:localhost:NSTemporaryExceptionAllowsInsecureHTTPLoads bool true" "$PLIST"
  $PLISTBUDDY -c "Add NSAppTransportSecurity:NSExceptionDomains:$IP.xip.io:NSTemporaryExceptionAllowsInsecureHTTPLoads bool true" "$PLIST"
  echo "$IP.xip.io" > "$DEST/ip.txt"
fi

这样,在使用iphone真机调试时,只要保证iphone和电脑在同一局域网内,iphone上的React Native程序即可从电脑上运行的Packager Server加载JS代码包,无需再手动设置jsCodeLocation

packagerServerHost

- (NSString *)packagerServerHost
{
  NSString *location = [self jsLocation];
  if (location != nil) {
    return location;
  }
#if RCT_DEV
  NSString *host = [self guessPackagerHost];
  if (host) {
    return host;
  }
#endif
  return nil;
}

该方法用于获取Packager Server Host。那既然有了guessPackagerHost,还要这个方法干什么呢?原来,为了给使用者定制Packager Server Host的机会,RCTBundleProvider类提供了jsLocation属性,通过设置jsLocation属性可以直接指定Packager Server Host。因此,packagerServerHost方法首先检查jsLocation属性值,如果jsLocation属性值不为空,则返回 jsLocation值作为Packager Server Host,否则如果是Debug模式,则继续通过guessPackagerHost方法获取Packager Server Host。以上方法都获取不到Packager Server Host时,则返回nil

packagerServerURL

- (NSURL *)packagerServerURL
{
  NSString *const host = [self packagerServerHost];
  return host ? serverRootWithHost(host) : nil;
}

该方法很简单,首先通过packagerServerHost方法获取Packager Server Host,然后通过serverRootWithHost方法获取Packager Server URL。

实例方法 jsBundleURLForBundleRoot

- (NSURL *)jsBundleURLForBundleRoot:(NSString *)bundleRoot fallbackResource:(NSString *)resourceName
{
  resourceName = resourceName ?: @"main";
  NSString *packagerServerHost = [self packagerServerHost];
  if (!packagerServerHost) {
    return [[NSBundle mainBundle] URLForResource:resourceName withExtension:@"jsbundle"];
  } else {

    return [[self class] jsBundleURLForBundleRoot:bundleRoot
                                     packagerHost:packagerServerHost
                                        enableDev:[self enableDev]
                               enableMinification:[self enableMinification]];
  }
}

该方法会返回最终的JS代码包URL。它接收两个参数,一个bundleRoot,指的是Packager Server中js代码包的入口文件名。另一个是fallbackResource,指的是本地JS代码包的资源文件名,当找不到Packager Server Host时,会根据该资源文件名返回本地JS代码包的文件路径。

类方法 jsBundleURLForBundleRoot

+ (NSURL *)jsBundleURLForBundleRoot:(NSString *)bundleRoot
                       packagerHost:(NSString *)packagerHost
                          enableDev:(BOOL)enableDev
                 enableMinification:(BOOL)enableMinification
{
  NSURLComponents *components = [NSURLComponents componentsWithURL:serverRootWithHost(packagerHost) resolvingAgainstBaseURL:NO];
  components.path = [NSString stringWithFormat:@"/%@.bundle", bundleRoot];
  // When we support only iOS 8 and above, use queryItems for a better API.
  components.query = [NSString stringWithFormat:@"platform=ios&dev=%@&minify=%@",
                      enableDev ? @"true" : @"false",
                      enableMinification ? @"true": @"false"];
  return components.URL;
}

该类方法与实例方法jsBundleURLForBundleRoot同名,但是该方法只用于生成Packager Server的JS代码包URL。

介绍完RCTBundleProvider的重要方法,最后简单梳理一下RCTBundleProvider的调用流程。
实例方法jsBundleURLForBundleRoot作为入口方法被调用,在该方法里面,先尝试获取Packager Server Host。如果获取到可用的Packager Server Host,则返回Packager Server中JS代码包的URL作为jsCodeLocation。如果没有获取到可用的Packager Server Host,则返回一个本地JS代码包的文件路径作为jsCodeLocation

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容