Laravel Event là cơ chế cho phép ứng dụng phát ra một sự kiện khi một hành động xảy ra và để các Listener phản hồi lại sự kiện đó. Cách tiếp cận này giúp tách biệt các phần logic, giảm sự phụ thuộc giữa các thành phần và đặc biệt hữu ích khi xử lý email, thông báo, log, đồng bộ dữ liệu hoặc các tác vụ chạy nền.
Laravel Event là gì?
Laravel Event là cơ chế sự kiện được tích hợp trong Laravel, cho phép một thành phần trong ứng dụng thông báo rằng một hành động hoặc trạng thái nào đó đã xảy ra.
Ví dụ, khi người dùng đăng ký tài khoản, ứng dụng có thể cần thực hiện nhiều việc:
- Tạo tài khoản.
- Gửi email chào mừng.
- Gửi thông báo.
- Ghi log.
- Đồng bộ dữ liệu với hệ thống khác.
Thay vì viết toàn bộ logic trong cùng một Controller:
public function register()
{
// Tạo user
// Gửi email
// Gửi notification
// Ghi log
}
Laravel Event cho phép tách các hành động này thành những Listener riêng.
Có thể hình dung:
Người dùng đăng ký
↓
UserRegistered
↓
┌──────┼──────────┐
↓ ↓ ↓
Email Log Notification
Event đóng vai trò thông báo rằng một sự kiện đã xảy ra, còn Listener chịu trách nhiệm phản hồi sự kiện đó.
Event và Listener trong Laravel
Hai thành phần quan trọng nhất của hệ thống Event là Event và Listener.
Event
Event đại diện cho một sự kiện xảy ra trong ứng dụng.
Ví dụ:
class UserRegistered
{
public function __construct(
public User $user
) {
}
}
Event có thể chứa dữ liệu mà Listener cần sử dụng. Trong ví dụ trên, UserRegistered mang theo đối tượng User.
Listener
Listener là thành phần nhận và xử lý Event.
Ví dụ:
class SendWelcomeEmail
{
public function handle(UserRegistered $event): void
{
// Gửi email chào mừng
}
}
Laravel sẽ gọi phương thức handle() khi Event tương ứng được phát ra.
Mối quan hệ có thể biểu diễn như sau:
Event
↓
Listener
↓
Action
Một Event có thể có nhiều Listener khác nhau.
Vì sao Laravel cần Event?
Trong ứng dụng nhỏ, việc gọi trực tiếp một phương thức có thể không gây nhiều vấn đề.
Nhưng khi hệ thống phát triển, một hành động có thể kéo theo rất nhiều xử lý.
Ví dụ khi một đơn hàng được thanh toán:
Order Paid
├── Gửi email
├── Gửi thông báo
├── Cập nhật điểm thành viên
├── Ghi log
└── Đồng bộ hệ thống kế toán
Nếu đưa tất cả logic này vào OrderController, Controller sẽ nhanh chóng trở nên khó đọc và khó bảo trì. Event giúp phần nghiệp vụ chính chỉ cần phát ra thông báo: event(new OrderPaid($order));
Các Listener sẽ đảm nhiệm những công việc tương ứng. Đây cũng là một trong những kiến thức đáng nắm khi tìm hiểu học Laravel, đặc biệt nếu bạn bắt đầu xây dựng ứng dụng có nhiều module và quy trình xử lý liên kết với nhau.
Cách tạo Event và Listener trong Laravel
Laravel cung cấp Artisan để tạo Event và Listener.
Tạo Event: php artisan make:event UserRegistered
Tạo Listener: php artisan make:listener SendWelcomeEmail
Sau khi chạy lệnh, Laravel tạo các class tương ứng trong thư mục:
app/
├── Events/
│ └── UserRegistered.php
└── Listeners/
└── SendWelcomeEmail.php
Cách tổ chức này giúp Event và Listener được tách khỏi Controller hoặc Service.
Tạo một Laravel Event thực tế
Giả sử ứng dụng cần phát sự kiện khi người dùng đăng ký.
Tạo Event: php artisan make:event UserRegistered
File Event:
namespace App\Events;
use App\Models\User;
class UserRegistered
{
public function __construct(
public User $user
) {
}
}
Event nhận User và lưu lại để Listener có thể sử dụng.
Tiếp theo tạo Listener: php artisan make:listener SendWelcomeEmail
Listener: namespace App\Listeners;
use App\Events\UserRegistered;
class SendWelcomeEmail
{
public function handle(UserRegistered $event): void
{
$user = $event->user;
// Gửi email chào mừng
}
}
Bây giờ Listener đã biết mình cần xử lý Event nào.
Đăng ký Event và Listener
Laravel có thể phát hiện Event và Listener thông qua cơ chế discovery tùy cấu hình và phiên bản Laravel. Trong trường hợp cần khai báo rõ ràng, có thể đăng ký mapping giữa Event và Listener trong EventServiceProvider hoặc cấu hình tương ứng của phiên bản Laravel đang sử dụng.
Ví dụ:
protected $listen = [
UserRegistered::class => [
SendWelcomeEmail::class,
],
];
Cấu hình này có nghĩa:
UserRegistered
↓
SendWelcomeEmail
Khi UserRegistered được phát, Laravel sẽ gọi Listener tương ứng.
Cách phát Event trong Laravel
Sau khi Event và Listener được cấu hình, có thể phát Event bằng nhiều cách.
Sử dụng hàm event()
Cách đơn giản: event(new UserRegistered($user));
Laravel sẽ phát Event và tìm các Listener tương ứng.
Sử dụng Event facade
Có thể sử dụng: Event::dispatch(new UserRegistered($user));
Cách này phù hợp khi muốn sử dụng Event facade trong code.
Event có thể chứa dữ liệu
Ví dụ Event nhận đơn hàng:
class OrderPaid
{
public function __construct(
public Order $order
) {
}
}
Phát Event: event(new OrderPaid($order));
Listener có thể truy cập:
public function handle(OrderPaid $event): void
{
$order = $event->order;
// Xử lý đơn hàng
}
Nhờ vậy, Event có thể truyền dữ liệu cần thiết đến nhiều Listener.
Một Event có thể có nhiều Listener
Đây là một trong những điểm mạnh của Laravel Event.
Ví dụ:
UserRegistered
có thể có:
UserRegistered
│
├── SendWelcomeEmail
├── CreateUserProfile
├── SendRegistrationNotification
└── LogUserRegistration
Mỗi Listener đảm nhận một nhiệm vụ.
Ví dụ:
class CreateUserProfile
{
public function handle(UserRegistered $event): void
{
// Tạo profile
}
}
Listener khác:
class LogUserRegistration
{
public function handle(UserRegistered $event): void
{
// Ghi log
}
}
Controller không cần biết từng hành động này được thực hiện như thế nào.
Laravel Event giúp giảm coupling
Không sử dụng Event, Controller có thể phải gọi trực tiếp nhiều Service:
$userService->createProfile($user);
$mailService->sendWelcome($user);
$notificationService->notify($user);
$logService->record($user);
Khi số lượng hành động tăng, Controller trở nên phụ thuộc vào nhiều thành phần.
Với Event: event(new UserRegistered($user));
Logic chính chỉ cần thông báo sự kiện đã xảy ra. Các Listener xử lý phần còn lại. Điều này giúp giảm coupling, tức mức độ phụ thuộc trực tiếp giữa các thành phần trong hệ thống.
Event và Queue trong Laravel
Một Listener có thể thực hiện những tác vụ mất nhiều thời gian như:
- Gửi email.
- Gọi API bên ngoài.
- Tạo báo cáo.
- Đồng bộ dữ liệu.
- Xử lý file.
- Gửi notification.
Nếu thực hiện trực tiếp trong request, người dùng có thể phải chờ lâu.
Laravel cho phép Listener chạy thông qua Queue.
Listener có thể triển khai ShouldQueue:
use Illuminate\Contracts\Queue\ShouldQueue;
class SendWelcomeEmail implements ShouldQueue
{
public function handle(UserRegistered $event): void
{
// Gửi email
}
}
Khi đó Listener có thể được đưa vào queue thay vì xử lý toàn bộ trong request hiện tại.
Luồng xử lý:
User Request
↓
Phát Event
↓
Listener được đưa vào Queue
↓
Request hoàn thành
↓
Queue Worker xử lý
↓
Gửi Email
Đây là cách hữu ích để cải thiện trải nghiệm người dùng đối với các tác vụ không cần hoàn thành ngay lập tức.
Laravel Event có thể xử lý lỗi như thế nào?
Listener thực hiện tác vụ bên ngoài như gọi API hoặc gửi email có thể gặp lỗi.
Khi sử dụng Queue, Laravel hỗ trợ cơ chế retry và failed jobs tùy cấu hình.
Ví dụ Listener:
class SyncOrder implements ShouldQueue
{
public function handle(OrderPaid $event): void
{
// Gọi API đồng bộ đơn hàng
}
}
Nếu quá trình xử lý thất bại, Queue có thể thực hiện lại công việc theo cấu hình.
Với những tác vụ quan trọng, nên xác định rõ:
- Có cần retry hay không?
- Có thể thực hiện lại an toàn không?
- Khi thất bại cần ghi log ở đâu?
- Có cần xử lý failed job không?
Điều này đặc biệt quan trọng với các tác vụ thanh toán, đồng bộ dữ liệu hoặc gọi API bên thứ ba.
Event Listener và Model Event
Laravel có hai khái niệm dễ bị nhầm lẫn là Event/Listener thông thường và Model Event.
Model Event được kích hoạt khi Model trải qua các trạng thái nhất định.
Ví dụ:
creating
created
updating
updated
saving
saved
deleting
deleted
Có thể xử lý:
protected static function booted(): void
{
static::created(function ($user) {
// Xử lý sau khi User được tạo
});
}
Trong khi đó, Event thông thường được thiết kế cho các sự kiện nghiệp vụ của ứng dụng:
OrderPaid
UserRegistered
InvoiceCreated
PaymentFailed
Có thể hiểu đơn giản:
| Loại | Mục đích |
| Model Event | Theo dõi vòng đời Model |
| Application Event | Phản ánh sự kiện nghiệp vụ |
| Listener | Phản hồi Event |
Không nên sử dụng Model Event cho mọi loại nghiệp vụ vì có thể khiến logic ứng dụng khó theo dõi.
Khi nào nên sử dụng Laravel Event?
Event phù hợp khi một hành động có thể kích hoạt nhiều xử lý độc lập.
Một số trường hợp phổ biến:
Đăng ký tài khoản
UserRegistered
├── SendWelcomeEmail
├── CreateProfile
└── SendNotification
Thanh toán đơn hàng
OrderPaid
├── SendReceipt
├── UpdateCustomerPoint
└── SyncAccounting
Đăng bài viết
PostPublished
├── NotifySubscribers
├── ClearCache
└── UpdateSearchIndex
Xóa tài khoản
UserDeleted
├── RemoveAvatar
├── RevokeTokens
└── CleanupData
Trong những trường hợp này, Event giúp nghiệp vụ chính không phải trực tiếp quản lý tất cả hành động phát sinh.
Khi nào không nên dùng Event?
Không phải mọi đoạn code đều cần Event.
Nếu một thao tác chỉ có một bước xử lý đơn giản:
$user->update([
‘status’ => ‘active’
]);
thì việc tạo riêng Event và Listener có thể khiến code phức tạp hơn cần thiết.
Event phù hợp nhất khi:
- Có nhiều hành động phản hồi một sự kiện.
- Các hành động có thể tách độc lập.
- Một số Listener có thể chạy bất đồng bộ.
- Muốn giảm coupling giữa các module.
- Cần mở rộng thêm hành động trong tương lai.
Nếu chỉ có một thao tác đơn giản và phụ thuộc chặt vào nghiệp vụ chính, gọi trực tiếp Service có thể rõ ràng hơn.
Event, Listener và Service khác nhau thế nào?
Ba thành phần này có vai trò khác nhau:
| Thành phần | Vai trò |
| Event | Thông báo một sự kiện đã xảy ra |
| Listener | Phản hồi và xử lý sự kiện |
| Service | Thực hiện một nghiệp vụ hoặc nhóm nghiệp vụ |
Ví dụ:
OrderService
↓
OrderPaid Event
↓
┌────┴─────────────┐
↓ ↓
SendReceipt SyncOrder
Service có thể thực hiện nghiệp vụ chính, Event thông báo kết quả hoặc trạng thái, còn Listener đảm nhiệm các hành động phản hồi.
Đây là cách phân tách khá hữu ích khi ứng dụng bắt đầu có nhiều module.
Những lỗi thường gặp khi sử dụng Laravel Event
Event không được Listener xử lý
Nếu Event được phát nhưng Listener không chạy, cần kiểm tra:
- Event và Listener đã được mapping chưa.
- Namespace có chính xác không.
- Event có được dispatch đúng không.
- Cấu hình discovery có phù hợp không.
- Queue worker có đang chạy nếu Listener sử dụng Queue hay không.
Quên chạy Queue Worker
Nếu Listener triển khai: ShouldQueue
nhưng queue worker chưa chạy, tác vụ sẽ không được xử lý ngay. Có thể chạy worker bằng: php artisan queue:work
Đưa quá nhiều logic vào Listener
Listener cũng không nên trở thành một class khổng lồ.
Nếu Listener có quá nhiều nghiệp vụ, có thể tách phần xử lý thành Service riêng:
class SendWelcomeEmail implements ShouldQueue
{
public function __construct(
private WelcomeMailService $service
) {
}
public function handle(UserRegistered $event): void
{
$this->service->send($event->user);
}
}
Cách này giúp Listener giữ đúng vai trò điều phối sự kiện.
Phụ thuộc vào thứ tự Listener
Không nên thiết kế hệ thống theo kiểu Listener A bắt buộc phải chạy xong thì Listener B mới được phép hoạt động, trừ khi có cơ chế điều phối rõ ràng. Nếu các bước thực sự phụ thuộc nhau, một Service hoặc Workflow riêng có thể phù hợp hơn.
Cách tổ chức Event trong dự án Laravel
Một dự án có thể tổ chức:
app/
├── Events/
│ ├── UserRegistered.php
│ ├── OrderPaid.php
│ └── PostPublished.php
│
└── Listeners/
├── SendWelcomeEmail.php
├── SendOrderReceipt.php
└── NotifySubscribers.php
Khi số lượng Event tăng, có thể tổ chức theo domain hoặc module để dễ quản lý hơn.
Ví dụ:
app/
└── Domain/
├── User/
│ ├── Events/
│ └── Listeners/
│
└── Order/
├── Events/
└── Listeners/
Cách tổ chức nào phù hợp phụ thuộc vào quy mô và kiến trúc của dự án. Nếu bạn đang xây dựng nền tảng kiến thức Laravel từ các thành phần nền tảng đến kiến trúc ứng dụng, Laravel cơ bản là phần nên nắm trước khi đi sâu vào Event, Queue và các cơ chế xử lý bất đồng bộ.
Quy trình sử dụng Laravel Event
Một quy trình cơ bản có thể gồm:
Bước 1: Xác định sự kiện nghiệp vụ.
Ví dụ: OrderPaid
Bước 2: Tạo Event.
php artisan make:event OrderPaid
Bước 3: Tạo Listener.
php artisan make:listener SendOrderReceipt
Bước 4: Khai báo Event và Listener nếu cần.
Bước 5: Phát Event:
event(new OrderPaid($order));
Bước 6: Listener xử lý:
public function handle(OrderPaid $event): void
{
// Gửi email
}
Bước 7: Nếu tác vụ mất thời gian, cân nhắc đưa Listener vào Queue.
Quy trình này giúp tách rõ phần phát sinh sự kiện và phần phản hồi sự kiện.
Kết luận
Laravel Event cung cấp cơ chế để ứng dụng phát ra sự kiện và cho phép một hoặc nhiều Listener phản hồi sự kiện đó. Đây là giải pháp hữu ích để tách các tác vụ phụ khỏi nghiệp vụ chính, giảm coupling và giúp hệ thống dễ mở rộng hơn. Không phải mọi chức năng đều cần Event. Khi được sử dụng đúng chỗ, đặc biệt với các nghiệp vụ có nhiều hành động phản hồi hoặc cần xử lý bất đồng bộ, Laravel Event sẽ giúp kiến trúc ứng dụng rõ ràng và linh hoạt hơn.
