Memulai

Instalasi

Persyaratan

• PHP 8.2 atau lebih baru dan WordPress 6.4 atau lebih baru
• MySQL 8.0+ atau MariaDB 10.6+. Worker mengambil job dan jadwal yang jatuh tempo dengan SELECT ... FOR UPDATE SKIP LOCKED, yang ditolak server lama dengan kesalahan sintaks.
• mysqli atau pdo_mysql (lihat di bawah)
• WP-CLI di server jika Anda menjalankan worker khusus dengan wp queuety work
• Ekstensi pcntl dan posix PHP jika Anda menjalankan kumpulan worker dengan --workers atau --min-workers/--max-workers

Queuety memerlukan mysqli atau pdo_mysql dalam runtime PHP yang memuat WordPress dan WP-CLI. Driver dipilih secara otomatis: mysqli diutamakan untuk runtime WordPress, sementara pdo_mysql tetap tersedia untuk penggunaan runtime mandiri/langsung.

Jika Anda menginginkan runtime berbasis DB tanpa lapisan plugin WordPress, lihat Penggunaan Mandiri. Cara ini menggunakan koneksi dan tabel runtime yang sama, tetapi tidak menyertakan bridge hook WordPress atau pendaftaran WP-CLI.

Dari file zip rilis

Setiap rilis GitHub memiliki aset queuety.zip: plugin dengan dependensi Composer-nya sudah terpasang. Instal versi terbaru dengan WP-CLI:

wp plugin install https://github.com/inline0/queuety/releases/latest/download/queuety.zip --activate

Atau unduh file zip dan unggah di Plugins > Add New > Upload Plugin. Ini cara paling sederhana untuk situs WordPress biasa.

Melalui Composer untuk Composer yang dikelola WordPress

composer require queuety/queuety

Lalu aktifkan plugin:

wp plugin activate queuety

Jenis paketnya adalah wordpress-plugin. Composer menempatkannya di direktori plugin hanya jika proyek memerlukan composer/installers dan memetakan jenis tersebut ke jalur penginstal, seperti yang dilakukan Bedrock, dan proyek harus memuat vendor/autoload.php-nya sendiri (Bedrock juga melakukannya). Tanpa composer/installers, Composer memasangnya ke vendor/queuety/queuety, tempat WordPress tidak dapat menemukannya, jadi gunakan file zip rilis pada instalasi WordPress biasa.

Dari kode sumber selama pengembangan

Tempatkan repositori di wp-content/plugins/queuety, lalu instal dependensi PHP:

composer install
wp plugin activate queuety

Saat diaktifkan, Queuety membuat tabel databasenya (queuety_jobs, queuety_workflows, queuety_logs, queuety_schedules, queuety_queue_states, queuety_webhooks, queuety_locks, queuety_signals, queuety_workflow_dependencies, queuety_workflow_dispatch_keys, queuety_batches, queuety_chunks, queuety_workflow_events, queuety_artifacts, queuety_state_machines, queuety_state_machine_events) agar worker dapat mengambil job langsung dari MySQL.

Secara default, plugin juga menjadwalkan worker sekali jalan melalui WordPress cron setiap menit untuk antrean default. Ini menyediakan opsi dasar tanpa shell untuk job dan workflow yang tetap berjalan di default, selama WordPress cron terpicu. Setiap eksekusi memproses paling banyak satu job, dan tidak memicu jadwal berulang, memulihkan job usang, atau memeriksa tenggat workflow; semua itu hanya berjalan di dalam proses wp queuety work yang berjalan lama (#14). Untuk antrean khusus, jadwal berulang, latensi lebih rendah, atau beban kerja lebih berat, gunakan proses wp queuety work khusus.

Konfigurasi

Semua konstanta bersifat opsional. Definisikan di wp-config.php sebelum plugin dimuat, atau sebelum Queuety dimulai pada instalasi bergaya tema tersemat:

Konstanta penerimaan sumber daya dan kumpulan adaptif (QUEUETY_RESOURCE_*, QUEUETY_WORKER_POOL_*) tercantum di halaman Worker.

QUEUETY_TABLE_PREFIX hanya mengubah bagian Queuety pada nama tabel. Prefiks database WordPress tetap membungkus hasilnya, sehingga $wpdb->prefix = 'wp_' dan QUEUETY_TABLE_PREFIX = 'themequeue_' menghasilkan tabel seperti wp_themequeue_jobs. Konstanta QUEUETY_TABLE_* eksplisit tetap diutamakan untuk masing-masing tabel.

Koneksi mandiri juga dapat menetapkan prefiks tabel Queuety per koneksi:

$conn = new Connection(
    host: '127.0.0.1:3306',
    dbname: 'wordpress',
    user: 'root',
    password: 'secret',
    prefix: 'wp_',
    table_prefix: 'themequeue_',
);

Itu mempertahankan prefiks database WordPress dan hanya mengubah segmen tabel Queuety.

Job pertama Anda

Buat kelas handler yang mengimplementasikan antarmuka Handler:

use Queuety\Handler;

class SendEmailHandler implements Handler {
    public function handle( array $payload ): void {
        wp_mail( $payload['to'], $payload['subject'], $payload['body'] );
    }

    public function config(): array {
        return [
            'queue'           => 'emails',
            'max_attempts'    => 5,
        ];
    }
}

Daftarkan lalu kirim untuk dijalankan:

use Queuety\Queuety;

Queuety::register( 'send_email', SendEmailHandler::class );

Queuety::dispatch( 'send_email', [
    'to'      => 'user@example.com',
    'subject' => 'Welcome',
    'body'    => 'Hello from Queuety!',
] );

Atau gunakan kelas job modern yang dapat dikirim:

use Queuety\Contracts\Job;
use Queuety\Dispatchable;

readonly class SendEmailJob implements Job {
    use Dispatchable;

    public function __construct(
        public string $to,
        public string $subject,
        public string $body,
    ) {}

    public function handle(): void {
        wp_mail( $this->to, $this->subject, $this->body );
    }
}

SendEmailJob::dispatch( 'user@example.com', 'Welcome', 'Hello from Queuety!' );

Workflow pertama Anda

Definisikan handler langkah yang mengimplementasikan antarmuka Step:

use Queuety\Step;

class FetchDataHandler implements Step {
    public function handle( array $state ): array {
        $user = get_user_by( 'ID', $state['user_id'] );
        return [ 'user_name' => $user->display_name ];
    }

    public function config(): array {
        return [];
    }
}

class CallLLMHandler implements Step {
    public function handle( array $state ): array {
        $response = wp_remote_post( 'https://api.openai.com/v1/chat/completions', [
            'body' => json_encode( [ 'prompt' => "Generate report for {$state['user_name']}" ] ),
        ] );
        return [ 'llm_response' => wp_remote_retrieve_body( $response ) ];
    }

    public function config(): array {
        return [ 'max_attempts' => 5 ];
    }
}

class FormatOutputHandler implements Step {
    public function handle( array $state ): array {
        $url = save_report( $state['user_name'], $state['llm_response'] );
        return [ 'report_url' => $url ];
    }

    public function config(): array {
        return [];
    }
}

Kirim workflow untuk dijalankan:

$workflow_id = Queuety::workflow( 'generate_report' )
    ->then( FetchDataHandler::class )
    ->then( CallLLMHandler::class )
    ->then( FormatOutputHandler::class )
    ->dispatch( [ 'user_id' => 42 ] );

Mulai worker

wp queuety work

Worker memeriksa job yang menunggu, menjalankannya, melanjutkan workflow, dan beristirahat saat antrean kosong. Tekan Ctrl+C untuk berhenti; proses akan langsung berakhir, bahkan di tengah job (lihat Worker).

SendEmailHandler di atas mengirim job-nya ke antrean emails melalui config(), jadi worker di default tidak akan mengambilnya. Sebutkan setiap antrean yang Anda gunakan:

wp queuety work --queue=emails,default

Jika Anda tidak menjalankan worker khusus, Queuety tetap memiliki opsi cadangan WordPress cron bawaan yang berjalan sekali per menit seperti dijelaskan di atas, terbatas pada antrean default dan satu job per eksekusi. Worker khusus menawarkan throughput lebih tinggi dan latensi lebih rendah.

Untuk penggunaan produksi, jalankan beberapa worker:

wp queuety work --workers=4

Proses beberapa antrean dengan urutan prioritas:

wp queuety work --queue=high,default,low

Langkah berikutnya

• Job untuk panduan lengkap pengiriman dan handler
• Workflow untuk rantai, langkah paralel, percabangan bersyarat, dan menjalankan workflow
• Middleware untuk pembatasan laju, pengaturan throttle, dan logika pipeline khusus
• Batching untuk mengirim kelompok job dengan callback
• Langkah Streaming untuk menyimpan data streaming sedikit demi sedikit
• Penjadwalan untuk job berulang
• Caching untuk lapisan cache yang dapat diganti
• Pengujian untuk QueueFake dan asersi pengujian
• CLI Referensi untuk semua perintah yang tersedia
• PHP API untuk akses melalui kode