CocoaMQTT
用于iOS/macOS/tvOS的Swift 5编写的MQTT v3.1.1和v5.0客户端库
构建
使用Xcode 11.1 / Swift 5.1构建
IOS目标:9.0或更高,OSX目标:10.12或更高,TVOS目标:10.0或更高
xcode 14.3问题
File not found: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/arc/libarclite_iphonesimulator.a
如果遇到问题,请更新您的项目最低部署为11.0。
安装
CocoaPods
要使用 CocoaPods 将 CocoaMQTT 整合到您的 Xcode 项目中,您需要修改以下 Podfile
use_frameworks!
target 'Example' do
pod 'CocoaMQTT'
end
然后,运行以下命令
$ pod install
最后,将 "CocoaMQTT" 导入到您的项目中
import CocoaMQTT
Carthage
使用 Carthage 安装,请将以下行添加到您的 Cartfile 中
github "emqx/CocoaMQTT" "master"
然后,运行以下命令
$ carthage update --platform iOS,macOS,tvOS --use-xcframeworks
最后
在您的应用程序目标的 "General" 设置选项卡中,在 "Frameworks, Libraries, and Embedded content" 部分中,将 CocoaMQTT.xcframework、CocoaAsyncSocket.xcframework 和 Starscream.xcframework 从磁盘上的 Carthage/Build 文件夹拖放到相应的位置。然后选择 "Embed & Sign"。
用法
创建客户端以连接到 MQTT 代理
///MQTT 5.0
let clientID = "CocoaMQTT-" + String(ProcessInfo().processIdentifier)
let mqtt5 = CocoaMQTT5(clientID: clientID, host: "broker.emqx.io", port: 1883)
let connectProperties = MqttConnectProperties()
connectProperties.topicAliasMaximum = 0
connectProperties.sessionExpiryInterval = 0
connectProperties.receiveMaximum = 100
connectProperties.maximumPacketSize = 500
mqtt5.connectProperties = connectProperties
mqtt5.username = "test"
mqtt5.password = "public"
mqtt5.willMessage = CocoaMQTTWill(topic: "/will", message: "dieout")
mqtt5.keepAlive = 60
mqtt5.delegate = self
mqtt5.connect()
///MQTT 3.1.1
let clientID = "CocoaMQTT-" + String(ProcessInfo().processIdentifier)
let mqtt = CocoaMQTT(clientID: clientID, host: "broker.emqx.io", port: 1883)
mqtt.username = "test"
mqtt.password = "public"
mqtt.willMessage = CocoaMQTTWill(topic: "/will", message: "dieout")
mqtt.keepAlive = 60
mqtt.delegate = self
mqtt.connect()
现在您可以使用 closures 替代 CocoaMQTTDelegate
mqtt.didReceiveMessage = { mqtt, message, id in
print("Message received in topic \(message.topic) with payload \(message.string!)")
}
SSL安全
单向认证
本地不需要证书。如果您想信任所有不受信任的CA证书,可以这样做
mqtt.allowUntrustCACertificate = true
双向认证
需要由公钥文件和私钥文件生成的.p12文件。您可以在终端生成p12文件
openssl pkcs12 -export -clcerts -in client-cert.pem -inkey client-key.pem -out client.p12
通过Websocket的MQTT
在1.3.0版本中,CocoaMQTT支持通过Websocket连接到MQTT代理
如果您通过 CocoaPods 进行集成,您需要修改您的 Podfile
并重新执行 pod install
use_frameworks!
target 'Example' do
pod 'CocoaMQTT/WebSockets'
end
如果您在仅有一个 .podspec
而没有 Podfile
的项目中使用CocoaMQTT,例如在React Native模块中,请将此行添加到您的 .podspec
Pod::Spec.new do |s|
...
s.dependency "Starscream"
end
然后,创建一个通过Websocket的MQTT实例
///MQTT 5.0
let websocket = CocoaMQTTWebSocket(uri: "/mqtt")
let mqtt5 = CocoaMQTT5(clientID: clientID, host: host, port: 8083, socket: websocket)
let connectProperties = MqttConnectProperties()
connectProperties.topicAliasMaximum = 0
// ...
mqtt5.connectProperties = connectProperties
// ...
_ = mqtt5.connect()
///MQTT 3.1.1
let websocket = CocoaMQTTWebSocket(uri: "/mqtt")
let mqtt = CocoaMQTT(clientID: clientID, host: host, port: 8083, socket: websocket)
// ...
_ = mqtt.connect()
如果您想为连接添加额外的自定义头,可以使用以下方法
let websocket = CocoaMQTTWebSocket(uri: "/mqtt")
websocket.headers = [
"x-api-key": "value"
]
websocket.enableSSL = true
let mqtt = CocoaMQTT(clientID: clientID, host: host, port: 8083, socket: websocket)
// ...
_ = mqtt.connect()
示例应用
您可以通过示例应用了解如何使用它。但首先我们需要使示例应用能正常运行。
$ cd Examples
$ pod install
然后,通过 Xcode 打开 Example.xcworkspace
并启动它!
依赖项
这些第三方功能被使用
许可证
MIT 许可证(见 LICENSE
)
贡献者
作者
- Feng Lee [email protected]
- CrazyWisdom [email protected]
- Alex Yu [email protected]
- Leeway [email protected]