Routing trong Express: route, tham số và Router

Routing trong Express ánh xạ một phương thức HTTP và một đường dẫn tới một hàm handler: app.get('/users', handler) trả lời các request GET đến /users, còn app.post(), app.put() và app.delete() làm điều tương tự cho các phương thức khác. Một đoạn bắt đầu bằng dấu hai chấm, như trong /users/:id, là tham số route, và giá trị của nó nằm trong req.params. Để giữ một app đang lớn dần cho gọn gàng, hãy đặt các route liên quan vào một express.Router() và gắn nó dưới một tiền tố bằng app.use('/api', router).

const express = require('express');
const app = express();
app.use(express.json());

const users = [
    { id: 1, name: 'Ada' },
    { id: 2, name: 'Linus' },
];
let nextId = 3;

app.get('/users', (req, res) => {
    res.json(users);
});

// GET /users/2
app.get('/users/:id', (req, res) => {
    const user = users.find((u) => u.id === Number(req.params.id));
    if (!user) return res.status(404).json({ error: 'User not found' });
    res.json(user);
});

app.post('/users', (req, res) => {
    const user = { id: nextId++, name: req.body.name };
    users.push(user);
    res.status(201).json(user);
});

app.delete('/users/:id', (req, res) => {
    const index = users.findIndex((u) => u.id === Number(req.params.id));
    if (index === -1) return res.status(404).json({ error: 'User not found' });
    users.splice(index, 1);
    res.status(204).end();
});

app.listen(3000);

GET /users/2 trả về {"id":2,"name":"Linus"}. Tham số route luôn là chuỗi, vì vậy handler so sánh với Number(req.params.id). Gửi POST /users với body {"name": "Grace"} để nhận 201, sau đó gửi DELETE /users/1 và GET /users để xem danh sách thay đổi.

express.Router() với tiền tố

Router là một app thu nhỏ với route và middleware riêng. Đường dẫn của nó là tương đối: một route viết là /:id trong router được gắn ở /api/books sẽ trả lời /api/books/:id. Trong dự án thật, mỗi router nằm trong một tệp riêng và kết thúc bằng module.exports = router.

const express = require('express');

// routes/books.js
const books = express.Router();
const list = [{ id: 1, title: 'Dune' }];

books.get('/', (req, res) => {
    res.json(list);
});

books
    .route('/:id')
    .get((req, res) => {
        res.json(list.find((b) => b.id === Number(req.params.id)) ?? null);
    })
    .put((req, res) => {
        res.json({ updated: req.params.id });
    })
    .delete((req, res) => {
        res.json({ deleted: req.params.id });
    });

// server.js
const app = express();
app.use('/api/books', books);

// GET /api/books/1
app.listen(3000);

GET /api/books/1 trả về {"id":1,"title":"Dune"}. router.route('/:id') chỉ cần viết đường dẫn một lần rồi nối các handler theo từng phương thức; gửi PUT /api/books/1 thì bạn nhận {"updated":"1"}. Đổi đường dẫn gắn thành /v2/books thì cùng router đó sẽ trả lời ở đường dẫn mới.

Thứ tự route: route khớp đầu tiên thắng

Express thử các route theo thứ tự bạn đăng ký và dừng ở route đầu tiên gửi response. Một route có tham số bắt mọi giá trị ở vị trí đó, nên một đường dẫn cố định đăng ký sau nó sẽ không bao giờ được chạy tới:

const express = require('express');
const app = express();

app.get('/users/:id', (req, res) => {
    res.json({ route: '/users/:id', id: req.params.id });
});

app.get('/users/new', (req, res) => {
    res.json({ route: '/users/new' });
});

// Runs only when no route above answered.
app.use((req, res) => {
    res.status(404).json({ error: `Cannot ${req.method} ${req.path}` });
});

// GET /users/new
app.listen(3000);

GET /users/new trả về {"route":"/users/:id","id":"new"}: route có tham số được đăng ký trước nên đã nhận request này. Chuyển route /users/new lên trên /users/:id rồi chạy lại để nhận {"route":"/users/new"}. Sau đó gửi GET /books để đến handler 404 ở cuối.

Handler 404

Express trả lời request không khớp route nào bằng trang HTML của riêng nó, Cannot GET /books. Với một API, bạn thường muốn trả về JSON, nên hãy thêm một app.use() không có đường dẫn làm route cuối cùng, như trong đoạn code ở trên. Nó chỉ chạy khi mọi route phía trước đều đã chuyển request đi tiếp. Lỗi do handler ném ra là một trường hợp khác, có handler bốn đối số riêng, được trình bày trong xử lý lỗi trong Express.

Đường dẫn route trong Express 5

Express 5 đã thay đổi cú pháp đường dẫn, trong khi phần lớn đoạn code trên mạng được viết cho Express 4:

Một dấu * đứng riêng hoặc dấu ? sau tham số sẽ ném TypeError ngay khi route được đăng ký, nên app không khởi động được.

Lỗi thường gặp

Đăng ký handler 404 đầu tiên. app.use() không có đường dẫn khớp với mọi thứ, nên request nào cũng nhận 404. Hãy giữ nó ở cuối.

Quên rằng tiền tố bị bỏ đi. Bên trong router được gắn ở /api, req.path không chứa /api. Dùng req.originalUrl khi bạn cần đường dẫn đầy đủ.

So sánh tham số với số. req.params.id === 1 luôn sai vì req.params.id là chuỗi '1'.