探索 Swift 和 Java 互操作性

探索 Swift 和 Java 互操作性

了解如何在一个代码库中混合使用 Swift 和 Java。我们将介绍 swift-java 互操作性项目，该项目让你可以在 Java 程序中使用 Swift，反之亦然。我们将向你展示如何使用 swift-java 提供的工具和库来编写可在这两个运行时之间进行互操作的安全高效代码。

章节
- 0:00 - 简介与内容安排
- 2:41 - 运行时差异
- 3:31 - Java Native Methods
- 6:29 - SwiftJava
- 10:13 - 在 Swift 中调用 Java
- 14:01 - 在 Java 中调用 Swift
- 20:47 - 总结
资源
相关视频

WWDC25
WWDC23
- 融合 Swift 和 C++
大家好我叫 Konrad 是 Swift 语言团队的一名工程师今天我想向大家介绍我们在今年早些时候启动的新互操作性方案： Swift-Java 互操作性我们对互操作性充满期待因为它让我们能够在更多应用程序中使用 Swift 通过互操作性我们可以循序渐进地将 Swift 引入用其他语言编写的现有代码库中我们不需要进行大规模且风险高的重写可直接添加新功能或使用 Swift 替换现有功能无需改动现有的代码库我们还可以重复利用其他语言实现的现有库同时也能让其他语言使用在 Swift 中编写的库我们实现互操作性的方式不仅限于语言因为我们集成了最适合每个生态系统的构建工具比如面向 C 或 C++ 的 CMake 或面向 Java 项目的 Gradle 自 Swift 问世以来它就具备与 C 语言的高级互操作性这种互操作性使 Swift 能够无缝集成到现有的 Apple 开发者生态系统中并最终成为在这些平台上进行开发的主要语言两年前我们推出了 C++ 互操作性方案它支持在单个代码库中无缝混合 C++ 和 Swift 库这使得 Swift 能够在更多场景中得以应用要进一步了解相关信息请观看 WWDC23 讲座 “融合 Swift 和 C++” 或今年的讲座“安全地混合使用 C、C++ 和 Swift” 在讨论互操作性时我们可以关注两个方案首先我们可以主要用 Swift 编写应用程序并调用一些用 Java 编写的代码或者我们可以专注于让 Swift 能够简单高效地从 Java 执行调用 Swift 的 Java 互操作性支持这两个方案我们在每个方案中使用的工具和技术略有不同但你可能会发现在一个项目中也能同时使用所有这些内容在我们开始讨论具体示例之前让我们先弄明白 Java 和 Swift 运行时的差异然后我们将探讨应用 Java 互操作性的三个实际示例首先通过使用 Java 现有的原生方法功能然后我们将探讨如何让 Swift 可访问整个 Java 库最后我们将探索相反的方案封装整个 Swift 库以便 Java 项目轻松利用我们先来比较一下这两种运行时毕竟 Java 运行时与 Swift 现有互操作的其他原生语言存在显著差异不过如果从宏观视角来看或许可以说 Swift 可能是目前与 Java 最相似的原生语言这两种语言都提供具有相似继承模型的类并且都提供一种自动内存管理方法对开发者来说基本上是透明的它们都提供非常相似的泛型系统尽管在运行时表示方式不同最后 Swift 错误与 Java 异常一样都可以抛出虽然它们在运行时携带的信息量略有不同重要的是通过精心设计与这些功能的交互方案我们能够实现两种语言间大多数 API 的表达现在我们已经了解了这些语言的差异及相似之处让我们一起来看看如何扩展现有的 Java 应用程序我们将从基础知识开始先专注于在 Swift 中实现单个函数为了实现这个操作我们将使用 Java 语言功能名为 Native Methods Java Native Methods 属于 Java Native Interface API 简称 JNI 自 1997 年以来也就是 iPod 出现之前 JNI 一直属于 Java 它专门用于实现 Java 与原生代码的互操作性它通常用于以下场景：通过将任务移出 Java 堆以实现高性能目标；或者使用无 Java 等效的原生库它仍然是 Java 和本机代码进行互操作的主要方式之一并且这些 API 从那时起几乎没有改变过因此我们只有开始探索 JNI 才有意义为了稍微熟悉一下 JNI 让我们按照常规步骤使用 JNI 不借助任何支持库或工具在 Java 应用程序端你将定义一个原生函数这个函数将使用原生代码实现为了说明 JNI 如何将对象传递给原生代码我们使用大写 Integer 类型作为参数并返回这个函数的类型与原始 Int 值不同这些是 Java 对象我们必须相应地使用它们然后必须将带 -h 标志的 Java 编译器用于包含原生方法的任何文件上这将生成一个包含 C 函数声明的 C 标头文件当调用相应 Java 原生方法时 JVM 将尝试调用这些函数这个声明有一个相当冗长的名称： Java_com_example_JNIExample_compute 它会匹配原生方法的软件包、类和方法名它会接受名为 JNI 环境的参数以及用于 Java 对象调用方法的 This 引用的 jobject 参数还有原始 Java 函数声明的所有参数最后你需要使用选择的原生语言也就是 Swift 来实际实现这个函数
代码还真不少呢！尽管样板代码确实掩盖了实际的逻辑实现就是这个部分但它并非只是噪音它们是无数个可能导致细微错误的潜在风险点任何失误都可能引发致命崩溃综上所述 JNI 虽是 JVM 调用原生代码的主流方案但正确使用难度极高要提高方法实现的性能我们可能需要引入缓存等优化技术但这会进一步增加代码复杂度还需要考虑其他构建步骤和 C 标头等问题手动匹配所有方法签名和魔术字符串非常容易出错我们还必须谨慎地管理任何已创建或接收的 Java 对象的生命周期因此在没有额外支持的情况下使用 JNI 开发虽然可行但开发体验非常低效 SwiftJava 应运而生它是 Swift 和 Java 互操作性的新解决方案我们构建的 SwiftJava 将为 Swift 和 Java 开发者提供一种灵活、安全且高效的双语言交互方案
SwiftJava 由几个部分组成你可以单独或搭配使用首先是 Swift 软件包它提供 JavaKit 库和宏这使得处理 JNI 代码变得更安全就像在之前的示例中展示的那样然后我们有一个 Java 库名为 SwiftKit 它可以帮助 Java 应用程序有效处理 Swift 对象最后是 Swift-Java 命令行工具以及其他构建系统集成比如 SwiftPM 插件甚至是那些正在开发中、与 Gradle 等主流 Java 构建工具深度集成的方案让我们重新执行刚才的示例但这次我们将使用 SwiftJava 提供的工具我们不使用 Java 编译器而是应用 Swift-Java 命令行工具生成必要的桥接我们需要提供模块名称其中应该写入生成的源代码以及一些额外的配置在更复杂的项目中这将由 SwiftPM 中的构建插件或者你正在使用的其他构建系统触发这个工作流的结果是包含装饰性元素的 Swift 文件这些元素会描述导入的 Java 类如果 Java 类型包含成员方法它们也会出现在相应的 Swift 类型上这意味着我们可以从 Swift 端回调这些 Java 函数最后生成的 JNIExampleNativeMethods 协议包含我们可为这个类型实现的所有原生方法这可以替代我们之前使用的 C 标头要实际实现原生计算函数我们只需在生成的 JNIExample 类上编写扩展并使它符合 JNIExampleNativeMethods 协议我们还要使用由 JavaKit 提供的 JavaImplementation 宏对它进行注释接下来编译器将帮助我们实现正确的必需函数签名唯一需要额外注意的是必须使用 JavaMethod 宏进行注释这个宏会处理一些复杂的 JNI 细节现在借助 SwiftJava 我们的方法实现变得更加简单我们只需专注于业务逻辑更棒的是由于处于 Swift 中我们可使用任何 Swift 库例如我可能需要调用某些加密算法的原生实现 Swift 生态系统正好有适合的库我可以导入 Crypto 模块例如计算传入数据的 SHA256 哈希值你可能还记得我们之前 JNI 实现中的种种问题其实这些问题大多并不在于 JNI 本身而在于正确使用的高难度得益于 SwiftJava 对 JNI 的方法我们不仅能规避大量模板代码默认生成的代码也更易维护且更安全我们完全不需要与 C 标头进行交互相反我们可以依赖类型完备、自动生成的函数签名这为我们避免了可能需要花费很长时间进行调试的错误最后相比手动编写语言桥接代码对象生命周期管理有了显著改进这对编写跨语言内存安全代码至关重要总而言之相比手动编写使用 SwiftJava 执行 JNI 交互会更便捷且更安全以上内容只是冰山一角 SwiftJava 还会为你带来更多惊喜接下来我们来设想一种情况我们需要在 Swift 中调用 Java 库我们将再次使用相同的 Swift-Java 工具但这一次让我们重点关注如何导入现有的整个 Java 库而非单一的类型例如假设我想调用 Swift 中常用的 Apache commons-csv Java 库我需要同时找到这个库以及它的所有下游依赖项依赖项解析的复杂度会迅速攀升因为 Java 库往往存在大量传递依赖项而它们也会有自己的依赖项情况愈加复杂幸好 SwiftJava 可解决这个问题我们只需准备要使用的库的工件坐标通常你可通过在线搜索轻松找到它们如果你自己无法确定可以询问团队中的 Java 开发者依赖项将表示为三元组：标识特定工件的 Artifact ID、标识发布库的组织的 Group ID 以及版本号接下来我们将利用 SwiftJava 的 Gradle 集成这是 Java 生态系统中常用的构建工具和依赖项管理器为了向 Gradle 声明这种依赖项只需将这三个值用冒号分隔开这样就能以 Gradle 可理解的格式形成依赖项描述符现在我们了解了依赖项坐标我们可通过两种方式下载依赖项并将它们封装到到 JavaApacheCommonsCSV 目标中第一种方法是使用 SwiftJava 构建工具插件在目标的 swift-java.config 文件中我们添加了依赖项部分其中列出我们要解析的所有根依赖项这非常方便现在当我们构建 SwiftPM 项目时插件将自动调用 Gradle 以解析 Java 依赖项但是 SwiftPM 会强制执行安全沙盒这可确保构建的插件无法访问任意文件和网络因此如果你想使用这种方法可以选择在生成项目时禁用安全沙盒这可能并非在所有环境中都可行因此你可采取一种替代方法我们可以转而使用 Swift-Java 命令行工具的 Resolve 命令通过向它传递包含配置文件的模块名称这个工具将解析依赖项并将生成的类路径写入文件由于这是在 SwiftPM 构建之外执行的操作我们不必禁用沙盒不过这意味着在构建项目之前你需要手动触发这类依赖项解析你需要根据工作流程进行取舍选择更适合自己的模型
无论如何选择现在我们都可在 Swift 中调用 Java 库只需导入 JavaKit 和 JavaApacheCommonsCSV 模块然后在 Swift 进程中启动 JVM 以运行 Java 代码这样我们就可在 Swift 应用程序中使用 Java 了比如这里我们使用的是 JDK 的 FileReader 并将它传递给我们刚导入的 CSV 库更重要的是我们甚至可以直接在返回的 Java 集合上使用 Swift 的 for-each 循环
了解了 SwiftJava 如何同时使用 Gradle 和 SwiftPM 来提供出色的用户体验我们就能够导入整个 Java 库而无需修改任何 Java 源代码生成的 Swift 源代码会利用 JavaKit 提供的 JDK 包装器类型并无缝处理用户定义的类型 JavaKit 还会简化 Java 对象的生命周期管理这可通过在必要时将对 Java 对象的引用提升为全局引用来实现我们今天要讨论的最后一项技术是将整个 Swift 库提供给 Java 应用程序调用这是非常重要的用例因为我们可在 Swift 中实现关键的核心业务逻辑并将它用于我们的所有应用程序和服务中而不用考虑他们是否采用了 Swift
我们之前提到过互操作性必须是双向的我们应当深刻理解：优化 Java 到 Swift 的互操作体验不仅能推动更多项目采用 Swift 还能提升开发者的效率这正是将新语言引入代码库对社会产生的深远影响现在如果我们要使用以前的技术公开整个 Swift 库我们必须在 Java 端编写大量包装器函数这仅适用于少量函数如果涉及整个库就应该考虑另一种方法这与向 Swift 公开 Java 库的操作类似现在我们要让 Java 调用 Swift 变得更加顺畅和简单要实现这一目标需要通过 Java 类封装 Swift 库的所有类型并将它打包为完整的 Java 库进行分发这一次我们会彻底弃用 JNI 转而使用新的 Foreign Function 和 Memory API 这些 API 已于去年 3 月稳定并随 Java 22 正式推出它们增强了对原生内存和原生调用方式的控制在某些情况下可以替代 JNI 通过使用这些新 API 我们能够在 Java 和 Swift 运行时以及内存管理之间构建深度集成这在之前根本无法实现这提升了 Java 调用原生代码时的安全性和性能在本例中我们使用 Swift 结构体类型这个类型表示我想向 Java 公开的某个业务对象它是一种值类型因此没有稳定的对象标识并非 Java 对象可以表达的因此我们必须谨慎地处理 Java 中的这个对象它还具有公共属性、构造器以及一些操作的方法为了向 Java 公开这个类型我们将再次使用 Swift-Java 命令行工具但是这一次我们的使用模式略有不同我们将为它提供 Swift 输入路径和输出目录用于生成的 Swift 和 Java 源代码然后这个工具将获取输入路径中的所有源代码并生成 Java 类这些类充当 Swift 类型和函数的访问器我们还将生成一些必要的 Swift 辅助代码最后所有内容 (包括构建为动态库的 Swift 代码) 都将被编译并打包到 Java 库中生成的 Java 类将如下所示它实现了 Swift 值接口因为它是一个结构体这个类包含 Self MemorySegment 这实际上是指向原生内存中实例的指针它还表示所有公共构造器、属性以及使用等效 Java 签名的函数在这些代码中我们有源代码生成的高效代码可使用 Foreign Function API 执行原生调用现在在 Java 应用程序中我们可以依赖生成的 Java 源代码要创建和管理原生 Swift 值我们需要 SwiftArena 它负责 Swift 对象的内存分配和生命周期准备好 Arena 后我们只需调用 Swift 值的构造函数就好像它是普通的 Java 类一样让我们借这个机会进一步讨论这里的原生和 Java 内存资源是如何进行管理的首先会在 Java 堆上分配新的 Java 包装器对象这个对象由 JVM 的垃圾回收器管理然后源代码生成的构造函数会使用 SwiftArena 中传入的数据在原生堆上分配并初始化 Swift 值类型的实例通常像 SwiftyBusiness 结构体这样的值类型都会在栈上进行分配但由于我们需要稳定的内存地址我们会在堆上分配它这样我们就能从 Java 包装器对象安全指向这个内存地址最终当 Java 包装器不再使用时垃圾回收器将采取回收和销毁操作这也将触发对 Swift 端原生实例的销毁因此从内存管理的角度来看这是安全的然而与 Swift 不同的是依赖这种对象终结会给垃圾回收器带来较大的压力因为它需要对这类对象执行额外的追踪这还会导致原生 Swift 值的去初始化时机变得不可预测因此虽然这个模式易于上手但还有管理原生内存的更好方法我们可以改用 try-with-resources Java 语法结合 Confined Arena 类型来替代 Auto Arena 在这里对象分配将以相同方式执行但是 try-with-resources 会更改对象的销毁方式具体来说在 triscope 结束时 Arena 将关闭这会触发对 Java 包装器对象的销毁进而触发原生堆上 Swift 值的销毁这种方法好得多垃圾回收器不必承担对象终结的工作因为当这类操作大规模执行时可能会引发问题并且我们还重新获得了对象去初始化过程定义清晰、有序进行的特性这正是众多 Swift 程序依赖的因此请尽量使用 Scoped Arena 而不是依赖垃圾回收器来获得最佳应用程序行为和性能让我们回顾一下今天的内容我们能够封装完整的 Swift 库只需调用一次 Swift-Java 命令行工具即可我们能够将这样的 Swift 代码封装成 Java 库并进行发布这样便能在 Java 项目中轻松调用这些库进一步简化了团队对 Swift 的采用过程通过使用新的 Foreign Function 和 Memory API 我们能够严格控制对象的分配和生命周期甚至是 Swift 值类型今天我们介绍了许多使用 Swift 和 Java 的不同技术你可单独或搭配应用具体取决于你的项目需求尽管我们才刚刚起步还有很多地方需要打磨和完善但 SwiftJava 提供了非常不错的解决方案可实现这两种语言之间的互操作性通过使用 SwiftKit 和 JavaKit 支持库你可编写安全且高效的代码在一种语言中调用另一种语言 JavaKit 宏以及 Swift-Java 命令行工具会自动生成原本难以维护的各种样板代码
最后诚挚邀请大家加入我们共同参与这个项目的开发这个项目完全开源并可通过 Swiftlang Github 组织获取我们仍面临许多值得探索的技术挑战与创新方向如果你还没准备好参与开发工作但想进一步了解 Swift 和 Java 或者分享你的想法和反馈不妨加入我们的 Swift 论坛非常感谢大家观看！至于我嘛该去给自己倒杯咖啡了

9:05 - Implement JNI native methods in Swift

import JavaKit
import JavaRuntime

import Crypto

@JavaImplementation("com.example.JNIExample")
extension JNIExample: JNIExampleNativeMethods {
 
  @JavaMethod
  func compute(_ a: JavaInteger?, _ b: JavaInteger?) -> [UInt8] {
    guard let a else { fatalError("Expected non-null parameter 'a'") }
    guard let a else { fatalError("Expected non-null parameter 'b'") }
    
    let digest = SHA256Digest([a.intValue(), b.intValue()]) // convenience init defined elsewhere
    return digest.toArray()
  }
}

12:30 - Resolve Java dependencies with swift-java
```
swift-java resolve --module-name JavaApacheCommonsCSV
```

13:05 - Use a Java library from Swift

import JavaKit
import JavaKitIO
import JavaApacheCommonsCSV

let jvm = try JavaVirtualMachine.shared()

let reader = FileReader("sample.csv") // java.io.StringReader

for record in try JavaClass<CSVFormat>().RFC4180.parse(reader)!.getRecords()! {
  for field in record.toList()! {      // Field: hello
    print("Field: \(field)")           // Field: example
  }                                    // Field: csv
}

print("Done.")

16:22 - Wrap Swift types for Java

swift-java --input-swift Sources/SwiftyBusiness \ 
           --java-package com.example.business \
           --output-swift .build/.../outputs/SwiftyBusiness \
           --output-java .build/.../outputs/Java ...

18:55 - Create Swift objects from Java

try (var arena = SwiftArena.ofConfined()) {
  var business = new SwiftyBusiness(..., arena);
}

- 0:00 - 简介与内容安排
- 了解一个名为“swift-java”的实验性 Swift 语言库，它基于与 Objective-C、C 和 C++ 的现有互操作性功能，使 Swift 能与 Java 无缝协作。借助这种互操作性，你可以逐步将 Swift 引入现有的 Java 代码库，跨语言重复使用资源库，以及将 Swift 资源库与 Java 项目集成。 “swift-java”提供的互操作性支持从 Swift 调用 Java 代码，反之亦然。这个团队正在开发工具和技术来处理 Java 和 Swift 运行时之间的差异，并为转换为 Swift 类型的 Java 代码提供更出色的内存安全性。
- 2:41 - 运行时差异
- Swift 和 Java 具有一些共同的特性 (例如类、继承、自动内存管理、泛型和错误处理)，但也存在运行时差异。尽管如此，但这两种语言的相似之处使得其中一种语言的大多数 API 都可以用另一种语言表达。
- 3:31 - Java Native Methods
- Java Native Interface API (JNI) 于 1997 年初推出，它使 Java 虚拟机 (JVM) 中运行的 Java 代码能够与原生代码 (例如 Swift) 进行互操作。这通常是为了提高性能或利用没有 Java 等效项的原生库。若要使用 JNI，需要使用 Java 语言定义一个“原生”函数，并生成相应的 C 语言头文件。这个头文件包含一个必须使用原生语言 (如 Swift) 实现的 C 函数声明。这一过程涉及管理对象生命周期、匹配方法签名以及处理冗长的样板代码 (这些代码容易出错且耗时，可能导致严重的崩溃)。
- 6:29 - SwiftJava
- SwiftJava 增强了 Swift 语言与 Java 语言之间的互操作性。它提供了一套工具，包括 Swift 和 Java 资源库、命令行工具以及构建系统集成，可简化和保护这两种语言之间的交互。 “swift-java”命令行工具可自动生成桥接代码，无需手动进行 C 语言头交互。这使得代码更简洁、更易于维护，同时也改进了对象生命周期管理和类型安全性。现在，你可以专注于业务逻辑，这得益于两个方面：一方面可以充分利用 Swift 和 Java 生态系统的强大功能，另一方面也可避免手动 JNI 实现中常见的陷阱和错误。
- 10:13 - 在 Swift 中调用 Java
- SwiftJava 支持将 Java 资源库集成到 Swift 项目中。若要导入整个 Java 资源库 (例如 Apache Commons CSV)，请准备以下工件坐标：“groupId”、“artifactId”和“version”。然后，SwiftJava 会利用开源构建系统 Gradle 来解析 Java 依赖项。下载和封装 Java 依赖项的方法有两种：使用 SwiftJava 构建工具插件，这需要禁用 SwiftPM 的安全沙盒；或者使用“swift-java”命令行工具的“resolve”命令，这条命令会在构建过程之外执行解析。解析完 Java 依赖项后，你可以将 Java 资源库导入 Swift，在 Swift 进程中启动 JVM，并无缝地使用 Java 代码和集合以及 Swift 功能 (借由 JavaKit 处理对象生命周期管理)。
- 14:01 - 在 Java 中调用 Swift
- SwiftJava 支持将 Swift 资源库集成到 Java 项目中。为了实现这一点，本次 WWDC25 讲座介绍了一种新方法，无需在 Java 端使用大量封装容器函数。整个 Swift 资源库都使用 Java 22 中推出的全新 Foreign Function and Memory API (FFI)，通过 Java 类进行封装。 FFI 改进了对原生内存的控制，并支持 Java 运行时和 Swift 运行时以及内存管理系统之间的深度集成。通过使用 FFI，从 Java 调用 Swift 代码的过程变得更加高效和安全。 “swift-java”命令行工具用于生成必要的 Java 类和 Swift 帮助程序代码。这一工具可自动生成样板，使这个过程更加简单。生成的 Java 类将充当 Swift 类型和函数的访问器，有效地将 Swift 资源库的功能暴露给 Java。在 Java 中使用原生 Swift 对象时，适当的内存管理至关重要。本次讨论重点介绍了两种方法：使用依赖于 Java 垃圾回收器 (GC) 的“AutoArena”，以及使用“try-with-resources”和“ConfinedArena”。后一种方法是首选方法，可确保对象去初始化过程定义明确且有序进行，从而避免性能问题和增加 GC 的负担。借助这一技术，你可以构建和发布 Swift 封装的 Java 资源库，使它易于在 Java 项目中使用。这样就简化了拥有扎实 Java 基础的团队采用 Swift 的过程，可营造更灵活、更高效的开发环境。SwiftJava 的后续开发目标是，进一步完善和改进这些技术，为实现两种语言之间的互操作性提供强大的解决方案。
- 20:47 - 总结
- Swift 编程语言是开源的，托管在 GitHub 上，SwiftJava 等资源库也同样如此。广大开发者在 Swift 论坛上非常活跃，你可以在这些论坛中学习、分享想法和提供反馈。

章节

资源

相关视频

WWDC25

WWDC23