如何使用纯JavaScript将字符转换为HTML实体

61

我有以下代码:

var text = "Übergroße Äpfel mit Würmern";

我正在寻找一种JavaScript函数,以便将每个特殊字母转换为其HTML实体序列,例如:

var newText = magicFunction(text);
...
newText = "Übergroße Äpfel mit Würmern";

该函数不仅应该转义此示例中的字母,还应该转义所有这些字符。

您如何实现呢?是否存在任何现有函数可用?(最好是纯函数,因为不使用框架的解决方案更受欢迎)

顺便说一下:是的,我看过这个问题,但它不能满足我的需求。

12个回答

65

在bucabay的帮助下并得到创建自己的函数的建议后,我创建了这个适合我的函数。你们认为有更好的解决方案吗?

if(typeof escapeHtmlEntities == 'undefined') {
        escapeHtmlEntities = function (text) {
            return text.replace(/[\u00A0-\u2666<>\&]/g, function(c) {
                return '&' + 
                (escapeHtmlEntities.entityTable[c.charCodeAt(0)] || '#'+c.charCodeAt(0)) + ';';
            });
        };

        // all HTML4 entities as defined here: http://www.w3.org/TR/html4/sgml/entities.html
        // added: amp, lt, gt, quot and apos
        escapeHtmlEntities.entityTable = {
            34 : 'quot', 
            38 : 'amp', 
            39 : 'apos', 
            60 : 'lt', 
            62 : 'gt', 
            160 : 'nbsp', 
            161 : 'iexcl', 
            162 : 'cent', 
            163 : 'pound', 
            164 : 'curren', 
            165 : 'yen', 
            166 : 'brvbar', 
            167 : 'sect', 
            168 : 'uml', 
            169 : 'copy', 
            170 : 'ordf', 
            171 : 'laquo', 
            172 : 'not', 
            173 : 'shy', 
            174 : 'reg', 
            175 : 'macr', 
            176 : 'deg', 
            177 : 'plusmn', 
            178 : 'sup2', 
            179 : 'sup3', 
            180 : 'acute', 
            181 : 'micro', 
            182 : 'para', 
            183 : 'middot', 
            184 : 'cedil', 
            185 : 'sup1', 
            186 : 'ordm', 
            187 : 'raquo', 
            188 : 'frac14', 
            189 : 'frac12', 
            190 : 'frac34', 
            191 : 'iquest', 
            192 : 'Agrave', 
            193 : 'Aacute', 
            194 : 'Acirc', 
            195 : 'Atilde', 
            196 : 'Auml', 
            197 : 'Aring', 
            198 : 'AElig', 
            199 : 'Ccedil', 
            200 : 'Egrave', 
            201 : 'Eacute', 
            202 : 'Ecirc', 
            203 : 'Euml', 
            204 : 'Igrave', 
            205 : 'Iacute', 
            206 : 'Icirc', 
            207 : 'Iuml', 
            208 : 'ETH', 
            209 : 'Ntilde', 
            210 : 'Ograve', 
            211 : 'Oacute', 
            212 : 'Ocirc', 
            213 : 'Otilde', 
            214 : 'Ouml', 
            215 : 'times', 
            216 : 'Oslash', 
            217 : 'Ugrave', 
            218 : 'Uacute', 
            219 : 'Ucirc', 
            220 : 'Uuml', 
            221 : 'Yacute', 
            222 : 'THORN', 
            223 : 'szlig', 
            224 : 'agrave', 
            225 : 'aacute', 
            226 : 'acirc', 
            227 : 'atilde', 
            228 : 'auml', 
            229 : 'aring', 
            230 : 'aelig', 
            231 : 'ccedil', 
            232 : 'egrave', 
            233 : 'eacute', 
            234 : 'ecirc', 
            235 : 'euml', 
            236 : 'igrave', 
            237 : 'iacute', 
            238 : 'icirc', 
            239 : 'iuml', 
            240 : 'eth', 
            241 : 'ntilde', 
            242 : 'ograve', 
            243 : 'oacute', 
            244 : 'ocirc', 
            245 : 'otilde', 
            246 : 'ouml', 
            247 : 'divide', 
            248 : 'oslash', 
            249 : 'ugrave', 
            250 : 'uacute', 
            251 : 'ucirc', 
            252 : 'uuml', 
            253 : 'yacute', 
            254 : 'thorn', 
            255 : 'yuml', 
            402 : 'fnof', 
            913 : 'Alpha', 
            914 : 'Beta', 
            915 : 'Gamma', 
            916 : 'Delta', 
            917 : 'Epsilon', 
            918 : 'Zeta', 
            919 : 'Eta', 
            920 : 'Theta', 
            921 : 'Iota', 
            922 : 'Kappa', 
            923 : 'Lambda', 
            924 : 'Mu', 
            925 : 'Nu', 
            926 : 'Xi', 
            927 : 'Omicron', 
            928 : 'Pi', 
            929 : 'Rho', 
            931 : 'Sigma', 
            932 : 'Tau', 
            933 : 'Upsilon', 
            934 : 'Phi', 
            935 : 'Chi', 
            936 : 'Psi', 
            937 : 'Omega', 
            945 : 'alpha', 
            946 : 'beta', 
            947 : 'gamma', 
            948 : 'delta', 
            949 : 'epsilon', 
            950 : 'zeta', 
            951 : 'eta', 
            952 : 'theta', 
            953 : 'iota', 
            954 : 'kappa', 
            955 : 'lambda', 
            956 : 'mu', 
            957 : 'nu', 
            958 : 'xi', 
            959 : 'omicron', 
            960 : 'pi', 
            961 : 'rho', 
            962 : 'sigmaf', 
            963 : 'sigma', 
            964 : 'tau', 
            965 : 'upsilon', 
            966 : 'phi', 
            967 : 'chi', 
            968 : 'psi', 
            969 : 'omega', 
            977 : 'thetasym', 
            978 : 'upsih', 
            982 : 'piv', 
            8226 : 'bull', 
            8230 : 'hellip', 
            8242 : 'prime', 
            8243 : 'Prime', 
            8254 : 'oline', 
            8260 : 'frasl', 
            8472 : 'weierp', 
            8465 : 'image', 
            8476 : 'real', 
            8482 : 'trade', 
            8501 : 'alefsym', 
            8592 : 'larr', 
            8593 : 'uarr', 
            8594 : 'rarr', 
            8595 : 'darr', 
            8596 : 'harr', 
            8629 : 'crarr', 
            8656 : 'lArr', 
            8657 : 'uArr', 
            8658 : 'rArr', 
            8659 : 'dArr', 
            8660 : 'hArr', 
            8704 : 'forall', 
            8706 : 'part', 
            8707 : 'exist', 
            8709 : 'empty', 
            8711 : 'nabla', 
            8712 : 'isin', 
            8713 : 'notin', 
            8715 : 'ni', 
            8719 : 'prod', 
            8721 : 'sum', 
            8722 : 'minus', 
            8727 : 'lowast', 
            8730 : 'radic', 
            8733 : 'prop', 
            8734 : 'infin', 
            8736 : 'ang', 
            8743 : 'and', 
            8744 : 'or', 
            8745 : 'cap', 
            8746 : 'cup', 
            8747 : 'int', 
            8756 : 'there4', 
            8764 : 'sim', 
            8773 : 'cong', 
            8776 : 'asymp', 
            8800 : 'ne', 
            8801 : 'equiv', 
            8804 : 'le', 
            8805 : 'ge', 
            8834 : 'sub', 
            8835 : 'sup', 
            8836 : 'nsub', 
            8838 : 'sube', 
            8839 : 'supe', 
            8853 : 'oplus', 
            8855 : 'otimes', 
            8869 : 'perp', 
            8901 : 'sdot', 
            8968 : 'lceil', 
            8969 : 'rceil', 
            8970 : 'lfloor', 
            8971 : 'rfloor', 
            9001 : 'lang', 
            9002 : 'rang', 
            9674 : 'loz', 
            9824 : 'spades', 
            9827 : 'clubs', 
            9829 : 'hearts', 
            9830 : 'diams', 
            338 : 'OElig', 
            339 : 'oelig', 
            352 : 'Scaron', 
            353 : 'scaron', 
            376 : 'Yuml', 
            710 : 'circ', 
            732 : 'tilde', 
            8194 : 'ensp', 
            8195 : 'emsp', 
            8201 : 'thinsp', 
            8204 : 'zwnj', 
            8205 : 'zwj', 
            8206 : 'lrm', 
            8207 : 'rlm', 
            8211 : 'ndash', 
            8212 : 'mdash', 
            8216 : 'lsquo', 
            8217 : 'rsquo', 
            8218 : 'sbquo', 
            8220 : 'ldquo', 
            8221 : 'rdquo', 
            8222 : 'bdquo', 
            8224 : 'dagger', 
            8225 : 'Dagger', 
            8240 : 'permil', 
            8249 : 'lsaquo', 
            8250 : 'rsaquo', 
            8364 : 'euro'
        };
    }

使用示例:

var text = "Übergroße Äpfel mit Würmern";
alert(escapeHtmlEntities (text));

结果:

&Uuml;bergro&szlig;e &Auml;pfel mit W&uuml;rmern
  • 更新1: 再次感谢bucabay给的 || - 提示

  • 更新2: 使用amp,lt,gt,apos和quot更新实体表,感谢richardtallent的提示

  • 更新3(2014年): Mathias Bynens创建了名为'he'的库,也许可以满足您的需求。


1
看起来不错。我会选择:escapeHtmlEntities.entityTable[c.charCodeAt(0)] || '#'+c.charCodeAt(0) 这样你就可以捕获那些不在entityTable中的charCode。 - bucabay
如果有人感兴趣,我已经将其制作成了一个Node.js模块,这是代码 - hitautodestruct
喜欢这个答案。我简化了它,省略了实体表,不匹配<>&,你就可以得到一个很棒的函数,用于7位html序列化,你所关心的只是不丢失数据。 - podperson
1
另一个需要注意的是:按照现有的代码编写方式,无法正确处理Unicode字符U+10000及以上。为了处理这些字符,需要添加代码将每个UTF-16代理对组合成单个值。 - PleaseStand
1
@Mathias Bynens,我在我的回答中添加了你的库链接。 - Chris
显示剩余8条评论

63

这里提出的所有其他解决方案,以及大多数进行HTML实体编码/解码的JavaScript库,都存在一些错误:

为了得到一个健壮的解决方案,避免所有这些问题,可以使用我编写的一个叫做he的库。从它的README中可以看到:

he(“HTML实体”)是一个用JavaScript编写的强大的HTML实体编码器/解码器。它支持HTML中的所有标准命名字符引用, 处理模棱两可的&号和其他边缘情况就像浏览器一样, 有广泛的测试套件,并且与许多其他JavaScript解决方案不同,he可以很好地处理星际Unicode符号。提供在线演示。


(1),(3),(4)和(5)讨论解码而非编码,并且忽略了问题的要点。_he_库还是很棒的,只是不太需要回答这个问题。您可以查看我的解决方案,用短小精悍的JavaScript实现(仅编码)。 - kritzikratzi

21

使用escape()应该适用于字符编码范围为0x00到0xFF(UTF-8范围)。

如果超出0xFF(255),例如0x100(256),则escape()将无法正常工作:

escape("\u0100"); // %u0100

并且:

text = "\u0100"; // Ā
html = escape(text).replace(/%(..)/g,"&#x$1;"); // &#xu0;100

因此,如果您想覆盖http://www.w3.org/TR/html4/sgml/entities.html上定义的所有Unicode字符,则可以使用类似以下内容的东西:

var html = text.replace(/[\u00A0-\u00FF]/g, function(c) {
   return '&#'+c.charCodeAt(0)+';';
});

请注意,此处的范围为:\u00A0-\u00FF。

这是http://www.w3.org/TR/html4/sgml/entities.html中定义的第一个字符代码范围,与escape()所覆盖的范围相同。

您还需要添加其他想要覆盖的范围,或者全部覆盖。

示例:带有一般标点符号的UTF-8范围(\u00A0-\u00FF和\u2022-\u2135)

var html = text.replace(/[\u00A0-\u00FF\u2022-\u2135]/g, function(c) {
   return '&#'+c.charCodeAt(0)+';';
});

编辑:

顺便说一句:\u00A0-\u2666 应该将不在 ASCII 范围内的所有 Unicode 字符代码盲目转换为 HTML 实体:

var html = text.replace(/[\u00A0-\u2666]/g, function(c) {
   return '&#'+c.charCodeAt(0)+';';
});

非常好的观点,bucabay...我正在处理UTF8的最简单情况,使用了一个快速的hack,但这绝对是一个更健壮的解决方案。传递函数来处理正则表达式替换的方法很棒,我忘记了可以这样做。点赞。但需要快速修复一下,将&、小于号和大于号添加到字符范围中,以便完全替换我的代码。 - richardtallent
这比那些HTML编码查找服务要容易得多。尝试将其作为书签?alert(prompt('输入要进行HTML编码的字符', '').replace(/[\u00A0-\u2666]/g, function(c) { return '&#'+c.charCodeAt(0)+';'; })); - drzaus
3
这种方法没有考虑HTML标准中的字符引用覆盖。例如,htmlEncode('\x80')不应返回&#x80;&#128;。事实上,它根本不应该返回HTML实体;在HTML中没有有效的表示该字符的方式。请参见我的答案以获取更多信息和更好的解决方案。 - Mathias Bynens
最后一次编辑真是救了我们。谢谢你。我正在处理从服务器返回的一些HTML,并尝试在弹出窗口中打开它。这个很有用。 - Avindra Goolcharan

8

He 库是我所知道的唯一可靠的100%解决方案!

He 由全球最著名的 JavaScript 大师之一 Mathias Bynens 编写,并具有以下特点:


示例用法

he.encode('foo © bar ≠ baz  qux'); 
// Output : 'foo &#xA9; bar &#x2260; baz &#x1D306; qux'

he.decode('foo &copy; bar &ne; baz &#x1D306; qux');
// Output : 'foo © bar ≠ baz  qux'

问题是一个不需要使用库的本地解决方案。 - chovy

7

您可以使用:

function encodeHTML(str){
 var aStr = str.split(''),
     i = aStr.length,
     aRet = [];

   while (i--) {
    var iC = aStr[i].charCodeAt();
    if (iC < 65 || iC > 127 || (iC>90 && iC<97)) {
      aRet.push('&#'+iC+';');
    } else {
      aRet.push(aStr[i]);
    }
  }
 return aRet.reverse().join('');
}

这个函数对除了a-z/A-Z以外的所有内容进行HTML编码。

[编辑] 这是一个比较旧的答案。我们可以添加一个更简单的字符串扩展来编码所有扩展字符:

String.prototype.encodeHTML = function () {
  return this.replace(/[\u0080-\u024F]/g, 
          function (v) {return '&#'+v.charCodeAt()+';';}
         );
}
// usage
log('Übergroße Äpfel mit Würmern'.encodeHTML());
//=> '&#220;bergro&#223;e &#196;pfel mit W&#252;rmern'

这样做比使用text.replace()快得多。我喜欢在循环中使用while(--i)而不是for()循环。我猜想这样做的理论是对于大文本/循环,快速条件测试抵消了Array.reverse().join('')在循环外部的影响。否则你会使用字符串连接吗? - bucabay
谢谢。递减循环确实比递增循环更快,这是我很久以前读到的优化步骤,我大多数时候都使用它(而且代码更少)。我不确定“反向”部分是否能够抵消速度上的收益。对于较短的字符串,使用aRet[i] = [value]可能仍然比使用aRet.push更快(正如“olliej”在https://dev59.com/rHRB5IYBdhLWcg3weHHx中非常好地解释了)。 - KooiInc
2
当到达第一个字符时,“--i”将等于0。你的条件应该是“while (--i >= 0)”,否则你会丢失输入字符串的第一个字符。 - Ali Gangji
@AliGangji,是的,应该是i--,已经调整了答案。 - KooiInc
这个示例似乎对Unicode字符有缺陷;请参见https://dev59.com/PWoMtIcB2Jgan1znimw9#69588382以获取更好的encodeHTML()选项。 - user1432181

4

拥有一个包含大量replace()调用的查找表是缓慢且难以维护的。

幸运的是,内置的escape()函数也编码了大多数相同的字符,并将它们放在一个一致的格式中(%XX,其中XX是字符的十六进制值)。

因此,您可以让escape()方法为您完成大部分工作,只需将其答案更改为HTML实体而不是URL转义字符:

htmlescaped = escape(mystring).replace(/%(..)/g,"&#x$1;");

这里使用十六进制格式来转义值,而不是命名实体。但对于存储和显示数值,它与命名实体一样有效。

当然,转义也会转义在 HTML 中本来无需转义的字符(例如空格),但您可以使用几个替换调用将其还原。

编辑:我喜欢 bucabay 的答案胜过我的... 能够处理更大范围的字符,并且不需要事后进行任何修改以将空格、斜线等还原。


2
这种方法没有考虑HTML标准中的字符引用覆盖。例如,htmlEncode('\x80')不应返回&#x80;&#128;。实际上,它根本不应该返回HTML实体;在HTML中没有有效的表示该字符的方式。请参见我的答案以获取更多信息和更好的解决方案。 - Mathias Bynens
实际上,这对于\u00FF范围之外的字符无效。 - kritzikratzi

3

我通过使用encodeURIComponent()来解决了我的问题,而不是使用escape()

如果您的问题出现在将字符串发送到URL时,请尝试使用这种方法。

请用短语(“hi & % ‘”)尝试一下。

escape()返回

"hi%20%26%20%25%20%u2018"

请注意,%u2018 不符合 url 规范,可能会破坏查询字符串的其他部分。 encodeURI() 返回:
"hi%20&%20%25%20%E2%80%98"

注意到这里还有个“&”符号。

encodeURIComponent() 返回:

"hi%20%26%20%25%20%E2%80%98"

最后,我们所有的字符都已经正确编码。

3

JSFiddle演示

这里有一个简单的独立方法:

  • 尝试汇总此页面上的答案,而无需使用库
  • 适用于旧版浏览器
  • 支持代理对(例如表情符号)
  • 应用字符覆盖(什么是字符覆盖?不太确定)

我对Unicode了解不多,但它似乎运行良好。

// escape a string for display in html
// see also: 
// polyfill for String.prototype.codePointAt
//   https://raw.githubusercontent.com/mathiasbynens/String.prototype.codePointAt/master/codepointat.js
// how to convert characters to html entities
//     https://dev59.com/fHM_5IYBdhLWcg3wfTS7#1354491
// html overrides from 
//   https://html.spec.whatwg.org/multipage/syntax.html#table-charref-overrides / https://dev59.com/fHM_5IYBdhLWcg3wfTS7#W6blnYgBc1ULPQZFI-tW

var _escape_overrides = { 0x00:'\uFFFD',0x80:'\u20AC',0x82:'\u201A',0x83:'\u0192',0x84:'\u201E',0x85:'\u2026',0x86:'\u2020',0x87:'\u2021',0x88:'\u02C6',0x89:'\u2030',0x8A:'\u0160',0x8B:'\u2039',0x8C:'\u0152',0x8E:'\u017D',0x91:'\u2018',0x92:'\u2019',0x93:'\u201C',0x94:'\u201D',0x95:'\u2022',0x96:'\u2013',0x97:'\u2014',0x98:'\u02DC',0x99:'\u2122',0x9A:'\u0161',0x9B:'\u203A',0x9C:'\u0153',0x9E:'\u017E',0x9F:'\u0178' }; 

function escapeHtml(str){
    return str.replace(/([\u0000-\uD799]|[\uD800-\uDBFF][\uDC00-\uFFFF])/g, function(c) {
        var c1 = c.charCodeAt(0);
        // ascii character, use override or escape
        if( c1 <= 0xFF ) return (c1=_escape_overrides[c1])?c1:escape(c).replace(/%(..)/g,"&#x$1;");
        // utf8/16 character
        else if( c.length == 1 ) return "&#" + c1 + ";"; 
        // surrogate pair
        else if( c.length == 2 && c1 >= 0xD800 && c1 <= 0xDBFF ) return "&#" + ((c1-0xD800)*0x400 + c.charCodeAt(1) - 0xDC00 + 0x10000) + ";"
        // no clue .. 
        else return "";
    });
}

当使用str = ⚠️时,似乎会失败。请改用下面KooiInc的encodeHTML(https://dev59.com/fHM_5IYBdhLWcg3wfTS7#1354489)。 - user1432181

1

我只是将 @bucababy 的 答案 转发为“书签”,因为有时使用 那些 查询 页面比较容易:

alert(prompt('Enter characters to htmlEncode', '').replace(/[\u00A0-\u2666]/g, function(c) {
   return '&#'+c.charCodeAt(0)+';';
}));

1
这对于星际符号不起作用(例如尝试“”,并且它还有一些其他问题)。请考虑使用我的在线HTML实体编码器/解码器,而不是这个书签。链接 - Mathias Bynens
@MathiasBynens你显然考虑得更多,并且是正确的,但它仍然不是一个书签小程序 ;) - drzaus
1
请注意,我之前不知道@MathiasBynens在说什么,因此将链接指向了星体符号(http://www.tlg.uci.edu/~opoudjis/unicode/unicode_astral.html)。 - drzaus
1
在我看来,将http://mothereff.in/html-entities#%s添加为浏览器的自定义搜索引擎要方便得多,但如果您坚持的话:javascript:void (function(){location='http://mothereff.in/html-entities#'+encodeURIComponent(pro‌​mpt('Enter text to HTML-encode:',''))}()) - Mathias Bynens

1

我建议使用JS库entities。使用该库非常简单。请参阅文档中的示例:

const entities = require("entities");
//encoding
entities.escape("&#38;"); // "&#x26;#38;"
entities.encodeXML("&#38;"); // "&amp;#38;"
entities.encodeHTML("&#38;"); // "&amp;&num;38&semi;"
//decoding
entities.decodeXML("asdf &amp; &#xFF; &#xFC; &apos;"); // "asdf & ÿ ü '"
entities.decodeHTML("asdf &amp; &yuml; &uuml; &apos;"); // "asdf & ÿ ü '"

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接