Job and Queue Generators

Purpose and Scope

This document covers the make:job command for generating queueable job classes in the Hypervel framework. Jobs represent units of work that can be pushed to a queue for asynchronous processing, enabling background task execution and improved application responsiveness.

For information about generating the database tables required for the queue system (jobs, batches, and failed jobs tables), see Queue System Table Migrations.

Sources: src/ConfigProvider.php20-69

---

Overview

The JobCommand generates job classes that implement queued task execution. These jobs can be dispatched to various queue backends (database, Redis, etc.) and processed asynchronously by queue workers. The command follows the standard generator pattern, extending GeneratorCommand from Hyperf's base devtool.

Command Registration

The JobCommand is registered through the ConfigProvider alongside other generator commands:

Sources: src/ConfigProvider.php39-82

---

Job Class Structure

Basic Job Template

Generated job classes follow a standard structure that includes:

Component	Purpose
Class declaration	Defines the job class name
Constructor	Accepts job parameters and initializes properties
handle() method	Contains the job's execution logic
Queue traits/interfaces	Provides queue functionality
Serialization support	Enables job storage and retrieval

Job Class Architecture

Sources: src/ConfigProvider.php20

---

Queue Integration

Database Queue Schema

When using the database queue driver, jobs are stored in a table with the following structure:

Column	Type	Purpose
id	bigIncrements	Primary key for job identification
queue	string (indexed)	Queue channel name (default, high, low, etc.)
payload	longText	Serialized job object and metadata
attempts	unsignedTinyInteger	Number of execution attempts
reserved_at	unsignedInteger (nullable)	Timestamp when worker claimed job
available_at	unsignedInteger	Timestamp when job should be processed
created_at	unsignedInteger	Job creation timestamp

Sources: src/Generator/stubs/jobs-table.stub1-34

Job Lifecycle Flow

Sources: src/Generator/stubs/jobs-table.stub16-24

---

Command Usage

Basic Syntax

Common Patterns

Use Case	Command Example
Basic job	make:job ProcessPodcast
Nested namespace	make:job Jobs/Media/ProcessPodcast
Email sending	make:job SendWelcomeEmail
Data processing	make:job ImportCsvData
Cleanup tasks	make:job CleanupOldRecords

---

Job Dispatch Methods

Dispatch Strategies

Sources: src/Generator/stubs/jobs-table.stub18

---

Queue Table Dependencies

Related Migration Commands

The job generator works in conjunction with queue table migrations:

Table Name Configuration:

The jobs-table.stub uses a %TABLE% placeholder that is replaced with the configured table name. This allows customization of the queue table name through configuration:

Sources: src/Generator/stubs/jobs-table.stub16-32 src/ConfigProvider.php66-68

---

File Output Location

Default Namespace and Directory

Aspect	Default Value
Namespace	App\Jobs
Directory	app/Jobs/
File naming	{JobName}.php

Example Output Structure

app/
└── Jobs/
 ├── ProcessPodcast.php
 ├── SendWelcomeEmail.php
 └── Media/
 └── ProcessVideo.php

Sources: src/ConfigProvider.php20

---

Integration with Other Systems

Job Dependencies

Sources: src/ConfigProvider.php20-69 src/Generator/stubs/jobs-table.stub1-34

---

Queue Worker Execution

Worker Process Flow

Sources: src/Generator/stubs/jobs-table.stub16-24

---

Configuration Integration

Queue Configuration Access

Jobs interact with the queue system through configuration:

Configuration	Purpose
queue.default	Default queue connection
queue.connections.database.table	Job queue table name
queue.connections.database.queue	Default queue name
queue.failed.table	Failed jobs table name
queue.batching.table	Job batches table name

Command to Configuration Mapping

Sources: src/ConfigProvider.php66-69 src/Generator/stubs/jobs-table.stub16

---

Best Practices

Job Design Guidelines

Guideline	Rationale
Keep jobs focused	Single responsibility, easier to debug
Make jobs idempotent	Safe for retries after failures
Use type hints	Enable container auto-resolution
Avoid large payloads	Minimize serialization overhead
Set appropriate timeouts	Prevent worker hangs
Implement proper error handling	Graceful failure recovery

Job Naming Conventions

Pattern	Example	Use Case
Verb + Noun	ProcessPodcast	Action-oriented tasks
Send + Subject	SendWelcomeEmail	Notification delivery
Generate + Output	GenerateReport	Data generation
Import/Export	ImportUsers	Data transfer
Cleanup + Target	CleanupOldFiles	Maintenance tasks

Sources: src/ConfigProvider.php20