Функции для работы с URL
Функции, упомянутые в этом разделе, оптимизированы для максимальной производительности и в основном не соответствуют стандарту RFC-3986. Функции, которые реализуют RFC-3986, имеют суффикс RFC
в названии функции и, как правило, работают медленнее.
Вы можете использовать варианты функций без RFC
при работе с общедоступно зарегистрированными доменами, которые не содержат строк пользователей и символов @
.
В таблице ниже указано, какие символы в URL могут (✔
) или не могут (✗
) быть обработаны соответствующими вариантами RFC
и non-RFC
:
Символ | non-RFC | RFC |
---|---|---|
' ' | ✗ | ✗ |
\t | ✗ | ✗ |
< | ✗ | ✗ |
> | ✗ | ✗ |
% | ✗ | ✔* |
{ | ✗ | ✗ |
} | ✗ | ✗ |
| | ✗ | ✗ |
\ | ✗ | ✗ |
^ | ✗ | ✗ |
~ | ✗ | ✔* |
[ | ✗ | ✗ |
] | ✗ | ✔ |
; | ✗ | ✔* |
= | ✗ | ✔* |
& | ✗ | ✔* |
Символы, помеченные *
, являются суб-делимитерами в RFC 3986 и разрешены для пользовательской информации после символа @
.
Функции, извлекающие части URL
Если соответствующая часть отсутствует в URL, возвращается пустая строка.
protocol
Извлекает протокол из URL.
Примеры типичных возвращаемых значений: http, https, ftp, mailto, tel, magnet.
domain
Извлекает имя хоста из URL.
Синтаксис
Аргументы
url
— URL. String.
URL может быть указан с протоколом или без него. Примеры:
Для этих примеров функция domain
возвращает следующие результаты:
Возвращаемые значения
- Имя хоста, если входная строка может быть проанализирована как URL, иначе пустая строка. String.
Пример
domainRFC
Извлекает имя хоста из URL. Похоже на domain, но соответствует RFC 3986.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемые значения
- Имя хоста, если входная строка может быть проанализирована как URL, иначе пустая строка. String.
Пример
domainWithoutWWW
Возвращает домен без ведущего www.
, если он присутствует.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемые значения
- Имя домена, если входная строка может быть проанализирована как URL (без ведущего
www.
), иначе пустая строка. String.
Пример
domainWithoutWWWRFC
Возвращает домен без ведущего www.
, если он присутствует. Похоже на domainWithoutWWW, но соответствует RFC 3986.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемые значения
- Имя домена, если входная строка может быть проанализирована как URL (без ведущего
www.
), иначе пустая строка. String.
Пример
Запрос:
Результат:
topLevelDomain
Извлекает домен верхнего уровня из URL.
Аргументы
url
— URL. String.
URL может быть указан с протоколом или без него. Примеры:
Возвращаемые значения
- Имя домена, если входная строка может быть проанализирована как URL. В противном случае — пустая строка. String.
Пример
Запрос:
Результат:
topLevelDomainRFC
Извлекает домен верхнего уровня из URL. Похоже на topLevelDomain, но соответствует RFC 3986.
Аргументы
url
— URL. String.
URL может быть указан с протоколом или без него. Примеры:
Возвращаемые значения
- Имя домена, если входная строка может быть проанализирована как URL. В противном случае — пустая строка. String.
Пример
Запрос:
Результат:
firstSignificantSubdomain
Возвращает "первый значимый поддомен".
Первый значимый поддомен — это домен второго уровня для com
, net
, org
или co
, иначе это домен третьего уровня.
Например, firstSignificantSubdomain ('https://news.clickhouse.com/') = 'clickhouse'
, firstSignificantSubdomain ('https://news.clickhouse.com.tr/') = 'clickhouse'
.
Список "незначительных" доменов второго уровня и другие детали реализации могут измениться в будущем.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемое значение
- Первый значимый поддомен. String.
Пример
Запрос:
Результат:
firstSignificantSubdomainRFC
Возвращает "первый значимый поддомен".
Первый значимый поддомен — это домен второго уровня для com
, net
, org
или co
, иначе это домен третьего уровня.
Например, firstSignificantSubdomain ('https://news.clickhouse.com/') = 'clickhouse'
, firstSignificantSubdomain ('https://news.clickhouse.com.tr/') = 'clickhouse'
.
Список "незначительных" доменов второго уровня и другие детали реализации могут измениться в будущем. Похоже на firstSignificantSubdomain, но соответствует RFC 1034.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемое значение
- Первый значимый поддомен. String.
Пример
Запрос:
Результат:
cutToFirstSignificantSubdomain
Возвращает часть домена, которая включает домены верхнего уровня до "первого значимого поддомена".
Синтаксис
Аргументы
url
— URL. String.
Возвращаемое значение
- Часть домена, которая включает домены верхнего уровня до первого значимого поддомена, если это возможно, в противном случае возвращает пустую строку. String.
Пример
Запрос:
Результат:
cutToFirstSignificantSubdomainRFC
Возвращает часть домена, которая включает домены верхнего уровня до "первого значимого поддомена". Похоже на cutToFirstSignificantSubdomain, но соответствует RFC 3986.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемое значение
- Часть домена, которая включает домены верхнего уровня до первого значимого поддомена, если это возможно, в противном случае возвращает пустую строку. String.
Пример
Запрос:
Результат:
cutToFirstSignificantSubdomainWithWWW
Возвращает часть домена, которая включает домены верхнего уровня до "первого значимого поддомена", не удаляя www
.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемое значение
- Часть домена, которая включает домены верхнего уровня до первого значимого поддомена (с
www
), если это возможно, в противном случае возвращает пустую строку. String.
Пример
Запрос:
Результат:
cutToFirstSignificantSubdomainWithWWWRFC
Возвращает часть домена, которая включает домены верхнего уровня до "первого значимого поддомена", не удаляя www
. Похоже на cutToFirstSignificantSubdomainWithWWW, но соответствует RFC 3986.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемое значение
- Часть домена, которая включает домены верхнего уровня до первого значимого поддомена (с "www"), если это возможно, в противном случае возвращает пустую строку. String.
Пример
Запрос:
Результат:
cutToFirstSignificantSubdomainCustom
Возвращает часть домена, которая включает домены верхнего уровня до первого значимого поддомена. Принимает произвольное имя списка TLD. Эта функция может быть полезна, если вам нужен новый список TLD или если у вас есть пользовательский список.
Пример конфигурации
Синтаксис
Аргументы
Возвращаемое значение
- Часть домена, которая включает домены верхнего уровня до первого значимого поддомена. String.
Пример
Запрос:
Результат:
Смотрите также
cutToFirstSignificantSubdomainCustomRFC
Возвращает часть домена, которая включает домены верхнего уровня до первого значимого поддомена. Принимает произвольное имя списка TLD. Эта функция может быть полезна, если вам нужен новый список TLD или если у вас есть пользовательский список. Похоже на cutToFirstSignificantSubdomainCustom, но соответствует RFC 3986.
Синтаксис
Аргументы
Возвращаемое значение
- Часть домена, которая включает домены верхнего уровня до первого значимого поддомена. String.
Смотрите также
cutToFirstSignificantSubdomainCustomWithWWW
Возвращает часть домена, которая включает домены верхнего уровня до первого значимого поддомена без удаления www
.
Принимает произвольное имя списка TLD.
Это может быть полезно, если вам нужен новый список TLD или если у вас есть пользовательский список.
Пример конфигурации
Синтаксис
Аргументы
Возвращаемое значение
- Часть домена, которая включает домены верхнего уровня до первого значимого поддомена без удаления
www
. String.
Пример
Запрос:
Результат:
Смотрите также
cutToFirstSignificantSubdomainCustomWithWWWRFC
Возвращает часть домена, которая включает домены верхнего уровня до первого значимого поддомена без удаления www
.
Принимает произвольное имя списка TLD.
Это может быть полезно, если вам нужен новый список TLD или если у вас есть пользовательский список. Похоже на cutToFirstSignificantSubdomainCustomWithWWW, но соответствует RFC 3986.
Синтаксис
Аргументы
Возвращаемое значение
- Часть домена, которая включает домены верхнего уровня до первого значимого поддомена без удаления
www
. String.
Смотрите также
firstSignificantSubdomainCustom
Возвращает первый значимый поддомен. Принимает произвольное имя списка TLD. Может быть полезно, если вам нужен новый список TLD или у вас есть пользовательский.
Пример конфигурации:
Синтаксис
Аргументы
Возвращаемое значение
- Первый значимый поддомен. String.
Пример
Запрос:
Результат:
Смотрите также
firstSignificantSubdomainCustomRFC
Возвращает первый значимый поддомен. Принимает произвольное имя списка TLD. Может быть полезно, если вам нужен новый список TLD или у вас есть пользовательский. Похоже на firstSignificantSubdomainCustom, но соответствует RFC 3986.
Синтаксис
Аргументы
Возвращаемое значение
- Первый значимый поддомен. String.
Смотрите также
port
Возвращает порт или default_port
, если URL не содержит порта или не может быть проанализирован.
Синтаксис
Аргументы
Возвращаемое значение
- Порт или порт по умолчанию, если в URL нет порта или в случае ошибки проверки. UInt16.
Пример
Запрос:
Результат:
portRFC
Возвращает порт или default_port
, если URL не содержит порта или не может быть проанализирован. Похоже на port, но соответствует RFC 3986.
Синтаксис
Аргументы
Возвращаемое значение
- Порт или порт по умолчанию, если в URL нет порта или в случае ошибки проверки. UInt16.
Пример
Запрос:
Результат:
path
Возвращает путь без строки запроса.
Пример: /top/news.html
.
pathFull
То же самое, что и выше, но включает строку запроса и фрагмент.
Пример: /top/news.html?page=2#comments
.
protocol
Извлекает протокол из URL.
Синтаксис
Аргументы
url
— URL, из которого извлекается протокол. String.
Возвращаемое значение
- Протокол или пустая строка, если его нельзя определить. String.
Пример
Запрос:
Результат:
queryString
Возвращает строку запроса без начального знака вопроса, #
и всего, что после #
.
Пример: page=1&lr=213
.
fragment
Возвращает идентификатор фрагмента без начального символа хеширования.
queryStringAndFragment
Возвращает строку запроса и идентификатор фрагмента.
Пример: page=1#29390
.
extractURLParameter(url, name)
Возвращает значение параметра name
в URL, если он присутствует, иначе возвращается пустая строка.
Если есть несколько параметров с этим именем, возвращается первое вхождение.
Функция предполагает, что параметр в параметре url
закодирован так же, как и в аргументе name
.
extractURLParameters(url)
Возвращает массив строк name=value
, соответствующих параметрам URL.
Значения не декодируются.
extractURLParameterNames(url)
Возвращает массив строк имен, соответствующих именам параметров URL. Значения не декодируются.
URLHierarchy(url)
Возвращает массив, содержащий URL, обрезанный в конце символами /,? в пути и строке запроса. Последовательные символы-разделители учитываются как один. Нарезка производится сразу после всех последовательных символов-разделителей.
URLPathHierarchy(url)
То же самое, что и выше, но без протокола и хоста в результате. Элемент / (корень) не включен.
encodeURLComponent(url)
Возвращает закодированный URL.
Пример:
decodeURLComponent(url)
Возвращает декодированный URL.
Пример:
encodeURLFormComponent(url)
Возвращает закодированный URL. Соответствует rfc-1866, пробел (
) закодирован как плюс (+
).
Пример:
decodeURLFormComponent(url)
Возвращает декодированный URL. Соответствует rfc-1866, простой плюс (+
) декодируется как пробел (
).
Пример:
netloc
Извлекает сетевую локальность (username:password@host:port
) из URL.
Синтаксис
Аргументы
url
— URL. String.
Возвращаемое значение
username:password@host:port
. String.
Пример
Запрос:
Результат:
Функции, которые удаляют часть URL
Если в URL нет ничего подобного, URL остается без изменений.
cutWWW
Удаляет ведущий www.
(если присутствует) из домена URL.
cutQueryString
Удаляет строку запроса, включая знак вопроса.
cutFragment
Удаляет идентификатор фрагмента, включая знак решетки.
cutQueryStringAndFragment
Удаляет строку запроса и идентификатор фрагмента, включая знак вопроса и знак решетки.
cutURLParameter(url, name)
Удаляет параметр name
из URL, если он присутствует.
Эта функция не кодирует и не декодирует символы в именах параметров, например, Client ID
и Client%20ID
рассматриваются как разные имена параметров.
Синтаксис
Аргументы
Возвращаемое значение
- url с удаленным параметром URL
name
. String.
Пример
Запрос:
Результат: