跳到主要内容
版本:Next

Integration with Existing Apps

React Native is great when you are starting a new mobile app from scratch. However, it also works well for adding a single view or user flow to existing native applications. With a few steps, you can add new React Native based features, screens, views, etc.

The specific steps are different depending on what platform you're targeting.

核心概念

将 React Native 组件集成到 Android 应用中的关键在于:

  1. 设置正确的目录结构。
  2. 安装必要的 NPM 依赖。
  3. 将 React Native 添加到你的 Gradle 配置中。
  4. 编写第一个 React Native 屏幕的 TypeScript 代码。
  5. 使用 ReactActivity 将 React Native 与你的 Android 代码集成。
  6. 运行打包器并查看应用实际效果,以测试集成结果。

使用社区模板

在按照本指南操作时,我们建议你将 React Native Community Template 作为参考。该模板包含一个最小化的 Android 应用,并将帮助你理解如何将 React Native 集成到现有的 Android 应用中。

前提条件

请先按照 配置开发环境在没有框架的情况下使用 React Native 中的指南配置你的开发环境,以便构建 Android 版 React Native 应用。 本指南还假设你已经熟悉 Android 开发基础,例如创建 Activity 和编辑 AndroidManifest.xml 文件。

1. 设置目录结构

为了确保顺畅的开发体验,请为集成 React Native 的项目创建一个新文件夹,然后将你现有的 Android 项目移动到 /android 子文件夹中。

2. 安装 NPM 依赖

进入根目录并运行以下命令:

shell
curl -O https://raw.githubusercontent.com/react-native-community/template/refs/heads/main/template/package.json

这会将社区模板中的 package.json 文件复制到你的项目中。

接下来,运行以下命令安装 NPM 包:

npm install

安装过程会创建一个新的 node_modules 文件夹。这个文件夹用于存放构建项目所需的所有 JavaScript 依赖项。

node_modules/ 添加到你的 .gitignore 文件中(这里使用 社区默认版本)。

3. 将 React Native 添加到你的应用中

配置 Gradle

React Native 使用 React Native Gradle Plugin 来配置你的依赖项和项目设置。

首先,编辑你的 settings.gradle 文件并添加这些行(如 社区模板 所建议):

Groovy
// 配置用于自动链接的 React Native Gradle Settings 插件
pluginManagement { includeBuild("../node_modules/@react-native/gradle-plugin") }
plugins { id("com.facebook.react.settings") }
extensions.configure(com.facebook.react.ReactSettingsExtension){ ex -> ex.autolinkLibrariesFromCommand() }
// 如果使用 .gradle.kts 文件:
// extensions.configure<com.facebook.react.ReactSettingsExtension> { autolinkLibrariesFromCommand() }
includeBuild("../node_modules/@react-native/gradle-plugin")

// 在这里包含你现有的 Gradle 模块。
// include(":app")

然后,你需要打开顶层的 build.gradle 并加入这一行(如 社区模板 所建议):

Diff
buildscript {
repositories {
google()
mavenCentral()
}
dependencies {
classpath("com.android.tools.build:gradle:7.3.1")
+ classpath("com.facebook.react:react-native-gradle-plugin")
}
}

这可确保 React Native Gradle Plugin(RNGP)在你的项目中可用。 最后,在你的应用 build.gradle 文件中添加这些行(它是另一个 build.gradle 文件,通常位于你的 app 文件夹中——你可以将 社区模板文件作为参考):

Diff
apply plugin: "com.android.application"
+apply plugin: "com.facebook.react"

repositories {
mavenCentral()
}

dependencies {
// 其他依赖写在这里
+ // 注意:我们故意不在这里指定版本号,因为 RNGP 会负责处理。
+ // 如果你不使用 RNGP,就必须手动指定版本。
+ implementation("com.facebook.react:react-android")
+ implementation("com.facebook.react:hermes-android")
}

+react {
+ // 启用自动链接所需 - https://github.com/react-native-community/cli/blob/master/docs/autolinking.md
+ autolinkLibrariesWithApp()
+}

最后,打开你的应用 gradle.properties 文件并添加以下行(这里将 社区模板文件作为参考):

Diff
+reactNativeArchitectures=armeabi-v7a,arm64-v8a,x86,x86_64
+newArchEnabled=true
+hermesEnabled=true

配置清单文件

首先,确保你的 AndroidManifest.xml 中具有 Internet 权限:

Diff
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

+ <uses-permission android:name="android.permission.INTERNET" />

<application
android:name=".MainApplication">
</application>
</manifest>

然后,你需要在调试用的 AndroidManifest.xml 中启用 明文流量

Diff
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools">

<application
+ android:usesCleartextTraffic="true"
+ tools:targetApi="28"
/>
</manifest>

和往常一样,这里提供社区模板中的 AndroidManifest.xml 文件作为参考:maindebug

这是必需的,因为你的应用将通过 HTTP 与本地打包器 Metro 通信。

请确保只将其添加到你的调试清单文件中。

4. 编写 TypeScript 代码

现在我们将真正修改原生 Android 应用,以集成 React Native。

我们要编写的第一部分代码是新屏幕的实际 React Native 代码,该屏幕将被集成到我们的应用中。

创建一个 index.js 文件

首先,在你的 React Native 项目根目录下创建一个空的 index.js 文件。

index.js 是 React Native 应用的入口点,并且始终是必需的。它可以是一个小文件,通过 import 导入属于你的 React Native 组件或应用的其他文件;也可以直接包含所需的全部代码。

我们的 index.js 应如下所示(这里以 社区模板文件作为参考):

JavaScript
import {AppRegistry} from 'react-native';
import App from './App';

AppRegistry.registerComponent('HelloWorld', () => App);

创建一个 App.tsx 文件

让我们创建一个 App.tsx 文件。这是一个可以包含 JSX 表达式的 TypeScript 文件。它包含我们将集成到 Android 应用中的根 React Native 组件(链接):

React TSX
import {type JSX} from 'react';
import {
SafeAreaView,
ScrollView,
StatusBar,
StyleSheet,
Text,
useColorScheme,
View,
} from 'react-native';
import {
Colors,
DebugInstructions,
Header,
ReloadInstructions,
} from 'react-native/Libraries/NewAppScreen';

function App(): JSX.Element {
const isDarkMode = useColorScheme() === 'dark';

const backgroundStyle = {
backgroundColor: isDarkMode ? Colors.darker : Colors.lighter,
};

return (
<SafeAreaView style={backgroundStyle}>
<StatusBar
barStyle={isDarkMode ? 'light-content' : 'dark-content'}
backgroundColor={backgroundStyle.backgroundColor}
/>
<ScrollView
contentInsetAdjustmentBehavior="automatic"
style={backgroundStyle}>
<Header />
<View
style={{
backgroundColor: isDarkMode
? Colors.black
: Colors.white,
padding: 24,
}}>
<Text style={styles.title}>第一步</Text>
<Text>
编辑 <Text style={styles.bold}>App.tsx</Text>
更改此屏幕并查看你的修改。
</Text>
<Text style={styles.title}>查看你的更改</Text>
<ReloadInstructions />
<Text style={styles.title}>调试</Text>
<DebugInstructions />
</View>
</ScrollView>
</SafeAreaView>
);
}

const styles = StyleSheet.create({
title: {
fontSize: 24,
fontWeight: '600',
},
bold: {
fontWeight: '700',
},
});

export default App;

这里是 社区模板文件作为参考

5. 与你的 Android 代码集成

现在我们需要添加一些原生代码,以便启动 React Native 运行时并告诉它渲染我们的 React 组件。

更新你的 Application 类

首先,我们需要更新你的 Application 类,以便正确初始化 React Native,如下所示:

Diff
package <your-package-here>;

import android.app.Application;
+import com.facebook.react.PackageList;
+import com.facebook.react.ReactApplication;
+import com.facebook.react.ReactHost;
+import com.facebook.react.ReactNativeHost;
+import com.facebook.react.ReactPackage;
+import com.facebook.react.defaults.DefaultNewArchitectureEntryPoint;
+import com.facebook.react.defaults.DefaultReactHost;
+import com.facebook.react.defaults.DefaultReactNativeHost;
+import com.facebook.soloader.SoLoader;
+import com.facebook.react.soloader.OpenSourceMergedSoMapping
+import java.util.List;

-class MainApplication extends Application {
+class MainApplication extends Application implements ReactApplication {
+ @Override
+ public ReactNativeHost getReactNativeHost() {
+ return new DefaultReactNativeHost(this) {
+ @Override
+ protected List<ReactPackage> getPackages() { return new PackageList(this).getPackages(); }
+ @Override
+ protected String getJSMainModuleName() { return "index"; }
+ @Override
+ public boolean getUseDeveloperSupport() { return BuildConfig.DEBUG; }
+ @Override
+ protected boolean isNewArchEnabled() { return BuildConfig.IS_NEW_ARCHITECTURE_ENABLED; }
+ @Override
+ protected Boolean isHermesEnabled() { return BuildConfig.IS_HERMES_ENABLED; }
+ };
+ }

+ @Override
+ public ReactHost getReactHost() {
+ return DefaultReactHost.getDefaultReactHost(getApplicationContext(), getReactNativeHost());
+ }

@Override
public void onCreate() {
super.onCreate();
+ SoLoader.init(this, OpenSourceMergedSoMapping);
+ if (BuildConfig.IS_NEW_ARCHITECTURE_ENABLED) {
+ DefaultNewArchitectureEntryPoint.load();
+ }
}
}

和往常一样,这里是 MainApplication.kt 社区模板文件作为参考

创建一个 ReactActivity

最后,我们需要创建一个新的 Activity,它将继承 ReactActivity 并承载 React Native 代码。这个 Activity 将负责启动 React Native 运行时并渲染 React 组件。

Java
// package <your-package-here>;

import com.facebook.react.ReactActivity;
import com.facebook.react.ReactActivityDelegate;
import com.facebook.react.defaults.DefaultNewArchitectureEntryPoint;
import com.facebook.react.defaults.DefaultReactActivityDelegate;

public class MyReactActivity extends ReactActivity {

@Override
protected String getMainComponentName() {
return "HelloWorld";
}

@Override
protected ReactActivityDelegate createReactActivityDelegate() {
return new DefaultReactActivityDelegate(this, getMainComponentName(), DefaultNewArchitectureEntryPoint.getFabricEnabled());
}
}

和往常一样,这里是 MainActivity.kt 社区模板文件作为参考

每当你创建一个新的 Activity 时,都需要将其添加到你的 AndroidManifest.xml 文件中。你还需要将 MyReactActivity 的主题设置为 Theme.AppCompat.Light.NoActionBar(或任何非 ActionBar 主题),否则你的应用会在 React Native 屏幕顶部渲染一个 ActionBar:

Diff
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

<uses-permission android:name="android.permission.INTERNET" />

<application
android:name=".MainApplication">

+ <activity
+ android:name=".MyReactActivity"
+ android:label="@string/app_name"
+ android:theme="@style/Theme.AppCompat.Light.NoActionBar">
+ </activity>
</application>
</manifest>

现在你的 Activity 已经可以运行一些 JavaScript 代码了。

6. 测试你的集成

你已经完成了将 React Native 与你的应用程序集成的所有基本步骤。现在我们将启动 Metro bundler,把你的 TypeScript 应用代码构建成一个 bundle。Metro 的 HTTP 服务器会将你开发环境中 localhost 上的 bundle 分享到模拟器或设备。这使得 热重载 成为可能。

首先,你需要在项目根目录中创建一个 metro.config.js 文件,如下所示:

JavaScript
const {getDefaultConfig} = require('@react-native/metro-config');
module.exports = getDefaultConfig(__dirname);

你可以参考 Community 模板文件中的 metro.config.js 文件

配置文件就位后,你就可以运行 bundler 了。在项目根目录下运行以下命令:

npm start

现在像平常一样构建并运行你的 Android 应用。

一旦你进入应用中的 React 驱动 Activity,它就应该会从开发服务器加载 JavaScript 代码并显示:

在 Android Studio 中创建发布构建

你也可以使用 Android Studio 来创建发布构建!这和为你之前已有的原生 Android 应用创建发布构建一样快捷。

React Native Gradle Plugin 会负责将 JS 代码打包到你的 APK/App Bundle 中。

如果你不使用 Android Studio,可以通过以下方式创建发布构建:

cd android
# 对于 Release APK
./gradlew :app:assembleRelease
# 对于 Release AAB
./gradlew :app:bundleRelease

接下来呢?

此时你可以像往常一样继续开发你的应用。请参考我们的 调试部署 文档,了解更多有关使用 React Native 的内容。