JavaScriptのURLSearchParamsでクエリを取得し解析!

[PR]

JavaScript

WebページのURLに含まれるクエリパラメータを取得して解析したいと考えたことはありませんか。JavaScriptの標準APIであるURLSearchParamsを使えば、手軽にパラメータの取得、存在チェック、変形などが可能です。本記事ではその機能を余すところなく解説し、モダン環境での互換性や注意点にも触れています。初心者から中級者まで理解でき、すぐに使える実用的な内容です。

JavaScript URLSearchParams クエリ 取得 解析の基本とは

この章では、URLSearchParamsを使ったクエリの取得と解析の基本的な仕組みを説明します。URLSearchParamsはURLの?以降にあるクエリ文字列を取り扱う標準インターフェースで、キーと値の組を取得、検査、変更、削除など多彩な操作が可能です。特にgetやgetAll、hasといったメソッドによって、指定したキーの値を取得したり、重複するキーに対応できます。ここでは基本的なメソッドの使い方を中心に解説し、初めて使う人にも理解できるよう丁寧に解説します。

URLSearchParamsとは何か

URLSearchParamsはURL構造を扱うWHATWGの仕様に含まれる機能で、クエリ文字列を簡単に処理できるインターフェースです。URL全体を解析するURLオブジェクトと組み合わせて使われ、クエリ部分だけを抽出してオブジェクトとして操作できます。文字列で表現されたクエリからキーと値のペアを取得したり、順序を保ったまま反復処理できるなど、直感的なAPIが揃っています。このため、手動で文字列をsplitしたり正規表現を使ったりするよりも安全で可読性が高いコードを書くことができます。

基本的な取得メソッド:get, getAll, has

取得メソッドでまず注目すべきはgetです。これは指定したキーの最初の値を返し、該当しない場合はnullを返します。そのため、値が重複する可能性があればgetAllを使うことで配列で全ての値を取得可能です。さらにhasを使えばそのキーが存在するかどうかを真偽値で判定でき、存在チェックには非常に便利です。いずれのメソッドも、値のデコード(パーセントエンコードの展開など)まで自動で処理されるため、取り扱いが容易です。

文字列からの解析とURLオブジェクトを使う方法

URLSearchParamsのコンストラクタには複数のパターンがあります。まず、URLオブジェクトのsearchプロパティ(?以降の文字列)を渡す方法。これにより完全なURL解析をしつつ、クエリ部分だけを扱えます。あるいは「query=値&another=他値」のようなクエリ文字列を直接渡す方法もあります。この場合、先頭の?はあってもなくても処理できます。それに加えて、オブジェクトや配列のペアから生成することも可能で、システム内で動的にパラメータを構築したいときに役立ちます。

応用メソッド:append, set, delete, toString

取得だけでなく、URLSearchParamsには変更系のメソッドも充実しています。appendでは同じキーで複数の値を追加可能です。setは既存の値を上書きして一つの値のみにします。deleteでキーとその値を完全に消去できます。最後にtoStringで現在の状態をクエリ文字列として取得できます。これらを使いこなすことで、動的なリンク生成やURL操作など幅広い用途に対応できるようになります。

実践例:クエリ取得と解析のステップとコード

この章では、具体的なコード例を通じて、クエリ文字列を取得し解析するステップを順を追って見ていきます。読み手が実際に手を動かす際に参考になるよう、分かりやすいサンプルコードとそれに伴う解説を含めています。また、値の重複、存在しないキーへのアクセス、エンコード・デコードなどの注意点にも触れます。これにより、日常的な開発で直面するケースを網羅します。

現在のページURLからキーと値を取得する方法

例として、ブラウザ画面で見ているページのURLからクエリを取得する方法があります。window.location.searchを使って?以降のクエリを文字列として取得し、それをURLSearchParamsのコンストラクタに渡します。その後get(‘key’)で値を取得し、parseIntなどで数値に変換することも可能です。存在しないキーにはnullが返るため、そのチェックも忘れずに書きます。これが最も基本的な使い方です。

キーが重複する場合の処理例

タグフィルターなどで同じキーが複数回現れる場合、getでは最初の値のみ返されますが、getAllを使えば全ての値が配列で取得できます。例えば?tag=js&tag=react&tag=webのようなクエリに対し、getAll(‘tag’)を使うことで配列として[‘js’,’react’,’web’]が得られます。その応用として、チェックボックス形式のUIで複数選択された値をURLに反映させる処理にも使えます。

生成と編集:appendやsetでURLを動的に組み立てる例

例えば検索機能でフィルターを追加したり、ページ遷移時にクエリを変更したいケースがあります。appendを使って既存のパラメータに新しいキーと値を追加し、keyが重複する場合にはsetで一つの値だけに制限するなどの戦略がとれます。またdeleteで不要なパラメータを削除できます。その結果、toStringで完成したクエリ文字列を得て、それをlocation.hrefなどに組み込むことで即時反映が可能になります。

欠点・互換性・注意点:より堅牢に使うために

URLSearchParamsは非常に便利ですが、全てのブラウザで仕様が揃っているわけではありません。この章では対応状況や仕様の落とし穴、ブラウザ間の違い、エンコードに関する注意点などを説明し、コードの堅牢性を高めるための対応策を提示します。特に古いブラウザやIEへの対応が必要な環境で働く場合は必ず確認すべき内容です。

ブラウザ互換性の現状とポリフィル

URLSearchParamsは主なモダンブラウザではサポートされています。Chromeでは49以降、Firefoxでは29以降、Safariでは10.1以降などで動作確認されており、iOSにおいても同様です。ただしInternet Explorerにはサポートがなく、その環境下で使うならpolyfillを導入するか代替の文字列処理を行う必要があります。ユーザーの利用環境を把握して、フォールバックを用意することが重要です。

エンコード・デコードの挙動と注意点

URLSearchParamsはapplication/x-www-form-urlencoded方式に準拠し、空白は「+」に変換され、特殊文字や非ASCII文字はパーセントエンコードされます。パーセントエンコード済みクエリを解析する際にはgetなどで自動的にデコードされて取得できますが、+と空白の扱い、文字列に既にエンコードが含まれている場合の二重エンコード等に注意が必要です。文字列を直接操作する際はencodeURIComponentを使う判断も必要です。

サポートされていないプロパティやメソッド、サイズプロパティなど

標準的なメソッドはほぼ全てのモダンブラウザで使えますが、比較的新しいプロパティであるsizeなどはまだ完全には普及していません。古いブラウザではsizeが存在しなかったり、挙動が異なったりします。sortメソッドのサポート状況も条件によって異なることがあり、その場合は独自のソート処理を行うなど対応が必要です。ブラウザのバージョンチェックやfeature detectionを予め組むことが望ましいです。

応用編:実用的なユースケースとパターン

この章では実際の開発でよくあるパターンや応用例を紹介します。例えば検索フィルター、ページネーション、パラメータの共有/保持、リンク生成などです。さらにReactやNodeなどでの扱い方も簡単に触れます。コード例を通して、「取得」「解析」「編集」「反映」に至る一連の流れが理解できるようにしています。

検索フィルターやタグ付きリストでの利用

例えば商品一覧やブログの一覧ページでタグやカテゴリーで絞り込むUIがある場合、クエリ文字列に選択されたタグを反映させて画面の状態を復元できるようにすることが重要です。ユーザーが複数タグを選択したらappendでタグを追加し、その状態をURLに反映。読み込み時にはgetAllで配列として取得し、選択された内容をUIに反映します。こうした仕組みによってユーザー体験が向上します。

ページネーションやソートとの組み合わせ

ページ番号やソート順をクエリに持たせることで、どのページを表示しているか、どの基準でソートしているかをURLで明示できます。例えば?page=2&sort=priceといった形式です。setを使ってページ番号を更新し、ソートキーを切り替えるなど動的操作が可能です。またlocation.href や history.pushState を使えばページ遷移と同時にURLのクエリも更新できます。

API呼び出しやサーバーとの連携

クライアント側でURLSearchParamsを用いてクエリを構築し、それをフェッチAPIやAjax呼び出しの際にURL末尾に付加するというパターンがあります。サーバー側でこのクエリを解析し、動的なレスポンスを返す設計に便利です。またフォーム送信時にGETメソッドを使うとURLにクエリが含まれるため、URLSearchParamsで構築された文字列をそのままフォームのactionに設定することも可能です。

まとめ

URLSearchParamsを使えば、JavaScriptでクエリ取得・解析・編集を簡潔に実装できます。get, getAll, has による取得と存在チェック、append や set による編集、delete による削除、toString で文字列化する基本操作は、どのプロジェクトでも有用です。特に複数値のキーや特殊文字を含む値を扱う機能は手動実装よりも信頼性が高いです。

ただし、Internet Explorer など古いブラウザではサポートされていないため、必要であればポリフィルを導入するか、代替処理を準備すべきです。エンコードや+記号の扱いにも気をつけ、仕様を十分理解して使うことが重要です。

クエリを使った検索フィルター、ページネーション、API の呼び出しなどで URLSearchParams を活用することで、コードが整理され、保守性が向上します。まずは基本を抑えて、応用シーンで自在に使えるようになることを目指して下さい。

まとめ

JavaScript の URLSearchParams を使うことで、URL のクエリ部分からパラメータを取得し解析する作業が効率的かつ安全になります。取得、存在確認、重複対応、編集、生成などの機能を組み合わせることで多くのユースケースに対応可能です。モダンなブラウザでは広くサポートされており、古い環境ではポリフィルが必要なことを念頭においておけば安心です。

関連記事

特集記事

コメント

この記事へのトラックバックはありません。

TOP
CLOSE