Chuyển đến nội dung chính

Giới thiệu

Kích hoạt lỗi kiểm tra (404, 500) theo yêu cầu để xác minh rằng các trang lỗi của bạn được hiển thị đúng cách, và đọc số lượng yêu cầu API của dự án.

Thông tin thêm về giao diện người dùng của mô-đun https://doc.oneentry.cloud/docs/category/system

🎯 Mô-đun này làm gì?​

Mô-đun System cung cấp các tiện ích cấp hệ thống. Nó cho phép bạn kiểm tra xử lý trang lỗi - mô phỏng lỗi 404 và 500 để xác minh rằng các trang lỗi của bạn hiển thị đúng cách trước khi người dùng gặp phải các vấn đề thực sự - và nó cung cấp getApiStat() để đọc số lượng yêu cầu API của dự án.

Các phương thức lỗi (test404, test500) kích hoạt chuyển hướng đến trang lỗi tương ứng để bạn có thể xác nhận rằng việc xử lý lỗi của bạn đã được triển khai đúng cách. Sử dụng chúng trong quá trình phát triển và kiểm tra, không trong mã sản xuất.

🚀 Bắt đầu nhanh​

Khởi tạo mô-đun từ defineOneEntry:


const { System } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Đọc số lượng yêu cầu API của dự án:

// Returns an object with the API request count for the project.
const stat = await System.getApiStat();

console.log('API usage:', stat);

test404() và test500() ném lỗi có chủ đích để kiểm tra logic xử lý của bạn, vì vậy hãy gọi chúng bên trong một try/catch:

try {
  await System.test404();
} catch (error) {
  // Your 404 handling runs here.
  console.log('404 handler fired', error);
}

✨ Khái niệm chính​

Mô-đun System là gì?​

Mô-đun System cung cấp các tiện ích kiểm tra và chẩn đoán:

  • Kiểm tra lỗi - Mô phỏng lỗi 404 / 500 với test404() / test500()
  • Xác thực trang lỗi - Xác nhận rằng các trang lỗi tùy chỉnh của bạn được hiển thị
  • Sử dụng API - Đọc số lượng yêu cầu API của dự án với getApiStat()
  • Công cụ phát triển - Sử dụng các phương thức lỗi trong quá trình phát triển/kiểm tra, không trong sản xuất

Các loại lỗi​

Mã lỗiTênKhi nào xảy raTrường hợp sử dụng
404Không tìm thấyTài nguyên yêu cầu không tồn tạiTrang không tìm thấy, sản phẩm bị thiếu
500Lỗi máy chủ nội bộLỗi xảy ra ở phía máy chủLỗi cơ sở dữ liệu, lỗi mã

Quy trình kiểm tra​

1. Develop custom 404 and 500 pages
   ↓
2. Implement error handling (try/catch, error boundaries)
   ↓
3. Trigger errors with System.test404() / System.test500()
   ↓
4. Verify your error pages display correctly
   ↓
5. Remove the test calls before deploying to production

📋 Những điều bạn cần biết​

Các phương thức lỗi chỉ dành cho kiểm tra​

Sử dụng test404() và test500() chỉ trong phát triển và kiểm tra - chúng ném lỗi để kiểm tra logic xử lý của bạn. Chạy chúng trong môi trường phát triển/ staging, và xóa các cuộc gọi kiểm tra trước khi sản xuất. Các lỗi 404/500 thực sự nên được xử lý bằng try/catch và ranh giới lỗi của riêng bạn.

Ghi log và giám sát là trách nhiệm của bạn​

Mô-đun System không ghi log hoặc giám sát lỗi. Việc ghi log và giám sát nằm trong ứng dụng của bạn hoặc các công cụ bên thứ ba - sử dụng các phương thức kiểm tra để kích hoạt lỗi để bạn có thể xác nhận rằng việc theo dõi của bạn hoạt động.

Các trang lỗi tùy chỉnh là do bạn xây dựng​

Mô-đun chỉ kích hoạt lỗi; bạn phải tạo các trang 404 và 500 tùy chỉnh và logic xử lý trong ứng dụng của bạn.

📊 Bảng tham khảo nhanh​

Phương thứcMô tảNémTrường hợp sử dụng
test404()Mô phỏng lỗi 404 Không tìm thấy404 ErrorKiểm tra trang lỗi 404
test500()Mô phỏng lỗi 500 Máy chủ500 ErrorKiểm tra trang lỗi 500
getApiStat()Lấy số lượng yêu cầu API—Giám sát việc sử dụng API

❓ Câu hỏi thường gặp (FAQ)​

Khi nào tôi nên sử dụng các phương thức lỗi?​

Sử dụng test404() và test500() chỉ trong phát triển và kiểm tra để xác minh rằng các trang lỗi của bạn hoạt động đúng cách. Không bao giờ sử dụng chúng trong mã sản xuất - chúng chỉ là công cụ kiểm tra để xác thực việc xử lý lỗi.

Làm thế nào để tôi kiểm tra các trang lỗi tùy chỉnh của mình?​

Gọi System.test404() hoặc System.test500() trong môi trường phát triển của bạn, bên trong một try/catch. Các phương thức này ném lỗi, kích hoạt logic xử lý lỗi của bạn để bạn có thể xác minh rằng các trang lỗi tùy chỉnh được hiển thị đúng cách.

Sự khác biệt giữa test404() và test500() là gì?​

test404() mô phỏng lỗi "Không tìm thấy" (tài nguyên không tồn tại), trong khi test500() mô phỏng lỗi "Lỗi máy chủ nội bộ" (lỗi phía máy chủ). Kiểm tra cả hai để đảm bảo rằng tất cả các kịch bản lỗi đều được xử lý đúng cách.

getApiStat() trả về gì?​

Nó trả về một đối tượng với số lượng yêu cầu API của dự án, hữu ích cho việc giám sát việc sử dụng API.

🎓 Thực hành tốt nhất​

  • Sử dụng các phương thức lỗi chỉ trong môi trường kiểm tra - Không bao giờ kích hoạt lỗi kiểm tra trong sản xuất.
  • Bọc các cuộc gọi kiểm tra trong try/catch - Cả test404() và test500() đều ném lỗi có chủ đích.
  • Triển khai các trang lỗi tùy chỉnh - Mô-đun chỉ kích hoạt lỗi; các trang là do bạn xây dựng.
  • Xác minh việc theo dõi lỗi - Sử dụng các phương thức kiểm tra để xác nhận rằng việc giám sát/ghi log của bạn hoạt động.
  • Xóa các cuộc gọi kiểm tra trước khi triển khai - Dọn dẹp các cuộc gọi test404() / test500() trước khi sản xuất.

🔗 Tài liệu liên quan​