req.params, req.query và req.body trong Express

Trong Express, req.params chứa giá trị của các đoạn có tên trong đường dẫn route (/users/:id cho bạn req.params.id), req.query chứa query string sau dấu ? (/search?q=node cho bạn req.query.q), còn req.body chứa dữ liệu gửi trong body của request. req.params và req.query có giá trị ở mọi request, nhưng req.body vẫn là undefined cho đến khi một body parser như app.use(express.json()) đọc nó. Giá trị trong params và query luôn là chuỗi.

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

app.get('/users/:userId/posts', (req, res) => {
    res.json({ params: req.params, query: req.query });
});

app.post('/users/:userId/posts', (req, res) => {
    res.status(201).json({ params: req.params, body: req.body });
});

// GET /users/7/posts?sort=new&limit=2
app.listen(3000);

Request đầu tiên trả về {"params":{"userId":"7"},"query":{"sort":"new","limit":"2"}}. Chú ý dấu ngoặc kép: 7 và 2 là chuỗi, nên hãy chuyển chúng bằng Number() trước khi tính toán hoặc so sánh với số. Giờ đổi phương thức sang POST, giữ đường dẫn /users/7/posts và gửi body {"title": "Hello", "draft": true}: câu trả lời là 201 với "body":{"title":"Hello","draft":true}, trong đó true là boolean thật vì nó đến từ JSON.

req.params, req.query và req.body khác nhau thế nào

Một route có thể có nhiều tham số, và mỗi tên trở thành một khóa của req.params: /teams/:teamId/members/:memberId cho bạn cả hai id. Dấu gạch nối hoặc dấu chấm cũng tách các tham số, nên /flights/:from-:to biến /flights/LAX-SFO thành { from: 'LAX', to: 'SFO' }.

req.query với khóa lặp lại và khóa bị thiếu

Một khóa xuất hiện hai lần sẽ thành mảng, còn khóa bị thiếu là undefined, nên hãy cho các tùy chọn một giá trị mặc định:

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

app.get('/products', (req, res) => {
    const page = Number(req.query.page ?? 1);
    const tags = [].concat(req.query.tag ?? []);
    res.json({ page, tags, raw: req.query });
});

// GET /products?tag=red&tag=sale
app.listen(3000);

Câu trả lời là {"page":1,"tags":["red","sale"],"raw":{"tag":["red","sale"]}}. Gửi GET /products?tag=red&page=3 thì tags vẫn là mảng, ["red"], vì [].concat() biến một chuỗi hay một mảng đều thành mảng. Express 5 parse query string bằng bộ parser đơn giản của Node, nên ?filter[size]=m cho ra khóa "filter[size]", không phải object lồng nhau; Express 4 thì tạo object lồng nhau.

req.body cần express.json()

Node đưa body đến dưới dạng một luồng byte. express.json() đọc, parse và gán req.body, nhưng chỉ khi request có Content-Type: application/json. Form HTML gửi application/x-www-form-urlencoded, loại này cần express.urlencoded().

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

app.post('/signup', (req, res) => {
    const { email, name } = req.body ?? {};
    if (!email) {
        return res.status(400).json({ error: 'email is required' });
    }
    res.status(201).json({ email, name: name ?? 'anonymous' });
});

app.get('/', (req, res) => {
    res.send('Send POST /signup with a JSON body');
});

app.listen(3000);

Gửi POST /signup với body {"email": "ada@example.com"} và bạn nhận 201 với {"email":"ada@example.com","name":"anonymous"}. Gửi body rỗng thì bạn nhận 400. Phần ?? {} rất quan trọng: thiếu nó, việc destructuring undefined sẽ ném TypeError với mọi request không có body JSON. Để kiểm tra thật sự cấu trúc và kiểu dữ liệu, hãy dùng một thư viện schema như zod.

req.headers và req.get()

req.headers là một object chứa mọi header của request, với tên viết thường. req.get(name) đọc một header và không phân biệt hoa thường, nên req.get('Content-Type') và req.get('content-type') trả về cùng một giá trị. Một vài thuộc tính khác bạn sẽ dùng đến:

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

app.get('/whoami', (req, res) => {
    res.json({
        method: req.method,
        path: req.path,
        originalUrl: req.originalUrl,
        agent: req.get('User-Agent') ?? null,
        token: req.get('authorization') ?? null,
    });
});

// GET /whoami?debug=1
app.listen(3000);

path là /whoami còn originalUrl là /whoami?debug=1. Thêm header Authorization: Bearer abc vào thanh request rồi gửi lại: token trở thành "Bearer abc". Bên trong một router được gắn bằng app.use('/api', router), req.path mất tiền tố /api còn req.originalUrl vẫn giữ nó (routing trong Express giải thích cách gắn router).

Lỗi thường gặp

Đọc req.body trong request GET. Trình duyệt và hầu hết client không gửi body với GET. Hãy đặt các tùy chọn của GET vào query string.

Kiểm tra cờ trong query theo kiểu truthy. ?admin=false cho ra chuỗi 'false', là giá trị truthy, nên if (req.query.admin) vẫn đúng. Hãy so sánh chuỗi: req.query.admin === 'true'.

Gửi JSON mà không có header. Client gửi JSON với kiểu text/plain sẽ nhận req.body === undefined. Hãy đặt Content-Type: application/json ở phía client.