Beanstalk è una coda di lavoro semplice e veloce. Ti consente di eseguire attività che richiedono tempo in modo asincrono, come l'invio di e-mail, la connessione ad API esterne o l'elaborazione di immagini. In questo modo, ridurrai la latenza dell'app web. Laravel fornisce supporto immediato per beanstalkd
.
In questo tutorial installeremo beanstalkd
, configureremo un'applicazione Laravel demo e gestiremo i lavoratori in coda tramite Supervisor . L'applicazione demo otterrà un elenco di sistemi operativi disponibili dall'API Vultr e ne sceglierà uno a caso.
Si presume che sul proprio sistema sia già installato Supervisor. In caso contrario, leggere il seguente tutorial su come impostare Supervisor: Installazione e configurazione del supervisore su Ubuntu 16.04
Si presume inoltre che si disponga dell'accesso SSH all'istanza Vultr.
Installazione di Beanstalk
Il primo passo da fare è installare beanstalkd
.
sudo apt-get update
sudo apt-get install beanstalkd
Avvia il servizio.
sudo systemctl start beanstalkd
È inoltre possibile abilitare l'avvio del servizio dopo l'inizializzazione del sistema.
sudo systemctl enable beanstalkd
Verificare lo stato del servizio immettendo il seguente comando.
sudo systemctl status beanstalkd
Per impostazione predefinita, beanstalkd
ascolta sulla porta 11300
. Beanstalk utilizza un semplice protocollo testuale descritto nel suo repository github . Puoi testare il suo protocollo eseguendo telnet
.
telnet localhost 11300
Scrivi quanto segue e premi ENTER.
list-tubes
Dovresti vedere un elenco di tubi disponibili sul server:
OK 14
---
- default
Per chiudere la connessione, digitare quit
e quindi premere ENTER.
I tubi in Beanstalk rappresentano le code di lavoro. Il fagiolo magico è composto essenzialmente da produttori , consumatori , posti di lavoro e tubi . I produttori mettono i lavori in un tubo per essere consumati (elaborati) da un numero qualsiasi di consumatori. Si noti che sia i produttori che i consumatori sono semplicemente client del server Beanstalk e sono totalmente indipendenti l'uno dall'altro. In termini pratici ciò significa che usando Beanstalk puoi produrre i tuoi lavori nella tua applicazione PHP e farli elaborare ad esempio in un'app NodeJS. Fortunatamente, Laravel riassume tutto questo e ci fornisce un'API molto semplice per inviare e gestire i lavori, come vedremo in seguito.
Progetto di esempio
Per costruire il nostro progetto di esempio, dobbiamo prima installare le sue dipendenze. Installeremo PHP e Composer.
sudo apt-get install php php-mbstring php-xml php-common php-zip composer
Ora crea il progetto basato su Laravel 5.5.
composer create-project --prefer-dist laravel/laravel vultr "5.5.*"
Avanti cd
nella cartella creata di recente. D'ora in poi lavoreremo in questa directory. Questa cartella può essere referenziata in seguito come PROJECT_ROOT
.
cd vultr/
Per usare Beanstalk in Laravel dobbiamo installare un'altra dipendenza, il client PHP Beanstalk.
composer require pda/pheanstalk ~3.0
Dobbiamo anche creare una rappresentazione di lavoro. In Laravel, questa è una classe all'interno della app/Jobs
cartella. Laravel ha un comando console per aiutarci a creare una classe Job. Creiamo il nostro lavoro di esempio.
php artisan make:job FindFavoriteOS
Aggiorna il app/Jobs/FindFavoriteOS.php
file al seguente.
<?php
namespace App\Jobs;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Support\Facades\Log;
class FindFavoriteOS implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
/**
* Create a new job instance.
*
* @return void
*/
public function __construct()
{
//
}
/**
* Execute the job.
*
* @return void
*/
public function handle()
{
$rawData = file_get_contents('https://api.vultr.com/v1/os/list');
$list = json_decode($rawData, true);
shuffle($list);
$key = array_rand($list);
$favorite = $list[$key];
Log::info('My Favorite OS is: ' . $favorite['name']);
}
}
Il metodo handle è ciò che verrà effettivamente eseguito quando il lavoro viene consumato. Qui, recuperiamo i dati dall'API Vultr, selezioniamo casualmente un sistema operativo e scriviamo il sistema operativo scelto nel file di registro. Il file di registro si trova in storage/logs/laravel.log
.
Abbiamo già installato Beanstalk e definito il lavoro che deve essere eseguito da esso. Ora è il momento di dire a Laravel di usare Beanstalk come coda di lavoro predefinita. Copia il .env
file predefinito fornito dall'installazione di Laravel.
cp .env.example .env
Ora apri il .env
file e aggiorna la riga in cui è specificato il driver della coda.
QUEUE_DRIVER=beanstalkd
Infine, genera una chiave dell'applicazione.
php artisan key:generate
Ora siamo pronti per inviare i lavori alla coda di lavoro di Beanstalk.
Invio ed esecuzione di lavori
Spedire un lavoro a Laravel è abbastanza semplice. Aggiorna il routes/web.php
file.
<?php
Route::get('/', function () {
for ($i = 0; $i < 50; $i++) {
\App\Jobs\FindFavoriteOS::dispatch();
}
return '50 Jobs dispatched!';
});
Nonostante non sia consigliato eseguire il server fornito in produzione in produzione, lo useremo qui per brevità.
php artisan serve --host 0.0.0.0 --port 8000
Ora in un browser Web, vai a http://[vultr-instance-ip]:8000
. Vedrai il seguente messaggio.
50 Jobs dispatched!
Apri una nuova connessione SSH al tuo server e all'interno della radice del nostro progetto, esegui quanto segue.
php artisan queue:work --once
Questo è l'output previsto:
[2018-02-14 00:03:52] Processing: App\Jobs\FindFavoriteOS
[2018-02-14 00:03:53] Processed: App\Jobs\FindFavoriteOS
Conferma che il registro è stato generato.
cat storage/logs/laravel.log
Configurazione supervisore
Per evitare la necessità di elaborare manualmente la coda, utilizzeremo supervisord
. Creare la seguente configurazione del programma in /etc/supervisor/conf.d/vultr.conf
.
[program:vultr]
process_name=%(program_name)s_%(process_num)02d
command=php [PROJECT_ROOT]/artisan queue:work
autostart=true
autorestart=true
numprocs=8
redirect_stderr=true
stdout_logfile=/var/log/worker.log
Si noti che il percorso corretto per inserire il file di configurazione del supervisore dipenderà dalla propria configurazione. Inoltre, ricorda di sostituire [PROJECT_ROOT]
con il percorso completo PROJECT_ROOT
sul tuo sistema.
Qui stiamo configurando Supervisor per avviare automaticamente l'elaborazione della coda e, in caso di interruzione dello script, per riavviarla. Si noti inoltre che non stiamo istanziando un singolo lavoratore, ma 8 processi. Sei libero di creare un'istanza, tuttavia, molti processi che ritieni necessari in base alla tua applicazione.
Per consentire al Supervisore di gestire il nostro lavoratore, costringilo a rileggere la sua configurazione.
sudo supervisorctl reread
sudo supervisorctl update
Se il servizio Supervisore non è stato avviato, è necessario avviarlo in molti.
sudo systemctl start supervisord
Ora vediamo se i lavori sono in fase di elaborazione.
tail -f storage/logs/laravel.log
Su un browser Web, accedere a http://[vultr-instance-ip]:8000
. Vedrai i log generati sulla tua console.
Conclusione
Abbiamo configurato correttamente un'applicazione Laravel per utilizzare Beanstalk come coda di lavoro. Inoltre, abbiamo dimostrato come utilizzare il supervisore per gestire i lavoratori.