swift使用swift-protobuf协议通讯,使用指北

2024-06-20 19:20

本文主要是介绍swift使用swift-protobuf协议通讯,使用指北,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

什么是Protobuf

Protobuf(Protocol Buffers)协议😉 Protobuf 是一种由 Google 开发的二进制序列化格式和相关的技术,它用于高效地序列化和反序列化结构化数据,通常用于网络通信、数据存储等场景。

为什么要使用Protobuf? 因为快

其实 Protobuf 在许多领域都得到了广泛应用,特别是在分布式系统、RPC(Remote Procedure Call)框架和数据存储中,它提供了一种高效、简洁和可扩展的方式来序列化和交换数据,

Protobuf 的主要优点包括:

高效性:Protobuf 序列化后的二进制数据通常比其他序列化格式(比如超级常用的JSON)更小,并且序列化和反序列化的速度更快,这对于性能敏感的应用非常有益。
简洁性:Protobuf 使用一种定义消息格式的语法,它允许定义字段类型、顺序和规则(消息结构更加清晰和简洁)
版本兼容性:Protobuf 支持向前和向后兼容的版本控制,使得在消息格式发生变化时可以更容易地处理不同版本的通信。
语言无关性:Protobuf 定义的消息格式可以在多种编程语言中使用,这有助于跨语言的通信和数据交换(截至本文发布目前官方支持的有C++/C#/Dart/Go/Java/Kotlin/python/Swift)
自动生成代码:Protobuf 通常与相应的工具一起使用,可以自动生成代码,包括序列化/反序列化代码和相关的类(减少了手动编写代码的工作量,提高效率)

安装编译器

注意:需要swift5.8以上的版本和xcode14.3以后的版本才可以

你也可以通过命令行使用 swift --version 命令来查看安装的Swift版本。这将会输出类似于下面的信息,显示当前安装的Swift编译器的版本:

安装swift-protobuf:这条命令将会给你的电脑上安装 protoc 和 Swift 代码生成器插件。

brew install swift-protobuf

根据官方文档可以使用brew安装:

安装完之后,输入protoc将会出现提示:

编译Proto文件

将.proto文件编译为swift代码:--swift_out=. 表示将生成的文件放在当前文件夹中

protoc --swift_out=. my.proto

运行之后,就会出现一个GameMsg.pb.swift文件,这就是编译后的swift文件:

生成的代码将为每个 proto 字段公开一个 Swift 属性以及一组序列化和反序列化功能。假如你的proto文件内容是:

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

那么生成的swift代码:

// DO NOT EDIT.
// swift-format-ignore-file
//
// Generated by the Swift generator plugin for the protocol buffer compiler.
// Source: game.proto
//
// For information on using the generated types, please see the documentation:
//   https://github.com/apple/swift-protobuf/import Foundation
import SwiftProtobuf// If the compiler emits an error on this type, it is because this file
// was generated by a version of the `protoc` Swift plug-in that is
// incompatible with the version of SwiftProtobuf to which you are linking.
// Please ensure that you are building against the same version of the API
// that was used to generate this file.
fileprivate struct _GeneratedWithProtocGenSwiftVersion: SwiftProtobuf.ProtobufAPIVersionCheck {struct _2: SwiftProtobuf.ProtobufAPIVersion_2 {}typealias Version = _2
}struct BookInfo {// SwiftProtobuf.Message conformance is added in an extension below. See the// `Message` and `Message+*Additions` files in the SwiftProtobuf library for// methods supported on all messages.var id: Int64 = 0var title: String = String()var author: String = String()var unknownFields = SwiftProtobuf.UnknownStorage()init() {}
}#if swift(>=5.5) && canImport(_Concurrency)
extension BookInfo: @unchecked Sendable {}
#endif  // swift(>=5.5) && canImport(_Concurrency)// MARK: - Code below here is support for the SwiftProtobuf runtime.extension BookInfo: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding {static let protoMessageName: String = "BookInfo"static let _protobuf_nameMap: SwiftProtobuf._NameMap = [1: .same(proto: "id"),2: .same(proto: "title"),3: .same(proto: "author"),]mutating func decodeMessage<D: SwiftProtobuf.Decoder>(decoder: inout D) throws {while let fieldNumber = try decoder.nextFieldNumber() {// The use of inline closures is to circumvent an issue where the compiler// allocates stack space for every case branch when no optimizations are// enabled. https://github.com/apple/swift-protobuf/issues/1034switch fieldNumber {case 1: try { try decoder.decodeSingularInt64Field(value: &self.id) }()case 2: try { try decoder.decodeSingularStringField(value: &self.title) }()case 3: try { try decoder.decodeSingularStringField(value: &self.author) }()default: break}}}func traverse<V: SwiftProtobuf.Visitor>(visitor: inout V) throws {if self.id != 0 {try visitor.visitSingularInt64Field(value: self.id, fieldNumber: 1)}if !self.title.isEmpty {try visitor.visitSingularStringField(value: self.title, fieldNumber: 2)}if !self.author.isEmpty {try visitor.visitSingularStringField(value: self.author, fieldNumber: 3)}try unknownFields.traverse(visitor: &visitor)}static func ==(lhs: BookInfo, rhs: BookInfo) -> Bool {if lhs.id != rhs.id {return false}if lhs.title != rhs.title {return false}if lhs.author != rhs.author {return false}if lhs.unknownFields != rhs.unknownFields {return false}return true}
}

在项目中使用的话:

// 创建一个BookInfo对象,并给它赋值
var info = BookInfo()
info.id = 1734
info.title = "Really Interesting Book"
info.author = "Jane Smith"// 如上所述,但生成只读值:
let info2 = BookInfo.with {$0.id = 1735$0.title = "Even More Interesting"$0.author = "Jane Q. Smith"}// 序列化为二进制protobuf格式:可以选择序列化为
// 符合SwiftProtobufContiqueBytes的任何类型。例如
let binaryData: Data = try info.serializedBytes()
let binaryDataAsBytes: [UInt8] = try info.serializedBytes()// 从`binaryData反序列化接收到的Data对象`
let decodedInfo = try BookInfo(serializedData: binaryData)// 反序列化从`binaryDataAsBytes接收的[UInt8]对象`
let decodedInfo = try BookInfo(serializedBytes: binaryDataAsBytes)//序列化为JSON格式的数据对象,或符合
//SwiftProtobufContiqueBytes。例如
let jsonData: Data = try info.jsonUTF8Data()
let jsonBytes: [UInt8] = try info.jsonUTF8Bytes()// 从`jsonBytes从JSON格式反序列化`
let receivedFromJSON = try BookInfo(jsonUTF8Bytes: jsonBytes)

添加SwiftProtobuf到你的项目中

要想使用Protobuf还需要在你的项目中添加SwiftProtobuf,可以使用SPM添加或者使用CocoaPods添加,我这里习惯使用SPM,在xcode项目中可以直接右键添加包就可以了:

添加之后就可以在左侧项目的依赖包里面显示出来了:

解决遇到的问题

1.如果你在finder中在proto文件夹中生成swift代码,但是当你会到xcode总,发现proto文件夹中不一定会显示proto文件和生成的swift文件:

需要在xcode中手动添加文件到文件夹中:

再回到项目文件夹就可以看到了:

2.但是这个时候,当你打开生成的swift文件,可能发现报错了:

Could not find module 'SwiftProtobuf' for target 'arm64-apple-watchos'; found: arm64_32-apple-watchos, at: /Users/song/Library/Developer/Xcode/DerivedData/mywatch-coaeflxmpfflredurreogfyfvbxz/Index.noindex/Build/Products/Debug-watchos/SwiftProtobuf.swiftmodule 

这是因为你没有将 SwiftProtobuf 真正添加到项目中:

需要你手动再将依赖添加到项目中

就不会报错了:

简单的DEMO

我写了一个简单的Demo:

//
//  ContentView.swift
//  mywatch Watch App
//
//  Created by song on 2024/6/19.
//import SwiftUIstruct ContentView: View {// Create a BookInfo object and populate it:@State var info = BookInfo()// binaryData@State var binaryData: Data = .init()// binaryInfo@State var binaryInfo: BookInfo = .init()var body: some View {VStack {Text(info.author)Text("Hello, 1024小神!")Button(action: {info.id = 1734info.title = "Really Interesting Book"info.author = "Jane Smith"}, label: {Text("编辑")})Button(action: {binaryData = try! info.serializedData()print("二进制数据:\(binaryData)")}, label: {Text("序列化")})Button(action: {binaryInfo = try! BookInfo(serializedData: binaryData)print("反序列化数据:\(binaryInfo)")}, label: {Text("反序列化")})}.padding()}
}#Preview {ContentView()
}

 可以实现协议消息的序列化和反序列化:

这篇关于swift使用swift-protobuf协议通讯,使用指北的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1079027

相关文章

vue使用docxtemplater导出word

《vue使用docxtemplater导出word》docxtemplater是一种邮件合并工具,以编程方式使用并处理条件、循环,并且可以扩展以插入任何内容,下面我们来看看如何使用docxtempl... 目录docxtemplatervue使用docxtemplater导出word安装常用语法 封装导出方

Linux换行符的使用方法详解

《Linux换行符的使用方法详解》本文介绍了Linux中常用的换行符LF及其在文件中的表示,展示了如何使用sed命令替换换行符,并列举了与换行符处理相关的Linux命令,通过代码讲解的非常详细,需要的... 目录简介检测文件中的换行符使用 cat -A 查看换行符使用 od -c 检查字符换行符格式转换将

使用Jackson进行JSON生成与解析的新手指南

《使用Jackson进行JSON生成与解析的新手指南》这篇文章主要为大家详细介绍了如何使用Jackson进行JSON生成与解析处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 核心依赖2. 基础用法2.1 对象转 jsON(序列化)2.2 JSON 转对象(反序列化)3.

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》:本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

Android中Dialog的使用详解

《Android中Dialog的使用详解》Dialog(对话框)是Android中常用的UI组件,用于临时显示重要信息或获取用户输入,本文给大家介绍Android中Dialog的使用,感兴趣的朋友一起... 目录android中Dialog的使用详解1. 基本Dialog类型1.1 AlertDialog(

Python使用自带的base64库进行base64编码和解码

《Python使用自带的base64库进行base64编码和解码》在Python中,处理数据的编码和解码是数据传输和存储中非常普遍的需求,其中,Base64是一种常用的编码方案,本文我将详细介绍如何使... 目录引言使用python的base64库进行编码和解码编码函数解码函数Base64编码的应用场景注意