SQSJobQueueをSymfony2で扱う為のバンドル。
作った背景としては、Amaazon SQSをBCCResqueBundleと同じような感じで、Jobを利用した処理ができるということを目的につくりました。
- PHP5.6+
- Symfony2.7+
$ composer require tavii/sqs-job-queue-bundle:0.0.3
<?php
// app/AppKernel.php
// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...
new Tavii\SQSJobQueueBunblde\SQSJobQueueBundle()
);
// ...
}
// ...
}
tavii_sqs_job_queue:
aws:
key: %aws_api_key%
secret: %aws_api_secret%
region: %aws_api_region%
ワーカーの情報をDBに記録するために、テーブルを生成します。
現状は、sqs_workers
というテーブルが作成されるようになっています。
$ app/console sqs_job_queue:storage-init
amazon sqs側にqueueを登録します。
AWSの管理画面から作成する事も出来ますが、コマンドも用意しました。
今回はtest
というキューを登録します。
$ app/console sqs_job_queue:queue-create test
処理を担当する�Jobクラスを作成します。
今回はメールを送るJobクラスを作成します。
Tavii\SQSJobQueue\Job
クラス、または、Tavii\SQSJobQueueBundle\ContainerAwareJob
クラスを継承したクラスを作ります。
二つのクラスの違いはDIコンテナが使えるか使えないかの違いです。
Tavii\SQSJobQueueBundle\ContainerAwareJob
を利用すればDIコンテナを使うことが出来ます。
また、必ず処理が成功した場合
はtrue
を返すようにしてください。
<?php
// src/AppBundle/Job/SendMailJob.php
namespace AppBundle\Job;
use Tavii\SQSJobQueueBundle\ContainerAwareJob;
class SendMailJob extends ContainerAwareJob
{
public function getName()
{
return 'test'; // ここをキュー名と一致させること
}
public function run()
{
$message = \Swift_Message::newInstance()
->setFrom('hoge@fuga.com')
->setTo('fuga@hoge.com')
->setSubject('job test')
->setBody('job mail test');
$mailer = $this->getContainer()->get('mailer');
$ret = $mailer->send($message);
return true;
}
}
Jobのインスタンスから、キューに登録します。
<?php
...
$job = new TestJob();
$this->getContainer()->get('sqs_job_queue.queue')->push($job);
ワーカーを実行する場合はsqs_job_queue:worker-run
を実行します。
$ app/console sqs_job_queue:worker-run test
ワーカーを常駐する場合はsqs_job_queue:worker-start
を実行します。
$ app/console sqs_job_queue:worker-start test
常駐しているワーカーを停止する場合はsqs_job_queue:worker-stop
を実行します。
$ app/console sqs_job_queue:worker-start test
いくつかEventを発生させるようにしました。
SQSからキューを受け取った際にイベントが発生します。
SQSがキューを受け付けた場合にイベントが発生します。
SQSのキューが削除された際にイベントが発生します。
Jobが実行された際にイベントが発生します。
Jobの実行が完了した際にイベントが発生します。
- ストレージがDoctrineしか使えない問題の解消
- 管理画面の提供