Ở bài trước chúng ta đã viết middleware và gắn morgan vào MiniBlog. Tiếp tục với series, bài này mình sẽ giới thiệu với mọi người về xử lý lỗi trong Express 5: error-handling middleware, trang 404 riêng, lớp lỗi HttpError và cách không để lộ stack trace khi chạy production.
1. Express xử lý lỗi như thế nào?
Khi có lỗi, Express bỏ qua các middleware thường còn lại và chuyển lỗi cho phần xử lý lỗi. Lỗi đến được Express theo ba cách:
throwtrong code đồng bộ: Express tự bắt.throwtrong hàmasynchoặc promise bị reject: Express 5 tự gọinext(err), không cầntry/catchnhư Express 4 (xem Bài 1).- Tự gọi
next(err)(truyền vàonext()một giá trị khác'route','router'và khác rỗng nhưnull,undefinedthì Express coi là lỗi): bắt buộc với API dùng callback nhưsetTimeout,fs.readFile, vì Express không bắt được lỗi trong callback.
- default.js
import express from 'express';
const app = express();
// Lỗi trong code đồng bộ: Express tự bắt
app.get('/sync', (req, res) => {
throw new Error('Lỗi trong code đồng bộ');
});
// Lỗi gắn status code riêng
app.get('/admin', async (req, res) => {
const err = new Error('Bạn không có quyền truy cập');
err.status = 403;
throw err;
});
app.listen(3000);
Như các bài trước, các bạn tạo file ví dụ trong thư mục miniblog, tắt npm run dev rồi chạy node default.js (kết quả đã lược bớt):
curl -i http://localhost:3000/sync
# HTTP/1.1 500 Internal Server Error
# ...
# <pre>Error: Lỗi trong code đồng bộ<br> at file:///.../default.js:7:11 ...
curl -i http://localhost:3000/admin
# HTTP/1.1 403 Forbidden
Các lỗi trên đi tới default error handler của Express. Nó lấy status code từ err.status (hoặc err.statusCode) nếu nằm trong khoảng 4xx, 5xx, ngược lại dùng 500, in lỗi ra terminal và trả về trang HTML chứa stack trace.
Stack trace để lộ đường dẫn file và cấu trúc code, nên khi biến môi trường NODE_ENV là production, Express chỉ trả về tên status code:
NODE_ENV=production node default.js
curl http://localhost:3000/sync
# ...<pre>Internal Server Error</pre>...
2. Viết error-handling middleware.
Để tự quyết định response khi có lỗi (VD: trả JSON thay vì trang HTML mặc định), các bạn viết error-handling middleware với cú pháp như sau:
app.use((err, req, res, next) => {
// Xử lý lỗi và trả response...
});
Trong đó:
errlà lỗi đượcthrowhoặc truyền vàonext(err).req,res,nextgiống middleware thường. Gọinext(err)để chuyển lỗi cho error handler tiếp theo, nếu không thì phải trả response.
Express phân biệt error-handling middleware bằng số tham số của hàm, nên luôn khai báo đủ bốn tham số, kể cả khi không dùng next. Error handler phải đặt sau cùng, sau tất cả các route và middleware khác.
VD: Mình thêm vào default.js hai middleware sau, đặt ngay trước dòng app.listen(3000);: một trang 404 (phần 3) và một error handler trả về JSON.
- default.js (đoạn thêm vào)
// Trang 404: đặt sau tất cả các route
app.use((req, res) => {
res.status(404).json({ message: 'Không tìm thấy trang' });
});
// Error-handling middleware: đặt cuối cùng, đủ 4 tham số
app.use((err, req, res, next) => {
console.error(err.message);
res.status(err.status || 500).json({ message: err.message });
});
curl -i http://localhost:3000/sync
# HTTP/1.1 500 Internal Server Error
# ...
# {"message":"Lỗi trong code đồng bộ"}
curl http://localhost:3000/admin
# {"message":"Bạn không có quyền truy cập"}
Chú ý: Viết thiếu tham số như (err, req, res) => {...} thì Express coi đó là middleware thường, error handler của các bạn sẽ không bao giờ được gọi khi có lỗi.
3. Trang 404.
Với Express, không tìm thấy route không phải là lỗi, chỉ là đã chạy hết middleware và route mà không ai trả response. Error handler không bắt được trường hợp này, nên chúng ta cần một middleware thường đặt sau tất cả các route, như middleware 404 ở trên:
curl -i http://localhost:3000/abc
# HTTP/1.1 404 Not Found
# ...
# {"message":"Không tìm thấy trang"}
Thay cho Cannot GET /abc mặc định ở Bài 6, giờ ứng dụng trả JSON giống các lỗi khác. Middleware 404 cũng có thể gọi next(err) với một lỗi có status 404 để mọi lỗi đi qua một error handler duy nhất, MiniBlog sẽ dùng cách này ở phần 5.
Thử xong các bạn xoá file default.js.
4. Tạo lớp lỗi riêng HttpError.
Tạo Error rồi gán err.status như trên khá dài dòng, nên chúng ta tạo một class kế thừa Error nhận luôn status code và thông báo lỗi.
// Lỗi HTTP có kèm status code, VD: new HttpError(404, 'Không tìm thấy bài viết')
export default class HttpError extends Error {
constructor(status, message) {
super(message);
this.name = 'HttpError';
this.status = status;
}
}
Giờ route chi tiết bài viết của MiniBlog chỉ cần throw lỗi, việc trả response 404 để error handler lo.
- routes/posts.js (thêm dòng import và đổi đoạn trả về 404)
import HttpError from '../lib/http-error.js';
// ...
if (!post) {
throw new HttpError(404, 'Không tìm thấy bài viết');
}
Nhờ thuộc tính status, HttpError chạy đúng cả với default error handler. Package http-errors (Express dùng bên trong) có hàm createError(404, '...') tương tự, nhưng với MiniBlog một class vài dòng là đủ.
5. Xử lý lỗi thống nhất cho MiniBlog.
Giờ chúng ta viết middleware 404 và error handler cho MiniBlog, với các yêu cầu:
- Trình duyệt nhận HTML, curl hay ứng dụng gọi API nhận JSON.
req.accepts(['json', 'html'])chọn kiểu theo headerAcceptcủa client (curl gửi*/*nên nhận kiểu đầu tiên,json). - Lỗi 5xx được ghi đầy đủ vào log, ở production chỉ trả thông báo chung. Response không bao giờ chứa stack trace.
- middlewares/error-handler.js
import HttpError from '../lib/http-error.js';
// Không route nào khớp: chuyển thành lỗi 404
export function notFound(req, res, next) {
next(new HttpError(404, 'Không tìm thấy trang'));
}
// Error-handling middleware: luôn khai báo đủ 4 tham số
export function errorHandler(err, req, res, next) {
// Response đã gửi một phần: để Express tự đóng kết nối
if (res.headersSent) {
return next(err);
}
const status = err.status >= 400 && err.status < 600 ? err.status : 500;
const isProduction = req.app.get('env') === 'production';
// Lỗi phía server: ghi đầy đủ stack vào log để sửa
if (status >= 500) {
console.error(err);
}
// Ở production không gửi chi tiết lỗi 5xx cho người dùng
const message = status >= 500 && isProduction
? 'Đã có lỗi xảy ra, vui lòng thử lại sau'
: err.message;
if (req.accepts(['json', 'html']) === 'json') {
return res.status(status).json({ message });
}
res.status(status).send(`<h1>Lỗi ${status}</h1><p>${message}</p>`);
}
req.app.get('env') là giá trị của NODE_ENV, mặc định development. res.headersSent là true khi response đã bắt đầu gửi, lúc đó không đổi được status nữa nên tài liệu Express khuyên chuyển lỗi cho default error handler.
Gắn hai middleware vào cuối app.js:
- app.js
import express from 'express';
import morgan from 'morgan';
import pagesRouter from './routes/pages.js';
import postsRouter from './routes/posts.js';
import { notFound, errorHandler } from './middlewares/error-handler.js';
const app = express();
// Ghi log mọi request, đặt trước các router
app.use(morgan('dev'));
app.use('/', pagesRouter);
app.use('/posts', postsRouter);
// Đặt sau tất cả router: trang 404 rồi đến error handler
app.use(notFound);
app.use(errorHandler);
export default app;
Chạy npm run dev và kiểm tra:
curl http://localhost:3000/posts/khong-ton-tai
# {"message":"Không tìm thấy bài viết"}
curl http://localhost:3000/abc
# {"message":"Không tìm thấy trang"}
curl -H "Accept: text/html" http://localhost:3000/abc
# <h1>Lỗi 404</h1><p>Không tìm thấy trang</p>
Để thử lỗi 500, các bạn thêm tạm route sau vào routes/pages.js (trước dòng export default router;):
router.get('/loi', () => {
throw new Error('Lỗi thử nghiệm');
});
Gọi /loi, rồi tắt npm run dev và gọi lại khi chạy ở chế độ production:
curl http://localhost:3000/loi
# {"message":"Lỗi thử nghiệm"}
NODE_ENV=production npm start
curl http://localhost:3000/loi
# {"message":"Đã có lỗi xảy ra, vui lòng thử lại sau"}
Cả hai lần terminal đều in Error: Lỗi thử nghiệm kèm stack trace, nhưng ở production người dùng không thấy chi tiết lỗi. Thử xong các bạn nhớ xoá route /loi. Trang lỗi hiện vẫn ghép HTML bằng chuỗi và in thẳng message vào HTML chưa escape (giống trang chủ ở Bài 5), Bài 8 sẽ chuyển sang template EJS để escape.
Code đầy đủ của MiniBlog sau bài này nằm ở tag bai-07 trên GitHub; các thay đổi của riêng bài này: so sánh bai-06...bai-07.
6. Lời kết.
Như vậy là chúng ta đã tìm hiểu xong xử lý lỗi trong Express 5: default error handler, error-handling middleware, trang 404, lớp HttpError và ẩn chi tiết lỗi ở production. Bài sau mình sẽ giới thiệu với mọi người về template engine EJS, thay các chuỗi HTML trong MiniBlog bằng giao diện danh sách bài viết.
Đăng ký nhận tin.
Chúng tôi chỉ gửi tối đa 2 lần trên 1 tháng. Tuyên bố không spam mail!





0 Comments