URLSearchParams: подредена работа с параметрите на адреса

Полезно е да знаеш

Частта след въпросителния знак в един адрес често съдържа параметри на заявката. Чрез тях сайтът може да представя избрана страница, дума за търсене или подредба на резултатите. URLSearchParams предоставя методи за работа с тези двойки ключ и стойност. Вместо програмата ръчно да разрязва текста по различни знаци, тя може да прочита, добавя и премахва параметри чрез определен интерфейс. Това прави намерението на операцията по-лесно за разпознаване при преглед на кода. [1]

Свойството searchParams на обект URL предоставя достъп до декодираните параметри. [2] Методи като get, getAll, set и append имат различни задачи. Един ключ може да присъства повече от веднъж, а добавянето на още една стойност не е същото като замяната на съществуващата. [1] Преди избор на метод е полезно да се опише договорът на адреса. Позволява ли филтърът една категория или няколко? Представлява ли повтореният ключ очакван избор, или е нежелан вход?

Нека разгледаме измислен каталог за изложби. Посетителят избира град и тема, а после копира адреса на приятел. Желаното поведение може да бъде описано без програмен код: при отваряне на копирания адрес се възстановяват същите филтри. Това дава ясна задача за параметрите. За проверка можем да използваме град с интервал в името, празна дума за търсене и повече от една тема. Така се вижда дали адресът представя избора последователно и разбираемо.

Кодирането на символите е още една причина да не се разчита на ръчно слепване. URLSearchParams сериализира стойностите според определени правила, а интервалите могат да бъдат представени със знак плюс. [1] MDN отбелязва, че при обновяване чрез searchParams текстовото представяне на URL може да се промени дори когато стойностите изглеждат същите. [2] Затова сравнението на адреси трябва да бъде съобразено с целта: интересува ли ни буквалният текст или значенията на конкретните параметри?

При изпитване на филтъра е полезно да се провери и какво става с параметрите, които не променяме. Ако посетителят смени темата, трябва ли избраният град да остане? Ако започне ново търсене, запазва ли се номерът на предишната страница? Това са решения на приложението, които интерфейсът за параметри не взема автоматично. Добре описаните очаквания предотвратяват ситуации, в които технически валиден адрес представя неочаквана комбинация от избори.

Една завършена проверка може да премине през създаване на адрес, отваряне в нов раздел и повторна промяна на филтъра. За всяка стъпка сравняваме видимите контроли с показаните резултати. Така параметрите се превръщат в проверим договор между адреса и страницата. URLSearchParams улеснява обработката на текста, а качеството на функцията зависи от ясното значение на ключовете, допустимите стойности и поведението при липсващи или повторени параметри.