README

PHP客户端，用于NSQ。

NSQ基础知识

您可以在GitHub上的readme或通过Bitly博客文章了解有关NSQ的所有信息。项目中的每个文件夹内都提供了关于nsqd、nsqlookupd的更多详细信息。

我所学到的知识

• 集群仅提供在nsqlookupd发现特定主题的消息宿主机的意义上。要从集群中消费，您只需询问一个nslookupd实例消息在哪里，然后连接到它告诉您的每个nsqd（这是nsq好的一面之一）。
• 由于每个nsqd实例都是隔离的，因此HA（对于发布）很容易实现；您可以简单地连接到任何一个并发布消息（我已经将其构建到客户端中）。
• 通过简单地写入多个nsqd并在订阅时去重，提供了弹性（我已经将其构建到客户端中）。
• nsq不是作为工作队列（用于长时间运行的任务）设计的。默认的msg-timeout设置为60,000ms（60秒）。这是nsq自动将消息视为失败并重新入队之前的时间。我们的“工作”应该比这少得多。此外，PHP是一种阻塞语言，尽管我们正在使用非阻塞IO事件循环，但您处理消息的工作将阻止客户端回复任何心跳等。

安装

您可以通过composer将nsqphp添加到项目中。只需将以下内容添加到您的composer.json中。

{
    ...
    "require": {
        ...
        "davegardnerisme/nsqphp": "dev-master"
    }
    ...
}

您也可以简单地将其克隆到项目中

git clone git://github.com/davegardnerisme/nsqphp.git
cd nsqphp
git submodule update --init --recursive

要在项目中使用nsqphp，只需包含bootstrap.php文件，或通过composer设置自动加载。设计适用于依赖注入容器（所有依赖项都是构造函数注入），尽管您可以在使用时手动设置依赖项。

尝试使用它

按照入门指南在本地主机上安装nsq。

发布一些事件

php cruft/test-pub.php 10

在一个shell中启动一个订阅者

php cruft/test-sub.php mychannel > /tmp/processed-messages

然后在另一个shell中跟踪重定向的STDOUT，这样您就可以看到接收和处理的消息

tail -f /tmp/processed-messages

注意

在这些测试中，我先发布，因为我还没有让客户端自动重新发现给定主题的消息宿主机节点；因此，如果您先订阅，则找不到具有该主题消息的节点。

其他测试

多个通道

博客文章描述了一个通道

| 每个通道都接收主题的所有消息的副本。在实践中，通道映射到消费主题的下游服务。

因此，主题中的每条消息都将发送到每个channel。

在两个shell中启动具有不同通道的两个订阅者（每个shell中一个）

php cruft/test-sub.php mychannel
php cruft/test-sub.php otherchannel

发布一些消息

php cruft/test-pub.php 10

每条消息都将发送到每个通道。还值得注意的是，API允许您在同一个进程中订阅多个主题/通道。

多个nsqds

配置多个运行 nsqd 和 nsqlookupd 的服务器，主机名为 nsq1、nsq2 ... 然后，向它们发布一批消息。

php cruft/test-pub.php 10 nsq1
php cruft/test-pub.php 10 nsq2

现在进行订阅

php cruft/test-sub.php mychannel > /tmp/processed-messages

您将收到 20 条消息。

弹性投递

与之前的测试相同，但这次我们将相同的消息投递到两个 nsqd 实例，然后在订阅时去重。

php cruft/test-pub.php 10 nsq1,nsq2
php cruft/test-sub.php mychannel > /tmp/processed-messages

这次您应该只收到 10 条消息。

待办事项

• 使用退避策略重新队列失败的消息（目前仅支持简单的固定延迟重新队列策略）
• 持续评估哪些节点包含特定主题的消息（即订阅的主题），并为这些客户端建立新连接（通过事件循环计时器）

PHP 客户端接口

消息

消息由 nsqphp\Message\Message 类封装，并在代码中通过接口引用（因此您可以自行实现）。

接口

public function getPayload();
public function getId();
public function getAttempts();
public function getTimestamp();

发布

客户端支持向 N 个 nsqd 服务器发布消息，这些服务器必须通过主机名显式指定。与订阅不同，没有通过 nslookupd 查找主机名的功能（我们可能也不希望这样做以提高速度）。

最小化方法

    $nsq = new nsqphp\nsqphp;
    $nsq->publishTo('localhost')
        ->publish('mytopic', new nsqphp\Message\Message('some message payload'));

您需要自行决定如何编码您的有效负载（例如：JSON）。

高可用性发布

    $nsq = new nsqphp\nsqphp;
    $nsq->publishTo(array('nsq1', 'nsq2', 'nsq3'), nsqphp\nsqphp::PUB_QUORUM)
        ->publish('mytopic', new nsqphp\Message\Message('some message payload'));

我们将需要 publishTo nsqd 守护进程的多数派响应来认为此操作成功（目前这是顺序发生的）。这是假设我在三个主机上运行了 3 个 nsqd，这些主机可以通过 nsq1 等方式访问。

这种技术将记录消息两次，这将需要在订阅时进行去重。

订阅

客户端支持从 N 个 nsqd 服务器订阅，每个服务器将自动从一个或多个 nslookupd 服务器发现。这是通过 nslookupd 能够提供自动发现节点的列表来实现的，这些节点托管着特定主题的消息。此功能解耦了我们的客户端，使其不必知道消息在哪里。

因此，在订阅时，我们首先需要初始化我们的查找服务对象

    $lookup = new nsqphp\Lookup\Nsqlookupd;

或者，也可以

    $lookup = new nsqphp\Lookup\Nsqlookupd('nsq1,nsq2');

然后我们可以使用这个来订阅

    $lookup = new nsqphp\Lookup\Nsqlookupd;
    $nsq = new nsqphp\nsqphp($lookup);
    $nsq->subscribe('mytopic', 'somechannel', function($msg) {
        echo $msg->getId() . "\n";
        })->run();

警告：如果我们的回调抛出任何异常，则不会使用这些设置重试消息 - 继续阅读以了解更多信息。

或者更符合 PHP 的风格

    $lookup = new nsqphp\Lookup\Nsqlookupd;
    $nsq = new nsqphp\nsqphp($lookup);
    $nsq->subscribe('mytopic', 'somechannel', 'msgCallback')
        ->run();

    function msgCallback($msg)
    {
        echo $msg->getId() . "\n";
    }

我们还可以订阅多个频道/流

    $lookup = new nsqphp\Lookup\Nsqlookup;
    $nsq = new nsqphp\nsqphp($lookup);
    $nsq->subscribe('mytopic', 'somechannel', 'msgCallback')
        ->subscribe('othertopic', 'somechannel', 'msgCallback')
        ->run();

重试失败的消息

PHP 客户端会捕获回调中抛出的任何异常，然后要么（a）重试，要么（b）丢弃消息。通常您不希望丢弃消息。

为了解决这个问题，我们需要一个 重新队列策略 - 这是以实现 nsqphp\RequeueStrategy\RequeueStrategyInterface 的任何对象的形式。

    public function shouldRequeue(MessageInterface $msg);

客户端目前提供了一个；固定延迟策略

    $requeueStrategy = new nsqphp\RequeueStrategy\FixedDelay;
    $lookup = new nsqphp\Lookup\Nsqlookupd;
    $nsq = new nsqphp\nsqphp($lookup, NULL, $requeueStrategy);
    $nsq->subscribe('mytopic', 'somechannel', 'msgCallback')
        ->run();

    function msgCallback($msg)
    {
        if (rand(1,3) == 1) {
            throw new \Exception('Argh, something bad happened');
        }
        echo $msg->getId() . "\n";
    }

订阅时去重

回想一下，为了实现高可用性，我们简单地在不同 nsqd 服务器上发布重复的消息。为了执行去重，我们只需要提供一个实现 nsqphp\Dedupe\DedupeInterface 的对象。

public function containsAndAdd($topic, $channel, MessageInterface $msg);

PHP 客户端提供了两种在订阅时去重消息的机制。两者都基于 与布隆过滤器相反的技术。一个维护着 PHP 数组作为哈希表（因此绑定到单个进程）；另一个调用 Memcached，因此可以在许多进程之间共享数据结构。

我们可以这样使用

    $requeueStrategy = new nsqphp\RequeueStrategy\FixedDelay;
    $dedupe = new nsqphp\Dedupe\OppositeOfBloomFilterMemcached;
    $lookup = new nsqphp\Lookup\Nsqlookupd;
    $nsq = new nsqphp\nsqphp($lookup, $dedupe, $requeueStrategy);
    $nsq->subscribe('mytopic', 'somechannel', 'msgCallback')
        ->run();

    function msgCallback($msg)
    {
        if (rand(1,3) == 1) {
            throw new \Exception('Argh, something bad happened');
        }
        echo $msg->getId() . "\n";
    }

您可以在我的博客上了解更多关于去重的内容 ，但是请注意以下几点

• 使用Memcached去重功能后，我们可以愉快地启动N个进程来订阅相同的主题和通道，并且只需处理一次消息。
• 去重不能保证（事实上远非如此）——所提供的实现基于一个损耗性哈希表，因此在性能上具有概率性。对于在相似时间内输入的事件，它们通常可以接受（并且可以通过权衡内存使用和去重能力进行调整）
• nsq的设计理念是基于幂等订阅者——例如：您的订阅者必须能够处理重复的消息（写入Cassandra是一个能够很好地处理执行两次的系统示例）。

日志记录

最后的可选依赖项是一个日志记录器，它以实现nsqphp\Logger\LoggerInterface的对象形式存在（据我所知，PHP没有提供标准日志接口）

    public function error($msg);
    public function warn($msg);
    public function info($msg);
    public function debug($msg);

PHP客户端包含一个将所有日志信息转储到STDERR的日志记录器。将这些内容综合起来，我们就会得到类似于test-sub.php文件的内容

    $requeueStrategy = new nsqphp\RequeueStrategy\FixedDelay;
    $dedupe = new nsqphp\Dedupe\OppositeOfBloomFilterMemcached;
    $lookup = new nsqphp\Lookup\Nsqlookupd;
    $logger = new nsqphp\Logger\Stderr;
    $nsq = new nsqphp\nsqphp($lookup, $dedupe, $requeueStrategy, logger);
    $nsq->subscribe('mytopic', 'somechannel', 'msgCallback')
        ->run();

    function msgCallback($msg)
    {
        if (rand(1,3) == 1) {
            throw new \Exception('Argh, something bad happened');
        }
        echo $msg->getId() . "\n";
    }

设计日志

• 基于事件循环（由React PHP提供动力）的主要客户端，使我们能够处理对多个nsqd实例的多个连接