|
12 anos atrás | |
---|---|---|
Command | 12 anos atrás | |
DependencyInjection | 12 anos atrás | |
Driver | 12 anos atrás | |
Event | 12 anos atrás | |
Exceptions | 12 anos atrás | |
Module | 12 anos atrás | |
Resources | 12 anos atrás | |
Service | 12 anos atrás | |
Tests | 12 anos atrás | |
.gitignore | 12 anos atrás | |
.travis.yml | 12 anos atrás | |
GearmanBundle.php | 12 anos atrás | |
GearmanEvents.php | 12 anos atrás | |
GearmanMethods.php | 12 anos atrás | |
LICENSE | 12 anos atrás | |
README.md | 12 anos atrás | |
composer.json | 12 anos atrás | |
humans.txt | 12 anos atrás | |
multipush.sh | 12 anos atrás | |
phpunit.xml.dist | 12 anos atrás |
GearmanBundle is a bundle for Symfony2 intended to provide an easy way to support developers who need to use job queues. For example: mail queues, Solr generation queues or Database upload queues.
This bundle has been refactored.
All tests are being performed and will be published as soon as possible.
All help will be very grateful.
My apologies for all possible issues caused by this big repository change.
I am at your disposal.
2.1
for Symfony version 2.1.*
2.2
for Symfony version 2.2.*
2.3
or the master
for Symfony version 2.3.*
To install Gearman Job Server with apt-get
use the following commands:
$ sudo apt-get install gearman-job-server
And start server
$ service gearman-job-server start
Then you need to install Gearman driver using the following commands
$ pecl install channel://pecl.php.net/gearman-X.X.X
You will find all available gearman versions in Pear Repository
Finally you need to start php module
$ echo "extension=gearman.so" > /etc/php5/conf.d/gearman.ini
You have to add require line into you composer.json file
"require": {
"php": ">=5.3.3",
"symfony/symfony": "2.3.*",
...
"mmoreram/gearman-bundle": "dev-master"
},
Then you have to use composer to update your project dependencies
php composer.phar update
And register the bundle in your appkernel.php file
return array(
// ...
new Liip\DoctrineCacheBundle\LiipDoctrineCacheBundle(),
new Mmoreram\GearmanBundle\GearmanBundle(),
// ...
);
We must configure our Worker. Common definitions must be defined in config.yml file, setting values for all installed Workers. Also we must config gearman cache, using doctrine cache.
If
iterations
value is 0, worker will not kill itself never, so thread will be alive as long as needed.
The reason to allow workers to kill themselves is just to prevent each process to accumulate a large quantity of memory.
liip_doctrine_cache:
namespaces:
gearman:
type: file_system
gearman:
# Bundles will parsed searching workers
bundles:
# Name of bundle
AcmeBundle:
# Bundle name
name: MmoreramerinoTestBundle
# Bundle search can be enabled or disabled
active: true
# If any include is defined, Only these namespaces will be parsed
# Otherwise, full Bundle will be parsed
include:
- Services
- EventListener
# Namespaces this Bundle will ignore when parsing
ignore:
- DependencyInjection
- Resources
# default values
# All these values will be used if are not overwritten in Workers or jobs
defaults:
# default method related with all jobs
# do // deprecated as of pecl/gearman 1.0.0. Use doNormal
# doNormal
# doBackground
# doHigh
# doHighBackground
# doLow
# doLowBackground
method: doNormal
# Default number of executions before job dies.
# If annotations defined, will be overwritten
# If empty, 0 is defined by default
iterations: 150
# Server list where workers and clients will connect to
# Each server must contain host and port
# If annotations defined, will be full overwritten
#
# If servers empty, simple localhost server is defined by default
# If port empty, 4730 is defined by efault
servers:
localhost:
host: 127.0.0.1
port: 4730
In development mode you do not want to cache things over more than one request. An easy solution for this is to use the array cache in the dev environment ( Extracted from LiipDoctrineCacheBundle documentation )
#config.yml
liip_doctrine_cache:
namespaces:
presta_sitemap:
type: file_system
# config_dev.yml
liip_doctrine_cache:
namespaces:
presta_sitemap:
type: array
This Bundle allows you to configure whatever as a Job. It provides you an easy way to execute it with Supervisor, for example. Moreover, it let you call client methods in Symfony2 environment in a really simple and practical way.
Job annotations always overwrite work annotations, and work annotations always overwrite environment settings.
<?php
namespace Acme\AcmeBundle\Workers;
use Mmoreram\GearmanBundle\Driver\Gearman;
/**
* @Gearman\Work(
* iterations = 3,
* description = "Worker test description",
* defaultMethod = "doBackground",
* servers = {
* { "host": "192.168.1.1", "port": 4560 },
* { "host": "192.168.1.2", "port": 4560 },
* }
* )
*/
class AcmeWorker
{
/**
* Test method to run as a job
*
* @param \GearmanJob $job Object with job parameters
*
* @return boolean
*
* @Gearman\Job(
* iterations = 3,
* name = "test",
* description = "This is a description"
* )
*/
public function testA(\GearmanJob $job)
{
echo 'Job testA done!' . PHP_EOL;
return true;
}
/**
* Test method to run as a job
*
* @param \GearmanJob $job Object with job parameters
*
* @return boolean
*
* @Gearman\Job(
* defaultMethod = "doLowBackground"
* )
*/
public function testB(\GearmanJob $job)
{
echo 'Job testB done!' . PHP_EOL;
return true;
}
}
/**
* @Gearman\Work(
* name = "MyAcmeWorker",
* iterations = 3,
* description = "Acme Worker. Containing multiple available jobs",
* defaultMethod = "doHigh",
* servers = {
* { "host": "192.168.1.1", "port": 4560 },
* { "host": "192.168.1.2", "port": 4560 },
* }
* )
*/
/**
* @Gearman\Job(
* name = "doSomething",
* iterations = 10,
* description = "Acme Job action. This is just a description of a method that do something",
* defaultMethod = "doBackground",
* servers = { "host": "192.168.1.1", "port": 4560 }
* )
*/
If you want to use your service as a worker, you have to specify service variable in Worker annotation
<?php
namespace Acme\AcmeBundle\Services;
/**
* @Gearman\Work(
* service="myServiceName"
* )
*/
class AcmeService
{
... some code ...
/**
* Test method to run as a job
*
* @param \GearmanJob $job Object with job parameters
*
* @return boolean
*
* @Gearman\Job()
*/
public function testA(\GearmanJob $job)
{
echo 'Job testA done!' . PHP_EOL;
return true;
}
}
And have this service defined in your dependency injection definition file
# /Resources/config/services.yml
bundles:
Services:
myServiceName:
class: Acme\AcmeBundle\Services\AcmeService
arguments:
event_dispatcher: @event_dispatcher
mailer: @mailer
Gearman provides a set of commands that will make easier to know all workers settings.
/app/console
gearman
gearman:cache:clear Clears gearman cache data on current environment
gearman:cache:warmup Warms up gearman cache data
gearman:job:describe Describe given job
gearman:job:execute Execute one single job
gearman:worker:describe Describe given worker
gearman:worker:execute Execute one worker with all contained Jobs
gearman:worker:list List all Gearman Workers and their Jobs
Once all your workers are defined, you can simply list them to ensure all settings are correct.
/app/console gearman:workers:list
@Worker: Mmoreramerino\TestBundle\Services\AcmeWorker
callablename: MmoreramerinoTestBundleServicesMyAcmeWorker
Jobs:
- #1
name: testA
callablename: MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething
You can describe full worker using its callableName.
This command provides you all information about desired Worker, overwritting custom annotation settings to default config settings.
This command also provides you all needed information to work with Supervisord.
php app/console gearman:worker:describe MmoreramerinoTestBundleServicesMyAcmeWorker
@Worker\className : Mmoreramerino\TestBundle\Services\AcmeWorker
@Worker\fileName : /var/www/projects/myrepo/src/Mmoreramerino/TestBundle/Services/AcmeWorker.php
@Worker\nameSpace : Mmoreramerino\TestBundle\Services
@Worker\callableName: MmoreramerinoTestBundleServicesMyAcmeWorker
@Worker\supervisord : /usr/bin/php /var/www/projects/myrepo/app/console gearman:worker:execute MmoreramerinoTestBundleServicesMyAcmeWorker --no-interaction
@worker\iterations : 3
@Worker\#jobs : 1
@worker\servers :
#0 - 192.168.1.1:4560
#1 - 192.168.1.2:4560
@Worker\description :
Acme Worker. Containing multiple available jobs
You can also describe full job using also its callableName
This command provides you all information about desired Job, overwritting custom annotation settings to worker settings.
This command also provides you all needed information to work with Supervisord.
php app/console gearman:job:describe MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething
@Worker\className : Mmoreramerino\TestBundle\Services\AcmeWorker
@Worker\fileName : /var/www/projects/myrepo/src/Mmoreramerino/TestBundle/Services/AcmeWorker.php
@Worker\nameSpace : Mmoreramerino\TestBundle\Services
@Worker\callableName: MmoreramerinoTestBundleServicesMyAcmeWorker
@Worker\supervisord : /usr/bin/php /var/www/projects/myrepo/app/console gearman:worker:execute MmoreramerinoTestBundleServicesMyAcmeWorker --no-interaction
@worker\iterations : 3
@Worker\#jobs : 1
@worker\servers :
#0 - 192.168.1.1:4560
#1 - 192.168.1.2:4560
@Worker\description :
Acme Worker. Containing multiple available jobs
@job\methodName : testA
@job\callableName : MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething
@job\supervisord : /usr/bin/php /var/www/projects/myrepo/app/console gearman:job:execute MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething --no-interaction
@job\iterations : 10
@job\defaultMethod : doBackground
@job\servers :
0 - 192.168.1.1:4560
@job\description :
#Acme Job action. This is just a description of a method that do something
You can execute by command line an instance of a worker or a job.
The difference between them is that an instance of a worker can execute any of their jobs, without assignning any priority to them, and a job only can run itself.
php app/console gearman:worker:execute MmoreramerinoTestBundleServicesMyAcmeWorker
php app/console gearman:job:execute MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething
By using callableName you can let Supervisord maintain alive a worker. When the job is executed as times as iterations is defined, will die, but supervisord will alive it again.
You can have as many as worker instances as you want.
Get some Supervisord info
You can request a Job by using the gearman client.
$this
->getContainer()
->get('gearman');
$gearman
->clearServers()
->setServer('127.1.1.1', 4677)
->addServer('127.1.1.1', 4678)
->addServer('127.1.1.1', 4679);
By default, if no server is set, gearman will use server defined as default in config.yml
host: 127.0.0.1
port: 4730
$result = $gearman
->doJob('MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething', json_encode(array('value1')));
$gearman
->addTask('MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething', 'value1')
->addLowTask('MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething', 'value2')
->addHighBackgroundTask('MmoreramerinoTestBundleServicesMyAcmeWorker~doSomething', 'value3')
->runTasks();
GearmanBundle transforms Gearman callbacks to Symfony2 kernel events.
This event recieves as parameter an instance of Mmoreram\GearmanBundle\Event\GearmanClientCallbackCompleteEvent
with one method $event->getGearmanTask()
. This method returns an instance of \GearmanTask
.
For more information about this GearmanEvent, read GearmanClient::setCompleteCallback documentation.
services:
my_event_listener:
class: AcmeBundle\EventListener\MyEventListener
tags:
- { name: kernel.event_listener, event: gearman.client.callback.complete, method: onComplete }
This event recieves as parameter an instance of Mmoreram\GearmanBundle\Event\GearmanClientCallbackCreatedEvent
with one method $event->getGearmanTask()
. This method returns an instance of \GearmanTask
.
For more information about this GearmanEvent, read GearmanClient::setCreatedCallback documentation.
services:
my_event_listener:
class: AcmeBundle\EventListener\MyEventListener
tags:
- { name: kernel.event_listener, event: gearman.client.callback.created, method: onCreated }
This event recieves as parameter an instance of Mmoreram\GearmanBundle\Event\GearmanClientCallbackDataEvent
with one method $event->getGearmanTask()
. This method returns an instance of \GearmanTask
.
For more information about this GearmanEvent, read GearmanClient::setDataCallback documentation.
services:
my_event_listener:
class: AcmeBundle\EventListener\MyEventListener
tags:
- { name: kernel.event_listener, event: gearman.client.callback.data, method: onData }
This event recieves as parameter an instance of Mmoreram\GearmanBundle\Event\GearmanClientCallbackExceptionEvent
with no methods.
For more information about this GearmanEvent, read GearmanClient::setExceptionCallback documentation.
services:
my_event_listener:
class: AcmeBundle\EventListener\MyEventListener
tags:
- { name: kernel.event_listener, event: gearman.client.callback.exception, method: onExcept }
This event recieves as parameter an instance of Mmoreram\GearmanBundle\Event\GearmanClientCallbackFailEvent
with one method $event->getGearmanTask()
. This method returns an instance of \GearmanTask
.
For more information about this GearmanEvent, read GearmanClient::setFailCallback documentation.
services:
my_event_listener:
class: AcmeBundle\EventListener\MyEventListener
tags:
- { name: kernel.event_listener, event: gearman.client.callback.fail, method: onFail }
This event recieves as parameter an instance of Mmoreram\GearmanBundle\Event\GearmanClientCallbackFailEvent
with one method $event->getGearmanTask()
. This method returns an instance of \GearmanTask
.
For more information about this GearmanEvent, read GearmanClient::setStatusCallback documentation.
services:
my_event_listener:
class: AcmeBundle\EventListener\MyEventListener
tags:
- { name: kernel.event_listener, event: gearman.client.callback.status, method: onStatus }
This event recieves as parameter an instance of Mmoreram\GearmanBundle\Event\GearmanClientCallbackWarningEvent
with one method $event->getGearmanTask()
. This method returns an instance of \GearmanTask
.
For more information about this GearmanEvent, read GearmanClient::setWarningCallback documentation.
services:
my_event_listener:
class: AcmeBundle\EventListener\MyEventListener
tags:
- { name: kernel.event_listener, event: gearman.client.callback.warning, method: onWarning }
This event recieves as parameter an instance of Mmoreram\GearmanBundle\Event\GearmanClientCallbackWorkloadEvent
with one method $event->getGearmanTask()
. This method returns an instance of \GearmanTask
.
For more information about this GearmanEvent, read GearmanClient::setWorkloadCallback documentation.
services:
my_event_listener:
class: AcmeBundle\EventListener\MyEventListener
tags:
- { name: kernel.event_listener, event: gearman.client.callback.workload, method: onWorkload }
All code is Symfony2 Code formatted, so every pull request must validate phpcs standards.
You should read Symfony2 coding standards and install this CodeSniffer to check all code is validated.
There is also a policy for contributing to this project. All pull request must be all explained step by step, to make us more understandable and easier to merge pull request. All new features must be tested with PHPUnit.