CocoaMQTT

PodVersion 许可证 Swift版本

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

构建

使用Xcode 11.1 / Swift 5.1构建

iOS目标版本：12.0或更高 macOS目标版本：10.13或更高 tvOS目标版本：10.0或更高

Xcode 14.3问题：

文件未找到：/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代理：

///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.topic) 中收到消息，负载为 \(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文件导入系统。

基于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()