Как добавить или обновить параметр строки запроса?
с javascript как я могу добавить параметр строки запроса к url, если его нет или если он присутствует, обновите текущее значение? Я использую jquery для разработки на стороне клиента.
22 ответов
Я написал следующую функцию, которая выполняет то, что я хочу достичь:
function updateQueryStringParameter(uri, key, value) {
var re = new RegExp("([?&])" + key + "=.*?(&|$)", "i");
var separator = uri.indexOf('?') !== -1 ? "&" : "?";
if (uri.match(re)) {
return uri.replace(re, '' + key + "=" + value + '');
}
else {
return uri + separator + key + "=" + value;
}
}
я расширил решение и объединил его с другим, который я нашел для замены/обновления/удаления параметров querystring на основе ввода пользователей и учета привязки URL-адресов.
Не предоставление значения удалит параметр, предоставление одного добавит / обновит параметр. Если URL-адрес не указан, он будет захвачен из окна.местоположение
function UpdateQueryString(key, value, url) {
if (!url) url = window.location.href;
var re = new RegExp("([?&])" + key + "=.*?(&|#|$)(.*)", "gi"),
hash;
if (re.test(url)) {
if (typeof value !== 'undefined' && value !== null)
return url.replace(re, '' + key + "=" + value + '');
else {
hash = url.split('#');
url = hash[0].replace(re, '').replace(/(&|\?)$/, '');
if (typeof hash[1] !== 'undefined' && hash[1] !== null)
url += '#' + hash[1];
return url;
}
}
else {
if (typeof value !== 'undefined' && value !== null) {
var separator = url.indexOf('?') !== -1 ? '&' : '?';
hash = url.split('#');
url = hash[0] + separator + key + '=' + value;
if (typeof hash[1] !== 'undefined' && hash[1] !== null)
url += '#' + hash[1];
return url;
}
else
return url;
}
}
обновление
при удалении первого параметра в в querystring я переработал регулярное выражение и тест, чтобы включить исправление.
Второе Обновление
как предложено @JarónBarends-Tweak value check, чтобы проверить против undefined и null, чтобы разрешить установку 0 значений
Третье Обновление
была ошибка, когда удаление переменной querystring непосредственно перед хэштегом потеряет символ хэштега, который был исправлен
четвертый Update
спасибо @rooby за указание оптимизации регулярных выражений в первом объекте RegExp. Установите начальное регулярное выражение в ([?& ]) из-за проблемы с использованием (\?/ & ) найдено @YonatanKarni
Пятое Обновление
удаление объявления хэша var в операторе if/else
на URLSearchParams утилита может быть полезна для этого в сочетании с window.location.search. Например:
if ('URLSearchParams' in window) {
var searchParams = new URLSearchParams(window.location.search);
searchParams.set("foo", "bar");
window.location.search = searchParams.toString();
}
теперь foo установлено в bar независимо от того, существует ли он уже или нет.
однако, вышеуказанное назначение window.location.search вызовет загрузку страницы, поэтому, если это нежелательно, используйте история API следующим образом:
if ('URLSearchParams' in window) {
var searchParams = new URLSearchParams(window.location.search)
searchParams.set("foo", "bar");
var newRelativePathQuery = window.location.pathname + '?' + searchParams.toString();
history.pushState(null, '', newRelativePathQuery);
}
теперь вам не нужно писать собственное регулярное выражение или логику для обработки возможного наличие строк запроса.
, поддержка браузеров беден, поскольку он в настоящее время экспериментальный и используется только в последних версиях Chrome, Firefox, Safari, iOS Safari, Android Browser, Android Chrome и Opera. Используйте с polyfill если вы решите использовать его.
обновление: поддержка браузера улучшилась с момента моего первоначального ответа.
на основе ответа @amateur (и теперь включающего исправление из комментария @j_walker_dev), но с учетом комментария о хэш-тегах в url-адресе я использую следующее:
function updateQueryStringParameter(uri, key, value) {
var re = new RegExp("([?&])" + key + "=.*?(&|#|$)", "i");
if (uri.match(re)) {
return uri.replace(re, '' + key + "=" + value + '');
} else {
var hash = '';
if( uri.indexOf('#') !== -1 ){
hash = uri.replace(/.*#/, '#');
uri = uri.replace(/#.*/, '');
}
var separator = uri.indexOf('?') !== -1 ? "&" : "?";
return uri + separator + key + "=" + value + hash;
}
}
редактировать, чтобы исправить [?|&] в регулярном выражении, которое, конечно, должно быть [?&] как указано в комментариях
Edit: альтернативная версия для поддержки удаления URL-адресов. Я использовал value === undefined как способ указать удаление. Мог бы использовать value === false или даже отдельный входной параметр как желаемый.
function updateQueryStringParameter(uri, key, value) {
var re = new RegExp("([?&])" + key + "=.*?(&|#|$)", "i");
if( value === undefined ) {
if (uri.match(re)) {
return uri.replace(re, '');
} else {
return uri;
}
} else {
if (uri.match(re)) {
return uri.replace(re, '' + key + "=" + value + '');
} else {
var hash = '';
if( uri.indexOf('#') !== -1 ){
hash = uri.replace(/.*#/, '#');
uri = uri.replace(/#.*/, '');
}
var separator = uri.indexOf('?') !== -1 ? "&" : "?";
return uri + separator + key + "=" + value + hash;
}
}
}
увидеть его в действии на https://jsfiddle.net/bp3tmuxh/1/
вот моя библиотека, чтобы сделать это: https://github.com/Mikhus/jsurl
var u = new Url;
u.query.param='value'; // adds or replaces the param
alert(u)
вот мой подход:location.params() функцию (показанную ниже) можно использовать как геттер или сеттер. Примеры:
учитывая URL-адрес http://example.com/?foo=bar&baz#some-hash,
-
location.params()вернет объект со всеми параметрами запроса:{foo: 'bar', baz: true}. -
location.params('foo')вернутся'bar'. -
location.params({foo: undefined, hello: 'world', test: true})изменит URL наhttp://example.com/?baz&hello=world&test#some-hash.
здесь params() функция, которая может быть дополнительно назначена window.location объект.
location.params = function(params) {
var obj = {}, i, parts, len, key, value;
if (typeof params === 'string') {
value = location.search.match(new RegExp('[?&]' + params + '=?([^&]*)[&#$]?'));
return value ? value[1] : undefined;
}
var _params = location.search.substr(1).split('&');
for (i = 0, len = _params.length; i < len; i++) {
parts = _params[i].split('=');
if (! parts[0]) {continue;}
obj[parts[0]] = parts[1] || true;
}
if (typeof params !== 'object') {return obj;}
for (key in params) {
value = params[key];
if (typeof value === 'undefined') {
delete obj[key];
} else {
obj[key] = value;
}
}
parts = [];
for (key in obj) {
parts.push(key + (obj[key] === true ? '' : '=' + obj[key]));
}
location.search = parts.join('&');
};
если он не установлен или не хочет обновляться с новым значением, вы можете использовать:
window.location.search = 'param=value'; // or param=new_value
это в простом Javascript, кстати.
редактировать
вы можете попробовать использовать jquery запрос-объект плагин
Это мое предпочтение, и оно охватывает случаи, о которых я могу думать. Может ли кто-нибудь придумать способ уменьшить его до одной замены?
function setParam(uri, key, val) {
return uri
.replace(RegExp("([?&]"+key+"(?=[=&#]|$)[^#&]*|(?=#|$))"), "&"+key+"="+encodeURIComponent(val))
.replace(/^([^?&]+)&/, "?");
}
функция находится ниже. Она довольно длинная, но сделана максимально упругой. Я хотел бы предложения для сокращения / улучшения его. Я собрал небольшой jsFiddle тестов для него (или другого подобного должностные обязанности.) Если функция может пройти каждый из тестов там, я говорю, что, вероятно, хорошо идти.
обновление: я наткнулся на классную функцию для использование DOM для анализа URL-адресов, поэтому я включил эту технику здесь. Это делает функцию короче и надежнее. Реквизит для автора этой функции.
/**
* Add or update a query string parameter. If no URI is given, we use the current
* window.location.href value for the URI.
*
* Based on the DOM URL parser described here:
* http://james.padolsey.com/javascript/parsing-urls-with-the-dom/
*
* @param (string) uri Optional: The URI to add or update a parameter in
* @param (string) key The key to add or update
* @param (string) value The new value to set for key
*
* Tested on Chrome 34, Firefox 29, IE 7 and 11
*/
function update_query_string( uri, key, value ) {
// Use window URL if no query string is provided
if ( ! uri ) { uri = window.location.href; }
// Create a dummy element to parse the URI with
var a = document.createElement( 'a' ),
// match the key, optional square bracktes, an equals sign or end of string, the optional value
reg_ex = new RegExp( key + '((?:\[[^\]]*\])?)(=|$)(.*)' ),
// Setup some additional variables
qs,
qs_len,
key_found = false;
// Use the JS API to parse the URI
a.href = uri;
// If the URI doesn't have a query string, add it and return
if ( ! a.search ) {
a.search = '?' + key + '=' + value;
return a.href;
}
// Split the query string by ampersands
qs = a.search.replace( /^\?/, '' ).split( /&(?:amp;)?/ );
qs_len = qs.length;
// Loop through each query string part
while ( qs_len > 0 ) {
qs_len--;
// Check if the current part matches our key
if ( reg_ex.test( qs[qs_len] ) ) {
// Replace the current value
qs[qs_len] = qs[qs_len].replace( reg_ex, key + '' ) + '=' + value;
key_found = true;
}
}
// If we haven't replaced any occurences above, add the new parameter and value
if ( ! key_found ) { qs.push( key + '=' + value ); }
// Set the new query string
a.search = '?' + qs.join( '&' );
return a.href;
}
Я знаю, что это довольно старый, но я хочу уволить мой рабочая версия здесь.
function addOrUpdateUrlParam(uri, paramKey, paramVal) {
var re = new RegExp("([?&])" + paramKey + "=[^&#]*", "i");
if (re.test(uri)) {
uri = uri.replace(re, '' + paramKey + "=" + paramVal);
} else {
var separator = /\?/.test(uri) ? "&" : "?";
uri = uri + separator + paramKey + "=" + paramVal;
}
return uri;
}
jQuery(document).ready(function($) {
$('#paramKey,#paramValue').on('change', function() {
if ($('#paramKey').val() != "" && $('#paramValue').val() != "") {
$('#uri').val(addOrUpdateUrlParam($('#uri').val(), $('#paramKey').val(), $('#paramValue').val()));
}
});
});<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<input style="width:100%" type="text" id="uri" value="http://www.example.com/text.php">
<label style="display:block;">paramKey
<input type="text" id="paramKey">
</label>
<label style="display:block;">paramValue
<input type="text" id="paramValue">
</label>Примечание Это модифицированная версия @elreimundo
мое мнение отсюда (совместим с "use strict"; на самом деле не использует jQuery):
function decodeURIParams(query) {
if (query == null)
query = window.location.search;
if (query[0] == '?')
query = query.substring(1);
var params = query.split('&');
var result = {};
for (var i = 0; i < params.length; i++) {
var param = params[i];
var pos = param.indexOf('=');
if (pos >= 0) {
var key = decodeURIComponent(param.substring(0, pos));
var val = decodeURIComponent(param.substring(pos + 1));
result[key] = val;
} else {
var key = decodeURIComponent(param);
result[key] = true;
}
}
return result;
}
function encodeURIParams(params, addQuestionMark) {
var pairs = [];
for (var key in params) if (params.hasOwnProperty(key)) {
var value = params[key];
if (value != null) /* matches null and undefined */ {
pairs.push(encodeURIComponent(key) + '=' + encodeURIComponent(value))
}
}
if (pairs.length == 0)
return '';
return (addQuestionMark ? '?' : '') + pairs.join('&');
}
//// alternative to $.extend if not using jQuery:
// function mergeObjects(destination, source) {
// for (var key in source) if (source.hasOwnProperty(key)) {
// destination[key] = source[key];
// }
// return destination;
// }
function navigateWithURIParams(newParams) {
window.location.search = encodeURIParams($.extend(decodeURIParams(), newParams), true);
}
пример использования:
// add/update parameters
navigateWithURIParams({ foo: 'bar', boz: 42 });
// remove parameter
navigateWithURIParams({ foo: null });
// submit the given form by adding/replacing URI parameters (with jQuery)
$('.filter-form').submit(function(e) {
e.preventDefault();
navigateWithURIParams(decodeURIParams($(this).serialize()));
});
основываясь на ответе @ellemayo, я придумал следующее решение, которое позволяет при желании отключить хэш-тег:
function updateQueryString(key, value, options) {
if (!options) options = {};
var url = options.url || location.href;
var re = new RegExp("([?&])" + key + "=.*?(&|#|$)(.*)", "gi"), hash;
hash = url.split('#');
url = hash[0];
if (re.test(url)) {
if (typeof value !== 'undefined' && value !== null) {
url = url.replace(re, '' + key + "=" + value + '');
} else {
url = url.replace(re, '').replace(/(&|\?)$/, '');
}
} else if (typeof value !== 'undefined' && value !== null) {
var separator = url.indexOf('?') !== -1 ? '&' : '?';
url = url + separator + key + '=' + value;
}
if ((typeof options.hash === 'undefined' || options.hash) &&
typeof hash[1] !== 'undefined' && hash[1] !== null)
url += '#' + hash[1];
return url;
}
назовем это так:
updateQueryString('foo', 'bar', {
url: 'http://my.example.com#hash',
hash: false
});
результаты:
http://my.example.com?foo=bar
вот более короткая версия, которая заботится о
- запрос с заданным параметром или без него
- запрос с несколькими значениями параметра
- запрос, содержащий хэш -
код:
var setQueryParameter = function(uri, key, value) {
var re = new RegExp("([?&])("+ key + "=)[^&#]*", "g");
if (uri.match(re))
return uri.replace(re, '' + value);
// need to add parameter to URI
var paramString = (uri.indexOf('?') < 0 ? "?" : "&") + key + "=" + value;
var hashIndex = uri.indexOf('#');
if (hashIndex < 0)
return uri + paramString;
else
return uri.substring(0, hashIndex) + paramString + uri.substring(hashIndex);
}
на выражение описание можно найти здесь.
Примечание: это решение основано на @ amateur answer, но со многими улучшениями.
разный подход без использования регулярных выражений. Поддерживает " хэш " якоря в конце url-адреса, а также несколько символов вопросительного знака (?). Должно быть немного быстрее, чем подход регулярного выражения.
function setUrlParameter(url, key, value) {
var parts = url.split("#", 2), anchor = parts.length > 1 ? "#" + parts[1] : '';
var query = (url = parts[0]).split("?", 2);
if (query.length === 1)
return url + "?" + key + "=" + value + anchor;
for (var params = query[query.length - 1].split("&"), i = 0; i < params.length; i++)
if (params[i].toLowerCase().startsWith(key.toLowerCase() + "="))
return params[i] = key + "=" + value, query[query.length - 1] = params.join("&"), query.join("?") + anchor;
return url + "&" + key + "=" + value + anchor
}
чтобы дать пример кода для изменения window.location.search как предложено Гал и tradyblix:
var qs = window.location.search || "?";
var param = key + "=" + value; // remember to URI encode your parameters
if (qs.length > 1) {
// more than just the question mark, so append with ampersand
qs = qs + "&";
}
qs = qs + param;
window.location.search = qs;
код сценария Java, чтобы найти определенную строку запроса и заменить ее значение *
('input.letter').click(function () {
//0- prepare values
var qsTargeted = 'letter=' + this.value; //"letter=A";
var windowUrl = '';
var qskey = qsTargeted.split('=')[0];
var qsvalue = qsTargeted.split('=')[1];
//1- get row url
var originalURL = window.location.href;
//2- get query string part, and url
if (originalURL.split('?').length > 1) //qs is exists
{
windowUrl = originalURL.split('?')[0];
var qs = originalURL.split('?')[1];
//3- get list of query strings
var qsArray = qs.split('&');
var flag = false;
//4- try to find query string key
for (var i = 0; i < qsArray.length; i++) {
if (qsArray[i].split('=').length > 0) {
if (qskey == qsArray[i].split('=')[0]) {
//exists key
qsArray[i] = qskey + '=' + qsvalue;
flag = true;
break;
}
}
}
if (!flag)// //5- if exists modify,else add
{
qsArray.push(qsTargeted);
}
var finalQs = qsArray.join('&');
//6- prepare final url
window.location = windowUrl + '?' + finalQs;
}
else {
//6- prepare final url
//add query string
window.location = originalURL + '?' + qsTargeted;
}
})
});
Да, у меня была проблема, когда моя строка запроса переполнялась и дублировалась, но это было связано с моей собственной вялостью. поэтому я немного поиграл и разработал JS jquery(actualy sizzle) и C# magick.
поэтому я просто понял, что после того, как сервер сделал с переданными значениями, значения больше не имеют значения, нет повторного использования, если клиент хотел сделать то же самое, очевидно, это всегда будет новый запрос, даже если его те же параметры передаются. И это все на стороне клиента, поэтому некоторые кэширование / куки и т. д. могут быть прохладными в этом отношении.
JS:
$(document).ready(function () {
$('#ser').click(function () {
SerializeIT();
});
function SerializeIT() {
var baseUrl = "";
baseUrl = getBaseUrlFromBrowserUrl(window.location.toString());
var myQueryString = "";
funkyMethodChangingStuff(); //whatever else before serializing and creating the querystring
myQueryString = $('#fr2').serialize();
window.location.replace(baseUrl + "?" + myQueryString);
}
function getBaseUrlFromBrowserUrl(szurl) {
return szurl.split("?")[0];
}
function funkyMethodChangingStuff(){
//do stuff to whatever is in fr2
}
});
HTML:
<div id="fr2">
<input type="text" name="qURL" value="http://somewhere.com" />
<input type="text" name="qSPart" value="someSearchPattern" />
</div>
<button id="ser">Serialize! and go play with the server.</button>
C#:
using System.Web;
using System.Text;
using System.Collections.Specialized;
public partial class SomeCoolWebApp : System.Web.UI.Page
{
string weburl = string.Empty;
string partName = string.Empty;
protected void Page_Load(object sender, EventArgs e)
{
string loadurl = HttpContext.Current.Request.RawUrl;
string querySZ = null;
int isQuery = loadurl.IndexOf('?');
if (isQuery == -1) {
//If There Was no Query
}
else if (isQuery >= 1) {
querySZ = (isQuery < loadurl.Length - 1) ? loadurl.Substring(isQuery + 1) : string.Empty;
string[] getSingleQuery = querySZ.Split('?');
querySZ = getSingleQuery[0];
NameValueCollection qs = null;
qs = HttpUtility.ParseQueryString(querySZ);
weburl = qs["qURL"];
partName = qs["qSPart"];
//call some great method thisPageRocks(weburl,partName); or whatever.
}
}
}
хорошо критика приветствуется (это была ночная стряпня, поэтому не стесняйтесь отмечать корректировки). Если это вообще помогло, нажмите его, счастливое кодирование.
нет дубликатов, каждый запрос уникален, как вы его изменили, и из-за того, как это структурировано, легко чтобы добавить больше запросов dynamicaly от wthin dom.
вот альтернативный метод, использующий встроенные свойства элемента HTML привязки:
- обрабатывает многозначные параметры.
- нет риска изменения фрагмента # или чего-либо другого, кроме самой строки запроса.
- может быть немного легче читать? Но она длиннее.
var a = document.createElement('a'),
getHrefWithUpdatedQueryString = function(param, value) {
return updatedQueryString(window.location.href, param, value);
},
updatedQueryString = function(url, param, value) {
/*
A function which modifies the query string
by setting one parameter to a single value.
Any other instances of parameter will be removed/replaced.
*/
var fragment = encodeURIComponent(param) +
'=' + encodeURIComponent(value);
a.href = url;
if (a.search.length === 0) {
a.search = '?' + fragment;
} else {
var didReplace = false,
// Remove leading '?'
parts = a.search.substring(1)
// Break into pieces
.split('&'),
reassemble = [],
len = parts.length;
for (var i = 0; i < len; i++) {
var pieces = parts[i].split('=');
if (pieces[0] === param) {
if (!didReplace) {
reassemble.push('&' + fragment);
didReplace = true;
}
} else {
reassemble.push(parts[i]);
}
}
if (!didReplace) {
reassemble.push('&' + fragment);
}
a.search = reassemble.join('&');
}
return a.href;
};Если вы хотите установить сразу несколько параметров:
function updateQueryStringParameters(uri, params) {
for(key in params){
var value = params[key],
re = new RegExp("([?&])" + key + "=.*?(&|$)", "i"),
separator = uri.indexOf('?') !== -1 ? "&" : "?";
if (uri.match(re)) {
uri = uri.replace(re, '' + key + "=" + value + '');
}
else {
uri = uri + separator + key + "=" + value;
}
}
return uri;
}
та же функция, что и @amateur's
Если jslint дает вам ошибку, добавьте это после цикла for
if(params.hasOwnProperty(key))
на этой странице много неудобных и излишне сложных ответов. Самый высокий рейтинг, @amateur's, довольно хорош, хотя у него есть немного ненужного пуха в регулярном выражении. Вот немного более оптимальное решение с cleaner RegExp и cleaner replace звоните:
function updateQueryStringParamsNoHash(uri, key, value) {
var re = new RegExp("([?&])" + key + "=[^&]*", "i");
return re.test(uri)
? uri.replace(re, '' + key + "=" + value)
: uri + separator + key + "=" + value
;
}
в качестве дополнительного бонуса, если uri не является строкой, вы не получите ошибок при попытке вызова match или replace на что-то, что может не реализовать эти методы.
и если вы хотите обработать случай хэша (и вы уже сделали проверку для правильно отформатированного HTML), вы можете использовать существующую функцию вместо написания новой функции, содержащей ту же логику:
function updateQueryStringParams(url, key, value) {
var splitURL = url.split('#');
var hash = splitURL[1];
var uri = updateQueryStringParamsNoHash(splitURL[0]);
return hash == null ? uri : uri + '#' + hash;
}
или вы можете внести некоторые небольшие изменения в @ Adam в противном случае отличный ответ:
function updateQueryStringParameter(uri, key, value) {
var re = new RegExp("([?&])" + key + "=[^&#]*", "i");
if (re.test(uri)) {
return uri.replace(re, '' + key + "=" + value);
} else {
var matchData = uri.match(/^([^#]*)(#.*)?$/);
var separator = /\?/.test(uri) ? "&" : "?";
return matchData[0] + separator + key + "=" + value + (matchData[1] || '');
}
}
Это должно служить цели:
function updateQueryString(url, key, value) {
var arr = url.split("#");
var url = arr[0];
var fragmentId = arr[1];
var updatedQS = "";
if (url.indexOf("?") == -1) {
updatedQS = encodeURIComponent(key) + "=" + encodeURIComponent(value);
}
else {
updatedQS = addOrModifyQS(url.substring(url.indexOf("?") + 1), key, value);
}
url = url.substring(0, url.indexOf("?")) + "?" + updatedQS;
if (typeof fragmentId !== 'undefined') {
url = url + "#" + fragmentId;
}
return url;
}
function addOrModifyQS(queryStrings, key, value) {
var oldQueryStrings = queryStrings.split("&");
var newQueryStrings = new Array();
var isNewKey = true;
for (var i in oldQueryStrings) {
var currItem = oldQueryStrings[i];
var searchKey = key + "=";
if (currItem.indexOf(searchKey) != -1) {
currItem = encodeURIComponent(key) + "=" + encodeURIComponent(value);
isNewKey = false;
}
newQueryStrings.push(currItem);
}
if (isNewKey) {
newQueryStrings.push(encodeURIComponent(key) + "=" + encodeURIComponent(value));
}
return newQueryStrings.join("&");
}