Xử lý lỗi và Exception trong ứng dụng CakePHP

Xử lý lỗi là một phần quan trọng để đảm bảo ứng dụng hoạt động ổn định và bảo mật. CakePHP cung cấp các công cụ mạnh mẽ để quản lý lỗi và ngoại lệ (Exception) thông qua các lớp và cấu hình tích hợp.

1. Tổng quan về lỗi và ngoại lệ

• Lỗi (Error): Là các vấn đề phát sinh từ mã nguồn, như lỗi cú pháp hoặc lỗi logic.
• Ngoại lệ (Exception): Là các tình huống bất thường được ứng dụng phát hiện và xử lý thông qua cơ chế try-catch.

CakePHP cung cấp cơ chế mặc định để bắt và hiển thị lỗi thông qua lớp ErrorHandler và các Exception riêng như NotFoundException, ForbiddenException, v.v.

2. Cấu hình xử lý lỗi

File cấu hình chính cho xử lý lỗi là config/app.php hoặc config/app_local.php.

2.1. Bật chế độ debug

Trong giai đoạn phát triển, bạn nên bật chế độ debug để hiển thị lỗi chi tiết:

'debug' => true,

Trong môi trường sản xuất, hãy tắt chế độ debug để tránh lộ thông tin nhạy cảm:

'debug' => false,

2.2. Cấu hình ErrorHandler

Trong file config/app.php, bạn có thể cấu hình ErrorHandler như sau:

'Error' => [
    'errorLevel' => E_ALL & ~E_DEPRECATED,
    'exceptionRenderer' => 'Cake\Error\ExceptionRenderer',
    'log' => true,
    'skipLog' => [],
    'trace' => true,
],

• errorLevel: Mức độ lỗi sẽ được xử lý.
• exceptionRenderer: Lớp xử lý lỗi và ngoại lệ.
• log: Ghi lỗi vào log.
• trace: Hiển thị stack trace của lỗi.

3. Xử lý lỗi trong Controller

CakePHP sử dụng ngoại lệ để xử lý các lỗi HTTP trong Controller.

3.1. Ví dụ sử dụng NotFoundException

Khi một tài nguyên không tồn tại, bạn có thể sử dụng ngoại lệ sau:

use Cake\Http\Exception\NotFoundException;

public function view($id = null)
{
    $item = $this->Items->get($id);
    if (!$item) {
        throw new NotFoundException(__('Item not found'));
    }
    $this->set(compact('item'));
}

3.2. Sử dụng ForbiddenException

Khi người dùng không được phép truy cập:

use Cake\Http\Exception\ForbiddenException;

public function edit($id = null)
{
    if (!$this->isAuthorized()) {
        throw new ForbiddenException(__('You are not authorized to access this resource.'));
    }
    // Tiếp tục xử lý
}

4. Ghi log lỗi

CakePHP sử dụng lớp Log để ghi lại lỗi. Tất cả các lỗi và ngoại lệ đều có thể được ghi vào file log.

4.1. Ghi log thủ công

Bạn có thể sử dụng hàm Log::write() để ghi log tùy chỉnh:

use Cake\Log\Log;

Log::write('error', 'Something went wrong here.');
Log::write('info', 'This is just an informational message.');

4.2. File log mặc định

Log được lưu tại thư mục logs/. Một số file log phổ biến:

• error.log: Lỗi hệ thống.
• debug.log: Thông tin debug.

5. Tùy chỉnh Exception Renderer

Bạn có thể tùy chỉnh cách CakePHP hiển thị ngoại lệ bằng cách tạo một lớp renderer riêng.

5.1. Tạo lớp tùy chỉnh

Tạo file src/Error/AppExceptionRenderer.php:

namespace App\Error;

use Cake\Error\ExceptionRenderer;

class AppExceptionRenderer extends ExceptionRenderer
{
    public function notFound($error)
    {
        // Hiển thị trang lỗi tùy chỉnh
        return $this->_outputMessage('error404');
    }
}

5.2. Cập nhật cấu hình

Trong config/app.php:

'Error' => [
    'exceptionRenderer' => 'App\Error\AppExceptionRenderer',
],

6. Tùy chỉnh trang lỗi

Bạn có thể tùy chỉnh giao diện hiển thị lỗi trong CakePHP bằng cách sửa các file trong thư mục templates/Error/:

• error500.php: Trang lỗi 500 (lỗi hệ thống).
• error400.php: Trang lỗi 400 (lỗi người dùng).

Ví dụ:

<div class="error">
    <h1><?= __('Something went wrong') ?></h1>
    <p><?= h($message) ?></p>
</div>

7. Xử lý lỗi toàn cục

Nếu bạn muốn xử lý lỗi toàn cục (không chỉ trong Controller), bạn có thể sử dụng middleware trong src/Application.php:

use Cake\Http\Middleware\ErrorHandlerMiddleware;

public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
{
    $middlewareQueue->add(new ErrorHandlerMiddleware());
    return $middlewareQueue;
}

8. Gợi ý kiểm tra lỗi

• Sử dụng DebugKit để kiểm tra truy vấn SQL, thời gian thực thi, và các biến liên quan.
• Kiểm tra file log trong thư mục logs/ để tìm hiểu nguyên nhân lỗi.
• Xác định rõ loại lỗi (lỗi 4xx hay 5xx) và xử lý phù hợp.

9. Kết luận

Xử lý lỗi và ngoại lệ hiệu quả giúp ứng dụng hoạt động ổn định, dễ bảo trì và bảo mật hơn. CakePHP cung cấp một hệ thống mạnh mẽ để xử lý mọi lỗi từ cơ bản đến phức tạp. Việc kết hợp DebugKit và log sẽ giúp bạn nhanh chóng tìm và khắc phục lỗi trong quá trình phát triển.