首页 > 技术文章 > MQTT-Client-FrameWork使用整理

anti-archs 2018-03-27 14:09 原文

作者: wbl

MQTT

MQTT(Message Queuing Telemetry Transport,消息队列遥测传输)是IBM开发的一个即时通讯协议,有可能成为物联网的重要组成部分。该协议支持所有平台,几乎可以把所有联网物品和外部连接起来,被用来当做传感器和制动器(比如通过Twitter让房屋联网)的通信协议

MQTT特点

MQTT协议是为大量计算能力有限,且工作在低带宽、不可靠的网络的远程传感器和控制设备通讯而设计的协议,它具有以下主要的几项特性:

1. 使用发布/订阅消息模式,提供一对多的消息发布,解除应用程序耦合;

2. 对负载内容屏蔽的消息传输;

3. 使用 TCP/IP 提供网络连接;

4. 有三种消息发布服务质量:

  • “至多一次”,消息发布完全依赖底层 TCP/IP 网络。会发生消息丢失或重复。这一级别可用于如下情况,环境传感器数据,丢失一次读记录无所谓,因为不久后还会有第二次发送。
  • “至少一次”,确保消息到达,但消息重复可能会发生。
  • “只有一次”,确保消息到达一次。这一级别可用于如下情况,在计费系统中,消息重复或丢失会导致不正确的结果。

5. 小型传输,开销很小(固定长度的头部是 2 字节),协议交换最小化,以降低网络流量;

6. 使用 Last Will 和 Testament 特性通知有关各方客户端异常中断的机制;

好了废话不多说,直接上干货

双向认证方法:让后台生成 ca.crt 和 client.p12文件(client.p12文件由client.crt和client.key合成)
单项认证方法:让后台生成 ca.crt

1.使用命令行把crt转化为der格式

openssl x509 -in ca.crt -out ca.der -outform der

2.建立连接

if (!self.manager) {
        MQTTSSLSecurityPolicyTransport *transport = [[MQTTSSLSecurityPolicyTransport alloc]init];
        transport.host = @"xxxx.com";
        transport.port = 8883;
        transport.tls = YES;
        NSString*  ca = [[NSBundle bundleForClass:[MQTTSession class]] pathForResource:@"ca" ofType:@"der"];
        ////TODO:双向认证需加入client证书
    //        NSString*  client = [[NSBundle bundleForClass:[MQTTSession class]] pathForResource:@"certificate" ofType:@"p12"];
    //        transport.certificates = [MQTTSSLSecurityPolicyTransport clientCertsFromP12:client passphrase:@"password"];
        MQTTSSLSecurityPolicy *securityPolicy = [MQTTSSLSecurityPolicy policyWithPinningMode:MQTTSSLPinningModeCertificate];
        securityPolicy.allowInvalidCertificates = YES;
        securityPolicy.validatesDomainName = NO;
        securityPolicy.validatesCertificateChain = NO;
        securityPolicy.pinnedCertificates = @[[NSData dataWithContentsOfFile:ca]];
        transport.securityPolicy = securityPolicy;
        
        self.manager = [[MQTTSessionManager alloc] init];
        self.manager.delegate = self;
        ////不使用证书
    //        [self.manager connectTo:@"xxxxx.com"
    //                           port:1883
    //                            tls:NO
    //                      keepalive:60  //心跳间隔不得大于120s
    //                          clean:true
    //                           auth:true
    //                           user:@"username"
    //                           pass:@"password"
    //                           will:false
    //                      willTopic:nil
    //                        willMsg:nil
    //                        willQos:0
    //                 willRetainFlag:FALSE
    //                   withClientId:@"xxxxxxxxxxxxx"];
        ////使用证书(这里采用单项认证,双向认证只需把certificates:参数设置为transport.certificates即可)
        [self.manager connectTo:@"xxxxx.com"
                           port:8883
                            tls:YES
                      keepalive:60
                          clean:true
                           auth:YES
                           user:@"username"
                           pass:@"password"
                           will:false
                      willTopic:nil
                        willMsg:nil
                        willQos:0
                 willRetainFlag:FALSE
                   withClientId:@"xxxxxxxxx"
                 securityPolicy:securityPolicy
                   certificates:nil];
    } else {
        [self.manager connectToLast];
    }
    /*
      MQTTCLient: observe the MQTTSessionManager's state to display the connection status
     */
    
    [self.manager addObserver:self
                   forKeyPath:@"state"
                      options:NSKeyValueObservingOptionInitial | NSKeyValueObservingOptionNew
                      context:nil];

参数解释:

  • host 主机
  • ip 端口
  • tls 是否使用ssl/tls认证
  • keepalive 心跳是一个时间间隔,客户端有规律地向代理服务器发送PING Request消息。服务器用PING Response消息进行响应,这种机制可以使双方据此判定对方是否还活着以及能否到达。
  • clean clean标志位向代理服务器表明客户端是否要建立持续的会话。持续的会话(CleanSession设置为false)意思是代理将存储所有服务质量 (QoS) 为1或2的客户端的订阅信息以及所有错过的消息。如果clean设置为true,则代理将不会存储客户端的任何信息,并将清除之前持续会话的所有信息。
  • auth MQTT允许发送用户名和密码以便验证客户端的身份和进行授权。
  • user 如果auth为yes 需要填用户名
  • pass 如果auth为yes 需要填密码
  • will 是否设遗嘱 是的话需要填写willTopic和willMsg 遗嘱消息是MQTT遗嘱特征的组成部分。当某个客户端恶意断开连接时,遗嘱消息将通知其他客户端。一个连接着的客户端将在CONNECT消息中以MQTT消息和主题的形式提供其遗嘱。如果客户端恶意断开了连接,代理将发送此消息来代表客户端。
  • willTopic 遗嘱的topic
  • willMsg 遗嘱消息 nsdate类型。
  • willQos 服务质量(QoS) 等级。
  • willRetainFlag 会话表示标志表示,代理和客户端之间自从前面的交互以来是否是持久会话。值为0,服务器必须在客户端断开之后继续存储/保持客户端的订阅状态。这些状态包括: 存储订阅的消息QoS1和QoS2消息 正在发送消息期间连接丢失导致发送失败的消息 以便当客户端重新连接时以上消息可以被重新传递。 值为1,服务器需要立刻清理连接状态数据。 (tips:断线重连时 如果为yes,会自动订阅回消息,如果为no,则要手动订阅topic,不然会收不到消息)。
  • clientId 客户端标识符(不能固定,每个用户需要不同的clientId,相同的会导致掉线),是每个连接到MQTT代理服务器的MQTT客户端的编号。单词identifier本身已经表明,ClientID应当是唯一的。代理服务器使用它来识别客户端以及当前的客户端状态。如果你不想让代理获得当前状态,那么在MQTT3.1.1(当前的标准)中也可以发送一个空的ClientID,这样的话,连接就不会附带任何状态。前提条件是clean为true,否则,连接会被拒绝。

3.服务器返回数据

状态信息:

- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
    switch (self.manager.state) {
        case MQTTSessionManagerStateClosed:
            NSLog(@"MQTTSessionManagerStateClosed");
            break;
        case MQTTSessionManagerStateClosing:
            NSLog(@"MQTTSessionManagerStateClosing");
            break;
        case MQTTSessionManagerStateConnected:
            NSLog(@"MQTTSessionManagerStateConnected");
            //连接成功订阅
            for (int i=0; i<3; i++) {
                [self.manager subscribeToTopic:[NSString stringWithFormat:@"%d%d%d%d%d%d%d%d",i,i,i,i,i,i,i,i] atLevel:1];
            }
            break;
        case MQTTSessionManagerStateConnecting:
            NSLog(@"MQTTSessionManagerStateConnecting");
            break;
        case MQTTSessionManagerStateError:
            NSLog(@"MQTTSessionManagerStateError");
            break;
        case MQTTSessionManagerStateStarting:
            NSLog(@"MQTTSessionManagerStateStarting");
        default:
            NSLog(@"default");
            break;
    }
}

数据信息:

- (void)handleMessage:(NSData *)data onTopic:(NSString *)topic retained:(BOOL)retained {
    NSLog(@"------------->>%@",topic);
    
    NSString *dataString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
    NSLog(@"%@",dataString);
    
}

4.连接(断开后的再次连接):

- (IBAction)connect:(id)sender {
    [self.manager connectToLast];
}

5.订阅

- (IBAction)sub:(id)sender {
    [self.manager subscribeToTopic:@"55555555555555555" atLevel:1];
}

6.取消订阅

- (IBAction)unsub:(id)sender {
    [self.manager unsubscribeTopic:@"55555555555555555"];
}

7.断开连接

- (IBAction)disconnect:(id)sender {
[self.manager disconnect];

说明:MQTTSessionManager是没有subscribeToTopic:atLevel:和unsubscribeTopic:方法的,只有subscriptions。为了更灵活使用,所以需要自己添加

1. 在.h中添加:

//订阅
- (void)subscribeToTopic:(NSString *)topic
             atLevel:(MQTTQosLevel)qosLevel;
//取消订阅
- (void)unsubscribeTopic:(NSString *)topic;

2. 在.m中添加

//订阅
- (void)subscribeToTopic:(NSString *)topic
                 atLevel:(MQTTQosLevel)qosLevel
{
    if (self.state == MQTTSessionManagerStateConnected) {
        [self.session subscribeToTopic:topic atLevel:1 subscribeHandler:^(NSError *error, NSArray<NSNumber *> *gQoss) {
            if (!error) {
                
            }else{
                
            }
        }];
    }
}

//取消订阅
- (void)unsubscribeTopic:(NSString *)topic
{
    if (self.state == MQTTSessionManagerStateConnected) {
        [self.session unsubscribeTopic:topic unsubscribeHandler:^(NSError *error) {
            if (!error) {
                
            }else{
                
            }
        }];
    }
}

项目地址

https://github.com/wangbaolei/Mqtt-Client.git

 

推荐阅读