Ở Bài 4 chúng ta đã dùng thử router.use() để ghi log cho một nhóm route, và ở bài trước các bạn đã thấy req.body, req.cookies chỉ có khi dùng middleware. 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ề middleware trong Express, thành phần quan trọng nhất của framework này.
1. Middleware là gì?
Middleware là một hàm nhận vào ba tham số req, res và next, được gọi lần lượt theo thứ tự khai báo mỗi khi có request. Tài liệu Express mô tả một ứng dụng Express về bản chất chỉ là một chuỗi các lần gọi middleware.
Một middleware có thể:
- Chạy code bất kỳ, VD: ghi log, đo thời gian.
- Sửa đổi
reqvàres, VD: thêm thuộc tính choreq. - Kết thúc request bằng cách trả response.
- Gọi
next()để chuyển request cho middleware tiếp theo.
Cú pháp như sau:
function tenMiddleware(req, res, next) {
// Xử lý...
next();
}
Các handler mà chúng ta viết từ Bài 3 cũng là middleware, chỉ là chúng luôn trả response nên không cần dùng tới next.
2. Hàm next() và thứ tự middleware.
Middleware khai báo trước sẽ chạy trước. Request đi qua từng middleware cho đến khi có một middleware trả response, những middleware phía sau sẽ không được gọi nữa.
VD: Mình khai báo hai middleware, một route và một middleware sau route.
- order.js
import express from 'express';
const app = express();
app.use((req, res, next) => {
console.log('1. Middleware thứ nhất');
next();
});
app.use((req, res, next) => {
console.log('2. Middleware thứ hai');
next();
});
app.get('/', (req, res) => {
console.log('3. Route handler');
res.send('Trang chủ');
});
// Chỉ chạy khi chưa có route nào trả response
app.use((req, res, next) => {
console.log('4. Middleware cuối cùng');
next();
});
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 order.js. Gọi / rồi /abc, terminal in ra:
# GET /
1. Middleware thứ nhất
2. Middleware thứ hai
3. Route handler
# GET /abc
1. Middleware thứ nhất
2. Middleware thứ hai
4. Middleware cuối cùng
Với /, route handler đã trả response nên middleware thứ tư không chạy. Với /abc, không route nào khớp nên request đi tới cuối, và vì middleware cuối vẫn gọi next() nên Express trả về trang 404 mặc định Cannot GET /abc (Bài 7 sẽ thay bằng trang 404 riêng).
Chú ý: Như đã nói ở Bài 4, middleware không gọi next() và cũng không trả response sẽ làm request bị treo.
3. Các loại middleware.
Application-level middleware.
Là middleware gắn vào app bằng app.use() hoặc app.get(), app.post()...
app.use(middleware): chạy cho mọi request.app.use(path, middleware): chỉ chạy cho request có đường dẫn bắt đầu bằngpath, với mọi method.app.get(path, middleware, handler): chỉ chạy cho một route. Các bạn có thể truyền nhiều middleware (hoặc một mảng) trước handler.
VD: Mình ghi log khu vực /admin và chỉ cho xem danh sách bài viết chờ duyệt khi có header X-Token đúng.
- admin.js
import express from 'express';
const app = express();
// Chạy cho mọi request có đường dẫn bắt đầu bằng /admin
app.use('/admin', (req, res, next) => {
console.log(`[admin] ${req.method} ${req.originalUrl}`);
next();
});
// Middleware dùng riêng cho từng route
function checkToken(req, res, next) {
if (req.get('X-Token') !== 'bi-mat') {
return res.status(401).json({ message: 'Bạn chưa đăng nhập' });
}
next();
}
app.get('/admin/posts', checkToken, (req, res) => {
res.json({ message: 'Danh sách bài viết chờ duyệt' });
});
app.listen(3000);
curl -i http://localhost:3000/admin/posts
# HTTP/1.1 401 Unauthorized
# ...
# {"message":"Bạn chưa đăng nhập"}
curl -H "X-Token: bi-mat" http://localhost:3000/admin/posts
# {"message":"Danh sách bài viết chờ duyệt"}
Khi thiếu token, checkToken trả response luôn nên handler phía sau không chạy. Mình dùng req.originalUrl vì nó luôn là đường dẫn đầy đủ, còn req.url đã bị bỏ phần prefix. Đăng nhập thật sẽ có ở Bài 16 và Bài 20.
Router-level middleware.
Hoạt động giống hệt application-level nhưng gắn vào router bằng router.use() hoặc router.get()..., nên chỉ chạy cho các request đi vào router đó. Ví dụ các bạn đã xem ở Bài 4.
Built-in middleware.
Express có sẵn một số middleware, mỗi hàm trả về một middleware nên các bạn gọi nó rồi truyền vào app.use():
express.static(): trả về file tĩnh như CSS, ảnh (Bài 9).express.json(),express.urlencoded(): đọc body dạng JSON và dữ liệu form vàoreq.body(Bài 10).express.raw(),express.text(): đọc body dạngBuffervà chuỗi.
Third-party middleware.
Là các package cài từ npm, VD: morgan (ghi log, ngay phần 5 bài này), cookie-parser (Bài 15), helmet (Bài 17). Các bạn cài bằng npm install, import rồi gắn vào app hoặc router như middleware tự viết.
Ngoài ra còn loại error-handling middleware nhận bốn tham số (err, req, res, next) để xử lý lỗi, mình sẽ nói ở bài sau.
4. Viết middleware ghi log.
Giờ chúng ta tự viết một middleware ghi lại method, đường dẫn, status code và thời gian xử lý của mỗi request. Vấn đề là status code chỉ có sau khi route trả response, nên middleware phải đăng ký sự kiện finish của res (sự kiện của Node.js, xảy ra khi response đã gửi xong) rồi mới gọi next().
- logger.js
import express from 'express';
const app = express();
function logger(req, res, next) {
const start = Date.now();
// Sự kiện 'finish' xảy ra khi response đã gửi xong
res.on('finish', () => {
const ms = Date.now() - start;
console.log(`${req.method} ${req.originalUrl} ${res.statusCode} - ${ms} ms`);
});
next();
}
app.use(logger);
app.get('/', (req, res) => {
res.send('Trang chủ');
});
app.listen(3000);
Gọi / rồi /abc, terminal in ra (thời gian trên máy các bạn sẽ khác):
GET / 200 - 15 ms
GET /abc 404 - 3 ms
app.use(logger) phải đặt trước các route, nếu đặt sau thì request đã được trả response trước khi tới logger.
Thử xong các bạn xoá các file order.js, admin.js và logger.js.
5. Ghi log với morgan cho MiniBlog.
Tự viết logger giúp hiểu cách middleware hoạt động, nhưng trong thực tế mọi người thường dùng morgan, middleware ghi log request do chính đội Express duy trì. Các bạn cài vào MiniBlog:
npm install morgan
Để tạo middleware, các bạn sử dụng hàm morgan() với cú pháp như sau:
morgan(format, options);
Trong đó:
formatlà định dạng log, có thể là tên định dạng có sẵn:dev(ngắn gọn, có màu, dùng khi phát triển),tiny,common,combined(định dạng log của Apache), hoặc chuỗi token tự ghép như':method :url :status'.optionscó thể bỏ trống, VD:skiplà hàm trả vềtrueđể bỏ qua không ghi log,streamlà nơi ghi log (mặc định là terminal).
Giống express.json(), morgan() là hàm trả về middleware. Mình gắn nó vào app.js, trước các router:
- app.js
import express from 'express';
import morgan from 'morgan';
import pagesRouter from './routes/pages.js';
import postsRouter from './routes/posts.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);
export default app;
Chạy npm run dev, gọi lần lượt /, /posts/route-trong-express-5 và /posts/khong-ton-tai, terminal in ra (status code có màu xanh với 2xx, vàng với 4xx):
GET / 200 8.857 ms - 206
GET /posts/route-trong-express-5 200 3.435 ms - 106
GET /posts/khong-ton-tai 404 1.658 ms - 44
Mỗi dòng gồm method, đường dẫn đầy đủ, status code, thời gian xử lý và kích thước response (byte). Đến Bài 23, chúng ta sẽ chuyển sang log có cấu trúc với pino.
Code đầy đủ của MiniBlog sau bài này nằm ở tag bai-06 trên GitHub; các thay đổi của riêng bài này: so sánh bai-05...bai-06.
6. Lời kết.
Như vậy là chúng ta đã tìm hiểu xong middleware trong Express: cách middleware hoạt động với next(), thứ tự chạy, các loại middleware, tự viết middleware ghi log và dùng morgan cho MiniBlog. Bài sau mình sẽ giới thiệu với mọi người về xử lý lỗi trong Express 5, với error-handling middleware và trang 404 riêng cho MiniBlog.
Đă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