JavaScript / コードを試す
URL のクエリ文字列を読む・組み立てる
自分で split() しないでください。URLSearchParams が符号化も復号も同じ値の複数指定も扱います。必ず文字列で返ること、空とキー無しの見分け、+ と %20 の違いまで実行して確かめます。
固定例はNode 24.22.3の実行記録を照合しています()。下の入力欄の結果は今回の実行で確認してください。
コードを編集して試す
ブラウザー内で実行します。コードの送信・自動実行・自動保存はしません。このタブを閉じると入力は失われます。機密情報は入力しないでください。
8,192 UTF-8 byte・実行1.5秒・出力60行/8KiB以内。Ctrl / ⌘ + Enterでも実行できます。
パネルを開くと編集できます。
現在の入力は未実行です。
入力中のコードをこの例へ置き換えます。
実行画面や検索画面の間の通常クリックでは入力をこのタブのRAMで保持します。元の教材は別タブで開きます。再読み込み・タブ終了ではRAMの入力は失われます。
答え
split() で自分で分解しないでください。
const params = new URLSearchParams('?q=猫&page=2'); console.log(params.get('q')); console.log(params.get('page'));
猫 2
先頭の ? は付いていても付いていなくても構いません。
復号は自動です。%E7%8C%AB のままにはなりません。
これは言語ではなくブラウザ側の仕様(URL Standard)ですが、Node にも同じものが入っています。どちらでも同じように使えます。
値は必ず文字列で返る
const params = new URLSearchParams('page=2');
const page = params.get('page');
console.log(typeof page);
console.log(page + 1);string 21
足し算のつもりが繋がりました。 数として使うなら、その場で変換してください。
const params = new URLSearchParams('page=2'); const page = Number(params.get('page')); console.log(page + 1);
3
無いキーは null
const params = new URLSearchParams('a=&b=1'); console.log(JSON.stringify(params.get('a'))); console.log(JSON.stringify(params.get('none'))); console.log(params.has('a'), params.has('none'));
"" null true false
「空で指定されている」と「そもそも無い」は別です。
get() だけでは見分けられないので、has() を使ってください。
既定値を入れるときも、この差が効きます。
const params = new URLSearchParams('keyword=');
console.log(JSON.stringify(params.get('keyword') || 'すべて'));
console.log(JSON.stringify(params.get('keyword') ?? 'すべて'));"すべて" ""
|| は空文字も既定値に倒します。どちらが正しいかは仕様しだいです。
→ ?. と ??
同じキーが複数あるとき
const params = new URLSearchParams('tag=a&tag=b'); console.log(params.get('tag')); console.log(params.getAll('tag'));
a [ 'a', 'b' ]
get() は最初の1つしか返しません。
チェックボックスのように複数付きうるものは、必ず getAll() です。
組み立てる
const params = new URLSearchParams({ q: '猫 犬', page: '2' }); console.log(params.toString());
q=%E7%8C%AB+%E7%8A%AC&page=2
符号化も自動です。 encodeURIComponent() を自分で呼ぶ必要はありません。
| したいこと | 使うもの |
|---|---|
| 足す(同じキーを増やす) | append() |
| 置き換える(同じキーは1つに) | set() |
| 消す | delete() |
const params = new URLSearchParams({ page: '2' }); params.append('tag', 'a'); params.append('tag', 'b'); console.log(params.toString()); params.set('tag', 'c'); console.log(params.toString()); params.delete('page'); console.log(params.toString());
page=2&tag=a&tag=b page=2&tag=c tag=c
set() は同じキーを全部まとめて1つにします。 増やしたいなら append() です。
URL ごと組み立てる
const url = new URL('https://codetaizen.com/ja/search/?q=1'); url.searchParams.set('q', '猫'); url.searchParams.set('page', '2'); console.log(url.toString()); console.log(url.pathname, url.origin);
https://codetaizen.com/ja/search/?q=%E7%8C%AB&page=2 /ja/search/ https://codetaizen.com
url.searchParams を触ると、url 自身も書き換わります。
文字列を繋いで組み立てるより、こちらのほうが安全です。
スペースが + になる
console.log(new URLSearchParams({ a: 'x y' }).toString()); console.log(encodeURIComponent('x y'));
a=x+y x%20y
同じスペースでも書き方が2つあります。
クエリ文字列では + が歴史的に使われ、URLSearchParams はそちらを選びます。
読むときはどちらも正しく戻ります。
console.log(new URLSearchParams('a=x+y').get('a')); console.log(new URLSearchParams('a=x%20y').get('a'));
x y x y
自分で encodeURIComponent() した文字列を、さらに set() に渡さないでください。
二重に符号化され、%2520 のような形になります。
よくある間違い:split() で自分で分ける
const query = 'q=%E7%8C%AB&tag=a&tag=b';
const parsed = Object.fromEntries(query.split('&').map((part) => part.split('=')));
console.log(parsed);{ q: '%E7%8C%AB', tag: 'b' }2つ壊れています。
- 復号されないので
%E7%8C%ABのまま - 同じキーが後ろで上書きされて 1つ消えた
値の中に = が入っていれば、そこでも切れます。
自分で書かないでください。
まとめ
- クエリは
URLSearchParamsに任せる。split()で分けない - 返るのは必ず文字列。数として使うなら変換する
- 無いキーは
null、空指定は空文字。見分けるならhas() - 同じキーが複数あるなら
getAll() - 足すのは
append()、置き換えるのはset() - 符号化は自動。自分で符号化してから渡さない
- URL ごと扱うなら
new URL()のsearchParams