MQTT協議之Mosquitto安裝和使用
Mosquitto是一款實現了 MQTT v3.1 協議的開源訊息代理軟體,提供輕量級的,支援釋出/訂閱的的訊息推送模式,使裝置對裝置之間的短訊息通訊簡單易用。
1.下載解壓、安裝Mosquitto:http://mosquitto.org/files/source/,我使用當前做新版本1.3.5
wget http://mosquitto.org/files/source/mosquitto-1.3.5.tar.gz
解壓:tar -zxvf mosquitto-1.3.5.tar.gz
cd mosquitto-1.3.5
在編譯前需要g++和openssl支援,若沒有安裝請使用如下命令安裝:
yum -y install gcc gcc-c++
yum -y install openssl openssl-devel
yum update openssl
除此之外還需修改安裝選項配置config.mk:
這裡需要注意的是,預設情況下Mosquitto的安裝需要OpenSSL的支援;如果不需要SSL,則需要關閉config.mk裡面的某些與SSL功能有關的選項(WITH_TLS、WITH_TLS_PSK)。# 是否支援tcpd/libwrap功能. #WITH_WRAP:=yes # 是否開啟SSL/TLS支援 #WITH_TLS:=yes # 是否開啟TLS/PSK支援 #WITH_TLS_PSK:=yes # Comment out to disable client client threading support. #WITH_THREADING:=yes # 是否使用嚴格的協議版本(老版本相容會有點問題) #WITH_STRICT_PROTOCOL:=yes # 是否開啟橋接模式 #WITH_BRIDGE:=yes # 是否開啟持久化功能 #WITH_PERSISTENCE:=yes # 是否監控執行狀態 #WITH_MEMORY_TRACKING:=yes
另外編譯過程找不到ares.h,需要把srv support 關掉
WITH_SRV:=yes,改為WITH_SRV:=no
安裝、編譯
make
make install
完成後在命令列裡發現mosquitto、mosquitto_pub和mosquitto_sub三個工具,分別用於啟動代理、釋出訊息和訂閱訊息。
注:在使用過程中找不到libmosquitto.so.1
error while loading shared libraries: libmosquitto.so.1: cannot open shared object file: No such file or directory
解決方法:修改libmosquitto.so位置
# 建立連結
ln -s /usr/local/lib/libmosquitto.so.1 /usr/lib/libmosquitto.so.1
# 更新動態連結庫
ldconfig
2.配置&執行
安裝完成之後,所有配置檔案會被放置於/etc/mosquitto/目錄下,其中最重要的就是Mosquitto的配置檔案,即mosquitto.conf,以下是詳細的配置引數說明:
# =================================================================
# General configuration
# =================================================================
# 客戶端心跳的間隔時間
#retry_interval 20
# 系統狀態的重新整理時間
#sys_interval 10
# 系統資源的回收時間,0表示儘快處理
#store_clean_interval 10
# 服務程序的PID
#pid_file /var/run/mosquitto.pid
# 服務程序的系統使用者
#user mosquitto
# 客戶端心跳訊息的最大併發數
#max_inflight_messages 10
# 客戶端心跳訊息快取佇列
#max_queued_messages 100
# 用於設定客戶端長連線的過期時間,預設永不過期
#persistent_client_expiration
# =================================================================
# Default listener
# =================================================================
# 服務繫結的IP地址
#bind_address
# 服務繫結的埠號
#port 1883
# 允許的最大連線數,-1表示沒有限制
#max_connections -1
# cafile:CA證書檔案
# capath:CA證書目錄
# certfile:PEM證書檔案
# keyfile:PEM金鑰檔案
#cafile
#capath
#certfile
#keyfile
# 必須提供證書以保證資料安全性
#require_certificate false
# 若require_certificate值為true,use_identity_as_username也必須為true
#use_identity_as_username false
# 啟用PSK(Pre-shared-key)支援
#psk_hint
# SSL/TSL加密演算法,可以使用“openssl ciphers”命令獲取
# as the output of that command.
#ciphers
# =================================================================
# Persistence
# =================================================================
# 訊息自動儲存的間隔時間
#autosave_interval 1800
# 訊息自動儲存功能的開關
#autosave_on_changes false
# 持久化功能的開關
persistence true
# 持久化DB檔案
#persistence_file mosquitto.db
# 持久化DB檔案目錄
#persistence_location /var/lib/mosquitto/
# =================================================================
# Logging
# =================================================================
# 4種日誌模式:stdout、stderr、syslog、topic
# none 則表示不記日誌,此配置可以提升些許效能
log_dest none
# 選擇日誌的級別(可設定多項)
#log_type error
#log_type warning
#log_type notice
#log_type information
# 是否記錄客戶端連線資訊
#connection_messages true
# 是否記錄日誌時間
#log_timestamp true
# =================================================================
# Security
# =================================================================
# 客戶端ID的字首限制,可用於保證安全性
#clientid_prefixes
# 允許匿名使用者
#allow_anonymous true
# 使用者/密碼檔案,預設格式:username:password
#password_file
# PSK格式密碼檔案,預設格式:identity:key
#psk_file
# pattern write sensor/%u/data
# ACL許可權配置,常用語法如下:
# 使用者限制:user <username>
# 話題限制:topic [read|write] <topic>
# 正則限制:pattern write sensor/%u/data
#acl_file
# =================================================================
# Bridges
# =================================================================
# 允許服務之間使用“橋接”模式(可用於分散式部署)
#connection <name>
#address <host>[:<port>]
#topic <topic> [[[out | in | both] qos-level] local-prefix remote-prefix]
# 設定橋接的客戶端ID
#clientid
# 橋接斷開時,是否清除遠端伺服器中的訊息
#cleansession false
# 是否釋出橋接的狀態資訊
#notifications true
# 設定橋接模式下,訊息將會發布到的話題地址
# $SYS/broker/connection/<clientid>/state
#notification_topic
# 設定橋接的keepalive數值
#keepalive_interval 60
# 橋接模式,目前有三種:automatic、lazy、once
#start_type automatic
# 橋接模式automatic的超時時間
#restart_timeout 30
# 橋接模式lazy的超時時間
#idle_timeout 60
# 橋接客戶端的使用者名稱
#username
# 橋接客戶端的密碼
#password
# bridge_cafile:橋接客戶端的CA證書檔案
# bridge_capath:橋接客戶端的CA證書目錄
# bridge_certfile:橋接客戶端的PEM證書檔案
# bridge_keyfile:橋接客戶端的PEM金鑰檔案
#bridge_cafile
#bridge_capath
#bridge_certfile
#bridge_keyfile
# 自己的配置可以放到以下目錄中
include_dir /etc/mosquitto/conf.d
啟動服務:
mosquitto -c /etc/mosquitto/mosquitto.conf -d #-d background running
[[email protected] mosquitto]# mosquitto -c mosquitto.conf -d
[[email protected] mosquitto]# 1421739302: Warning: Mosquitto should not be run as root/administrator.
1421739302: mosquitto version 1.3.5 (build date 2015-01-19 22:06:46-0800) starting
1421739302: Config loaded from mosquitto.conf.
1421739302: Opening ipv4 listen socket on port 1883.
1421739302: Opening ipv6 listen socket on port 1883.
從啟動日誌可以看出,監聽1883埠。Mosquitto是個非同步IO框架,經測試可以輕鬆處理20000個以上的客戶端連線。當然,實際的最大承載量還和業務的複雜度還有比較大的關係。壓力測試的時候不要忘記調整系統的最大連線數和棧大小,比如:Linux上可用ulimit -n20000 -s512命令設定你需要的系統引數。
3.測試
一個完整的MQTT示例包括一個代理器,一個釋出者和一個訂閱者。測試分為以下幾個步驟:
【1】啟動服務mosquitto。
【2】訂閱者通過mosquitto_sub訂閱指定主題的訊息。
【3】釋出者通過mosquitto_pub釋出指定主題的訊息。
【4】代理伺服器把該主題的訊息推送到訂閱者。
為了實現這個簡單的測試案例,需要在linux中開啟三個控制檯,分別代表代理伺服器、釋出者和訂閱者。
(1)啟動代理服務
mosquitto -v
【-v】列印更多的除錯資訊
(2)訂閱主題
mosquitto_sub -v -t mqtt_test
【-t】指定主題,此處為sensor
【-v】列印更多的除錯資訊
(3)釋出內容
mosquitto_pub -t mqtt_test -m "hello world "
【-t】指定主題
【-m】指定訊息內容
(4)執行結果
代理broker服務:
[[email protected] mosquitto]# mosquitto -c mosquitto.conf -d
[[email protected] mosquitto]# 1421739302: Warning: Mosquitto should not be run as root/administrator.
1421739302: mosquitto version 1.3.5 (build date 2015-01-19 22:06:46-0800) starting
1421739302: Config loaded from mosquitto.conf.
1421739302: Opening ipv4 listen socket on port 1883.
1421739302: Opening ipv6 listen socket on port 1883.
1421739302: New connection from ::1 on port 1883.
1421739302: New client connected from ::1 as mosqsub/4726-localhost (c1, k60).
1421739306: New connection from ::1 on port 1883.
1421739306: New client connected from ::1 as mosqpub/4850-localhost (c1, k60).
訂閱主題:
[[email protected] ~]# mosquitto_sub -v -t mqtt_test
mqtt_test hello world
mqtt_test hello world
釋出內容:
[[email protected] ~]# mosquitto_pub -t mqtt_test -m "hello world "
mosquitto_pub 客戶端可釋出一條訊息到指定主題:
用法:
mosquitto_pub [-d] [-h hostname] [-i client_id] [-I client id prefix] [-p port number] [-q message QoS] [--quiet] [-r] { -f file | -l | -m message | -n | -s} [-u username [-P password] ] [ --will-topic topic [--will-payload payload] [--will-qos qos] [--will-retain]
] -t message-topic
選項:
-d, --debug
開啟debug選項
-f, --file
把一個檔案的內容做為訊息的內容傳送。經測試,支援txt檔案,不支援doc等其他形式檔案。
-h, --host
說明所連線到的域名,預設是localhost
-i, --id
客戶端的ID號,如果沒有指定,預設是mosquitto_pub_加上客戶端的程序id,不能和--id_prefix同時使用。
-I, --id-prefix
指定客戶端ID的字首,與客戶端的程序ID連線組成客戶端的ID,不能喝--id同時使用。
-l, --stdin-line
從總段讀取輸入傳送訊息,一行為一條訊息,空白行不會被髮送。
-m, --message
從命令列傳送一條訊息,-m後面跟傳送的訊息內容。
-n, --null-message
傳送一條空訊息。
-p, --port
連線的埠號,預設是1883.
-P, --pw
指定密碼用於代理認證,使用此選項時必須有有效的使用者名稱。
-q, --qos
指定訊息的服務質量,可以為0,1,2,預設是0.
--quiet
如果指定該選項,則不會有任何錯誤被列印,當然,這排除了無效的使用者輸入所引起的錯誤訊息。
-r, --retain
如果指定該選項,該條訊息將被保留做為最後一條收到的訊息。下一個訂閱訊息者將能至少收到該條訊息。
-s, --stdin-file
從標準輸入接收傳輸的訊息內容,所有輸入做為一條訊息傳送。
-t, --topic
指定訊息所釋出到哪個主題。
-u, --username
指定使用者名稱用於代理認證。
--will-payload
如果指定該選項,則萬一客戶端意外和代理伺服器斷開,則該訊息將被保留在服務端併發送出去,該選項必須同時用--will-topic指定主題。
--will-qos
指定Will的服務質量,預設是0.必須和選項 --will-topic同時使用.
--will-retain
如果指定該選項,則萬一客戶端意外斷開,已被髮送的訊息將被當做retained訊息。必須和選項 --will-topic同時使用.
--will-topic
指定客戶端意外斷開時,Will訊息傳送到的主題。
sub_client客戶端訂閱一個或多個主題的訊息:
用法:
mosquitto_sub [-c] [-d] [-h hostname] [-i client_id] [-I client id prefix] [-k keepalive time] [-p port number] [-q message QoS] [--quiet] [-v] [ -u username [-Ppassword] ] [ --will-topic topic [--will-payload payload] [--will-qos qos] [--will-retain] ] -t
message topic ...
命令:
mosquitto_sub 訂閱到主題,接收到訊息時列印
選項:
-c, --disable-clean-session
禁止'clean session'選項,即如果客戶端斷開連線,這個訂閱仍然保留來接收隨後到的QoS為1和2的訊息,當改客戶端重新連線之後,它將接收到已排在佇列中的訊息。建議使用此選項時,客戶端id選項設為--id
If using this option, it is recommended that the client id is set manually with --id
-d, --debug
開啟debug選項
-h, --host
說明所連線到的域名,預設是localhost
-i, --id
客戶端的ID號,如果沒有指定,預設是mosquitto_pub_加上客戶端的程序id,不能和--id_prefix同時使用。
-I, --id-prefix
指定客戶端ID的字首,與客戶端的程序ID連線組成客戶端的ID,不能喝--id同時使用。
-k, --keepalive
給代理髮送PING命令(目的在於告知代理該客戶端連線保持且在正常工作)的間隔時間,預設是60s
-p, --port
說明客戶端連線到的埠,預設是1883
-P, --pw
指定密碼用於代理認證,使用此選項時必須有有效的使用者名稱。
-q, --qos
指定訊息的服務質量,可以為0,1,2,預設是0.
--quiet
如果指定該選項,則不會有任何錯誤被列印,當然,這排除了無效的使用者輸入所引起的錯誤訊息。
-t, --topic
指定訂閱的訊息主題,允許同時訂閱到多個主題
-u, --username
指定使用者名稱用於代理認證。
-v, --verbose
冗長地列印收到的訊息。若指定該選項,列印訊息時前面會列印主題名——“主題 訊息內容”,否則,只打印訊息內容
--will-payload
如果指定該選項,則萬一客戶端意外和代理伺服器斷開,則該訊息將被保留在服務端併發送出去,該選項必須同時用--will-topic指定主題。
--will-qos
指定Will的服務質量,預設是0.必須和選項 --will-topic同時使用.
--will-retain
如果指定該選項,則萬一客戶端意外斷開,已被髮送的訊息將被當做retained訊息。必須和選項 --will-topic同時使用.
--will-topic
指定客戶端意外斷開時,Will訊息傳送到的主題。
報文種類
1.連線請求(CONNECT)
當一個從客戶端到伺服器的TCP/IP套接字連線被建立時,必須用一個連線流來建立一個協議級別的會話。
2.連線請求確認(CONNECTACK)
連線請求確認報文(CONNECTACK)是伺服器發給客戶端,用以確認客戶端的連線請求
3.釋出報文(PUBLISH)
客戶端釋出報文到伺服器端,用來提供給有著不同需求的訂閱者們。每個釋出的報文都有一個主題,這是一個分層的名稱空間,他定義了報文來源分類,方便訂閱者訂閱他們需要的主題。訂閱者們可以註冊自己的需要的報文類別。
4.釋出確認報文(PUBACK)
釋出確認報文(PUBACK)是對服務質量級別為1的釋出報文的應答。他可以是伺服器對釋出報文的客戶端的報文確認,也可以是報文訂閱者對釋出報文的伺服器的應答。
5.釋出確認報文(PUBREC)
PUBREC報文是對服務質量級別為2的釋出報文的應答。這是服務質量級別為2的協議流的第二個報文。PUBREC是由伺服器端對釋出報文的客戶端的應答,或者是報文訂閱者對釋出報文的伺服器的應答。
6.釋出確認報文(PUBREL)
PUBREL是報文釋出者對來自伺服器的PUBREC報文的確認,或者是伺服器對來自報文訂閱者的PUBREC報文的確認。它是服務質量級別為2的協議流的第三個報文。
7.確定釋出完成(PUBCOMP)
PUBCOMP報文是伺服器對報文釋出者的PUBREL報文的應答,或者是報文訂閱者對伺服器的PUBREL報文的應答。它是服務質量級別為2的協議流的第四個也是最後一個報文。
8.訂閱命名的主題(SUBSCRIBE)
訂閱報文(SUBSCRIBE)允許一個客戶端在伺服器上註冊一個或多個感興趣的主題名字。釋出給這些主題的報文作為釋出報文從伺服器端交付給客戶端。訂閱報文也描述了訂閱者想要收到的釋出報文的服務質量等級。
9. 訂閱報文確認(SUBACK)
當伺服器收到客戶端發來的訂閱報文時,將傳送訂閱報文的確認報文給客戶端。一個這樣的確認報文包含一列被授予的服務質量等級。被授予的服務質量等級次序和對應的訂閱報文中的主題名稱的次序相符。
10. 退訂命名的主題(UNSUBSCRIBE)
退訂主題的報文是從客戶端發往伺服器端,用以退訂命名的主題。
11. 退訂確認(UNSUBACK)
退訂確認報文是從伺服器發往客戶端,用以確認客戶端發來的退訂請求報文。
12. Ping請求(PINGREQ)
Ping請求報文是從連線的客戶端發往伺服器端,用來詢問伺服器端是否還存在。
13. Ping應答(PINGRESP)
Ping應答報文是從伺服器端發往Ping請求的客戶端,對客戶端的Ping請求進行確認。
14. 斷開通知(DISCONNECT)
斷開通知報文是從客戶端發往伺服器端用來指明將要關閉它的TCP/IP連線,他允許徹底地斷開,而非只是下線。如果客戶端已經和乾淨會話標誌集聯絡,那麼所有先前關於客戶端維護的資訊將被丟棄。一個伺服器在收到斷開報文之後,不能依賴客戶端關閉TCP/IP連線。