CocoaMQTT

PodVersion Platforms License Swift version

用 Swift 5 编写的适用于 iOS/macOS/tvOS 的 MQTT v3.1.1 和 v5.0 客户端库

构建

使用 Xcode 11.1 / Swift 5.1 构建

IOS 目标: 12.0 或更高 OSX 目标: 10.13 或更高 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

通过将以下行添加到您的 Cartfile 来使用 Carthage 安装

github "emqx/CocoaMQTT" "master"

然后,运行以下命令

$ carthage update --platform iOS,macOS,tvOS --use-xcframeworks

最后

在您的应用程序目标的“General”设置选项卡中的“Frameworks, Libraries, and Embedded content”部分,从磁盘上的 Carthage/Build 文件夹中拖放 CocoaMQTT.xcframework、CocoaAsyncSocket.xcframework 和 Starscream.xcframework。 然后选择“Embed & Sign”。

用法

创建一个客户端来连接 MQTT broker

///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 = CocoaMQTTMessage(topic: "/will", string: "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 = CocoaMQTTMessage(topic: "/will", string: "dieout")
mqtt.keepAlive = 60
mqtt.delegate = self
mqtt.connect()

现在您可以使用闭包而不是 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

注意:请使用 openssl 版本 1.1 (例如 brew install openssl@1.1),否则您可能无法将生成的 .p12 文件正确导入系统。

MQTT over Websocket

在 1.3.0 版本中,CocoaMQTT 已经支持通过 Websocket 连接到 MQTT Broker。

如果您通过 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()

示例 App

您可以按照示例 App 来学习如何使用它。 但我们需要首先让示例 App 正常工作

$ cd Examples

$ pod install

然后,通过 Xcode 打开 Example.xcworkspace/ 并启动它!

依赖

使用了以下第三方函数

GCDAsyncSocket

LICENSE

MIT 许可证 (参见 LICENSE)

贡献者

作者

Twitter

https://twitter.com/EMQTech