req.params, req.query ו-req.body ב-Express בהסבר

ב-Express, ‏req.params מחזיק את הערכים של הקטעים עם השם בנתיב של ה-route (‏/users/:id נותן req.params.id), req.query מחזיק את ה-query string שאחרי ה-? (‏/search?q=node נותן req.query.q), ו-req.body מחזיק את הנתונים שנשלחו בגוף הבקשה. req.params ו-req.query מתמלאים בכל בקשה, אבל req.body נשאר undefined עד ש-body parser כמו app.use(express.json()) קורא אותו. ערכים ב-params וב-query הם תמיד מחרוזות.

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);

הבקשה הראשונה עונה {"params":{"userId":"7"},"query":{"sort":"new","limit":"2"}}. שימו לב למרכאות: 7 ו-2 הם מחרוזות, אז המירו אותם עם Number() לפני שאתם עושים חשבון או משווים למספרים. עכשיו החליפו את ה-method ל-POST, השאירו את הנתיב /users/7/posts ושלחו את הגוף {"title": "Hello", "draft": true}: התשובה היא 201 עם "body":{"title":"Hello","draft":true}, ושם true הוא בוליאני אמיתי, כי הוא הגיע מ-JSON.

req.params מול req.query מול req.body

ל-route יכולים להיות כמה פרמטרים, וכל שם הופך למפתח של req.params: ‏/teams/:teamId/members/:memberId נותן את שני ה-ids. גם מקף או נקודה מפרידים ביניהם, כך ש-/flights/:from-:to הופך את /flights/LAX-SFO ל-{ from: 'LAX', to: 'SFO' }.

req.query עם מפתחות חוזרים וחסרים

מפתח שמופיע פעמיים הופך למערך, ומפתח שחסר הוא undefined, אז תנו לאפשרויות ברירת מחדל:

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);

התשובה היא {"page":1,"tags":["red","sale"],"raw":{"tag":["red","sale"]}}. שלחו GET /products?tag=red&page=3 ו-tags עדיין מערך, ["red"], כי [].concat() הופך מחרוזת בודדת או מערך למערך. Express 5 מפענח query strings עם הפענוח הפשוט של Node, כך ש-?filter[size]=m נותן את המפתח "filter[size]" ולא אובייקט מקונן; Express 4 קינן אותו.

req.body צריך את express.json()

Node מעביר את הגוף כ-stream של בייטים. express.json() קורא אותו, מפענח אותו ומגדיר את req.body, אבל רק כשלבקשה יש Content-Type: application/json. טפסי HTML שולחים application/x-www-form-urlencoded, ושם צריך את 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);

שלחו POST /signup עם הגוף {"email": "ada@example.com"} ותקבלו 201 עם {"email":"ada@example.com","name":"anonymous"}. שלחו גוף ריק ותקבלו 400. ה-?? {} חשוב: בלעדיו, destructuring של undefined זורק TypeError בכל בקשה שאין לה גוף JSON. לבדיקה אמיתית של המבנה והטיפוסים, השתמשו בספריית schemas כמו zod.

req.headers ו-req.get()

req.headers הוא אובייקט של כל ה-headers של הבקשה, עם שמות באותיות קטנות. req.get(name) קורא header אחד ומתעלם מגודל האותיות, כך ש-req.get('Content-Type') ו-req.get('content-type') מחזירים את אותו ערך. עוד כמה מאפיינים שתשתמשו בהם:

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 הוא /whoami ו-originalUrl הוא /whoami?debug=1. הוסיפו בשורת הבקשה את ה-header ‏Authorization: Bearer abc ושלחו שוב: token הופך ל-"Bearer abc". בתוך router שמחובר עם app.use('/api', router), ‏req.path מאבד את ה-prefix ‏/api ואילו req.originalUrl שומר אותו (ניתוב ב-Express מסביר את החיבור).

טעויות נפוצות

קריאת req.body בבקשת GET. דפדפנים ורוב הלקוחות לא שולחים גוף עם GET. שימו את האפשרויות של GET ב-query string.

בדיקה של דגל ב-query לפי truthiness. ?admin=false נותן את המחרוזת 'false', שהיא truthy, ולכן if (req.query.admin) עובר. השוו מחרוזות: req.query.admin === 'true'.

שליחת JSON בלי ה-header. לקוח ששולח JSON כ-text/plain מקבל req.body === undefined. הגדירו Content-Type: application/json בצד הלקוח.