React Native startReactApplication 方法簡析

在 React Native 啟動流程簡析 這篇文章里，我們梳理了 RN 的啟動流程，最后的 startReactApplication 由於相對復雜且涉及到最終執行前端 js 的流程，我們單獨將其提取出來，獨立成文加以分析。

首先來看 startReactApplication 的調用之處：

mReactRootView.startReactApplication(
    getReactNativeHost().getReactInstanceManager(), appKey, mLaunchOptions);

可以看到是在 rootView 上調用 startReactApplication，入參為 instanceManager、appKey、mLaunchOptions。

順着 startReactApplication 扒出其調用鏈：mReactInstanceManager.createReactContextInBackground() -> recreateReactContextInBackgroundInner() -> recreateReactContextInBackgroundFromBundleLoader() -> recreateReactContextInBackground() -> runCreateReactContextOnNewThread()

recreateReactContextInBackground 為 ReactInstanceManager 中的方法，做了兩件事：

1. 創建 ReactContextInitParams 實例 initParams，如下，其入參 jsExecutorFactory 為創建 ReactInstanceManager 時傳入。

   final ReactContextInitParams initParams =
       new ReactContextInitParams(jsExecutorFactory, jsBundleLoader);
   

2. 調用 runCreateReactContextOnNewThread

runCreateReactContextOnNewThread 為 ReactInstanceManager 中的方法，主要做了兩件事：

1. 創建一個新的線程，並在新線程中通過 createReactContext 創建 ReactContext 上下文；
2. 通過 setupReactContext 來設置上下文環境，並最終調用到 AppRegistry.js 啟動App。

createReactContext

先看其調用的地方：

final ReactApplicationContext reactApplicationContext =
    createReactContext(
        initParams.getJsExecutorFactory().create(),
        initParams.getJsBundleLoader());

其兩個入參分別為 JsExecutorFactory 創建的 JavaScriptExecutor 實例，和 JsBundleLoader 實例。

JavaScriptExecutor

startReactApplication 第一個入參為 getReactNativeHost().getReactInstanceManager() 獲取 ReactInstanceManager 實例。ReactInstanceManager 實例在 RN 應用中只有一個，先前在創建 MainActivity 時已創建。

回顧 React Native 啟動流程簡析，在創建過程中實際上是調用下面的方法：

ReactInstanceManager reactInstanceManager = builder.build()

builder 即 ReactInstanceManagerBuilder，我們來到該類的 build 方法，發現其最終是執行 return new ReactInstanceManager(...)，在構造參數中第 4 個參數即為：getDefaultJSExecutorFactory，來到其定義處：

  private JavaScriptExecutorFactory getDefaultJSExecutorFactory(
      String appName, String deviceName, Context applicationContext) {
    try {
      // If JSC is included, use it as normal
      initializeSoLoaderIfNecessary(applicationContext);
      SoLoader.loadLibrary("jscexecutor");
      return new JSCExecutorFactory(appName, deviceName);
    } catch (UnsatisfiedLinkError jscE) { /* ... */ }
}

也就是說在創建 ReactInstanceManagerBuilder 時我們就創建了 JSCExecutorFactory，並在隨后調用其 create 方法創建 JSCExecutor 。JSCExecutorFactory 實現了 JavaScriptExecutorFactory 接口，其 create 方法如下，返回了 JSCExecutor 實例：

  @Override
  public JavaScriptExecutor create() throws Exception {
    WritableNativeMap jscConfig = new WritableNativeMap();
    jscConfig.putString("OwnerIdentity", "ReactNative");
    jscConfig.putString("AppIdentity", mAppName);
    jscConfig.putString("DeviceIdentity", mDeviceName);
    return new JSCExecutor(jscConfig);
  }

再往下看 JSCExecutor 的定義，其繼承自 JavaScriptExecutor 類：

@DoNotStrip
/* package */ class JSCExecutor extends JavaScriptExecutor {
  static {
    SoLoader.loadLibrary("jscexecutor");
  }
  /* package */ JSCExecutor(ReadableNativeMap jscConfig) {
    super(initHybrid(jscConfig));
  }
  @Override
  public String getName() {
    return "JSCExecutor";
  }
  private static native HybridData initHybrid(ReadableNativeMap jscConfig);
}

於是就很清楚了，createReactContext 第一個參數為 JSCExecutor 實例，是通過 SoLoader 加載的 C++ 模塊。

JsBundleLoader

同樣的，在 return new ReactInstanceManager(...)，其構造參數中第 5 個參數為：JSBundleLoader.createAssetLoader(mApplication, mJSBundleAssetUrl, false)

來到其定義之處，發現其返回了 JSBundleLoader 實例，並重寫了其 loadScript 方法。

public static JSBundleLoader createAssetLoader(
    final Context context, final String assetUrl, final boolean loadSynchronously) {
  return new JSBundleLoader() {
    @Override
    public String loadScript(JSBundleLoaderDelegate delegate) {
      delegate.loadScriptFromAssets(context.getAssets(), assetUrl, loadSynchronously);
      return assetUrl;
    }
  };
}

在創建完 JSCExecutor 實例和 JSBundleLoader 實例后，正式進入到 createReactContext 方法。

createReactContext

private ReactApplicationContext createReactContext(
  final ReactApplicationContext reactContext = new ReactApplicationContext(mApplicationContext);

  CatalystInstanceImpl.Builder catalystInstanceBuilder = /* ... */

  try {
    catalystInstance = catalystInstanceBuilder.build();
  } finally { /* ... */ }

  reactContext.initializeWithInstance(catalystInstance);

  TurboModuleManager turboModuleManager =
    new TurboModuleManager( /* ... */ )

  catalystInstance.setTurboModuleManager(turboModuleManager);

  if (mJSIModulePackage != null) {
    catalystInstance.addJSIModules( /* ... */ );
  }

  catalystInstance.runJSBundle();
  return reactContext;

在這里面，首先創建了 reactContext，並通過 catalystInstanceBuilder 創建了 catalystInstance。接着通過 initializeWithInstance 方法將 reactContext 和 catalystInstance 關聯起來，並進行了一系列的為 catalystInstance 初始化的工作。最后進入到方法 catalystInstance.runJSBundle() 中。

initializeWithInstance

通過調用 getUIQueueThread、getNativeModulesQueueThread、getJSQueueThread創建了3個線程隊列，分別是 UI線程、NativeModules 線程，和 JS 線程。

runJSBundle

public void runJSBundle() {
  mJSBundleLoader.loadScript(CatalystInstanceImpl.this);
  synchronized (mJSCallsPendingInitLock) {
    mAcceptCalls = true;
    for (PendingJSCall function : mJSCallsPendingInit) {
      function.call(this);
    }
    mJSCallsPendingInit.clear();
    mJSBundleHasLoaded = true;
  }
  Systrace.registerListener(mTraceListener);
}

通過先前返回的 mJSBundleLoader 執行其 loadScript 方法：

public String loadScript(JSBundleLoaderDelegate delegate) {
  delegate.loadScriptFromAssets(context.getAssets(), assetUrl, loadSynchronously);
  return assetUrl;
}

loadScriptFromAssets 方法在 CatalystInstanceImpl 中：

public void loadScriptFromAssets(
    AssetManager assetManager, String assetURL, boolean loadSynchronously) {
  mSourceURL = assetURL;
  jniLoadScriptFromAssets(assetManager, assetURL, loadSynchronously);
}

這里的 assetURL 是在 createAssetLoader 創建 mJSBundleLoader 時傳入，其賦值時機是在 reactInstanceManagerBuilder 實例中，由 reactNativeHost 實例的 createReactInstanceManager 方法。若 開發者在 MainApplication.java 中通過重寫 getJSBundleFile 方法自定義了 assetURL 則使用該 url，否則使用系統默認，如：file://sdcard/myapp_cache/index.android.bundle。

jniLoadScriptFromAssets 方法為 C++ 側定義的方法，用於讀取 js 文件。為什么 Java 代碼中可以直接調用 C++ 方法，這里還要打個問號，后續在分析 Java 與 C++ 通信及 Java 與 JS 通信時闡釋。

通過 createReactContext 創建了 reactContext，創建了 catalystInstance 實例，並將上述兩者關聯，接着通過 catalystInstance 讀入 js 文件。接下來就進入到 setupReactContext 的環節。

setupReactContext

private void setupReactContext(final ReactApplicationContext reactContext) {
    synchronized (mAttachedReactRoots) {
      catalystInstance.initialize();
      for (ReactRoot reactRoot : mAttachedReactRoots) {
        if (reactRoot.getState().compareAndSet(ReactRoot.STATE_STOPPED, ReactRoot.STATE_STARTED)) {
          attachRootViewToInstance(reactRoot);
        }
      }
    }
    UiThreadUtil.runOnUiThread(
      public void run() {
        listener.onReactContextInitialized(reactContext);
      }
    )
    reactContext.runOnJSQueueThread(
      public void run() {
        Process.setThreadPriority(Process.THREAD_PRIORITY_DEFAULT);
      }
    )
    reactContext.runOnNativeModulesQueueThread(
      public void run() {
        Process.setThreadPriority(Process.THREAD_PRIORITY_DEFAULT);
      }
    )
}

這里面做的事情如下：

1. catalystInstance.initialize(): 所有原生模塊的初始化
2. attachRootViewToInstance(reactRoot): 繪制所有的 RootView 並添加到相應實例並設置相應的監聽事件
3. 創建 UI 模塊、JS 模塊和原生模塊線程，並設置 JS 模塊和原生模塊所在線程的優先級

總結本文

從 createReactContext 和 setupReactContext 兩個方法的源碼出發，分析了 RN startReactApplication 方法的執行過程，其中：

createReactContext 的主要作用是：創建 reactContext、創建 catalystInstance 實例，並將上述兩者關聯，接着通過 catalystInstance 讀入 js 文件。

setupReactContext的主要作用是：初始化所有原生模塊，繪制所有 rootview，創建 UI 模塊、JS 模塊和原生模塊線程，並設置優先級。