在Node.js的Express.js中获取GET（查询字符串）变量的方法

技术背景

在Web开发中，经常需要从URL的查询字符串中获取参数。在Node.js的Express.js框架里，有多种方式可以实现获取GET请求中的查询字符串变量。理解这些方法能帮助开发者更好地处理客户端发送的请求，实现业务逻辑。

实现步骤

1. 使用Express.js的req.query获取查询字符串参数

在Express.js中，req.query可以直接获取查询字符串中的参数。示例代码如下：

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

app.get('/', function(req, res){
  res.send('id: ' + req.query.id);
});

app.listen(3000);

2. 使用Node.js的url模块手动解析

若不使用Express.js，可通过Node.js的url模块手动解析URL。示例代码如下：

var http = require('http');
var url = require('url');

http.createServer(function(req, res){
    var url_parts = url.parse(req.url, true);
    var query = url_parts.query;
    console.log(query); 
    res.end("End");
}).listen(3000);

3. 使用req.params获取路由参数

req.params用于获取路由中的参数，而非查询字符串参数。示例代码如下：

app.get('/user/:id', function(req, res) {
    res.send('user' + req.params.id);    
});

4. 使用解构赋值获取查询参数（ES6语法）

在ES6中，可以使用解构赋值从req.query中获取参数。示例代码如下：

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

app.get('/', function(req, res){
    const {id, since, fields, anotherField} = req.query;
});

app.listen(3000);

核心代码

获取查询字符串参数

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

app.get('/', function(req, res){
    const {id} = req.query;
    res.send(`id: ${id}`);
});

app.listen(3000);

手动解析URL获取查询参数

var http = require('http');
var url = require('url');

http.createServer(function(req, res){
    var url_parts = url.parse(req.url, true);
    var query = url_parts.query;
    res.writeHead(200);
    res.write(JSON.stringify(query));
    res.end();
}).listen(3000);

最佳实践

• 使用req.query：在Express.js中，优先使用req.query来获取查询字符串参数，它能简化代码，提高开发效率。
• 参数类型转换：查询或路径参数通常是字符串类型，若需要数字类型，需显式转换，如使用parseInt()或Number()。
• 统一参数类型：由于查询字符串参数可能是字符串或数组，可通过重写查询解析器来统一参数类型。示例代码如下：

const express = require("express");
const app = express();
const querystring = require("querystring");

const asArray = false;
app.set("query parser", (qs) => {
    const parsed = querystring.parse(qs);
    return Object.entries(parsed).reduce((previous, [key, value]) => {
        const isArray = Array.isArray(value);
        if (!asArray && isArray) {
            value = value[0];
        } else if (asArray && !isArray) {
            value = [value];
        }

        previous[key] = value;
        return previous;
    }, {});
});

app.get("/", function (req, res) {
    res.send(`Your name is ${(req.query.name || "").length} characters long`);
});

app.listen(3000);

常见问题

1. req.params和req.query的区别

req.params用于获取路由中的参数，如/user/:id中的id；而req.query用于获取查询字符串中的参数，如?id=123中的id。

2. 查询参数类型问题

查询参数可能是字符串或数组，可通过重写查询解析器来统一类型，避免因类型不一致导致的问题。

3. req.param()已被弃用

在Express 4中，req.param()已被弃用，建议直接使用req.query、req.params或req.body来获取参数。