DIV CSS 佈局教程網

Node.js 中 URL 字串與查詢字串的互相轉換詳解
編輯:關於JavaScript     

在處理 HTTP 請求時,「路徑」與「查詢參數」的轉換是日常操作。Node.js 內建的 querystring 與 url 兩個模組把這件事做得非常乾淨。

一、什麼是查詢字串

一段完整 URL 中,從 ?(不含)開始,到 #(若有)或字串結尾這一段,就是查詢字串。例如 ?username=guoyansi&age=40。

二、querystring.parse:字串轉物件

語法:

querystring.parse(str, [sep], [eq], [options])
  • str:待轉換的查詢字串
  • sep:參數分隔符,預設 &
  • eq:鍵值賦值符,預設 =
  • options.maxKeys:限制解析出的屬性數量,設為 0 等同不限制
var querystring = require("querystring");
var str = "username=guoyansi&age=40&sex=male";

var res = querystring.parse(str);
console.log("1:%j", res); // 1:{"username":"guoyansi","age":"40","sex":"male"}

res = querystring.parse(str, "!");
console.log("2:%j", res); // 2:{"username":"guoyansi&age=40&sex=male"}

res = querystring.parse(str, "&");
console.log("3:%j", res); // 3:{"username":"guoyansi","age":"40","sex":"male"}

str = "username=guoyansi!age=40!sex=male";
res = querystring.parse(str, "!");
console.log("4:%j", res); // 4:{"username":"guoyansi","age":"40","sex":"male"}

res = querystring.parse(str, "!", "=");
console.log("5:%j", res); // 5:{"username":"guoyansi","age":"40","sex":"male"}

res = querystring.parse(str, "!", ":");
console.log("6:%j", res); // 6:{"username=guoyansi":"","age=40":"","sex=male":""}

res = querystring.parse(str, "!", "=", { maxKeys: 2 });
console.log("7:%j", res); // 7:{"username":"guoyansi","age":"40"}

可以清楚看到:sep 與 eq 決定「怎麼切」與「怎麼配」,而 maxKeys 則是效能與安全上的保險絲,避免惡意超長參數把記憶體吃光。

三、querystring.stringify:物件轉字串

querystring.stringify(obj, [sep], [eq])
var querystring = require("querystring");

var res = querystring.stringify({ username: "guoyansi", age: "40", sex: "male" });
console.log(res); // username=guoyansi&age=40&sex=male

res = querystring.stringify({ username: "guoyansi", age: "40", sex: "male" }, "!");
console.log(res); // username=guoyansi!age=40!sex=male

res = querystring.stringify({ username: "guoyansi", age: "40", sex: "male" }, "&", ":");
console.log(res); // username:guoyansi&age:40&sex:male

res = querystring.stringify({ username: "guoyansi", age: ["40", "24"] }, "&", "=");
console.log(res); // username=guoyansi&age=40&age=24

最後一個例子值得注意:當某個鍵對應陣列時,會展開成多組同名參數,這是表單多選、標籤列表等場景的標準表達方式。

四、url.parse:拆解整個 URL

url 模組的 parse() 會把 URL 拆成結構化物件,各欄位含義如下:

  • href:原始 URL 字串
  • protocol:協議,如 http:
  • slashes:協議後是否使用 //
  • auth:認證資訊
  • host:主機名加埠號
  • hostname:僅主機名
  • port:埠號
  • pathname:路徑部分
  • search:含 ? 的查詢字串
  • query:不含 ? 的查詢字串,或解析後的物件
  • hash:含 # 的雜湊字串

語法:

url.parse(urlStr, [parseQueryString])

第二個參數為布爾值,為 true 時內部會呼叫 querystring 把查詢字串轉成物件,預設是 false。

var url = require("url");
var str = "https://user:pass@host.com:8080/users/user.php?username=sisi&age=24&sex=male#name1";
console.log(url.parse(str));

輸出:

{ protocol: 'http:',
  slashes: true,
  auth: 'user:pass',
  host: 'host.com:8080',
  port: '8080',
  hostname: 'host.com',
  hash: '#name1',
  search: '?username=sisi&age=24&sex=male',
  query: 'username=sisi&age=24&sex=male',
  pathname: '/users/user.php',
  path: '/users/user.php?username=sisi&age=24&sex=male',
  href: 'https://user:pass@host.com:8080/users/user.php?username=sisi&age=24&sex=male#name1' }

加上 true 之後,唯一的分別就是 query 變成了物件:

var res = url.parse(str, true);
console.log(res);
{ protocol: 'http:',
  // ...其餘欄位同上
  query: { username: 'sisi', age: '24', sex: 'male' },
  // ...
}

五、url.format:反向組回字串

把解析後的物件再組回 URL:

var url = require("url");
var str = "https://user:pass@host.com:8080/users/user.php?username=sisi&age=24&sex=male#name1";
var res = url.parse(str, true);
console.log(url.format(res));

結果:

https://user:pass@host.com:8080/users/user.php?username=sisi&age=24&sex=male#name1

實務提醒

新版 Node.js 已把 url.parse 標記為傳統 API,新專案建議改用 WHATWG 的 new URL() 與 URLSearchParams;querystring 若要處理更複雜的巢狀結構,也可評估 URLSearchParams。觀念是相通的:拆解、取用、再組回。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved