Когда вы должны использовать escape вместо encodeURI / encodeURIComponent?
-
09-06-2019 - |
Вопрос
При кодировании строки запроса для отправки на веб-сервер - когда вы используете escape()
и когда вы используете encodeURI()
или encodeURIComponent()
:
Используйте escape (побег):
escape("% +&=");
или
используйте encodeURI() / encodeURIComponent()
encodeURI("http://www.google.com?var1=value1&var2=value2");
encodeURIComponent("var1=value1&var2=value2");
Решение
побег()
Не используйте его!escape()
определяется в разделе B.2.1.2 побег и тот вводный текст Приложения В говорит:
...Все языковые функции и способы поведения, указанные в настоящем приложении, обладают одной или несколькими нежелательными характеристиками и при отсутствии устаревшего использования будут удалены из данной спецификации....
...Программисты не должны использовать или предполагать существование этих функций и моделей поведения при написании нового кода ECMAScript....
Поведение:
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape
Специальные символы кодируются , за исключением:@*_+-./
Шестнадцатеричная форма для символов, значение единицы кода которых равно 0xFF или меньше, представляет собой двухзначную управляющую последовательность: %xx
.
Для символов с большей кодовой единицей используется четырехзначный формат %uxxxx
используется.Это недопустимо в строке запроса (как определено в RFC3986):
query = *( pchar / "/" / "?" )
pchar = unreserved / pct-encoded / sub-delims / ":" / "@"
unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
pct-encoded = "%" HEXDIG HEXDIG
sub-delims = "!" / "$" / "&" / "'" / "(" / ")"
/ "*" / "+" / "," / ";" / "="
Знак процента допускается только в том случае, если за ним непосредственно следуют две шестнадцатеричные цифры, за процентами следует u
это не допускается.
encodeURI()
Используйте encodeURI, если вам нужен рабочий URL-адрес.Сделай этот звонок:
encodeURI("http://www.example.org/a file with spaces.html")
чтобы получить:
http://www.example.org/a%20file%20with%20spaces.html
Не вызывайте encodeURIComponent, так как это уничтожило бы URL и вернуло
http%3A%2F%2Fwww.example.org%2Fa%20file%20with%20spaces.html
encodeURIComponent() Кодирующий компонент ()
Используйте encodeURIComponent, когда вы хотите закодировать значение параметра URL.
var p1 = encodeURIComponent("http://example.org/?a=12&b=55")
Затем вы можете создать нужный вам URL-адрес:
var url = "http://example.net/?param1=" + p1 + "¶m2=99";
И вы получите этот полный URL-адрес:
http://example.net/?param1=http%3A%2F%2Fexample.org%2F%Ffa%3D12%26b%3D55¶m2=99
Обратите внимание, что encodeURIComponent не экранирует '
характер.Распространенной ошибкой является использование его для создания html-атрибутов, таких как href='MyUrl'
, который может пострадать от ошибки при инъекции.Если вы создаете html-код из строк, либо используйте "
вместо того, чтобы '
для кавычек атрибутов или добавьте дополнительный уровень кодировки ('
может быть закодирован как %27).
Для получения дополнительной информации об этом типе кодировки вы можете проверить: http://en.wikipedia.org/wiki/Percent-encoding
Другие советы
Разница между encodeURI()
и encodeURIComponent()
это ровно 11 символов, закодированных encodeURIComponent , но не encodeURI:
Я легко сгенерировал эту таблицу с помощью консоль.стол в Google Chrome с помощью этого кода:
var arr = [];
for(var i=0;i<256;i++) {
var char=String.fromCharCode(i);
if(encodeURI(char)!==encodeURIComponent(char)) {
arr.push({
character:char,
encodeURI:encodeURI(char),
encodeURIComponent:encodeURIComponent(char)
});
}
}
console.table(arr);
Я нашел эту статью поучительной :Безумие Javascript:Синтаксический анализ строки запроса
Я нашел это, когда пытался понять, почему decodeURIComponent неправильно декодировал '+'.Вот выдержка:
String: "A + B"
Expected Query String Encoding: "A+%2B+B"
escape("A + B") = "A%20+%20B" Wrong!
encodeURI("A + B") = "A%20+%20B" Wrong!
encodeURIComponent("A + B") = "A%20%2B%20B" Acceptable, but strange
Encoded String: "A+%2B+B"
Expected Decoding: "A + B"
unescape("A+%2B+B") = "A+++B" Wrong!
decodeURI("A+%2B+B") = "A+++B" Wrong!
decodeURIComponent("A+%2B+B") = "A+++B" Wrong!
encodeURIComponent не кодирует -_.!~*'()
, вызывающий проблему при отправке данных в php в виде xml-строки.
Например:
<xml><text x="100" y="150" value="It's a value with single quote" />
</xml>
Общий побег с encodeURI
%3Cxml%3E%3Ctext%20x=%22100%22%20y=%22150%22%20value=%22It's%20a%20value%20with%20single%20quote%22%20/%3E%20%3C/xml%3E
Вы можете видеть, что одинарная кавычка не закодирована.Чтобы решить проблему, я создал две функции для решения проблемы в моем проекте, для кодирования URL:
function encodeData(s:String):String{
return encodeURIComponent(s).replace(/\-/g, "%2D").replace(/\_/g, "%5F").replace(/\./g, "%2E").replace(/\!/g, "%21").replace(/\~/g, "%7E").replace(/\*/g, "%2A").replace(/\'/g, "%27").replace(/\(/g, "%28").replace(/\)/g, "%29");
}
Для декодирования URL-адреса:
function decodeData(s:String):String{
try{
return decodeURIComponent(s.replace(/\%2D/g, "-").replace(/\%5F/g, "_").replace(/\%2E/g, ".").replace(/\%21/g, "!").replace(/\%7E/g, "~").replace(/\%2A/g, "*").replace(/\%27/g, "'").replace(/\%28/g, "(").replace(/\%29/g, ")"));
}catch (e:Error) {
}
return "";
}
encodeURI() - функция escape() предназначена для экранирования javascript, а не HTTP.
Небольшая сравнительная таблица Java противJavaScript противPHP.
1. Java URLEncoder.encode (using UTF8 charset)
2. JavaScript encodeURIComponent
3. JavaScript escape
4. PHP urlencode
5. PHP rawurlencode
char JAVA JavaScript --PHP---
[ ] + %20 %20 + %20
[!] %21 ! %21 %21 %21
[*] * * * %2A %2A
['] %27 ' %27 %27 %27
[(] %28 ( %28 %28 %28
[)] %29 ) %29 %29 %29
[;] %3B %3B %3B %3B %3B
[:] %3A %3A %3A %3A %3A
[@] %40 %40 @ %40 %40
[&] %26 %26 %26 %26 %26
[=] %3D %3D %3D %3D %3D
[+] %2B %2B + %2B %2B
[$] %24 %24 %24 %24 %24
[,] %2C %2C %2C %2C %2C
[/] %2F %2F / %2F %2F
[?] %3F %3F %3F %3F %3F
[#] %23 %23 %23 %23 %23
[[] %5B %5B %5B %5B %5B
[]] %5D %5D %5D %5D %5D
----------------------------------------
[~] %7E ~ %7E %7E ~
[-] - - - - -
[_] _ _ _ _ _
[%] %25 %25 %25 %25 %25
[\] %5C %5C %5C %5C %5C
----------------------------------------
char -JAVA- --JavaScript-- -----PHP------
[ä] %C3%A4 %C3%A4 %E4 %C3%A4 %C3%A4
[ф] %D1%84 %D1%84 %u0444 %D1%84 %D1%84
Я рекомендую не использовать один из этих методов как есть.Напишите свою собственную функцию, которая будет делать правильные вещи.
MDN привел хороший пример кодировки URL, показанный ниже.
var fileName = 'my file(2).txt';
var header = "Content-Disposition: attachment; filename*=UTF-8''" + encodeRFC5987ValueChars(fileName);
console.log(header);
// logs "Content-Disposition: attachment; filename*=UTF-8''my%20file%282%29.txt"
function encodeRFC5987ValueChars (str) {
return encodeURIComponent(str).
// Note that although RFC3986 reserves "!", RFC5987 does not,
// so we do not need to escape it
replace(/['()]/g, escape). // i.e., %27 %28 %29
replace(/\*/g, '%2A').
// The following are not required for percent-encoding per RFC5987,
// so we can allow for a little better readability over the wire: |`^
replace(/%(?:7C|60|5E)/g, unescape);
}
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent
Также помните, что все они кодируют разные наборы символов, и выберите тот, который вам нужен соответствующим образом.encodeURI() кодирует меньше символов, чем encodeURIComponent(), который кодирует меньше (а также отличается, с точки зрения dannyp) символов, чем escape().
Для целей кодирования javascript предоставил три встроенные функции -
escape() - не кодирует
@*/+
Этот метод устарел после ECMA 3, поэтому его следует избегать.encodeURI() - не кодирует
~!@#$&*()=:/,;?+'
Предполагается, что URI является полным URI, поэтому не кодирует зарезервированные символы, которые имеют особое значение в URI.Этот метод используется, когда целью является преобразование полного URL-адреса вместо какого-то специального сегмента URL-адреса.Пример -encodeURI('http://stackoverflow.com');
даст - http://stackoverflow.comencodeURIComponent() - не кодирует
- _ . ! ~ * ' ( )
Эта функция кодирует компонент Uniform Resource Identifier (URI), заменяя каждый экземпляр определенных символов одной, двумя, тремя или четырьмя управляющими последовательностями, представляющими кодировку символа UTF-8.Этот метод следует использовать для преобразования компонента URL.Например, необходимо добавить некоторые пользовательские данные Пример -encodeURI('http://stackoverflow.com');
даст - http%3A%2F%2Fstackoverflow.com
Вся эта кодировка выполняется в формате UTF 8, т.е. символы будут преобразованы в формат UTF-8.
encodeURIComponent отличается от encodeURI тем, что он кодирует зарезервированные символы и цифровой знак # encodeURI
Я обнаружил, что экспериментирование с различными методами является хорошей проверкой на вменяемость даже после того, как вы хорошо разберетесь в их различных видах применения и возможностях.
С этой целью я нашел этот веб-сайт чрезвычайно полезно для подтверждения моих подозрений в том, что я делаю что-то надлежащим образом.Это также оказалось полезным для декодирования строки Encodeuricomponent'ed, которая может быть довольно сложной для интерпретации.Отличная закладка для хранения:
Вдохновленный Стол Иоганна, Я решил расширить таблицу.Я хотел посмотреть, какие символы ASCII будут закодированы.
var ascii = " !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~";
var encoded = [];
ascii.split("").forEach(function (char) {
var obj = { char };
if (char != encodeURI(char))
obj.encodeURI = encodeURI(char);
if (char != encodeURIComponent(char))
obj.encodeURIComponent = encodeURIComponent(char);
if (obj.encodeURI || obj.encodeURIComponent)
encoded.push(obj);
});
console.table(encoded);
В таблице приведены только закодированные символы.Пустые ячейки означают, что исходный и закодированный символы совпадают.
Просто для удобства я добавляю еще одну таблицу для urlencode()
против rawurlencode()
.Единственное отличие, по-видимому, заключается в кодировке пробела.
<script>
<?php
$ascii = str_split(" !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~", 1);
$encoded = [];
foreach ($ascii as $char) {
$obj = ["char" => $char];
if ($char != urlencode($char))
$obj["urlencode"] = urlencode($char);
if ($char != rawurlencode($char))
$obj["rawurlencode"] = rawurlencode($char);
if (isset($obj["rawurlencode"]) || isset($obj["rawurlencode"]))
$encoded[] = $obj;
}
echo "var encoded = " . json_encode($encoded) . ";";
?>
console.table(encoded);
</script>
У меня есть эта функция...
var escapeURIparam = function(url) {
if (encodeURIComponent) url = encodeURIComponent(url);
else if (encodeURI) url = encodeURI(url);
else url = escape(url);
url = url.replace(/\+/g, '%2B'); // Force the replacement of "+"
return url;
};
Общепринятый ответ - хороший.Подробнее о последней части:
Обратите внимание, что encodeURIComponent не экранирует символ '.Распространенной ошибкой является использование его для создания html-атрибутов, таких как href='MyUrl', которые могут содержать ошибку при внедрении.Если вы создаете html из строк, либо используйте " вместо " для кавычек атрибутов, либо добавьте дополнительный уровень кодирования (' может быть закодирован как %27).
Если ты хочешь быть в безопасности, процент кодирования неиспользованных символов также должно быть закодировано.
Вы можете использовать этот метод, чтобы избежать их (источник Mozilla)
function fixedEncodeURIComponent(str) {
return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
return '%' + c.charCodeAt(0).toString(16);
});
}
// fixedEncodeURIComponent("'") --> "%27"
Современная версия ответа @johann-echavarria:
console.log(
Array(256)
.fill()
.map((ignore, i) => String.fromCharCode(i))
.filter(
(char) =>
encodeURI(char) !== encodeURIComponent(char)
? {
character: char,
encodeURI: encodeURI(char),
encodeURIComponent: encodeURIComponent(char)
}
: false
)
)
Или, если вы можете использовать таблицу, замените console.log
с console.table
(для более красивого результата).