React Native OC源码阅读—RCTBundlePro

作者: tsyeyuanfeng | 来源:发表于2016-10-10 15:37 被阅读2905次

    从最外层源代码来看,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

    相关文章

      网友评论

      • SunnyEver0:写得非常好,请教一个问题呢。我是直接 X-Code run的,然后终端已打开launchpackager.command,可不知道为什么当把host传入到RCTBundleURLProvider的isPackagerRunning中后,返回的是NO,导致最后返回的jscodelocation是release模式下的路径。 不知道是为什么呢
        SunnyEver0:发现好像跟这个有关https://github.com/facebook/react-native/issues/10187
      • 75b8ffd94017:是配置好环境 打开那个helloword项目运行
      • 75b8ffd94017:(lldb) po jsCodeLocation
        nil
        (lldb)
        是的 打印出来就是nil , 然后就蹦掉了
        reason: 'bundleURL must be non-nil when not implementing loadSourceForBridge'

        我这个main.jsbundle 是红色的 是不是跟这个有关系
        tsyeyuanfeng:@eeeeedc_ 你在debug模式下运行,打开packager了吗?如果没有打开packager,又没有bundle包就有可能报上面的错。而你自行制定index.ios.js入口文件的位置是不行的,js引擎不识别ES6的语法,你写的js工程是需要经过编译打包才能在js引擎里面执行的
        75b8ffd94017:@tsyeyuanfeng 是debug模式, 然后我自己创建一个URL加进去
        NSURL *url = [[NSURL alloc]initWithString:@"file:///Users/yuedawuyemacbook-01/BookSearch/index.ios.js"];
        运行之后 模拟器就变红色了报错Unhandled JS Exception: SyntaxError



        tsyeyuanfeng:@eeeeedc_ 应该是因为没有找到你的mian.jsbundle,你是在release模式下运行的吗?
      • 75b8ffd94017:请问, jsCodeLocation = [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index.ios.js" fallbackResource:nil];

        返回的为什么是nil呢?
        tsyeyuanfeng:@eeeeedc_ 你是说这代码的运行结果是nil?

      本文标题:React Native OC源码阅读—RCTBundlePro

      本文链接:https://www.haomeiwen.com/subject/rmfmyttx.html