README

为 Laravel（或 Lumen）提供支持自定义格式 JSON 负载数据的 SQS 连接器。默认情况下，Laravel 预期 SQS 消息是以特定格式生成的 - 包含作业处理器类和序列化作业的格式。

但在某些情况下，您可能需要解析来自第三方应用程序、自定义 JSON 消息等情况的消息。

依赖项

PHP >= 5.5
Laravel（或 Lumen）>= 5.2

通过 Composer 安装

要安装，只需运行

composer require dusterio/laravel-plain-sqs

或者手动将其添加到 composer.json

{
    "require": {
        "dusterio/laravel-plain-sqs": "~0.1"
    }
}

Laravel 5 中的使用

// Add in your config/app.php

'providers' => [
    '...',
    'Dusterio\PlainSqs\Integrations\LaravelServiceProvider',
];

Lumen 5 中的使用

// Add in your bootstrap/app.php
$app->loadComponent('queue', 'Dusterio\PlainSqs\Integrations\LumenServiceProvider');

配置

// Generate standard config file (Laravel only)
php artisan vendor:publish

// In Lumen, create it manually (see example below) and load it in bootstrap/app.php
$app->configure('sqs-plain');

编辑 config/sqs-plain.php 以满足您的需求。此配置将 SQS 队列与处理器类匹配。

return [
    'handlers' => [
        'base-integrations-updates' => App\Jobs\HandlerJob::class,
    ],

    'default-handler' => App\Jobs\HandlerJob::class
];

如果队列未在 'handlers' 数组中找到，则将 SQS 负载数据传递给默认处理器。

将 sqs-plain 连接添加到您的 config/queue.php 中，例如

        ...
        'sqs-plain' => [
            'driver' => 'sqs-plain',
            'key'    => env('AWS_KEY', ''),
            'secret' => env('AWS_SECRET', ''),
            'prefix' => 'https://sqs.ap-southeast-2.amazonaws.com/123123/',
            'queue'  => 'important-music-updates',
            'region' => 'ap-southeast-2',
        ],
        ...

在您的 .env 文件中，选择 sqs-plain 作为您的新默认队列驱动程序

QUEUE_DRIVER=sqs-plain

向 SQS 发送消息

如果您计划从 Laravel 或 Lumen 推送普通消息，则可以依赖 DispatcherJob

use Dusterio\PlainSqs\Jobs\DispatcherJob;

class ExampleController extends Controller
{
    public function index()
    {
        // Create a PHP object
        $object = [
            'music' => 'M.I.A. - Bad girls',
            'time' => time()
        ];

        // Pass it to dispatcher job
        $job = new DispatcherJob($object);

        // Dispatch the job as you normally would
        // By default, your data will be encapsulated in 'data' and 'job' field will be added
        $this->dispatch($job);

        // If you wish to submit a true plain JSON, add setPlain()
        $this->dispatch($job->setPlain());
    }
}

这将向 SQS 推送以下 JSON 对象

{"job":"App\\Jobs\\HandlerJob@handle","data":{"music":"M.I.A. - Bad girls","time":1462511642}}

'job' 字段实际上未使用。它仅保留以保持兼容性。

从 SQS 接收消息

如果第三方应用程序正在创建自定义格式的 JSON 消息，只需在配置文件中添加处理器，并按以下方式实现处理器类

use Illuminate\Contracts\Queue\Job as LaravelJob;

class HandlerJob extends Job
{
    protected $data;

    /**
     * @param LaravelJob $job
     * @param array $data
     */
    public function handle(LaravelJob $job, array $data)
    {
        // This is incoming JSON payload, already decoded to an array
        var_dump($data);

        // Raw JSON payload from SQS, if necessary
        var_dump($job->getRawBody());
    }
}

待办事项

添加更多单元和集成测试

许可证

在此条件下，任何人有权免费获得本软件及其相关文档副本（“软件”），在不受限制的情况下处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许向软件提供的人这样做，前提是

najamhaq / laravel-plain-sqs

维护者

详细信息