Swift 字符串转本类（类 Type）进阶版：利用 Swift 5.3 的 KeyPath

2023-10-19 05:41:43

使用 KeyPath 安全且通用地将字符串转换为类类型

背景介绍

在 Swift 编程语言中，字符串和类类型之间密切相关，经常需要将字符串转换为类类型，例如从 storyboard 中加载视图控制器或从用户输入中获取类名。在 Swift 5.3 之前，NSClassFromString 函数是实现此转换的常用方法。然而，此方法存在一些缺陷，包括不安全性、通用性差和效率低。

KeyPath 解决方案

Swift 5.3 引入了 KeyPath，它提供了一种安全且通用的方式来访问类型和属性。KeyPath 是一种类型安全的值类型，表示从一个类型到另一个类型的路径。我们可以利用 KeyPath 将字符串安全且有效地转换为类类型。

转换步骤

以下是使用 KeyPath 将字符串转换为类类型的步骤：

创建一个到类元类型的 KeyPath。例如，let classKeyPath: KeyPath<AnyClass, AnyClass> = \AnyClass.self。
使用 value(forKeyPath:) 方法获取类元类型。例如，if let classType = NSClassFromString("ViewController")?.value(forKeyPath: classKeyPath) as? AnyClass { ... }。
将类元类型转换为所需的类类型。例如，let viewControllerClass = classType as? UIViewController.Type。

优势

使用 KeyPath 方法转换字符串到类类型具有以下优势：

安全性： KeyPath 会验证字符串是否指向有效的类名，避免因无效类名导致的崩溃。
通用性： 它支持可选字符串和泛型类型。
效率： 它使用运行时优化，在大多数情况下比 NSClassFromString 更快。

代码示例

// 从 storyboard 加载视图控制器
let storyboard = UIStoryboard(name: "Main", bundle: nil)
if let viewController = storyboard.instantiateViewController(withIdentifier: "ViewController") as? UIViewController {
    // ...
}

// 从用户输入获取类名
let className = "MyViewController"
if let viewControllerClass = NSClassFromString(className)?.value(forKeyPath: classKeyPath) as? UIViewController.Type {
    // ...
}

通用 AnyClass 版本

除了 KeyPath 方法之外，还有一种更通用的方法可以将字符串转换为类类型，它使用 AnyClass 类型作为中间步骤。

func classFromString(_ className: String) -> AnyClass? {
    guard let nsStringClass = NSClassFromString(className) else { return nil }
    return nsStringClass.self
}