提问人:Page 提问时间:8/24/2008 最后编辑:Matt FenwickPage 更新时间:1/12/2022 访问量:766600
使用 jQuery 转义 HTML 字符串
Escaping HTML strings with jQuery
问:
有谁知道一种简单的方法可以从jQuery中的字符串中转义HTML?我需要能够传递任意字符串并使其正确转义以显示在 HTML 页面中(防止 JavaScript/HTML 注入攻击)。我确信可以扩展jQuery来做到这一点,但我目前对框架的了解还不够,无法做到这一点。
答:
如果你要转义 HTML,我能想到的只有三个是真正必要的:
html.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">");
根据您的用例,您可能还需要执行以下操作: .如果列表足够大,我只会使用一个数组:"
"
var escaped = html;
var findReplace = [[/&/g, "&"], [/</g, "<"], [/>/g, ">"], [/"/g, """]]
for(var item in findReplace)
escaped = escaped.replace(findReplace[item][0], findReplace[item][1]);
encodeURIComponent()
只会对 URL 进行转义,而对 HTML 不进行转义。
评论
var
item
for … in
for
encodeURIComponent
escapeURIComponent
é
由于您使用的是 jQuery,因此只需设置元素的 text
属性:
// before:
// <div class="someClass">text</div>
var someHtmlString = "<script>alert('hi!');</script>";
// set a DIV's text:
$("div.someClass").text(someHtmlString);
// after:
// <div class="someClass"><script>alert('hi!');</script></div>
// get the text in a string:
var escaped = $("<div>").text(someHtmlString).html();
// value:
// <script>alert('hi!');</script>
评论
.text()
.attr()
$('<div/>').text('This is fun & stuff').html(); // "This is fun & stuff"
来源:http://debuggable.com/posts/encode-html-entities-with-jquery:480f4dd6-13cc-4ce9-8071-4710cbdd56cb
评论
如果你要走正则表达式路线,上面的 tghw 示例中有一个错误。
<!-- WON'T WORK - item[0] is an index, not an item -->
var escaped = html;
var findReplace = [[/&/g, "&"], [/</g, "<"], [/>/g,">"], [/"/g,
"""]]
for(var item in findReplace) {
escaped = escaped.replace(item[0], item[1]);
}
<!-- WORKS - findReplace[item[]] correctly references contents -->
var escaped = html;
var findReplace = [[/&/g, "&"], [/</g, "<"], [/>/g, ">"], [/"/g, """]]
for(var item in findReplace) {
escaped = escaped.replace(findReplace[item[0]], findReplace[item[1]]);
}
评论
escape()
并且旨在对 URL 的字符串进行编码/解码,而不是 HTML。unescape()
实际上,我使用以下代码片段来执行不需要任何框架的技巧:
var escapedHtml = html.replace(/&/g, '&')
.replace(/>/g, '>')
.replace(/</g, '<')
.replace(/"/g, '"')
.replace(/'/g, ''');
评论
"
'
这是一个干净、清晰的 JavaScript 函数。它会将诸如“少数<许多”之类的文本转义为“少数<很多”。
function escapeHtmlEntities (str) {
if (typeof jQuery !== 'undefined') {
// Create an empty div to use as a container,
// then put the raw text in and get the HTML
// equivalent out.
return jQuery('<div/>').text(str).html();
}
// No jQuery, so use string replace.
return str
.replace(/&/g, '&')
.replace(/>/g, '>')
.replace(/</g, '<')
.replace(/"/g, '"')
.replace(/'/g, ''');
}
function htmlEscape(str) {
var stringval="";
$.each(str, function (i, element) {
alert(element);
stringval += element
.replace(/&/g, '&')
.replace(/"/g, '"')
.replace(/'/g, ''')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(' ', '-')
.replace('?', '-')
.replace(':', '-')
.replace('|', '-')
.replace('.', '-');
});
alert(stringval);
return String(stringval);
}
试试Underscore.string lib,它适用于jQuery。
_.str.escapeHTML('<div>Blah blah blah</div>')
输出:
'<div>Blah blah blah</div>'
评论
_.escape()
var entityMap = {
'&': '&',
'<': '<',
'>': '>',
'"': '"',
"'": ''',
'/': '/',
'`': '`',
'=': '='
};
function escapeHtml (string) {
return String(string).replace(/[&<>"'`=\/]/g, function (s) {
return entityMap[s];
});
}
评论
&
#
;
/([<>"'`=\/]|&(?!([a-zA-Z]{1,8}\d{0,2}|#(\d{1,4}|x[a-zA-Z\d]{1,4}));))/g
escapeHtml('"This"	=	a &v3ry; &dumb; quote.')
'"This"	=	a &v3ry; &dumb; quote.'
'"This"\t=\ta &v3ry; &dumb; quote.'
"This" = a &v3ry; &dumb; quote.
这个答案提供了 jQuery 和普通的 JS 方法,但在不使用 DOM 的情况下这是最短的:
unescape(escape("It's > 20% less complicated this way."))
转义字符串:It%27s%20%3E%2020%25%20less%20complicated%20this%20way.
如果转义空格困扰您,请尝试:
unescape(escape("It's > 20% less complicated this way.").replace(/%20/g, " "))
转义字符串:It%27s %3E 20%25 less complicated this way.
不幸的是,该函数在 JavaScript 版本 1.5 中已弃用。 或者是替代方案,但它们忽略了 ,因此最后一行代码将变成这样:escape()
encodeURI()
encodeURIComponent()
'
decodeURI(encodeURI("It's > 20% less complicated this way.").replace(/%20/g, " ").replace("'", '%27'))
所有主流浏览器仍然支持短代码,考虑到旧网站的数量,我怀疑这种情况很快就会改变。
评论
这是一个很好的安全例子......
function escapeHtml(str) {
if (typeof(str) == "string"){
try{
var newStr = "";
var nextCode = 0;
for (var i = 0;i < str.length;i++){
nextCode = str.charCodeAt(i);
if (nextCode > 0 && nextCode < 128){
newStr += "&#"+nextCode+";";
}
else{
newStr += "?";
}
}
return newStr;
}
catch(err){
}
}
else{
return str;
}
}
评论
我写了一个小函数来做到这一点。它只逃脱 、 和 (但通常这就是你所需要的)。它比之前提出的解决方案稍微优雅一些,因为它只使用一个来完成所有转换。(编辑 2:降低了代码复杂性,使函数更小、更整洁,如果您对原始代码感到好奇,请参阅本答案的结尾。"
&
<
>
.replace()
function escapeHtml(text) {
'use strict';
return text.replace(/[\"&<>]/g, function (a) {
return { '"': '"', '&': '&', '<': '<', '>': '>' }[a];
});
}
这是普通的 Javascript,没有使用 jQuery。
逃避和太/
'
根据 mklement 的评论进行编辑。
上述功能可以很容易地扩展为包含任何字符。要指定更多要转义的字符,只需将它们插入正则表达式的字符类中(即在 中)和作为对象中的条目。(编辑2:以同样的方式缩短了此功能。/[...]/g
chr
function escapeHtml(text) {
'use strict';
return text.replace(/[\"&'\/<>]/g, function (a) {
return {
'"': '"', '&': '&', "'": ''',
'/': '/', '<': '<', '>': '>'
}[a];
});
}
请注意上面的 for 撇号用法(符号实体可能已被改用 - 它是在 XML 中定义的,但最初不包含在 HTML 规范中,因此可能并非所有浏览器都支持。请参阅:维基百科上关于HTML字符编码的文章)。我还记得在某处读到,使用十进制实体比使用十六进制实体更广泛地得到支持,但我现在似乎找不到它的来源。(而且不可能有很多浏览器不支持十六进制实体。'
'
注意:在转义字符列表中添加 and 并不是那么有用,因为它们在 HTML 中没有任何特殊含义,也不需要转义。/
'
独创功能escapeHtml
编辑2:原始函数使用变量 () 来存储回调所需的对象。这个变量还需要一个额外的匿名函数来限定它的作用,使函数(不必要地)更大、更复杂。chr
.replace()
var escapeHtml = (function () {
'use strict';
var chr = { '"': '"', '&': '&', '<': '<', '>': '>' };
return function (text) {
return text.replace(/[\"&<>]/g, function (a) { return chr[a]; });
};
}());
我还没有测试过两个版本中哪个更快。如果您这样做,请随时在此处添加有关它的信息和链接。
我增强了 mustache.js 示例,将方法添加到字符串对象。escapeHTML()
var __entityMap = {
"&": "&",
"<": "<",
">": ">",
'"': '"',
"'": ''',
"/": '/'
};
String.prototype.escapeHTML = function() {
return String(this).replace(/[&<>"'\/]/g, function (s) {
return __entityMap[s];
});
}
这样就很容易使用了"Some <text>, more Text&Text".escapeHTML()
评论
__entityMap
if (typeof String.prototype.escapeHTML !== 'function'){...}
(function(undefined){
var charsToReplace = {
'&': '&',
'<': '<',
'>': '>'
};
var replaceReg = new RegExp("[" + Object.keys(charsToReplace).join("") + "]", "g");
var replaceFn = function(tag){ return charsToReplace[tag] || tag; };
var replaceRegF = function(replaceMap) {
return (new RegExp("[" + Object.keys(charsToReplace).concat(Object.keys(replaceMap)).join("") + "]", "gi"));
};
var replaceFnF = function(replaceMap) {
return function(tag){ return replaceMap[tag] || charsToReplace[tag] || tag; };
};
String.prototype.htmlEscape = function(replaceMap) {
if (replaceMap === undefined) return this.replace(replaceReg, replaceFn);
return this.replace(replaceRegF(replaceMap), replaceFnF(replaceMap));
};
})();
没有全局变量,一些内存优化。 用法:
"some<tag>and&symbol©".htmlEscape({'©': '©'})
结果是:
"some<tag>and&symbol©"
function htmlDecode(t){
if (t) return $('<div />').html(t).text();
}
像魅力一样工作
评论
经过上次测试,我可以推荐最快且完全跨浏览器兼容的原生 javaScript(DOM)解决方案:
function HTMLescape(html){
return document.createElement('div')
.appendChild(document.createTextNode(html))
.parentNode
.innerHTML
}
如果你重复很多次,你可以用准备好的变量来做:
//prepare variables
var DOMtext = document.createTextNode("test");
var DOMnative = document.createElement("span");
DOMnative.appendChild(DOMtext);
//main work for each case
function HTMLescape(html){
DOMtext.nodeValue = html;
return DOMnative.innerHTML
}
评论
var p = document.createElement('p'); p.textContent = html; return p.innerHTML;
textContent
p.innerText = html; return p.innerHTML
易于使用的下划线:
_.escape(string)
Underscore 是一个实用程序库,它提供了许多原生 js 不提供的功能。还有 lodash,它与下划线的 API 相同,但被重写以提高性能。
评论
_.unescape(string)
如果您有下划线.js,请使用(比上面发布的jQuery方法更有效):_.escape
_.escape('Curly, Larry & Moe'); // returns: Curly, Larry & Moe
你可以用 vanilla js 轻松做到这一点。
只需在文档中添加一个文本节点即可。 它将被浏览器转义。
var escaped = document.createTextNode("<HTML TO/ESCAPE/>")
document.getElementById("[PARENT_NODE]").appendChild(escaped)
如果要将此信息保存在数据库中,则使用客户端脚本转义 HTML 是错误的,则应在服务器中完成此操作。否则很容易绕过您的 XSS 保护。
为了阐明我的观点,这里有一个使用答案之一的例子:
假设您正在使用函数 escapeHtml 从博客中的评论中转义 Html,然后将其发布到您的服务器。
var entityMap = {
"&": "&",
"<": "<",
">": ">",
'"': '"',
"'": ''',
"/": '/'
};
function escapeHtml(string) {
return String(string).replace(/[&<>"'\/]/g, function (s) {
return entityMap[s];
});
}
用户可以:
- 编辑 POST 请求参数,并将注释替换为 javascript 代码。
- 使用浏览器控制台覆盖 escapeHtml 函数。
如果用户将此代码片段粘贴到控制台中,它将绕过 XSS 验证:
function escapeHtml(string){
return string
}
评论
如果你不防止再次逃逸,所有解决方案都是无用的,例如,大多数解决方案会一直逃逸到 .&
&
escapeHtml = function (s) {
return s ? s.replace(
/[&<>'"]/g,
function (c, offset, str) {
if (c === "&") {
var substr = str.substring(offset, offset + 6);
if (/&(amp|lt|gt|apos|quot);/.test(substr)) {
// already escaped, do not re-escape
return c;
}
}
return "&" + {
"&": "amp",
"<": "lt",
">": "gt",
"'": "apos",
'"': "quot"
}[c] + ";";
}
) : "";
};
评论
2 个不需要 JQUERY 的简单方法...
您可以像这样对字符串中的所有字符进行编码:
function encode(e){return e.replace(/[^]/g,function(e){return"&#"+e.charCodeAt(0)+";"})}
或者只是针对主要角色担心,换行符,,&
<
>
"
'
function encode(r){
return r.replace(/[\x26\x0A\<>'"]/g,function(r){return"&#"+r.charCodeAt(0)+";"})
}
var myString='Encode HTML entities!\n"Safe" escape <script></'+'script> & other tags!';
test.value=encode(myString);
testing.innerHTML=encode(myString);
/*************
* \x26 is &ersand (it has to be first),
* \x0A is newline,
*************/
<p><b>What JavaScript Generated:</b></p>
<textarea id=test rows="3" cols="55"></textarea>
<p><b>What It Renders Too In HTML:</b></p>
<div id="testing">www.WHAK.com</div>
我意识到我参加这个聚会有多晚,但我有一个非常简单的解决方案,不需要jQuery。
escaped = new Option(unescaped).innerHTML;
编辑:这不会转义引号。需要转义引号的唯一情况是,如果内容将内联粘贴到 HTML 字符串中的属性中。我很难想象这样做会是好的设计。
编辑3:要获得最快的解决方案,请查看Saram上面的答案。这个是最短的。
纯 JavaScript 转义示例:
function escapeHtml(text) {
var div = document.createElement('div');
div.innerText = text;
return div.innerHTML;
}
escapeHtml("<script>alert('hi!');</script>")
// "<script>alert('hi!');</script>"
评论
ES6 一个衬里,用于小胡子.js的解决方案
const escapeHTML = str => (str+'').replace(/[&<>"'`=\/]/g, s => ({'&': '&','<': '<','>': '>','"': '"',"'": ''','/': '/','`': '`','=': '='})[s]);
速度优化版本:
function escapeHtml(s) {
let out = "";
let p2 = 0;
for (let p = 0; p < s.length; p++) {
let r;
switch (s.charCodeAt(p)) {
case 34: r = """; break; // "
case 38: r = "&" ; break; // &
case 39: r = "'" ; break; // '
case 60: r = '<' ; break; // <
case 62: r = '>' ; break; // >
default: continue;
}
if (p2 < p) {
out += s.substring(p2, p);
}
out += r;
p2 = p + 1;
}
if (p2 == 0) {
return s;
}
if (p2 < s.length) {
out += s.substring(p2);
}
return out;
}
const s = "Hello <World>!";
document.write(escapeHtml(s));
console.log(escapeHtml(s));
用于转义 html 特殊 (UTF-8)
function htmlEscape(str) {
return str
.replace(/&/g, '&')
.replace(/"/g, '"')
.replace(/'/g, ''')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(/\//g, '/')
.replace(/=/g, '=')
.replace(/`/g, '`');
}
对于 unescape html 特殊 (UTF-8)
function htmlUnescape(str) {
return str
.replace(/&/g, '&')
.replace(/"/g, '"')
.replace(/'/g, "'")
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(///g, '/')
.replace(/=/g, '=')
.replace(/`/g, '`');
}
评论