融合 Swift 和 C++

了解如何在你的 C++ 和 Objective-C++ 项目中使用 Swift，使你的代码更安全、快速和易于开发。我们将向你展示如何使用 C++ 和 Swift API 来逐步将 Swift 融入你的 App。

章节

0:40 - Basics of interoperability
2:22 - Adding Swift to a C++ codebase
4:10 - Calling a C++ method in Swift
4:50 - Calling a Swift method in C++
7:32 - Improving how C++ APIs are imported
12:15 - Foreign reference types

资源

相关视频

WWDC23

Swift 的新功能

下载

♪ ♪

Zoe：你好我是 Zoe 是 Apple Compiler 团队的工程师今天我将介绍 Xcode 15 的新功能 Swift 和 C++ 互操作使你可同时使用 Swift 和 C++ 本讲将分为两个部分首先我将解释互操作的基础知识然后我将向你展示如何自然和安全地在 Swift 中应用你的 C++ API Swift 推出时世界上已有许多用 Objective-C 编写的大型 App 和代码库 Swift 能够利用这些现有的代码并逐步被这些代码库采用这是至关重要的一点今天 Swift 将这种互操作提升到了一个新的水平使你可在更多的地方采用 Swift

如果你有一个大型的 C++ 代码库你现在可利用双向互操作逐步采用 Swift 如你的 App 需要访问一个 C++ 库你不再需要编写 Objective-C 桥接层让我们通过查看一个示例 App 来看看在 C++ 代码库中采用 Swift 有多容易

我正在开发一个照片编辑 App 它允许我从相机胶卷中选择一张图片进行反色、调节亮度等操作

在进入代码之前让我们先看看我的 App 的结构

该 App 可分为两个部分图像处理框架和用户界面代码我的 App 基于图像处理框架该框架是用 C++ 编写的我希望我的用户界面层能够轻松地与我的 C++ 框架通信所以我使用了 Objective-C++ 来实现大部分用户界面比如使用 ViewController 现在我希望我的 App 用户能够从他们的相机胶卷中选择一些照片进行编辑我听说 SwiftUI 有一个新的 PhotoPicker 视图可轻松实现这点所以我想开始在我的 App 中采用 Swift 幸运的是从 Xcode 15 开始我可轻松地在我的 Objective-C++ 代码库中采用 Swift 并仍可访问所有我的 C++ API 让我们从为项目添加一个 Swift 文件开始吧因为我使用了一个 C++ 框架 Xcode 会自动导入我的 C++ API 所以我不需要桥接头文件

然后我需要在项目编译设置中启用 C++ 互操作如你所知 Swift 已可调用 C 和 Objective-C API 所以当前编译设置为 C 和 Objective-C 模式但我可将其更改为 C++

现在编译设置就变为 C++ 和 Objective-C++ 模式我可以直接调用我的 C++ 图像工具包框架中的 API 回到我的 Swift 文件我可以像导入其他 Swift 模块一样导入该框架并且我可点击模块名以查看其内容现在这些代码可能看起来像 Swift API 但这些代码实际上来自我的 C++ ImageKit 库；这只是 Swift 编译器显示代码的方式让我们看一下我今天要使用的一些 API

从最底层开始你可以看到一个类型为 CxxImageEngine 的静态成员这目前被导入为一个不安全指针我们稍后会详细介绍 CxxImageEngine 还有一些其他成员即 loadImage 和 getImages 我很快就会用到它们现在我将放入我的照片选择器的所有 UI 这样我就可以专注于与 C++ 交互的两种方法

我可获取共享的 CxxImageEngine 并在每个选定图像上调用 loadImage 将选定图像加载到引擎中哇用 Swift 调用一个 C++ 方法真是超级简单现在我的 SwiftUI 视图已完成我想在我的 Objective-C++ ViewController 中使用该视图

为此我需要公用我的结构体以便我的 Objective-C++ 代码可访问该结构体

太棒了！我的所有 Swift 代码都已成功构建现在我可转到 ViewController 文件并导入 Swift 生成的头文件

此头文件包含所有我的公共 Swift API 现在我已导入了生成的头文件可以开始在 C++ 中调用我的 Swift 代码首先我将构造 SwiftUI 视图然后我可以调用 present 方法

Xcode 代码补全功能会自动帮我填写代码

让我们在设备上测试一下

编译和运行 App 后你可以看到我们的新 SwiftUI 视图直接导入到了我的 Objective-C++ App 中

这是一个真正双向互操作的示例我能够无缝地在 Swift 中使用 C++ 类型和函数反之亦然在 C++ 中我能够构造和使用 SwiftUI 视图其视图的主体则回调到我的 C++ 框架中所有的集成均由 Swift 编译器自动完成所以我不需要编写桥接层所有的 API 都是直接的、原生的与大多数互操作语言不同在 Swift 中调用 C++ API 无任何额外开销反之亦然我今天演示的是一个很小的 App 但 Swift 编译器可支持大型和复杂代码库的互操作

Swift 可导入大多数 C++ 集合包括从标准库和从其他地方 Swift 可处理函数模板和类模板特化支持使用共享指针和类似用户自定义类型来管理内存 Swift 可高水平理解这些导入的 API 比如它了解共享指针的保留和释放操作并且可利用这种高级知识来应用一整套强大的优化方法

另一方面你可将大多数 Swift API 暴露给 C++ 比如结构体、类、方法和其他成员你甚至可以暴露像 Array 这样的泛型类型和随时间演变的弹性类型 C++ 互操作在 Xcode 中也得到了完全支持这两种语言均支持代码补全、跳转到定义和调试器支持功能这些只是一些 C++ 互操作所支持的 API Swift 编译器支持使用所有这些 API 和更多 API 的大型代码库之间的互操作提升了跨语言的聚合体验并允许你在更多地方采用 Swift 现在我们已掌握互操作的基础知识让我们深入探讨这个特性探索一些方法在 Swift 中自然和安全地应用 C++ API Swift 编译器能够自动导入大多数 C++ API 并将它们表示为安全的 Swift API 比如默认情况下 C++ 类型将被导入为 Swift 结构体 C++ 运算符将被映射为类似的 Swift 运算符容器则被自动导入为集合但编译器也允许你微调 API 导入方式并暴露感觉更自然的 API 为此你可使用注释向编译器提供你的 API 的更多相关信息

比如一个函数或方法可能使用 C++ 命名惯例而该命名在 Swift 中感觉并不自然在此情况下你可使用注释重命名导入的函数添加参数标签或将取值函数和设值函数导入为计算属性

注释还可帮助解释高级模式如引用语义并允许你将某些类型作为 Swift 类导入

或在 Swift 认为 API 不安全但实际是安全的时候对其进行纠正

这些注释是个强有力的方法可向你传递 Swift 正在导入的 API 的相关信息让我们来确认一些我在示例 App 中使用的不同 API 并探索如何使用这些注释来帮助 Swift 以让人感觉安全和直观的方式导入我的 API

现在我已完成了照片选择器还想添加一个保存按钮将编辑后的照片保存回我的照片库

回到 Swift 我可以再次查看导入的所有 API

首先我需要收集要保存的照片我可以使用 getImages 函数来完成该任务

getImages 函数返回一个 C++ 向量在调用此方法之前让我们了解一下向量在 Swift 中的操作细节 Swift 类型分为两类：值类型和引用类型在 Swift 中结构体表示值类型类则表示引用类型

默认情况下 C++ 类型将作为值类型导入 Swift

因此 Swift 将向量导入为值类型行为类似于 Swift 结构体向量和其他 Swift 结构体之间唯一的区别是 Swift 会使用该类型的特殊成员比如复制构造函数来管理生命周期这些复制构造函数常执行深度复制与只在修改时复制的 Swift Array 不同当 Swift 复制向量时也会复制所有元素

现在我有了一组图像向量我可以在 for 循环中迭代向量以获取每个图像将图像转换回 uiImage 并将图像保存到我的照片库中

这个for 循环可工作是因为向量有 begin 和 end 方法所以 Swift 自动将其导入为集合与集合自动实现一致使得向量可以很容易地转换为 Swift 数组并可访问 map 和 filter 等方法为了安全起见重要的是使用这些 Swift 集合 API 而不要使用不适用于 Swift 安全模型的 C++ 迭代器 API

使用这些 C++ 迭代器很容易引入错误比如生命周期问题或无效内存访问另一方面 Swift 集合 API 是完全安全的即使当其在 C++ 集合上操作时也是完全安全的

Swift 编译器会将不安全的 C++ API 标记为不可用并建议更安全的替代方案来帮助指导你使用这些更安全的 API 让我们回到我的 Swift App 有些事一直在困扰我每次我使用 C++ ImageEngine 时都会被提醒这是一个不安全的指针实际上该类型在 Swift 和 C++ 中都是作为指针使用的这是因为该类型具有所谓的“引用语义” 这意味着该类型应该具有对象标识并且副本不应有不同的值而应该共享对同一内存的引用正如我之前提到的 Swift 类型分为两类：值类型和引用类型 Objective-C 也明确了值类型和引用类型之间的区别这使得将 Objective-C 类型映射到结构体和类变得容易 C++ 中哪些类型属于哪个类别不像 Swift 和 Objective-C 那样清晰不同于 Swift 和 Objective-C C++ 的值类型和引用类型之间并没有那么清晰的区别

因此默认情况下编译器将所有内容作为值类型导入但是 Swift 还可向 C++ 代码添加注释将某些内容导入为引用或类的类型

我可以使用 SWIFT_SHARED_REFERENCE 属性将 CxxImageEngine 映射到 Swift 类中该属性意味着 Swift 将强制将类型始终作为指针或引用进行传参并将简单地用类型而非 Swift 中的不安全指针来表示这种间接调用

为保障你的代码安全 Swift 将根据需要保留和释放引用来自动管理引用的生命周期为了启用这种引用计数你需要为 Swift 提供保留和释放函数让我们深入了解 C++ ImageKit 头文件

我可以导入 swift/bridging 来访问 SWIFT_SHARED_REFERENCE 等注释现在我可以将此注释应用于类型指定 Swift 可调用的保留和释放函数太棒了！现在有一些 Swift 编译器错误告知我我不再需要解引用一个指针

我还可做最后一件事让这个 C++ 的API 完全适应 Swift 在此 for 循环中我正在调用 getImages 像这样定义取值函数和设值函数在 C++ 中是一个相当常见的模式但这在 Swift 中感觉不是很自然为了使其在 Swift 中显得更原生我可以使用 swift/bridging 中的另一个注释 SWIFT_COMPUTED_PROPERTY 属性可应用于取值函数和设值函数将这个对子映射到 Swift 计算属性中让我们再次回到我们的 C++ 头文件以应用此注释

现在我可以在定义上点击右键选择我的 Swift 调用情况来查找我的 getImages 方法的调用情况现在我可以将其重命名为简单的“images”

漂亮！现在让我们最后测试一次我们的 App

我可以选择一些照片并将它们保存回我的相机胶卷

太棒了！在本讲中我只使用了两个注释来改进我的 API 导入方式但是在你的 C++ 头文件中还有许多其他注释可供使用你只需导入 swift/bridging 即可访问这些注释

要在 Xcode 15 启用 C++ 互操作请将 C++ 和 Objective-C 互操作模式从 C 和 Objective-C 更改为 C++ 和 Objective-C++ 所有 Apple 平台以及 Linux 和 Windows 均支持 Swift 和 C++ 互操作 C++ 是一种庞大而复杂的语言我们希望通过你的反馈来改进导入 C++ API 和暴露 Swift API 的方式当我们改变 C++ API 导入方式时我们将创建一个新版本的互操作这意味着你可以选择何时使用这些新功能从而使你可以自信地从今天开始在开发中使用 C++ API

如你注意到任何问题或有任何建议我们很乐意听取你的意见请使用反馈助理告诉我们 C++ 互操作是由 Swift 编译器工作组在完全开源代码的情况下设计的该工作组由来自十多个公司和学校的工程师和学生组成工作组制定了两个文件定义了 Swift 和 C++ 互操作的未来愿景并将指导这一功能的逐步发展

你可加入工作组并参与论坛谈论只需前往 swift.org 即可

在 Swift 5.9 中你可自动且安全地使用 C++ API 无需额外开销你可将新的 Swift 代码暴露给 C++ 来逐步采用 Swift 你可为编译器提供更多信息来改进和微调导入的 API

感谢你的观看祝你在所有 C++ 代码库中愉快采用 Swift

4:10 - Calling a C++ method from Swift

func loadImage(_ image: UIImage) {
    // Load an image into the shared C++ class.
    CxxImageEngine.shared.pointee.loadImage(image)
}

4:20 - Import a C++ framework
```
import CxxImageKit
```
4:45 - Import the Generated Header
```
#import "SampleApp-Swift.h"
```

4:57 - Calling a Swift method in C++

- (IBAction)openPhotoLibrary:(UIButton *)sender {
    // Construct SwiftUI view
    SampleApp::ImagePicker::init().present(self);
}

8:22 - Using the SWIFT_COMPUTED_PROPERTY attribute

int  getValue() const SWIFT_COMPUTED_PROPERTY;
void setValue(int newValue);

8:42 - Using the SWIFT_SHARED_REFERENCE attribute

struct SWIFT_SHARED_REFERENCE(retain, release) CxxReferenceType;

8:52 - Using the SWIFT_RETURNS_INDEPENDENT_VALUE attribute

SWIFT_RETURNS_INDEPENDENT_VALUE 
std::string_view networkName() const;

10:45 - Using a for-loop to iterate over a C++ std::vector in Swift

// Get every image out of the shared C++ class.
for image in CxxImageEngine.shared.pointee.getImages() {
    let uiImage = CxxImageEngine.shared.pointee.uiImageFrom(image)
    UIImageWriteToSavedPhotosAlbum(uiImage, nil, nil, nil)
}

13:54 - Import swift/bridging
```
#import <swift/bridging>
```

14:01 - Applying the SWIFT_SHARED_REFERENCE attribute to CxxImageEngine

struct SWIFT_SHARED_REFERENCE(IKRetain, IKRelease) CxxImageEngine {
    // ...
};

14:53 - Applying the SWIFT_COMPUTED_PROPERTY attribute to getImages

/// \returns all images that have been loaded into the engine. Includes any modifications that were
/// applied to the images.
SWIFT_COMPUTED_PROPERTY
inline std::vector<Image *_Nonnull> getImages() const;

15:06 - Updated for-loop using the "images" computed property

// Get every image out of the shared C++ class.
for image in CxxImageEngine.shared.pointee.images {
    let uiImage = CxxImageEngine.shared.pointee.uiImageFrom(image)
    UIImageWriteToSavedPhotosAlbum(uiImage, nil, nil, nil)
}

正在查找特定内容？在上方输入一个主题，就能直接跳转到相应的精彩内容。