當前位置：首頁 > 科技 > 軟件

Qs 和 Querystring：解析和格式化 URL query 字符串的工具庫

來源：責編：時間：2024-01-02 09:27:53 223觀看

導讀今天介紹兩個庫 qs、querystring，但是作用一樣，都是用來解析和格式化 URL query 字符串（URL query string）的工具庫。背景在學習 express 的中間件 body-parser 的文檔[1]時，bodyParser.urlencoded([options]) 的 options

今天介紹兩個庫 qs、querystring，但是作用一樣，都是用來解析和格式化 URL query 字符串（URL query string）的工具庫。

背景

在學習 express 的中間件 body-parser 的文檔[1]時，bodyParser.urlencoded([options]) 的 options 參數有一個 extended 參數，是個布爾值。

// parse application/x-www-form-urlencodedapp.use(bodyParser.urlencoded({ extended: false }))// parse application/x-www-form-urlencodedapp.use(bodyParser.urlencoded({ extended: true }))

extended 控制 body-parser 內部在解析 URL query 字符串時，內部使用哪個工具庫：

為 false 時，body-parser 內部使用的是 querystring（只支持單層對象和數組的解析）
為 true 時，body-parser 內部使用的是 qs（能支持嵌套對象和數組的解析）

extended 默認值雖然為 true，但這個默認值已被棄用了。我們需要學習 qs 和 querystring 之間的區(qū)別并選擇適當的進行設置。

我們下面就分別來學習。

querystring

querystring 開始是一個三方工具庫，后面內置到了 Node.js 中[2]，querystring 支持單層對象和數組的解析和格式化

你可以通過下列方式引用 querystring：

const querystring = require('node:querystring');

querystring 提供的核心方法就 2 個：.parse() 和 .stringify() 有點類似與 JSON.parse()/JSON.stringify()。

querystring.parse()

.parse() 用來將 URL query 字符串轉換成對象和數組。

const querystring = require('node:querystring'); querystring.parse('foo=bar&abc=xyz') // { foo: 'bar', abc: 'xyz'  }

URL query 字符串中，鍵值對采用 = 連接，每個鍵值對之間采用 & 連接。

如果 URL query 字符串包含一樣的鍵名，那么會作為數組解析。

const querystring = require('node:querystring'); querystring.parse('foo=bar&abc=xyz&abc=123')/*{  "foo": "bar",  "abc": ["xyz", "123"]}*/

.parse() 方法的完整語法是：querystring.parse(str[, sep[, eq[, options]]]) 。

第 2 個參數 sep 用于控制鍵值對之間的間隔，默認值 '&'
第 3 個參數 eq 用于控制鍵值之間的間隔，默認值 '='

const querystring = require('node:querystring'); querystring.parse('foo:bar;abc:xyz;abc:123', ';', ':')/*{  "foo": "bar",  "abc": ["xyz", "123"]}*/

querystring.stringify()

.stringify() 用來將對象或數組轉換成 URL query 字符串，是 .parse() 方法的逆向操作。

querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' });// Returns 'foo=bar&baz=qux&baz=quux&corge='

.stringify() 方法的完整語法是：querystring.stringify(obj[, sep[, eq[, options]]])。

第 2 個參數 sep 用于控制鍵值對之間的間隔，默認值 '&'
第 3 個參數 eq 用于控制鍵值之間的間隔，默認值 '='

querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' }, ';', ':');// Returns 'foo:bar;baz:qux;baz:quux;corge:'

qs

qs[3] 是對 querystring 工具庫的擴展，能支持嵌套對象和數組的解析和格式化。

qs.parse()

.parse() 用來將 URL query 字符串轉換成對象和數組·。

var qs = require('qs');qs.parse('foo=bar&abc=xyz') // { foo: 'bar', abc: 'xyz'  }qs.parse('a=b&a=c') // { a: ['b', 'c'] }qs.parse('a[]=b&a[]=c') // { a: ['b', 'c'] }

可以發(fā)現(xiàn)，qs.parse() 對數組的解析是兼容 querystring.parse() 的，還可以在鍵中使用 [] 指定顯式指定是數組。

此外，qs.parse() 還支持嵌套對象的解析。

qs.parse('foo[bar]=baz')/*{    foo: {        bar: 'baz'    }}*/qs.parse('foo[bar][baz]=foobarbaz')/*{    foo: {        bar: {            baz: 'foobarbaz'        }    }}*/

鍵部分，[nestedProp] 中的 nestdProp 會被看作嵌套屬性解析。

不過為了減少這個功能的濫用，qs.parse() 默認設置了 5 層的深度限制，可以通過 depth option 重置。

qs.parse('a[b][c][d][e][f][g][h][i]=j')/*{    a: {        b: {            c: {                d: {                    e: {                        f: {                            '[g][h][i]': 'j'                        }                    }                }            }        }    }}*/qs.parse('a[b][c][d][e][f][g][h][i]=j', { depth: 1 })/*{ a: { b: { '[c][d][e][f][g][h][i]': 'j' } } }*/

qs 嵌套屬性語法跟數組語法是重復的。數組中的索引和對象中的鍵之間的唯一區(qū)別是括號之間的值必須是數字才能創(chuàng)建數組，否則就是對象。

qs.parse('a[1]=c&a[0]=b') // { a: ['b', 'c'] }qs.parse('foo[bar]=baz') // { foo: { bar: 'baz' } }

不過為了減少這個功能的濫用，qs.parse() 默認將數組中指定的索引值限制到最大 20 ，任何索引大于 20 的索引都會作為對象屬性使用。可以通過 arrayLimit option 重置。

qs.parse('a[100]=b') // { a: { '100': 'b' } }qs.parse('a[1]=b', { arrayLimit: 0 }) // { a: { '1': 'b' } }

qs.stringify()

qs.stringify() 用來將對象或數組轉換成 URL query 字符串，是 qs.parse() 方法的逆向操作。

qs.stringify({ a: 'b' }) // 'a=b'qs.stringify({ a: { b: 'c' } }) // 'a%5Bb%5D=c'

字符串化時，qs 默認對 URI 進行編碼輸出。當然，也可以通過指定 encode option 設置成 false 指定不用編碼。

qs.stringify({ a: { b: 'c' } }, { encode: false }) // a[b]=c

還有字符串化數組。

qs.stringify({ a: ['b', 'c', 'd'] }) // 'a[0]=b&a[1]=c&a[2]=d'

注意，這里跟 querystring.stringify() 不同的是，數組默認會賦予索引標識（[]），可以通過將 indices option 設置為 false 來覆蓋此設置。

qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false })// 'a=b&a=c&a=d'

delimiter 選項參數

qs.stringify()/qs.parse() 還支持通過 delimiter 選項參數自定義鍵值對分隔符。

qs.parse('a=b;c=d', { delimiter: ';' }) // { a: 'b', c: 'd' }

不過，目前并不支持自定義鍵值之間的分隔符。

總結

本文介紹了兩個庫：qs 和 querystring。他們作用是一樣的，都是用來解析和格式化 URL query 字符串的工具庫。

qs 是對 querystring 工具庫的擴展。querystring 支持單層對象和數組的解析和格式化；而 qs 則能支持嵌套對象和數組的解析和格式化。如果 URL query 字符串不是那種嵌套結構，那么使用 Node.js 內置的 querystring 模塊就夠了。

對應到 express 的 body-parser 中間件的使用，那就是在調用 bodyParser.urlencoded() 時，extended 選項設置成 false 就夠了。

// express v4.16.0 之前// ===var express = require('express')var bodyParser = require('body-parser')var app = express()// create application/x-www-form-urlencoded parservar urlencodedParser = bodyParser.urlencoded({ extended: false })// POST /login gets urlencoded bodiesapp.post('/login', urlencodedParser, function (req, res) {  res.send('welcome, ' + req.body.username)})// express v4.16.0 之后（包含）// ===var express = require('express')var app = express()// create application/x-www-form-urlencoded parservar urlencodedParser = express.urlencoded({ extended: false })// POST /login gets urlencoded bodiesapp.post('/login', urlencodedParser, function (req, res) {  res.send('welcome, ' + req.body.username)})

希望本文內容對你有所幫助，感謝閱讀，Happing Coding！

參考資料

[1]body-parser 的文檔:https://www.npmjs.com/package/body-parser#body-parser

[2]內置到了 Node.js 中:https://nodejs.org/api/querystring.html

[3]qs:https://www.npmjs.com/package/qs

本文鏈接：http://www.www897cc.com/showinfo-26-54993-0.htmlQs 和 Querystring：解析和格式化 URL query 字符串的工具庫

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯(lián)系，我們將在第一時間刪除處理。郵件：2376512515@qq.com

上一篇：用RASP五步輕松保護云端無服務器架構

下一篇：多人多團隊應該如何實施微服務？版本如何管理？

標簽：

熱門焦點

一加Ace2 Pro真機揭曉鈦空灰配色質感拉滿

終于，在經過了幾波預熱之后，一加Ace2 Pro的外觀真機圖在網上出現(xiàn)了。還是博主數碼閑聊站曝光的，這次的外觀設計還是延續(xù)了一加11的方案，只是細節(jié)上有了調整，例如新加入了鈦空灰
把LangChain跑起來的三個方法

使用LangChain開發(fā)LLM應用時，需要機器進行GLM部署，好多同學第一步就被勸退了，那么如何繞過這個步驟先學習LLM模型的應用，對Langchain進行快速上手？本片講解3個把LangChain跑起來
自律，給不了Keep自由！

來源 | 互聯(lián)網品牌官作者 | 李大為編排 | 又耳審核 | 谷曉輝自律能不能給用戶自由暫時不好說，但大概率不能給Keep自由。近日，全球最大的在線健身平臺Keep正式登陸港交所，努力
網傳小米汽車開始篩選交付中心建筑面積不低于3000平方米

7月7日消息，近日有微博網友@長三角行健者爆料稱，據經銷商集團反饋，小米汽車目前已經開始了交付中心的篩選工作，要求候選場地至少有120個車位，建筑不能低
華為開發(fā)者大會2023日程公開：開設鴻蒙HarmonyOS 4體驗區(qū)

IT之家 7 月 31 日消息，華為今日公布了 HDC.Together 開發(fā)者大會 2023 的詳細日程。整場大會將于 8 月 4 日-6 日之間舉行，屆時將發(fā)布最新一代鴻蒙 H
機構稱Q2國內智能手機銷量同比下滑4% vivo份額重回第1

7月29日消息，根據市場調查機構Counterpoint Research公布的最新報告，2023年第2季度中國智能手機銷量同比下降4%，創(chuàng)新自2014年以來第2季度銷量新低。報
華為HarmonyOS 4.0將于8月4日發(fā)布或搭載AI大模型技術

華為宣布HarmonyOS4.0將于8月4日正式發(fā)布。此前，華為已經針對開發(fā)者公布了HarmonyOS4.0，以便于開發(fā)者提前進行適配，也因此被曝光出了一些新系統(tǒng)的特性
三星折疊屏手機去年銷售近1000萬臺今年目標定為1500萬

7月29日消息，三星率先發(fā)力可折疊手機市場，在全球市場已經取得了非常亮眼的成績，接下來會進一步鞏固和擴大這一優(yōu)勢。三星在推出Galaxy Z Flip5和Galax
上海舉辦人工智能大會活動，建設人工智能新高地

人工智能大會在上海浦江兩岸隆重拉開帷幕，人工智能新技術、新產品、新應用、新理念集中亮相。8月30日晚，作為大會的特色活動之一的上海人工智能發(fā)展盛典人工

日韩成人免费在线_国产成人一二_精品国产免费人成电影在线观..._日本一区二区三区久久久久久久久不

Qs 和 Querystring：解析和格式化 URL query 字符串的工具庫

背景

querystring

querystring.parse()

querystring.stringify()

qs

qs.parse()

qs.stringify()

delimiter 選項參數

總結

參考資料

一加Ace2 Pro真機揭曉鈦空灰配色質感拉滿

把LangChain跑起來的三個方法

自律，給不了Keep自由！

網傳小米汽車開始篩選交付中心建筑面積不低于3000平方米

華為開發(fā)者大會2023日程公開：開設鴻蒙HarmonyOS 4體驗區(qū)

機構稱Q2國內智能手機銷量同比下滑4% vivo份額重回第1

華為HarmonyOS 4.0將于8月4日發(fā)布或搭載AI大模型技術

三星折疊屏手機去年銷售近1000萬臺今年目標定為1500萬

上海舉辦人工智能大會活動，建設人工智能新高地

最新推薦

猜你喜歡

熱門推薦

相關資訊