README

一个支持自定义格式JSON有效负载的Laravel（或Lumen）SQS连接器。默认情况下，Laravel期望SQS消息以特定格式生成，包括作业处理类和序列化的作业。

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

依赖项

PHP >= 8.0
Laravel（或Lumen）>= 8.0

通过Composer安装

要安装，只需运行

composer require dusterio/laravel-plain-sqs

或者手动添加到composer.json

{
    "require": {
        "tyamahori/laravel-plain-sqs": "^1.0"
    }
}

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());
    }
}

待办事项

添加更多单元和集成测试

视频教程

我刚刚开始了一个教育YouTube频道，该频道将涵盖软件开发和DevOps的前沿IT趋势：config.sys

许可证

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

tyamahori / laravel-plain-sqs

维护者

详情