数据库 - ORM 前置说明临时连接数据库 table name test cache alias where whereOr whereIn whereNotIn field limit page order having group join select find value delete update insert setInc setDec count max min avg sum 执行原生SQL 子查询构造器调试SQL 时间查询事务分页

数据库 - Model 前置说明

Elasticsearch-ORM ES服务端自建教程使用前说明节点配置 config retry table id field limit page order where createTable deleteTable getTable aliasTable updateField insert insertAll update delete get value select count max min avg sum aggs 调试执行原生JSON 使用案例

Redis - 连接池使用前说明 prefix select 语法支持

UML 什么是UML 使用说明对象建模查询优先级 id field limit page order geo where like insert insertAll update delete select find value count max min avg sum setInc setDec getError getWriteBack deleteWriteBack 数据回写使用案例

客户端 HTTP

MongoDb 前置说明 table name where whereIn whereNotIn whereTime limit page order field fieldOn group find select insert insertAll update delete setInc setDec count sum avg min max distinct command aggregate geo 更多命令

Rpc 说明组件跨语言封装

RabbitMQ 说明使用

其他组件 session cookie lang container Swoole/Atomic 计数器

Swoole/Table 内存表前置说明初始化创建表操作

字符串时间日期订单号短网址文字识别分布式ID 枚举类缓存敏感词检测金额处理地理位置 Jwt Csrf 压缩/解压图片处理类型判断数组 Excel

官方扩展库身份证归属地解析国内车牌号码归属地解析国内手机号归属地解析国内银行卡归属行解析经纬度反解析出省市区乡镇微信开发

官方开源项目抓取代理IP

杂项内置函数系统常量框架执行流程二次开发Swoole事件关于调试模式关于内存溢出捐赠 SW-X团队架构图

介绍

MQTT服务端的控制器，主要用于代替消息事件中，分离业务逻辑的相关代码。

由于某些物联网项目，不单止用于客户端间通讯，更多需要用到服务端的业务查询、判断、主动推流等，所以在消息事件中对某个流程的代码分离，是非常重要的，便于日后的代码维护、版本迭代。

使用规范

MQTT的控制器文件，统一存放在/app/mqtt/目录下，需要继承\x\controller\Mqtt系统类。命名方式不强制大小写，但建议遵守以为标准：

类名称与类文件命名，均为大驼峰，变量与类方法为小驼峰。
(文件夹)，均为小写。

控制器挂载

框架不会自动载入MQTT服务的控制器，需要开发者在消息事件中手动挂载，具体可以参考：挂载业务控制器说明。

获取Server实例

在MQTT的控制器中，可以使用$this->getServer()方法，获取当前Swoole-Server的Class实例。
该方法的返回值是一个对象。

获取当前连接FD标识符

在MQTT的控制器中，可以使用$this->getFd()方法，获取当前连接设备的Swoole-fd的连接标识符。
该方法的返回值是一个int类型的标识符。

获取当前连接线程ID

在MQTT的控制器中，可以使用$this->getReactorId()方法，获取当前连接设备所处Swoole的线程ID。
该方法的返回值是一个int类型的线程ID。

获取当前连接的请求内容

在MQTT的控制器中，可以使用$this->getData()方法，获取当前连接所发布的消息内容。
该方法的返回值是一个多维数组。

搜索主题下的全部设备号

在MQTT的控制器中，可以使用$this->select(订阅主题名称)方法，搜索某个主题下的全部设备号。
该方法的返回值是一个多维数组。若无结果，返回一个空数组。
结果格式如下：

[
    [
        fd => 连接标识符
        client_id => 客户端设备号
        topic => 订阅主题
        qos => QOS
    ]
]

订阅主题名称支持MQTT通配符的使用。

指定设备号查询

在MQTT的控制器中，可以使用$this->find(设备号)方法，搜索某个设备号的当前详情。
该方法的返回值是一个多维数组。若无结果，返回一个空数组。
结果格式如下：

[
    fd => 连接标识符
    level => 协议版本 3|5
    status => 在线状态  1.在线  2.离线
    client_id => 客户端设备号
    ping_time => 最近一次心跳检测时间戳
    list => [
        [
            topic => 订阅主题名称
            qos => QOS
        ]
    ]
]

读取当前连接的详情

在MQTT的控制器中，可以使用$this->info()方法，读取当前连接的设备详情。
该方法的返回值是一个多维数组。若无结果，返回一个空数组。
结果格式如下：

[
    fd => 连接标识符
    level => 协议版本 3|5
    status => 在线状态  1.在线  2.离线
    client_id => 客户端设备号
    ping_time => 最近一次心跳检测时间戳
    list => [
        [
            topic => 订阅主题名称
            qos => QOS
        ]
    ]
]

给某个连接设备推流

在MQTT的控制器中，可以使用$this->send(FD标识符, 推送内容)方法，对某个客户端设备进行消息推送。
该方法的返回值是一个Bool值。

注意：参数2，推送内容是一个多维数组，其中type参数，必须读取\x\mqtt\common\Tyeps消息事件类中的标识符，否则消息将可能发送失败。

具体的使用案例，参考如下：

namespace app\mqtt\system;
use x\controller\Mqtt;
// 引入MQTT消息标识符类
use x\mqtt\common\Tyeps;

class index extends Mqtt {
    
    public function run() {
        $data = $this->getData();
        // 给当前请求推送一条消息回去
        $this->send($this->getFd(), [
                'type' => Types::PUBLISH,
                'topic' => $data['topic'],
                'message' => $data['message'],
                'dup' => $data['dup'],
                'qos' => $data['qos'],
                'retain' => $data['retain'],
                'message_id' => $data['message_id'] ?? '',
            ]
        );
    }
}

注意：在Types::PUBLISH中，message字段为客户端接受到的消息内容主体。

获取协议版本信息

v2.5.6版本起支持，在MQTT的控制器中，可以使用$this->getLevel()方法，获取当前连接对应的协议版本信息。
该方法的返回值是一个多维数组，结构如下：

[
    'level' => 5, // 协议版本号
    'class' => '\x\mqtt\v3\Dc', // 数据包处理类的命名空间地址
]

SW-X

企业级 - 高性能 PHP 框架

最后更新：3年前 . 作者-小黄牛

本篇目录

介绍