aiviaio/nats

PHP的nats.io客户端

0.8.8 2022-02-02 09:24 UTC

README

Travis

覆盖率

简介

PHP的NATS消息系统的客户端NATS

要求

用法

安装

首先,让我们将composer下载到我们的项目目录中

curl -O https://getcomposer.org.cn/composer.phar
chmod +x composer.phar

现在让我们让composer了解我们的项目依赖关系,在这个例子中,PHPNats。我们这样做的方式是创建一个composer.json文件,并将其放置在我们的项目的根目录中,紧挨着composer.phar

{
  "require": {
    "aiviaio/nats": "latest"
  }
}

让Composer施展其魔法

php composer.phar install

Composer将下载composer.json中定义的所有依赖项,并准备所有需要自动加载的文件。

基本用法

$client = new \Nats\Connection();
$client->connect();

// Publish Subscribe

// Simple Subscriber.
$client->subscribe(
    'foo',
    function ($message) {
        printf("Data: %s\r\n", $message->getBody());
    }
);

// Simple Publisher.
$client->publish('foo', 'Marty McFly');

// Wait for 1 message.
$client->wait(1);

// Request Response

// Responding to requests.
$sid = $client->subscribe(
    'sayhello',
    function ($message) {
        $message->reply('Reply: Hello, '.$message->getBody().' !!!');
    }
);

// Request.
$client->request(
    'sayhello',
    'Marty McFly',
    function ($message) {
        echo $message->getBody();
    }
);

编码连接

$encoder = new \Nats\Encoders\JSONEncoder();
$options = new \Nats\ConnectionOptions();
$client = new \Nats\EncodedConnection($options, $encoder);
$client->connect();

// Publish Subscribe

// Simple Subscriber.
$client->subscribe(
    'foo',
    function ($payload) {
        printf("Data: %s\r\n", $payload->getBody()[1]);
    }
);

// Simple Publisher.
$client->publish(
    'foo',
    [
     'Marty',
     'McFly',
    ]
);

// Wait for 1 message.
$client->wait(1);

// Request Response

// Responding to requests.
$sid = $client->subscribe(
    'sayhello',
    function ($message) {
        $message->reply('Reply: Hello, '.$message->getBody()[1].' !!!');
    }
);

// Request.
$client->request(
    'sayhello',
    [
     'Marty',
     'McFly',
    ],
    function ($message) {
        echo $message->getBody();
    }
);

开发者信息

版本发布

测试

测试位于tests文件夹中。要运行它们,您需要PHPUnit并执行make test-tdd

我们还在spec文件夹下有一个BDD测试套件。要运行该套件,您需要PHPSpec并执行make test-bdd

您还可以通过make test执行所有套件(TDD + BDD)。

代码质量

我们使用PHP Code Sniffer来确保我们的代码遵循高标准。

要执行代码分析,请执行make lint

在代码检查时,目前有三个步骤

  • 首先使用php本身进行代码检查php -l
  • 然后使用PSR2标准进行代码检查
  • 最后使用自定义的ruleset.xml进行代码检查,该文件检查文档块和不同的性能提示。

创建者

Raül Pérez

许可证

MIT,请参阅LICENSE