URLSearchParams API предоставляет согласованный интерфейс для работы с частями URL и позволяет легко манипулировать строкой запроса (тем, что идет после ?).
Обычно разработчики используют регулярные выражения и разделение строк, чтобы извлечь параметры запроса из URL. Если быть честными, это не очень весело.
Это может быть утомительно и чревато ошибками. Один из моих секретов заключается в том, что я повторно использовал одни и те же get|set|removeURLParameter вспомогательные методы в нескольких крупных приложениях Google.com, включая Радар Санта-Клауса и веб-приложение Google I/O 2015.
Пришло время для правильного API, который делает это за нас!
URLSearchParams API
В Chrome 49 реализован метод URLSearchParams из спецификации URL – API, который полезен для работы с параметрами запросов URL. Я считаю, что URLSearchParams так же удобен для URL, как FormData для форм.
Что же можно сделать с помощью этого инструмента? Из строки URL можно легко извлечь значения параметров:
// Can also constructor from another URLSearchParams
const params = new URLSearchParams('q=search+string&version=1&person=Eric');
params.get('q') === "search string"
params.get('version') === "1"
Array.from(params).length === 3
for (let p of params) {
console.log(p);
}
Задать значение параметра.
params.set('version', 2);
добавить ещё одно значение для существующего параметра;
params.append('person', 'Tim');
params.getAll('person') === ['Eric', 'Tim']
удалить один или несколько параметров;
params.delete('person');
Работа с URL
В большинстве случаев вы будете работать с полными URL или изменять URL приложения. Конструктор URL может быть особенно полезен в следующих случаях:
const url = new URL('https://example.com?foo=1&bar=2');
const params = new URLSearchParams(url.search);
params.set('baz', 3);
params.has('baz') === true
params.toString() === 'foo=1&bar=2&baz=3'
Чтобы изменить URL, вы можете получить параметры, обновить их значения, а затем использовать history.replaceState для обновления URL.
// URL: https://example.com?version=1.0
const params = new URLSearchParams(location.search);
params.set('version', 2.0);
window.history.replaceState({}, '', `${location.pathname}?${params}`);
// URL: https://example.com?version=2.0
Здесь я использовал шаблонные строки ES6, чтобы создать обновленный URL на основе существующего пути URL приложения и измененных параметров.
Интеграция с другими местами, где используются URL
По умолчанию при отправке FormData в запросе к API fetch() создается тело, состоящее из нескольких частей.
Если вам это необходимо, URLSearchParams предоставляет альтернативный механизм для отправки данных POST, закодированных в URL, а не в формате MIME multipart.
const params = new URLSearchParams();
params.append('api_key', '1234567890');
fetch('https://example.com/api', {
method: 'POST',
body: params
}).then(...)
Хотя это ещё не реализовано в Chrome, URLSearchParams также интегрируется с конструктором URL и тегами a. Оба поддерживают наш новый buddy, предоставляя свойство только для чтения .searchParams для доступа к параметрам запроса:
const url = new URL(location);
const foo = url.searchParams.get('foo') || 'somedefault';
У ссылок также есть свойство .searchParams:
const a = document.createElement('a');
a.href = 'https://example.com?filter=api';
// a.searchParams.get('filter') === 'api';
Определение функций и поддержка браузеров
В настоящее время URLSearchParams поддерживается в Chrome 49, Firefox 44 и Opera 36.
if ('URLSearchParams' in window) {
// Browser supports URLSearchParams
}
Для полифилов я рекомендую использовать github.com/WebReflection/url-search-params.
Демоверсии
Попробуйте пример.
Чтобы посмотреть, как URLSearchParams работает в реальном приложении, ознакомьтесь с генератором наборов значков в стиле Material Design от Polymer. Я использовал его, чтобы настроить начальное состояние приложения по ссылке на контент. Очень удобно :)