library laravel-queue-cmq

freyo/laravel-queue-cmq

Queue Adapter for Tencent Qcloud CMQ SDK

Installation

shell composer require freyo/laravel-queue-cmq, _(*5)

Configure

Laravel 5.5+ uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider., _(*6)

1. config/app.php:, _(*7)

   'providers' => [
   // ...
   Freyo\LaravelQueueCMQ\LaravelQueueCMQServiceProvider::class,
   ]
   

2. .env:, _(*8)

   QUEUE_DRIVER=cmq
   
   CMQ_SECRET_KEY=
   CMQ_SECRET_ID=
   
   CMQ_QUEUE_HOST=https://cmq-queue-{region}.api.qcloud.com
   CMQ_QUEUE=queue_name #default queue name
   CMQ_QUEUE_POLLING_WAIT_SECONDS=0
   
   CMQ_TOPIC_ENABLE=false # set to true to use topic
   CMQ_TOPIC_FILTER=routing # or msgtag
   CMQ_TOPIC_HOST=https://cmq-topic-{region}.api.qcloud.com
   CMQ_TOPIC=topic_name
   

Tips

• Region should be replaced with a specific region: gz (Guangzhou), sh (Shanghai), or bj (Beijing)., _(*9)

• Domain for public network API request: cmq-queue-region.api.qcloud.com / cmq-topic-region.api.qcloud.com, _(*10)

• Domain for private network API request: cmq-queue-region.api.tencentyun.com / cmq-topic-region.api.tencentyun.com, _(*11)

Usage

Once you completed the configuration you can use Laravel Queue API. If you used other queue drivers you do not need to change anything else. If you do not know how to use Queue API, please refer to the official Laravel documentation: http://laravel.com/docs/queues, _(*12)

Example

Dispatch Jobs

The default connection name is cmq, _(*13)

```php //use queue only Job::dispatch()->onConnection('connection-name')->onQueue('queue-name'); // or dispatch((new Job())->onConnection('connection-name')->onQueue('queue-name')), <sub>(*14)</sub>

//use topic and tag filter Job::dispatch()->onConnection('connection-name')->onQueue('tag1,tag2,tag3'); // or dispatch((new Job())->onConnection('connection-name')->onQueue('tag1,tag2,tag3')), <sub>(*15)</sub>

//use topic and routing filter Job::dispatch()->onConnection('connection-name')->onQueue('routing-key'); // or dispatch((new Job())->onConnection('connection-name')->onQueue('routing-key')) ```, <sub>(*16)</sub>

Multiple Queues

Configure config/queue.php, <sub>(*17)</sub>

'connections' => [
    //...
    'new-connection-name' => [
        'driver' => 'cmq',
        'secret_key' => 'your-secret-key',
        'secret_id'  => 'your-secret-id',
        'queue' => 'your-queue-name',
        'options' => [
            'queue' => [
                'host'                 => 'https://cmq-queue-region.api.qcloud.com',
                'name'                 => 'your-queue-name',
                'polling_wait_seconds' => 0, // 0-30 seconds
                'retries'              => 3,
            ],
            'topic' => [
                'enable'  => false,
                'filter'  => 'routing', // routing or msgtag
                'host'    => 'https://cmq-topic-region.api.qcloud.com',
                'name'    => 'your-topic-name',
                'retries' => 3,
            ],
        ],
        'plain' => [
            'enable' => false,
            'job' => 'App\Jobs\CMQPlainJob@handle',
        ],
    ];
    //...
];

Process Jobs

php artisan queue:work {connection-name} --queue={queue-name}

Plain Mode

Configure .env, <sub>(*18)</sub>

CMQ_PLAIN_ENABLE=true
CMQ_PLAIN_JOB=App\Jobs\CMQPlainJobHandler@handle

Create a job implements PlainPayload interface. The method getPayload must return a sting value., <sub>(*19)</sub>

<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Freyo\LaravelQueueCMQ\Queue\Contracts\PlainPayload;

class CMQPlainJob implements ShouldQueue, PlainPayload
{
    use Dispatchable, InteractsWithQueue, Queueable;

    protected $payload;

    /**
     * Create a new job instance.
     *
     * @return void
     */
    public function __construct($payload)
    {
        $this->payload = $payload;
    }

    /**
     * Get the plain payload of the job.
     *
     * @return string
     */
    public function getPayload()
    {
        return $this->payload;
    }
}

Create a plain job handler, <sub>(*20)</sub>

<?php

namespace App\Jobs;

use Illuminate\Queue\Jobs\Job;

class CMQPlainJobHandler
{
    /**
     * Execute the job.
     * 
     * @param \Illuminate\Queue\Jobs\Job $job
     * @param string $payload
     * 
     * @return void
     */
    public function handle(Job $job, $payload)
    {
        // processing your payload...
        var_dump($payload);

        // release back to the queue manually when failed.
        // $job->release();

        // delete message when processed.
        if (! $job->isDeletedOrReleased()) {
            $job->delete();
        }        
    }
}

References

• Product Documentation

License

The MIT License (MIT). Please see License File for more information., <sub>(*21)</sub>

, <sub>(*22)</sub>