高级：自定义 C++ 类型

note

本指南假设你熟悉 纯 C++ Turbo Native 模块 指南。它将在此基础上进行构建。

C++ Turbo Native Modules 支持 桥接功能 大多数 std:: 标准类型。你可以在模块中使用大多数这些类型，而无需任何额外代码。

如果你想在应用或库中添加对新和自定义类型的支持，你需要提供必要的桥接头文件。

添加一个新的自定义类型：Int64

C++ Turbo Native Modules 目前不支持 int64_t 数字 - 因为 JavaScript 不支持大于 2^53 的数字。为了表示大于 2^53 的数字，我们可以在 JS 中使用 string 类型，并自动将其转换为 C++ 中的 int64_t。

1. 创建桥接头文件

支持新自定义类型的第一步是定义桥接头文件，以处理从 JS 表示转换为 C++ 表示，以及从 C++ 表示转换为 JS 表示。

1. 在 shared 文件夹中，添加一个名为 Int64.h 的新文件
2. 在文件中添加以下代码：

Int64.h

#pragma once

#include <react/bridging/Bridging.h>

namespace facebook::react {

template <>
struct Bridging<int64_t> {
  // Converts from the JS representation to the C++ representation
  static int64_t fromJs(jsi::Runtime &rt, const jsi::String &value) {
    try {
      size_t pos;
      auto str = value.utf8(rt);
      auto num = std::stoll(str, &pos);
      if (pos != str.size()) {
        throw std::invalid_argument("Invalid number"); // don't support alphanumeric strings
      }
      return num;
    } catch (const std::logic_error &e) {
      throw jsi::JSError(rt, e.what());
    }
  }

  // Converts from the C++ representation to the JS representation
  static jsi::String toJs(jsi::Runtime &rt, int64_t value) {
    return bridging::toJs(rt, std::to_string(value));
  }
};

}

桥接头文件的关键组件是：

• 对自定义类型的 Bridging 结构显式特化。在这种情况下，模板指定了 int64_t 类型。
• 一个 fromJs 函数，用于将 JS 表示转换为 C++ 表示
• 一个 toJs 函数，用于将 C++ 表示转换为 JS 表示

note

对于 iOS，记得将 Int64.h 文件添加到 Xcode 项目中。

2. 修改 JS 规范

现在，我们可以修改 JS 规范，添加一个使用新类型的方法。像往常一样，我们可以使用 Flow 或 TypeScript 来编写规范。

1. 打开 specs/NativeSampleTurbomodule
2. 修改规范如下：

TypeScript

NativeSampleModule.ts

import {TurboModule, TurboModuleRegistry} from 'react-native';

export interface Spec extends TurboModule {
  readonly reverseString: (input: string) => string;
+  readonly cubicRoot: (input: string) => number;
}

export default TurboModuleRegistry.getEnforcing<Spec>(
  'NativeSampleModule',
);

Flow

NativeSampleModule.js

// @flow
import type {TurboModule} from 'react-native';
import { TurboModuleRegistry } from "react-native";

export interface Spec extends TurboModule {
  +reverseString: (input: string) => string;
+  +cubicRoot: (input: string) => number;
}

export default (TurboModuleRegistry.getEnforcing<Spec>(
  "NativeSampleModule"
): Spec);

在这个文件中，我们定义了需要在 C++ 中实现的功能。

3. 实现原生代码。

现在，我们需要实现我们在 JS 规范中声明的功能。

1. 打开 specs/NativeSampleModule.h 文件并应用以下更改：

NativeSampleModule.h

#pragma once

#include <AppSpecsJSI.h>
#include <memory>
#include <string>

+ #include "Int64.h"

namespace facebook::react {

class NativeSampleModule : public NativeSampleModuleCxxSpec<NativeSampleModule> {
public:
  NativeSampleModule(std::shared_ptr<CallInvoker> jsInvoker);

  std::string reverseString(jsi::Runtime& rt, std::string input);
+ int32_t cubicRoot(jsi::Runtime& rt, int64_t input);
};

} // namespace facebook::react

2. 打开 specs/NativeSampleModule.cpp 文件并实现新功能：

NativeSampleModule.cpp

#include "NativeSampleModule.h"
+ #include <cmath>

namespace facebook::react {

NativeSampleModule::NativeSampleModule(std::shared_ptr<CallInvoker> jsInvoker)
    : NativeSampleModuleCxxSpec(std::move(jsInvoker)) {}

std::string NativeSampleModule::reverseString(jsi::Runtime& rt, std::string input) {
  return std::string(input.rbegin(), input.rend());
}

+int32_t NativeSampleModule::cubicRoot(jsi::Runtime& rt, int64_t input) {
+    return std::cbrt(input);
+}

} // namespace facebook::react

实现代码导入 <cmath> C++ 库以执行数学运算，然后使用 <cmath> 模块中的 cbrt 原语实现 cubicRoot 函数。

4. 在应用中测试代码

现在，我们可以在应用中测试代码。

首先，我们需要更新 App.tsx 文件以使用 TurboModule 中的新方法。然后，我们可以构建应用的 Android 和 iOS 版本。

1. 打开 App.tsx 文件并应用以下更改：

App.tsx

// ...
+ const [cubicSource, setCubicSource] = React.useState('')
+ const [cubicRoot, setCubicRoot] = React.useState(0)
  return (
    <SafeAreaView style={styles.container}>
      <View>
        <Text style={styles.title}>
          Welcome to C++ Turbo Native Module Example
        </Text>
        <Text>Write down here the text you want to revert</Text>
        <TextInput
          style={styles.textInput}
          placeholder="Write your text here"
          onChangeText={setValue}
          value={value}
        />
        <Button title="Reverse" onPress={onPress} />
        <Text>Reversed text: {reversedValue}</Text>
+        <Text>For which number do you want to compute the Cubic Root?</Text>
+        <TextInput
+          style={styles.textInput}
+          placeholder="Write your text here"
+          onChangeText={setCubicSource}
+          value={cubicSource}
+        />
+        <Button title="Get Cubic Root" onPress={() => setCubicRoot(SampleTurboModule.cubicRoot(cubicSource))} />
+        <Text>The cubic root is: {cubicRoot}</Text>
      </View>
    </SafeAreaView>
  );
}
//...

2. 要在 Android 上测试应用，从项目的根文件夹运行 yarn android。
3. 要在 iOS 上测试应用，从项目的根文件夹运行 yarn ios。

添加一个新的结构化自定义类型：Address

上述方法可以推广到任何类型。对于结构化类型，React Native 提供了一些辅助函数，使其更容易从 JS 桥接到 C++ 和 viceversa。

假设我们要桥接一个自定义的 Address 类型，具有以下属性：

ts

interface Address {
  street: string;
  num: number;
  isInUS: boolean;
}

1. 在规范中定义类型

第一步，我们在 JS 规范中定义新的自定义类型，以便 Codegen 可以输出所有支持的代码。这样，我们就不需要手动编写代码。

1. Open the specs/NativeSampleModule file and add the following changes.

TypeScript

NativeSampleModule (Add Address type and validateAddress function)

import {TurboModule, TurboModuleRegistry} from 'react-native';

+export type Address = {
+  street: string,
+  num: number,
+  isInUS: boolean,
+};

export interface Spec extends TurboModule {
  readonly reverseString: (input: string) => string;
+ readonly validateAddress: (input: Address) => boolean;
}

export default TurboModuleRegistry.getEnforcing<Spec>(
  'NativeSampleModule',
);

Flow

NativeSampleModule (Add Address type and validateAddress function)

// @flow
import type {TurboModule} from 'react-native';
import { TurboModuleRegistry } from "react-native";

+export type Address = {
+  street: string,
+  num: number,
+  isInUS: boolean,
+};


export interface Spec extends TurboModule {
  +reverseString: (input: string) => string;
+ +validateAddress: (input: Address) => boolean;
}

export default (TurboModuleRegistry.getEnforcing<Spec>(
  "NativeSampleModule"
): Spec);

这段代码定义了新的 Address 类型，并为 Turbo Native Module 定义了一个新的 validateAddress 函数。注意，validateFunction 需要一个 Address 对象作为参数。

也可以有返回自定义类型的函数。

2. 定义桥接代码

从规范中定义的 Address 类型，Codegen 将生成两个辅助类型：NativeSampleModuleAddress 和 NativeSampleModuleAddressBridging。

第一个类型是 Address 的定义。第二个类型包含所有基础设施，以桥接从 JS 到 C++ 和 viceversa 的自定义类型。我们唯一需要添加的额外步骤是定义扩展 NativeSampleModuleAddressBridging 类型的 Bridging 结构。

1. 打开 shared/NativeSampleModule.h 文件
2. 在文件中添加以下代码：

NativeSampleModule.h (桥接 Address 类型)

#include "Int64.h"
#include <memory>
#include <string>

namespace facebook::react {
+  using Address = NativeSampleModuleAddress<std::string, int32_t, bool>;

+  template <>
+  struct Bridging<Address>
+      : NativeSampleModuleAddressBridging<Address> {};
  // ...
}

这段代码定义了一个 Address 类型别名，用于通用的 NativeSampleModuleAddress 类型。模板参数的顺序很重要：第一个模板参数引用结构体中的第一个数据类型，第二个参数引用第二个，依此类推。

然后，代码添加了新的 Address 类型的 Bridging 特化，通过扩展由 Codegen 生成的 NativeSampleModuleAddressBridging 类型。

note

有一个约定用于生成这些类型：

• 名称的第一部分始终是模块的类型。在本例中为 NativeSampleModule。
• 名称的第二部分始终是规范中定义的 JS 类型的名称。在本例中为 Address。

3. 实现原生代码

现在，我们需要在 C++ 中实现 validateAddress 函数。首先，我们需要在 .h 文件中添加函数声明，然后在 .cpp 文件中实现它。

1. 打开 shared/NativeSampleModule.h 文件并添加函数定义

NativeSampleModule.h (validateAddress function prototype)

  std::string reverseString(jsi::Runtime& rt, std::string input);

+  bool validateAddress(jsi::Runtime &rt, jsi::Object input);
};

} // namespace facebook::react

2. 打开 shared/NativeSampleModule.cpp 文件并添加函数实现

NativeSampleModule.cpp (validateAddress 实现)

bool NativeSampleModule::validateAddress(jsi::Runtime &rt, jsi::Object input) {
  std::string street = input.getProperty(rt, "street").asString(rt).utf8(rt);
  int32_t number = input.getProperty(rt, "num").asNumber();

  return !street.empty() && number > 0;
}

在实现中，表示 Address 的对象是一个 jsi::Object。要从这个对象中提取值，我们需要使用 JSI 提供的访问器：

• getProperty() 从对象中按名称检索属性。
• asString() 将属性转换为 jsi::String。
• utf8() 将 jsi::String 转换为 std::string。
• asNumber() 将属性转换为 double。

一旦我们手动解析了对象，我们就可以实现所需的逻辑。

note

如果你想了解更多关于 JSI 及其工作原理，请查看这个 精彩的演讲 来自 App.JS 2024。

4. Testing the code in the app.

要在应用中测试代码，我们需要修改 App.tsx 文件。

1. 打开 App.tsx 文件。删除 App() 函数的内容。
2. 将 App() 函数的主体替换为以下代码：

App.tsx (App 函数主体替换)

const [street, setStreet] = React.useState('');
const [num, setNum] = React.useState('');
const [isValidAddress, setIsValidAddress] = React.useState<
  boolean | null
>(null);

const onPress = () => {
  let houseNum = parseInt(num, 10);
  if (isNaN(houseNum)) {
    houseNum = -1;
  }
  const address = {
    street,
    num: houseNum,
    isInUS: false,
  };
  const result = SampleTurboModule.validateAddress(address);
  setIsValidAddress(result);
};

return (
  <SafeAreaView style={styles.container}>
    <View>
      <Text style={styles.title}>
        Welcome to C Turbo Native Module Example
      </Text>
      <Text>Address:</Text>
      <TextInput
        style={styles.textInput}
        placeholder="Write your address here"
        onChangeText={setStreet}
        value={street}
      />
      <Text>Number:</Text>
      <TextInput
        style={styles.textInput}
        placeholder="Write your address here"
        onChangeText={setNum}
        value={num}
      />
      <Button title="Validate" onPress={onPress} />
      {isValidAddress != null && (
        <Text>
          Your address is {isValidAddress ? 'valid' : 'not valid'}
        </Text>
      )}
    </View>
  </SafeAreaView>
);

恭喜！🎉

你桥接了从 JS 到 C++ 的第一个类型。