Skip to content

Latest commit

 

History

History
183 lines (139 loc) · 7.09 KB

READMEUA.md

File metadata and controls

183 lines (139 loc) · 7.09 KB
Raw

Simple Queue

Simple Queue

Latest Stable Version Total Downloads Stable License PHP Version

Прості черги та проста обробка черг для вашого PHP проекту

Ukrainian | English | Russian

Встановлення

Встановлення бібліотеки здійснюється через composer.

composer require glebsky/simple-queue

Налаштування

Вам потрібно імплементувати інтерфейс TransportInterface.

Ви можете використовувати MySql, Redis або будь-яке інше зручне для вас сховище.

Дані які є в Message і ваш клас повинен ґрунтуватися на цих даних.

$id - int
$status - int
$created_at - timestamp
$updated_at - timestamp 
$attempts - int
$queue  - string
$job - string
$body - string
$priority - int
$error - string

Наприклад, можете орієнтуватися на example/DBTranspot.php який працює на основі PDO.

Також ви можете використовувати готовий Transport клас Glebsky\SimpleQueue\Transports\PDOTransport який влаштований на основі PDO та працює з SQL базами даних.

Для створення таблиці черг у Базі даних у даному класі є метод migrate

Використання

Створення завдання

Вам необхідно створити свій Job клас імплементучи інтерфейс JobInterface

  • public $queueName - Властивість у цьому класі Ви можете призначити чергу певного завдання. Якщо цю властивість не додати, черга не буде призначена.

  • public $priority - Властивість у цьому класі Ви можете задати пріоритет у числах, чим вище число, тим вище пріоритет.

Метод handle У даному класі буде виконано при обробці черги. Тут Ви використовуєте необхідний вам код.

Приклад класу можна знайти в example/TestJob.php

Додавання завдання до черги

Для додавання завдання у чергу використовується клас Queue. Нам необхідно створити екземпляр нашого TransportInterface і з'єднати його з класом 'Queue'. Потім створюємо наше завдання - TestJob і додаємо завдання в чергу за допомогою методу dispatch

$transport = new DBTransport(); // create transport object
$queue = new Queue($transport); // add $transport to queue  
$job = new TestJob('testmail@gmail.com','Subject','Message text'); //  create job
$job->queueName = 'example_queue'; // you can change queue name
$job->priority = 3; // you can change priority
$result = $queue->dispatch($job); // send job to queue

Обробка черги

Черга обробляється за допомогою класу Worker.

$transport = new DBTransport();
$worker = new Worker($transport);
$worker->run();

Ви можете створити свій PHP скрипт, де буде обробка завдань, і ви можете запустити цей скрипт через CLI.

// Worker.php
<?php
require_once '../vendor/autoload.php';
require_once 'DBTransport.php';

use Glebsky\SimpleQueue\Example\DBTransport;
use Glebsky\SimpleQueue\Worker;

if (isset($argv[1])) {
    $queues = explode(',', $argv[1]);
} else {
    $queues = [];
}

$transport = new DBTransport();
$worker    = new Worker($transport);
$worker->run($queues);

Приклад запуску сценарію.

php Worker.php example_queue,test_queue

Де example_queue, test_queue - назви черг через кому, які будуть оброблятися. Якщо не передати параметр назви черг, обробник працюватиме з чергами без імені.

Також є можливість обробити певне завдання, у зручному для вас місці вашої програми.

$transport = new DBTransport();
$message = $transport->fetchMessage(['queue_name1','queue_name2'])
$worker->processJob($message);

Вбудований клас PDOTransport

Якщо ви плануєте налаштувати зв'язок на основі SQL баз даних, ви можете використовувати вбудований клас PDOTransport

Приклад використання:

<?php

use Glebsky\SimpleQueue\Example\TestJob;
use Glebsky\SimpleQueue\Queue;
use Glebsky\SimpleQueue\Transports\PDOTransport;
use Glebsky\SimpleQueue\Worker;

require_once '../vendor/autoload.php';
require_once 'TestJob.php';

//credentials
$host = 'localhost:3306';
$db_name = 'simple_queue';
$username = 'root';
$password = '';
$jobTableName = 'jobs';

//initialize PDO connection
$transport = новий PDOTransport($host, $db_name, $username, $password, $jobTableName);

//check for migrations and existing 'jobs' table
$transport->migrate();

//Create new queue and add new job
$queue = New Queue($transport);
$job = новий TestJob('testmail@gmail.com', 'Test Subject', 'Test Message text');
//set properties for queue
$job->priority = 3;
//set queue Name
$job->queueName = 'email_queue';
// add job to queue
$result = $queue->dispatch($job);

//run worker to handle queue
$worker = новий Worker($transport);
$worker->run(['email_queue']);
//or u can user to handle single job
$message = $transport->fetchMessage(['email_queue']);
$result = $worker->processJob($message); // true or false

Тести

Для запуску тестів можна використовувати команду composer run-script test-simple-queues

Приклади можна знайти в папці example

UA FLAG Підтримай Україну