最常見的 URL 參數寫法就是這樣:
url?arg1=value1&arg2=value2&arg3=value3...
這種形式最普遍、最易懂,但在專案中,如果後面的參數是可變的、欄位有不同取值或不同語意時,它的可維護性與可讀性其實並不高,程式碼也容易重複或冗餘。
以下是一個對 CGI 的請求串:
var url = "https://www.tenpay.com/app/v1.0/juhui.cgi?";
var queryString = "method=2&page=index";
if (content a) { // 訪問的首頁區域 A,需要加參數 subpage
queryString += "&subpage=a";
} else if (content b) { // 如果訪問了區域 B,則 subpage 要變為 b
queryString += "&subpage=b";
}
if (spec_method) { // 若要按照指定的篩選方法查看,還需要加 spec_method
queryString += "&spec_method=1";
}
這是最常見的拼串邏輯。程式碼本身沒問題,但註解寫起來很麻煩,可讀性也不高,欄位說明不明確。如果需要替換某個欄位,或在既有基礎上更改邏輯,都相當不便——你得來回確認哪一段加了哪個參數、有沒有重複。
參考了同事的方案:把參數用物件形式存起來,再在請求時寫一個方法把它們拼起來。
var queryConfig = {
"page": "index",
"method": 2, // 1: 按照方法 A 查看 2: 按照方法 B 查看
"subpage": -1, // -1: 此條件不傳遞 a: 查看 contentA b: 查看 contentB
"spec_method": -1 // -1: 此條件不傳遞 1: 按照銷量高低 2: 按照時間
};
var setQueryConfig = function(){
var _str = "";
for (var o in queryConfig) {
if (queryConfig[o] != -1) { // -1 代表不傳遞
_str += o + "=" + queryConfig[o] + "&";
}
}
_str = _str.substring(0, _str.length - 1); // 去掉最後多餘的 &
return _str;
}
優點是所有參數都在物件中一目了然地列出,註解可以針對每個欄位寫得很詳細,可讀性與維護性都提升了。缺點是程式碼多了一些,還需要額外維護一個序列化方法。
這裡用 -1 作為「不傳遞」的哨兵值,是個實用的小約定,但也要注意:若某個欄位的合法值可能就是 -1,就會發生衝突。更嚴謹的做法是改用 undefined 或 null 判斷,語意更明確。
var queryString = [
"method=2", // method 欄位的註解
"page=index"
];
if (content a) { // 訪問的首頁區域 A,需要加參數 subpage
queryString.concat([
"subpage=a", // subpage 註解
]);
} else if (content b) { // 如果訪問了區域 B,則 subpage 要變為 b
queryString.concat([
"subpage=b", // subpage 註解
]);
}
if (spec_method) { // 若要按照指定的篩選方法查看,還需要加參數
queryString.concat([
"spec_method=2", // spec_method 註解
]);
}
queryString = queryString.join("&");
可讀性可能略遜於物件方式,但維護性也不差,程式碼量更少。個人比較偏好這種。
不過這段程式碼有個 bug 值得指出:concat 並不會修改原陣列,而是回傳一個新陣列。因此 queryString.concat([...]) 的結果被丟掉了,參數實際上永遠不會被加進去。正確寫法應該是 queryString = queryString.concat([...]),或者直接用 queryString.push("subpage=a")。
今天有兩個標準答案可用。URLSearchParams 專為此而生:
var params = new URLSearchParams();
params.append("method", 2);
params.append("page", "index");
if (isContentA) params.append("subpage", "a");
var url = "https://example.com/app.cgi?" + params.toString();
它會自動處理編碼,也不必手動拼接 & 符號。若參數是現成的物件,一行就能搞定:
var url = "https://example.com/app.cgi?" + new URLSearchParams({method: 2, page: "index"});
值得一提的是,這篇筆記最有價值的部分其實不是程式碼本身,而是「程式碼審查能加速自身成長」這件事——這麼細微地方的優化,若不是有人指點,可能要工作很久之後才會自己察覺。