将类 JSON 文本转换为有效的 JSON,并对 HTML script 元素和 XML CDATA 段进行转义。它修复输入,而不是拒绝格式错误的 JSON;当必须拒绝无效输入时,请使用严格的解析器。
需要 Java 8 或更高版本,且无运行时依赖。
<dependency>
<groupId>org.owasp.json-sanitizer</groupId>
<artifactId>json-sanitizer</artifactId>
<version>1.3.0</version>
</dependency>
import com.google.json.JsonSanitizer;
String json = JsonSanitizer.sanitize("{name:'Ada',}");
// {"name":"Ada"}
该清理器在不执行代码的情况下修复常见的类 JavaScript 语法。 它并非 JavaScript 求值器。
| 构造 | 策略 |
|---|---|
'...' | 单引号字符串会被转换为 JSON 字符串。 |
\xAB | 十六进制转义会被转换为 JSON unicode 转义。 |
\012 | 八进制转义会被转换为 JSON unicode 转义。 |
0xAB | 十六进制整数字面量会被转换为 JSON 十进制数字。 |
012 | 八进制整数字面量会被转换为 JSON 十进制数字。 |
+.5 | 十进制数字会被强制转换为 JSON 更严格的格式。 |
[0,,2] | 数组中的省略项会被填充为 null。 |
[1,2,3,] | 末尾逗号会被移除。 |
{foo:"bar"} | 未加引号的属性名会被加上引号。 |
//comments | JS 风格的行注释和块注释会被移除。 |
(...) | 分组括号会被移除。 |
该清理器会修复缺失的标点、结束引号,以及不匹配或缺失的闭合括号。如果输入仅包含空白字符,则会替换为有效的 JSON 字符串 null。
输出具有以下保证(同样记录在 JsonSanitizer 的 Javadoc 中):
[1]],alert(1) 变为 [1]。<script、</script、<!-- 或 -->(无论大小写),因此可以嵌入 HTML script 元素而无需进一步编码。]]>,因此可以嵌入 XML CDATA 段而无需进一步编码。(<![CDATA[ 本身不会被转义。)JSON.parse 可以接受它。它也是一个 JavaScript 表达式,在包裹于括号中后可由 eval 执行,但重复键 __proto__ 的对象在那里是语法错误。任何字符串都不包含原始 U+2028 或 U+2029。\t 和 \n 的短形式,或 \uXXXX);在标记之间仅出现空格、制表符、换行符和回车符。其他字符(包括 U+007F 至 U+009F)按原样出现,因此输出是有效的 Unicode 并允许在 XML 1.0 中使用。转义的孤立代理项是有效的 RFC 8259,但不是 I-JSON。maximumNestingDepth 再次清理它时,会原样返回(通过 Reader 或 InputStream 重载,且 maximumInputLength 至少与输出一样长)。括号默认最多嵌套 64 层(DEFAULT_NESTING_DEPTH),或由 maximumNestingDepth 参数设置,该参数被限制在 1 到 4096 之间;更深的数组或对象会被替换为 null。超过 1024 位有效数字的十六进制和八进制字面量会变为 1e999,即 JavaScript 的 Infinity。数字对象键会以文本形式转换为字符串形式:超出 double 范围的指数会被保留({1e400:0} 变为 {"1e+400":0},而非 "Infinity"),超出 int 范围的指数按原样保留({1e2147483648:0} 变为 {"1e2147483648":0}),因此等值的键可能不同。Reader 和 InputStream 重载最多接受 4 Mi 字符(DEFAULT_MAXIMUM_INPUT_LENGTH),除非指定了 maximumInputLength。该库可在 Java 8 及更高版本上运行。
com.google.json。maximumInputLength 配置。
超出限制会在写入任何输出之前抛出 IOException。Reader
循环可能读取超出限制最多 8,192 个字符;UTF-8 解码可能额外
预读字节。这不是字节数或网络请求限制。provided 作用域中的 JSpecify。如果你的分析工具
需要它们,请将 org.jspecify:jspecify:1.0.1 添加到你的构建中。使用 JSON.parse 或 JSON 解析器解析输出。净化不会验证
业务规则、授权操作,也不会使解析后的值对 innerHTML、
SQL、shell 命令或后续 JavaScript 执行安全。上述嵌入保证
不适用于 HTML 属性或任意输出上下文。
EvalMinifier 已弃用。它生成的是需要执行的 JavaScript 表达式,
而不是供 JSON.parse 使用的 JSON;严格的 Content Security Policy
会阻止 eval。仅在现有集成中保留它。
使用 JDK 17 或更高版本以及 3.x 系列中的 Maven 3.6.3 或更高版本进行构建:
mvn -B -ntp clean verify
CI 构建基于 JDK 21,并在 Java 8、11、17、21 和 25 上进行测试,同时包含 Jazzer 模糊测试和 OSS-Fuzz 构建检查。有关模型辅助审查,请参阅 MODELS.md;有关发布流程,请参阅发布指南。 现代化归档保留了历史决策和证据;它并非当前的设置指南。