使用 Codegen
本指南将教您如何
- 配置 Codegen。
- 为每个平台手动调用它。
它还描述了生成的代码。
先决条件
即使手动调用 Codegen，您也始终需要一个 React Native 应用程序来正确生成代码。
Codegen 过程与应用程序的构建紧密耦合，脚本位于 react-native NPM 包中。
为了本指南的目的，请使用 React Native CLI 创建一个项目，如下所示
npx @react-native-community/cli@latest init SampleApp --version 0.76.0
Codegen 用于生成自定义模块或组件的胶水代码。有关如何创建它们的更多详细信息，请参阅 Turbo Native Modules 和 Fabric Native Components 的指南。
配置 Codegen
可以通过修改 package.json 文件在应用程序中配置 Codegen。Codegen 由一个名为 codegenConfig 的自定义字段控制。
"codegenConfig": {
"name": "<SpecName>",
"type": "<types>",
"jsSrcsDir": "<source_dir>",
"android": {
"javaPackageName": "<java.package.name>"
},
"ios": {
"modules": {
"TestModule": {
"className": "<iOS-class-implementing-the-RCTModuleProvider-protocol>",
"unstableRequiresMainQueueSetup": false,
"conformsToProtocols": ["RCTImageURLLoader", "RCTURLRequestHandler", "RCTImageDataDecoder"],
}
},
"components": {
"TestComponent": {
"className": "<iOS-class-implementing-the-component>"
}
}
}
},
您可以将此片段添加到您的应用程序并自定义各个字段
name:Codegen 配置的名称。这将自定义 Codegen 输出：文件名和代码。类型modules:仅为模块生成代码。components:仅为组件生成代码。all：生成所有代码。
jsSrcsDir：所有规范所在的根文件夹。android：Android 的 Codegen 配置（所有可选）.javaPackageName：配置 Android Java Codegen 输出的包名。
ios：iOS 的 Codegen 配置（所有可选）.modules[moduleName].className：此模块的 ObjC 类。或者，如果它是仅 C++ 模块，则为其RCTModuleProvider类。.unstableRequiresMainQueueSetup：在运行任何 JavaScript 之前，在 UI 线程上初始化此模块。.conformsToProtocols：注解此模块符合以下任何协议：RCTImageURLLoader、RCTURLRequestHandler、RCTImageDataDecoder。
.components[componentName]:.className：此组件的 ObjC 类（例如：TextInput->RCTTextInput）。
当 Codegen 运行时，它会在应用程序的所有依赖项中搜索遵循特定约定的 JS 文件，并生成所需的代码
- Turbo Native Modules 要求规范文件以
Native为前缀。例如，NativeLocalStorage.ts是规范文件的有效名称。 - Native Fabric Components 要求规范文件以
NativeComponent为后缀。例如，WebViewNativeComponent.ts是规范文件的有效名称。
运行 Codegen
本指南的其余部分假定您已经在项目中设置了 Native Turbo Module、Native Fabric Component 或两者。我们还假设您在 package.json 中指定的 jsSrcsDir 中有有效的规范文件。
Android
Android 的 Codegen 已与 React Native Gradle 插件 (RNGP) 集成。RNGP 包含一个可以调用的任务，该任务读取 package.json 文件中定义的配置并执行 Codegen。要运行 gradle 任务，首先导航到项目中的 android 文件夹。然后运行
./gradlew generateCodegenArtifactsFromSchema
此任务对应用程序的所有导入项目（应用程序和所有链接到它的节点模块）调用 generateCodegenArtifactsFromSchema 命令。它在相应的 node_modules/<dependency> 文件夹中生成代码。例如，如果您有一个 Fabric Native Component，其节点模块名为 my-fabric-component，则生成的代码位于 SampleApp/node_modules/my-fabric-component/android/build/generated/source/codegen 路径中。对于应用程序，代码生成在 android/app/build/generated/source/codegen 文件夹中。
生成的代码
运行上述 gradle 命令后，您将在 SampleApp/android/app/build 文件夹中找到 codegen 代码。结构将如下所示
build
└── generated
└── source
└── codegen
├── java
│ └── com
│ ├── facebook
│ │ └── react
│ │ └── viewmanagers
│ │ ├── <nativeComponent>ManagerDelegate.java
│ │ └── <nativeComponent>ManagerInterface.java
│ └── sampleapp
│ └── NativeLocalStorageSpec.java
├── jni
│ ├── <codegenConfig.name>-generated.cpp
│ ├── <codegenConfig.name>.h
│ ├── CMakeLists.txt
│ └── react
│ └── renderer
│ └── components
│ └── <codegenConfig.name>
│ ├── <codegenConfig.name>JSI-generated.cpp
│ ├── <codegenConfig.name>.h
│ ├── ComponentDescriptors.cpp
│ ├── ComponentDescriptors.h
│ ├── EventEmitters.cpp
│ ├── EventEmitters.h
│ ├── Props.cpp
│ ├── Props.h
│ ├── ShadowNodes.cpp
│ ├── ShadowNodes.h
│ ├── States.cpp
│ └── States.h
└── schema.json
生成的代码分为两个文件夹
java其中包含平台特定代码jni其中包含使 JS 和 Java 正确交互所需的 C++ 代码。
在 java 文件夹中，您可以在 com/facebook/viewmanagers 子文件夹中找到 Fabric Native 组件生成的代码。
<nativeComponent>ManagerDelegate.java包含ViewManager可以在自定义 Native Component 上调用的方法<nativeComponent>ManagerInterface.java包含ViewManager的接口。
在名称在 codegenConfig.android.javaPackageName 中设置的文件夹中，您可以找到 Turbo Native Module 必须实现的抽象类来执行其任务。
最后，在 jni 文件夹中，有所有连接 JS 到 Android 的样板代码。
<codegenConfig.name>.h这包含您的自定义 C++ Turbo Native Modules 的接口。<codegenConfig.name>-generated.cpp这包含您的自定义 C++ Turbo Native Modules 的胶水代码。react/renderer/components/<codegenConfig.name>：此文件夹包含您的自定义组件所需的所有胶水代码。
此结构是通过使用 codegenConfig.type 字段的 all 值生成的。如果您使用 modules 值，则不会看到 react/renderer/components/ 文件夹。如果您使用 components 值，则不会看到任何其他文件。
iOS
iOS 的 Codegen 依赖于在构建过程中调用的 Node 脚本。脚本位于 SampleApp/node_modules/react-native/scripts/ 文件夹中。
主脚本是 generate-codegen-artifacts.js 脚本。要调用该脚本，您可以从应用程序的根文件夹运行此命令
node node_modules/react-native/scripts/generate-codegen-artifacts.js
Usage: generate-codegen-artifacts.js -p [path to app] -t [target platform] -o [output path]
Options:
--help Show help [boolean]
--version Show version number [boolean]
-p, --path Path to the React Native project root. [required]
-t, --targetPlatform Target platform. Supported values: "android", "ios",
"all". [required]
-o, --outputPath Path where generated artifacts will be output to.
其中
--path是您的应用程序根文件夹的路径。--outputPath是 Codegen 将写入生成文件的目标位置。--targetPlatform是您要为其生成代码的平台。
生成的代码
使用这些参数运行脚本
node node_modules/react-native/scripts/generate-codegen-artifacts.js \
--path . \
--outputPath ios/ \
--targetPlatform ios
将在 ios/build 文件夹中生成这些文件
build
└── generated
└── ios
├── <codegenConfig.name>
│ ├── <codegenConfig.name>-generated.mm
│ └── <codegenConfig.name>.h
├── <codegenConfig.name>JSI-generated.cpp
├── <codegenConfig.name>JSI.h
├── FBReactNativeSpec
│ ├── FBReactNativeSpec-generated.mm
│ └── FBReactNativeSpec.h
├── FBReactNativeSpecJSI-generated.cpp
├── FBReactNativeSpecJSI.h
├── RCTModulesConformingToProtocolsProvider.h
├── RCTModulesConformingToProtocolsProvider.mm
└── react
└── renderer
└── components
└── <codegenConfig.name>
├── ComponentDescriptors.cpp
├── ComponentDescriptors.h
├── EventEmitters.cpp
├── EventEmitters.h
├── Props.cpp
├── Props.h
├── RCTComponentViewHelpers.h
├── ShadowNodes.cpp
├── ShadowNodes.h
├── States.cpp
└── States.h
这些生成文件的一部分由 React Native 在核心中使用。然后有一组文件包含您在 package.json codegenConfig.name 字段中指定的相同名称。
<codegenConfig.name>/<codegenConfig.name>.h：这包含您的自定义 iOS Turbo Native Modules 的接口。<codegenConfig.name>/<codegenConfig.name>-generated.mm：这包含您的自定义 iOS Turbo Native Modules 的胶水代码。<codegenConfig.name>JSI.h：这包含您的自定义 C++ Turbo Native Modules 的接口。<codegenConfig.name>JSI-generated.h：这包含您的自定义 C++ Turbo Native Modules 的胶水代码。react/renderer/components/<codegenConfig.name>：此文件夹包含您的自定义组件所需的所有胶水代码。
此结构是通过使用 codegenConfig.type 字段的 all 值生成的。如果您使用 modules 值，则不会看到 react/renderer/components/ 文件夹。如果您使用 components 值，则不会看到任何其他文件。