chenzi/laravel-mns-driver

Aliyun MNS Queue Driver For Laravel

Aliyun MNS Queue Driver For Laravel

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

Install

Via Composer, _(*2)

``` bash $ composer require chenzi/laravel-mns-driver, <sub>(*3)</sub>

## Config

Add following service providers into your providers array in `config/app.php`

``` php
Chenzi\LaravelMNS\LaravelMNSServiceProvider::class

Edit your config/queue.php, add mns connection, <sub>(*4)</sub>

'mns'        => [
    'sms'=> [
        'driver'       => 'sms',
        'key'          => env('QUEUE_MNS_ACCESS_KEY'),
        'secret'       => env('QUEUE_MNS_SECRET_KEY'),
        'endpoint'     => env('QUEUE_MNS_ENDPOINT'),
        'queue'        => env('QUEUE_NAME'),
        'wait_seconds' => 30,
    ],
    'email'=> [
        'driver'       => 'email',
        'key'          => env('QUEUE_MNS_ACCESS_KEY'),
        'secret'       => env('QUEUE_MNS_SECRET_KEY'),
        'endpoint'     => env('QUEUE_MNS_ENDPOINT'),
        'queue'        => env('QUEUE_NAME'),
        'wait_seconds' => 30,
    ]
]

About wait_seconds, <sub>(*5)</sub>

Edit your .env file, <sub>(*6)</sub>

QUEUE_DRIVER=mns
QUEUE_NAME=foobar-local
QUEUE_MNS_ACCESS_KEY=your_acccess_key
QUEUE_MNS_SECRET_KEY=your_secret_key
QUEUE_MNS_ENDPOINT=http://12345678910.mns.cn-hangzhou.aliyuncs.com/

You should update QUEUE_MNS_ENDPOINT to internal endpoint in production mode, <sub>(*7)</sub>

Usage

First create a queue and get queue endpoint at Aliyun MNS Console, <sub>(*8)</sub>

Then update MNS_ENDPOINT in .env, <sub>(*9)</sub>

Push a test message to queue, <sub>(*10)</sub>

Queue::push(function($job){
    /**
     * Your statments go here
     */
    $job->delete();
});

You also can custom request data format add mns queue with other program, <sub>(*11)</sub>

return json_encode( [
    'displayName' => 'App\Jobs\SendSms',
    'job'         => 'App\Jobs\SendSms',
    'maxTries'    => null,
    'timeout'     => null,
    'data'        => [],
] );

Create queue work, run command in terminal, <sub>(*12)</sub>

$ php artisan queue:mns:work sms

Commands

Flush MNS messages on Aliyun, <sub>(*13)</sub>

$ php artisan queue:mns:flush

Job handle

class SendSms implements ShouldQueue
{
    ...

    public function handle(ReceiveMessageResponse $job){
        $messageId = $job->getMessageId();
        $messageBody = $job->getMessageBody();

        //TODO do some thing...
    }

    ...
}   

Security

Create RAM access control at Aliyun RAM Console, <sub>(*14)</sub>

1. Create a custom policy such as AliyunMNSFullAccessFoobar, <sub>(*15)</sub>

   {
     "Version": "1",
     "Statement": [
       {
         "Action": "mns:*",
         "Resource": [
           "acs:mns:*:*:*/foobar-local",
           "acs:mns:*:*:*/foobar-sandbox",
           "acs:mns:*:*:*/foobar-production"
         ],
         "Effect": "Allow"
       }
     ]
   }
   

2. Create a user for you app such as foobar, <sub>(*16)</sub>

3. Assign the policy AliyunMNSFullAccessFoobar to the user foobar, <sub>(*17)</sub>

4. Create and get the AccessKeyId and AccessKeySecret for user foorbar, <sub>(*18)</sub>

5. update QUEUE_MNS_ACCESS_KEY and QUEUE_MNS_ACCESS_SECRET in .env, <sub>(*19)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*20)</sub>

Testing

bash $ composer test, <sub>(*21)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*22)</sub>

Credits

• Loki Else
• abrahamgreyson
• All Contributors

License

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