iOS - 在原生模块中使用 Swift

Swift 是为 iOS 原生应用程序开发指定的官方默认语言。

在本指南中，您将探索如何使用 Swift 编写原生模块。

注意

React Native 的核心主要用 C++ 编写，尽管 Apple 开发了互操作层，Swift 和 C++ 之间的互操作性仍然不太理想。

因此，在本指南中您将要编写的模块不会是纯 Swift 实现，因为这两种语言之间存在不兼容之处。您将不得不编写一些 Objective-C++ 粘合代码，但本指南的目标是尽量减少所需的 Objective-C++ 代码量。如果您正在将现有的原生模块从旧版架构迁移到新版架构，此方法应该可以允许您重用大部分代码。

本指南从原生模块指南的 iOS 实现开始。在深入本指南之前，请确保您已熟悉该指南，并可能已实现其中的示例。

适配器模式

我们的目标是使用 Swift 模块实现所有业务逻辑，并提供一个薄薄的 Objective-C++ 粘合层，能够将应用程序与 Swift 实现连接起来。

您可以通过利用适配器设计模式来实现这一点，将 Swift 模块与 Objective-C++ 层连接起来。

Objective-C++ 对象由 React Native 创建，它会保留对 Swift 模块的引用，并处理其生命周期。Objective-C++ 对象将所有方法调用转发给 Swift。

创建 Swift 模块

第一步是将实现从 Objective-C++ 层迁移到 Swift 层。

为此，请遵循以下步骤：

1. 在 Xcode 项目中创建一个新的空文件，并将其命名为 NativeLocalStorage.swift
2. 在您的 Swift 模块中添加如下实现：

NativeLocalStorage.swift

import Foundation

@objcMembers public class NativeLocalStorage: NSObject {
  let userDefaults = UserDefaults(suiteName: "local-storage");

  public func getItem(for key: String) -> String? {
    return userDefaults?.string(forKey: key)
  }

  public func setItem(for key: String, value: String) {
    userDefaults?.set(value, forKey: key)
  }

  public func removeItem(for key: String) {
    userDefaults?.removeObject(forKey: key)
  }

  public func clear() {
    userDefaults?.dictionaryRepresentation().keys.forEach { removeItem(for: $0) }
  }
}

请注意，您必须将所有需要从 Objective-C 调用到方法声明为 public 并带有 @objc 注解。另外，请记住让您的类继承自 NSObject，否则将无法从 Objective-C 使用它。

更新 RCTNativeLocalStorage 文件

然后，您需要更新 RCTNativeLocalStorage 的实现，以便能够创建 Swift 模块并调用其方法。

1. 打开 RCTNativeLocalStorage.mm 文件
2. 按如下方式更新它：

RCTNativeLocalStorage.mm

//  RCTNativeLocalStorage.m
//  TurboModuleExample

#import "RCTNativeLocalStorage.h"
+#import "SampleApp-Swift.h"

- static NSString *const RCTNativeLocalStorageKey = @"local-storage";

-@interface RCTNativeLocalStorage()
-@property (strong, nonatomic) NSUserDefaults *localStorage;
-@end

-@implementation RCTNativeLocalStorage
+@implementation RCTNativeLocalStorage {
+    NativeLocalStorage *storage;
+}

-RCT_EXPORT_MODULE(NativeLocalStorage)

 - (id) init {
   if (self = [super init]) {
-    _localStorage = [[NSUserDefaults alloc] initWithSuiteName:RCTNativeLocalStorageKey];
+    storage = [NativeLocalStorage new];
   }
   return self;
 }

 - (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:(const facebook::react::ObjCTurboModule::InitParams &)params {
   return std::make_shared<facebook::react::NativeLocalStorageSpecJSI>(params);
 }

 - (NSString * _Nullable)getItem:(NSString *)key {
-   return [self.localStorage stringForKey:key];
+   return [storage getItemFor:key];
 }

 - (void)setItem:(NSString *)value key:(NSString *)key {
-   [self.localStorage setObject:value forKey:key];
+   [storage setItemFor:key value:value];
 }

 - (void)removeItem:(NSString *)key {
-   [self.localStorage removeObjectForKey:key];
+   [storage removeItemFor:key];
 }

 - (void)clear {
-   NSDictionary *keys = [self.localStorage dictionaryRepresentation];
-   for (NSString *key in keys) {
-     [self removeItem:key];
-   }
+  [storage clear];
 }

++ (NSString *)moduleName
+{
+  return @"NativeLocalStorage";
+}

@end

代码实际上没有变化。它不再是直接创建 NSUserDefaults 的引用，而是创建了一个新的 NativeLocalStorage（使用 Swift 实现），并且每当调用原生模块函数时，调用都会被转发到 Swift 中实现的 NativeLocalStorage。

请记住导入 "SampleApp-Swift.h" 头文件。这是 Xcode 自动生成的头文件，其中包含您的 Swift 文件的公共 API，格式可供 Objective-C 使用。头文件中的 SampleApp 部分实际上是您的应用名称，如果您创建应用的名称与 SampleApp **不同**，则需要更改它。

还要注意，不再需要 RCT_EXPORT_MODULE 宏，因为原生模块现在使用 package.json 进行注册，如此处所述。

这种方法在接口中引入了一些代码重复，但它允许您重用代码库中可能已有的 Swift 代码，只需稍加努力。

实现桥接头文件

注意

如果您是库作者，正在开发一个将作为独立库分发的原生模块，则此步骤是必需的。

连接 Swift 代码和 Objective-C++ 对等方的最后一步是桥接头文件。

桥接头文件是一个头文件，您可以在其中导入所有需要对 Swift 代码可见的 Objective-C 头文件。

您的代码库中可能已经有一个桥接头文件，但如果没有，您可以通过以下步骤创建一个新的：

1. 在 Xcode 中，创建一个新文件并将其命名为 "SampleApp-Bridging-Header.h"
2. 像这样更新 "SampleApp-Bridging-Header.h" 的内容：

SampleApp-Bridging-Header.h

//
//  Use this file to import your target's public headers that you would like to expose to Swift.
//

+ #import <React-RCTAppDelegate/RCTDefaultReactNativeFactoryDelegate.h>

3. 将桥接头文件链接到您的项目中
   1. 在项目导航器中，选择您的应用名称（左侧的 SampleApp）
   2. 点击 Build Settings
   3. 搜索 "Bridging Header"
   4. 添加“桥接头文件”的相对路径，在示例中它是 SampleApp-Bridging-Header.h

构建并运行您的应用程序

现在您可以按照原生模块指南的最后一步进行操作，您应该会看到您的应用程序运行着一个用 Swift 编写的原生模块。