本项目提供命令行程序，用于向 Google 的 protoc 添加 Swift 代码生成功能，并提供使用生成的代码所需的运行时库。在使用 protoc 插件从您的 .proto 文件生成 Swift 代码后，您需要将此库添加到您的项目中。

最重要的是，您可以采用相同的 .proto 文件并生成 Java、C++、Python 或 Objective-C 代码，以供其他平台使用。这些语言生成的代码将使用与 SwiftProtobuf 完全相同的序列化和反序列化约定，从而可以轻松地以二进制或 JSON 形式交换序列化数据，而无需您付出额外的努力。

如果您以前使用过 Protocol Buffers，则添加 Swift 支持非常简单：您只需构建 protoc-gen-swift 程序并将其复制到您的 PATH 中即可。 protoc 程序会自动找到并使用它，从而允许您为 proto 文件构建 Swift 源代码。当然，您还需要按照下面的说明将 SwiftProtobuf 运行时库添加到您的项目中。

要将 .proto 文件转换为 Swift，您需要 Google 的 protoc 编译器和 SwiftProtobuf 代码生成器插件。

git clone https://github.com/apple/swift-protobuf.git
cd swift-protobuf

选择您要使用的 SwiftProtobuf 的已发布版本。您可以使用以下命令获取标签列表

选择您要使用的版本后，将您的本地状态设置为匹配，并构建 protoc 插件

git checkout tags/[tag_name]
swift build -c release

这将在 .build/release 目录中创建一个名为 protoc-gen-swift 的二进制文件。

要安装，只需将此可执行文件复制到您的 PATH 环境变量中的一个目录中。

注意：Swift 运行时支持现已包含在 macOS 中。如果您使用的是旧的 Xcode 版本或较旧的系统版本，您可能还需要将 --static-swift-stdlib 与 swift build 一起使用。

brew install swift-protobuf

要为您的 .proto 文件生成 Swift 输出，您可以像往常一样运行 protoc 命令，使用 --swift_out=<directory> 选项

protoc --swift_out=. my.proto

protoc 程序将自动在您的 PATH 中查找 protoc-gen-swift 并使用它。

每个 .proto 输入文件都将被转换为输出目录中相应的 .pb.swift 文件。

有关构建和使用 protoc-gen-swift 的更多信息，请参见详细的插件文档。

要使用生成的代码，您需要在项目中包含 SwiftProtobuf 库模块。具体方法取决于您构建项目的方式。请注意，在所有情况下，我们都强烈建议您使用与您用于生成代码的 protoc-gen-swift 版本对应的 SwiftProtobuf 库版本。

将 .pb.swift 文件复制到您的项目后，您需要将 SwiftProtobuf 库添加到您的项目中以支持生成的代码。如果您使用的是 Swift Package Manager，请将依赖项添加到您的 Package.swift 文件中，并将 SwiftProtobuf 库导入到所需的目标中。调整这里的 "1.27.0" 以匹配您用于构建上述插件的 [tag_name]

dependencies: [
    .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.27.0"),
],
targets: [
    .target(
      name: "MyTarget",
      dependencies: [.product(name: "SwiftProtobuf", package: "swift-protobuf")]
    ),
]

如果您使用的是 CocoaPods，请将其添加到您的 Podfile 中，调整 :tag 以匹配您用于构建上述插件的 [tag_name]

pod 'SwiftProtobuf', '~> 1.0'

安装代码生成器，使用它从您的 .proto 文件生成 Swift 代码，并将 SwiftProtobuf 库添加到您的项目后，您可以像使用任何其他 Swift 结构体一样使用生成的类型。

syntax = "proto3";

message BookInfo {
   int64 id = 1;
   string title = 2;
   string author = 3;
}

protoc --swift_out=. DataModel.proto

生成的代码将为每个 proto 字段公开一个 Swift 属性，以及一系列序列化和反序列化功能

// Create a BookInfo object and populate it:
var info = BookInfo()
info.id = 1734
info.title = "Really Interesting Book"
info.author = "Jane Smith"

// As above, but generating a read-only value:
let info2 = BookInfo.with {
    $0.id = 1735
    $0.title = "Even More Interesting"
    $0.author = "Jane Q. Smith"
  }

// Serialize to binary protobuf format: you can choose to serialize into
// any type conforming to `SwiftProtobufContiguousBytes`. For example:
// Resolve the `SwiftProtobufContiguousBytes` return value to `Data`
let binaryData: Data = try info.serializedBytes()
// Resolve the `SwiftProtobufContiguousBytes` return value to `[UInt8]`
let binaryDataAsBytes: [UInt8] = try info.serializedBytes()

// Note that while the `serializedBytes()` spelling is generally preferred,
// you may also use `serializedData()` to get the bytes as an instance of 
// `Data` where required.
// This means that the following two statements are equivalent:
// let binaryData: Data = try info.serializedBytes()
// let binaryData: Data = try info.serializedData()

// Deserialize a received Data object from `binaryData`
let decodedInfo = try BookInfo(serializedData: binaryData)

// Deserialize a received [UInt8] object from `binaryDataAsBytes`
let decodedInfo = try BookInfo(serializedBytes: binaryDataAsBytes)

// Serialize to JSON format as a Data object, or as any other type conforming to
// SwiftProtobufContiguousBytes. For example:
let jsonData: Data = try info.jsonUTF8Data()
let jsonBytes: [UInt8] = try info.jsonUTF8Bytes()

// Deserialize from JSON format from `jsonBytes`
let receivedFromJSON = try BookInfo(jsonUTF8Bytes: jsonBytes)

Swift Protobuf

SwiftProtobuf 的特性

文档

开始使用

系统要求

构建和安装代码生成器插件

或者通过 Homebrew 安装

将 .proto 文件转换为 Swift

将 SwiftProtobuf 库添加到您的项目...

...使用 `swift build`

...使用 Xcode

...使用 CocoaPods

快速入门

报告任何问题