在PHP 8.3版本中json_validate跟json_decode函数对比浅析
在PHP 8.3版本中添加的json_validate函数,是用于验证传入的字符串是否是合法的JSON字符串。
它只验证合法性,所以json_validate函数相比 json_decode耗用的内存和资源更少,
因为它只分析字符串而不会尝试解码。
函数签名
/**
* 验证传入的字符串是否为合法 JSON 字符串
*
* @param string $json 准备验证的字符串
* @param int $depth 最大嵌套深度,必须大于 0
* @param int $flags 标志掩码,用于指定行为
* @return bool $json 是合法 JSON 字符串时返回 true,否则返回 false
*/
function json_validate(string $json, int $depth = 512, int $flags = 0): bool {}
标志 Flags
json_validate 的第三个参数是 flags,用于指定函数的行为。
在目前,唯一可用的标志是 JSON_INVALID_UTF8_IGNORE。
该标志在 PHP 7.2 中添加,作为 json_decode 的标志常量,
用于忽略对应字符串中的 UTF-8 字符。
json_validate('[1, 2, 3]', flags: JSON_INVALID_UTF8_IGNORE); // true
json_validate("[\"\xc1\xc1\",\"a\"]"); // false
json_validate("[\"\xc1\xc1\",\"a\"]", flags: JSON_INVALID_UTF8_IGNORE); // true
错误处理
json_validate 本身并不会返回错误码,如果你想要获取具体的错误信息,
可用使用 json_last_error 和 json_last_error_msg 获取。
json_validate(""); // false
json_last_error(); // 4
json_last_error_msg(); // "Syntax error"
json_validate("null"); // true
json_last_error(); // 0
json_last_error_msg(); // "No error"
代码示例
验证字符串并抛出异常
if (json_validate($_GET['json']) === false) {
throw new \JsonException(json_last_error_msg(), json_last_error());
}
Polyfill 抢先适配
如果你想提前为 PHP 8.3 做适配,以在 8.3 发布的第一时间无缝切换到 json_validate,
你可以手动定义一个函数,以在之前的版本中模仿 json_validate 的作用。
if (!function_exists('json_validate')) {
function json_validate(string $json, int $depth = 512, int $flags = 0): bool {
if ($flags !== 0 && $flags !== \JSON_INVALID_UTF8_IGNORE) {
throw new \ValueError('json_validate(): Argument #3 ($flags) must be a valid flag (allowed flags: JSON_INVALID_UTF8_IGNORE)');
}
if ($depth <= 0 ) {
throw new \ValueError('json_validate(): Argument #2 ($depth) must be greater than 0');
}
\json_decode($json, null, $depth, $flags);
return \json_last_error() === \JSON_ERROR_NONE;
}
}
由于此函数内部依然使用json_decode,所以其实际上并没有性能上的改进,
只是提供了和json_validate相似的接口。
相关文章