README

PHP 客户端用于 NSQ。

NSQ 基础知识

您可以通过 Github 上的说明或通过 Bitly 博文了解 NSQ 的更多细节。项目中的每个文件夹内都提供了关于 nsqd、nsqlookupd 的更多详细信息。

我所学到的

集群功能仅限于 nsqlookupd 可以发现特定主题的消息宿主机器。要从集群中消费，只需询问一个 nslookupd 实例消息在哪里，然后连接到它告诉您的每个 nsqd（这是 nsq 优点之一）。
由于每个 nsqd 实例都是隔离的，因此发布高可用性（HA）很容易；您只需连接到任意一个并发送消息即可（我已经将其集成到客户端中）。
通过简单地写入多个 nsqd 并在订阅时去重，提供了弹性；我已经将其集成到客户端中。
nsq 并非默认设计为 工作队列（用于长时间运行的任务）。默认的 msg-timeout 设置为 60,000 毫秒（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

注意

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

其他测试

多个通道

博客文章描述了通道

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

因此，每个 topic 中的每条消息都将发送到每个 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客户端提供了两种在订阅时去重消息的机制。两者都基于与布隆过滤器相反的技术。一个维护一个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 实例的连接。

king / nsqphp

维护者

详情