你什么时候应该使用escape而不是encodeURI / encodeURIComponent?

时间:2008-09-16 19:24:35

标签: javascript encoding query-string

对要发送到Web服务器的查询字符串进行编码时 - 何时使用escape()以及何时使用encodeURI()encodeURIComponent()

使用转义:

escape("% +&=");

OR

使用encodeURI()/ encodeURIComponent()

encodeURI("http://www.google.com?var1=value1&var2=value2");

encodeURIComponent("var1=value1&var2=value2");

15 个答案:

答案 0 :(得分:1865)

逃逸()

不要使用它! escape()部分定义了%xxB.2.1.2 escape部分说明了

  

...本附录中指定的所有语言功能和行为都具有一个或多个不良特征,并且在没有遗留用法的情况下将从本规范中删除。 ...
  ......编写新的ECMAScript代码时,程序员不应使用或假设存在这些特性和行为....

行为:

introduction text of Annex B

特殊字符的编码除外:@ * _ + - ./

字符的十六进制形式,其代码单位值为0xFF或更小,是一个两位数的转义序列:%uxxxx

对于代码单元较大的字符,使用四位数格式query = *( pchar / "/" / "?" ) pchar = unreserved / pct-encoded / sub-delims / ":" / "@" unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" pct-encoded = "%" HEXDIG HEXDIG sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" 。查询字符串中不允许这样做(如https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/escape中所定义):

u

仅当百分号后面紧跟两个十六进制数字时才允许百分号,不允许使用百分号后跟encodeURI("http://www.example.org/a file with spaces.html")

是encodeURI()

如果需要工作网址,请使用encodeURI。拨打这个电话:

http://www.example.org/a%20file%20with%20spaces.html

得到:

http%3A%2F%2Fwww.example.org%2Fa%20file%20with%20spaces.html

不要调用encodeURIComponent,因为它会破坏URL并返回

var p1 = encodeURIComponent("http://example.org/?a=12&b=55")

encodeURIComponent方法()

如果要对URL参数的值进行编码,请使用encodeURIComponent。

var url = "http://example.net/?param1=" + p1 + "&param2=99";

然后您可以创建所需的网址:

http://example.net/?param1=http%3A%2F%2Fexample.org%2F%Ffa%3D12%26b%3D55&param2=99

您将获得完整的网址:

'

请注意,encodeURIComponent不会转义href='MyUrl'字符。一个常见的错误是使用它来创建html属性,例如",这可能会遭受注入错误。如果您要使用字符串构建html,请使用'代替'作为属性引号,或者添加额外的编码层({{1}}可以编码为%27)。

有关此类编码的详细信息,请查看:RFC3986

答案 1 :(得分:416)

encodeURI()encodeURIComponent()之间的差异恰好是由encodeURIComponent编码的11个字符,但不是由encodeURI编码:

Table with the ten differences between encodeURI and encodeURIComponent

我使用此代码在Google Chrome中使用 console.table 轻松生成此表格:



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);
&#13;
&#13;
&#13;

答案 2 :(得分:46)

我发现这篇文章很有启发性: Javascript Madness: Query String Parsing

当我试图解释为什么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!

答案 3 :(得分:40)

encodeURIComponent不对-_.!~*'()进行编码,导致在xml字符串中将数据发布到php时出现问题。

例如:
<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");
}

对于解码网址:

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 "";
}

答案 4 :(得分:38)

encodeURI() - escape()函数用于javascript转义,而不是HTTP。

答案 5 :(得分:17)

小型比较表Java vs. 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

答案 6 :(得分:11)

我建议不要按原样使用其中一种方法。写出你自己的功能,做正确的事。

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

答案 7 :(得分:10)

还要记住,它们都编码不同的字符集,并选择适当的字符集。 encodeURI()编码的字符数少于encodeURIComponent(),它比escape()编码的字符数更少(也与dannyp的点不同)。

答案 8 :(得分:7)

出于编码的目的,javascript给出了三个内置函数 -

  1. escape() - 不编码@*/+ 在ECMA 3之后不推荐使用此方法,因此应该避免使用此方法。

  2. encodeURI() - 不编码~!@#$&*()=:/,;?+' 它假定URI是完整的URI,因此不编码URI中具有特殊含义的保留字符。 意图是转换完整的URL而不是某些特殊的URL段时使用此方法。 示例 - encodeURI('http://stackoverflow.com'); 将给予 - http://stackoverflow.com

  3. encodeURIComponent() - 不编码- _ . ! ~ * ' ( ) 此函数通过将某些字符的每个实例替换为表示字符的UTF-8编码的一个,两个,三个或四个转义序列来编码统一资源标识符(URI)组件。此方法应用于转换URL的组件。例如,需要附加一些用户输入 示例 - encodeURI('http://stackoverflow.com'); 将给出 - http%3A%2F%2Fstackoverflow.com

  4. 所有这些编码都以UTF 8格式进行,即字符将以UTF-8格式转换。

    encodeURIComponent与encodeURI的不同之处在于它编码保留字符和编号的编号#Ir

答案 9 :(得分:3)

我发现尝试各种方法即使在掌握了各种用途和功能之后,也能进行良好的理智检查。

为此,我发现this website非常有用,可以证实我怀疑自己正在做些什么。它也被证明可用于解码encodeURIComponent的字符串,这对于解释起来相当具有挑战性。一个很棒的书签:

http://www.the-art-of-web.com/javascript/escape/

答案 10 :(得分:2)

Johann's table的启发,我决定扩展表格。我想看看要编码的ASCII字符。

screenshot of console.table

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()添加了另一个表。唯一的区别似乎是空格字符的编码。

screenshot of console.table

<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>

答案 11 :(得分:2)

只需自己尝试encodeURI()encodeURIComponent() ...

console.log(encodeURIComponent('@#$%^&*'));

输入:@#$%^&*。输出:%40%23%24%25%5E%26*。那么,等等,*怎么了?为什么不转换呢?如果您尝试进行linux command "$string",肯定会导致问题。 TLDR:您实际上想要fixedEncodeURIComponent()fixedEncodeURI()。长篇小说...

何时使用encodeURI() 从不。 encodeURI()在括号编码方面未遵循RFC3986。使用MDN encodeURI() Documentation中定义并进一步说明的fixedEncodeURI() ...

function fixedEncodeURI(str) { return encodeURI(str).replace(/%5B/g, '[').replace(/%5D/g, ']'); }

何时使用encodeURIComponent() 从不。 encodeURIComponent()在编码方面未遵守RFC3986:!'()*。使用MDN encodeURIComponent() Documentation定义并进一步说明的fixedEncodeURIComponent() ...

function fixedEncodeURIComponent(str) { return encodeURIComponent(str).replace(/[!'()*]/g, function(c) { return '%' + c.charCodeAt(0).toString(16); }); }

然后,您可以使用fixedEncodeURI()编码单个URL片段,而fixedEncodeURIComponent()将编码URL片段和连接符;或者,fixedEncodeURI()不会对+@?=:#;,$&进行编码(因为&+是常见的URL运算符),但是fixedEncodeURIComponent()会进行编码。

答案 12 :(得分:1)

我有这个功能......

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;
};

答案 13 :(得分:1)

接受的答案是好的。 扩展到最后一部分:

  

请注意,encodeURIComponent不会转义&#39;字符。普通的   bug是用它来创建html属性,例如href =&#39; MyUrl&#39;,哪个   可能会遭受注射虫。如果你正在构建html   字符串,要么使用&#34;而不是&#39;对于属性引号,或添加一个   额外的编码层(&#39;可以编码为%27)。

如果您想要安全起见,也应编码percent encoding unreserved characters

您可以使用此方法来转义它们(来源Mozilla

function fixedEncodeURIComponent(str) {
  return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
    return '%' + c.charCodeAt(0).toString(16);
  });
}

// fixedEncodeURIComponent("'") --> "%27"

答案 14 :(得分:1)

现代改写@ 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(对于更漂亮的输出)。