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事件循环，但您处理消息所做的任何工作都会阻止客户端能够回复任何心跳等。

安装

nsqphp可以通过composer添加到您的项目中。只需将以下内容添加到您的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中一个）

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客户端提供了两种在订阅时去重消息的机制。两者都是基于相反的Bloom过滤器。一个是维护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实例的多个连接