[源码分析系列] json_encode() 如何转化一个对象？

2024-05-14 18:08
文章标签 分析 源码 json 对象 系列 转化 encode

本文主要是介绍[源码分析系列] json_encode() 如何转化一个对象？，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

https://juejin.im/post/5c80b5ec6fb9a049f23d8a33

json_encode()如何转化一个对象？ 使用 json_encode() 将数组 array 转化成 json 字符串我们都已经很熟悉了

那么使用 json_encode() 转化一个对象是什么样的过程呢？

初步测试

我们需要新建一个具有多种属性的对象

新建 JsonTest

class JsonTest
{public const TEST = 'c';public $a = 'a';public static $b = 'b';protected $e = 'e';private $d = 'd';protected function test1(){return __FUNCTION__;}private function test2(){return __FUNCTION__;}public function test3(){return __FUNCTION__;}public static function test4(){return __FUNCTION__;}
}

执行

打印结果

echo json_encode(new JsonTest());
复制代码

输出

{ "a": "a" }
复制代码

可以看得出，只有公开非静态的属性被打印出来了，其他东西（常量、私有变量、方法等等）都丢失了。

思考

在实际的应用中，多数情况下，我们的属性都是非公开的，但是我们又想在执行 json_encode() 的时候将它打印出来，该怎么办呢？

JsonSerializable

JsonSerializable 是一个 PHP 的 JSON 序列化接口

官方定义

JSON 序列化接口

(PHP 5 >= 5.4.0, PHP 7)

简介

实现 JsonSerializable 的类可以 在 json_encode() 时定制他们的 JSON 表示法。

接口摘要

JsonSerializable {/* 方法 */abstract public jsonSerialize ( void ) : mixed
}
复制代码

可以看出 php 版本低于 5.4 是没有这个接口的

修改 JsonTest 继续测试

修改 JsonTest 让它实现 JsonSerializable，并为其写一个 jsonSerialize 方法

class JsonTest implements JsonSerializable
{public const TEST = 'c';public $a = 'a';public static $b = 'b';protected $e = 'e';private $d = 'd';protected function test1(){return __FUNCTION__;}private function test2(){return __FUNCTION__;}public function test3(){return __FUNCTION__;}public static function test4(){return __FUNCTION__;}public function jsonSerialize(){$json = array();foreach ($this as $key => $value) {$json[$key] = $value;}return $json;}
}
复制代码

执行

打印结果

echo json_encode(new JsonTest());
复制代码

输出

{ "a": "a", "e": "e", "d": "d" }
复制代码

可以看得出，公开属性和私有属性都被打印出来了，方法，常量以及静态变量没有打印出来（这是因为类(class)中静态变量和常量的实现方式是所有对象共享的，并不具体属于某个类）

源码分析

这部分源码较多，我会按照源码中的 function 来一个一个进行分析，注意看代码块中的注释

里边对应有一些 option 的位运算，我先贴出来每个 option 常量对应的值， << 是左移

/* json_encode() options */
#define PHP_JSON_HEX_TAG                    (1<<0)
#define PHP_JSON_HEX_AMP                    (1<<1)
#define PHP_JSON_HEX_APOS                   (1<<2)
#define PHP_JSON_HEX_QUOT                   (1<<3)
#define PHP_JSON_FORCE_OBJECT               (1<<4)
#define PHP_JSON_NUMERIC_CHECK              (1<<5)
#define PHP_JSON_UNESCAPED_SLASHES          (1<<6)
#define PHP_JSON_PRETTY_PRINT               (1<<7)
#define PHP_JSON_UNESCAPED_UNICODE          (1<<8)
#define PHP_JSON_PARTIAL_OUTPUT_ON_ERROR    (1<<9)
#define PHP_JSON_PRESERVE_ZERO_FRACTION     (1<<10)
#define PHP_JSON_UNESCAPED_LINE_TERMINATORS (1<<11)
复制代码

函数本身

PHP_JSON_API int php_json_encode(smart_str *buf, zval *val, int options) /* {{{ */
{return php_json_encode_ex(buf, val, options, JSON_G(encode_max_depth));
}PHP_JSON_API int php_json_encode_ex(smart_str *buf, zval *val, int options, zend_long depth) /* {{{ */
{php_json_encoder encoder;int return_code;// 初始化，开辟内存空间php_json_encode_init(&encoder);encoder.max_depth = depth;// 真正用于编码的函数体return_code = php_json_encode_zval(buf, val, options, &encoder);JSON_G(error_code) = encoder.error_code;return return_code;
}
/* }}} */
复制代码

可以看出真正的编码函数是 php_json_encode_zval()

php_json_encode_zval()

smart_str_appendl() 是一个拼接字符串的函数，第三个参数是字符串的长度

buf 就是最终要返回的 json 字符串

int php_json_encode_zval(smart_str *buf, zval *val, int options, php_json_encoder *encoder) /* {{{ */
{
again:switch (Z_TYPE_P(val)){case IS_NULL:smart_str_appendl(buf, "null", 4);break;case IS_TRUE:smart_str_appendl(buf, "true", 4);break;case IS_FALSE:smart_str_appendl(buf, "false", 5);break;case IS_LONG:smart_str_append_long(buf, Z_LVAL_P(val));break;case IS_DOUBLE:if (php_json_is_valid_double(Z_DVAL_P(val))) {php_json_encode_double(buf, Z_DVAL_P(val), options);} else {encoder->error_code = PHP_JSON_ERROR_INF_OR_NAN;smart_str_appendc(buf, '0');}break;case IS_STRING:return php_json_escape_string(buf, Z_STRVAL_P(val), Z_STRLEN_P(val), options, encoder);case IS_OBJECT:// 如果对象实现了JsonSerializable，就将对象中的jsonSerialize()返回的结果进行编码if (instanceof_function(Z_OBJCE_P(val), php_json_serializable_ce)) {return php_json_encode_serializable_object(buf, val, options, encoder);}// 如果对象没有实现了JsonSerializable，就执行下边的这个php_json_encode_array()/* fallthrough -- Non-serializable object */case IS_ARRAY:// 解析数组return php_json_encode_array(buf, val, options, encoder);case IS_REFERENCE://忽略引用val = Z_REFVAL_P(val);goto again;default:encoder->error_code = PHP_JSON_ERROR_UNSUPPORTED_TYPE;if (options & PHP_JSON_PARTIAL_OUTPUT_ON_ERROR) {smart_str_appendl(buf, "null", 4);}return FAILURE;}return SUCCESS;
}
/* }}} */
复制代码

php_json_encode_array()

这个函数递归编码数组及没有实现JsonSerializable()的对象（只编码对象的公开属性）

static int php_json_encode_array(smart_str *buf, zval *val, int options, php_json_encoder *encoder) /* {{{ */
{int i, r, need_comma = 0;HashTable *myht;// r用来表示输出 `json` 的结构类型是数组还是对象// 只有自然排序的数组（['a','b','c']）才有可能被输出为数组（考虑option可能为JSON_FORCE_OBJECT）if (Z_TYPE_P(val) == IS_ARRAY) {// 如果是数组myht = Z_ARRVAL_P(val);// options中有JSON_FORCE_OBJECT 就强制输出对象，否则就判断数组是不是自然数组r = (options & PHP_JSON_FORCE_OBJECT) ? PHP_JSON_OUTPUT_OBJECT : php_json_determine_array_type(val);} else {myht = Z_OBJPROP_P(val);//对象就是输出对象r = PHP_JSON_OUTPUT_OBJECT;}if (myht && ZEND_HASH_GET_APPLY_COUNT(myht) > 0) {encoder->error_code = PHP_JSON_ERROR_RECURSION;smart_str_appendl(buf, "null", 4);return FAILURE;}PHP_JSON_HASH_APPLY_PROTECTION_INC(myht);if (r == PHP_JSON_OUTPUT_ARRAY) {//输出为数组 就用 [ 做开头smart_str_appendc(buf, '[');} else {//输出为对象 就用 { 做开头smart_str_appendc(buf, '{');}// 当前递归的深度++encoder->depth;// zend_hash_num_elements 返回哈希表中元素的数量i = myht ? zend_hash_num_elements(myht) : 0;if (i > 0) {zend_string *key;zval *data;zend_ulong index;//遍历当前维度的数组 如果当前元素不是数组ZEND_HASH_FOREACH_KEY_VAL_IND(myht, index, key, data) {// ↓ begin 从这里开始都是判断key怎么处理以及元素末尾怎么处理  ↓↓↓↓if (r == PHP_JSON_OUTPUT_ARRAY) {//need_comma初始值是0if (need_comma) {smart_str_appendc(buf, ',');} else {need_comma = 1;}//这两个方法是option中有JSON_PRETTY_PRINT的时候才会执行的php_json_pretty_print_char(buf, options, '\n');php_json_pretty_print_indent(buf, options, encoder);} else if (r == PHP_JSON_OUTPUT_OBJECT) {if (key) {if (ZSTR_VAL(key)[0] == '\0' && ZSTR_LEN(key) > 0 && Z_TYPE_P(val) == IS_OBJECT) {//跳过受保护的属性和私有属性/* Skip protected and private members. */continue;}//need_comma初始值是0if (need_comma) {smart_str_appendc(buf, ',');} else {need_comma = 1;}php_json_pretty_print_char(buf, options, '\n');php_json_pretty_print_indent(buf, options, encoder);// 处理字符串属性的key（例如判断key中的中文或者特殊字符的处理）if (php_json_escape_string(buf, ZSTR_VAL(key), ZSTR_LEN(key),options & ~PHP_JSON_NUMERIC_CHECK, encoder) == FAILURE &&(options & PHP_JSON_PARTIAL_OUTPUT_ON_ERROR) &&buf->s) {ZSTR_LEN(buf->s) -= 4;smart_str_appendl(buf, "\"\"", 2);}} else {if (need_comma) {smart_str_appendc(buf, ',');} else {need_comma = 1;}php_json_pretty_print_char(buf, options, '\n');php_json_pretty_print_indent(buf, options, encoder);smart_str_appendc(buf, '"');smart_str_append_long(buf, (zend_long) index);smart_str_appendc(buf, '"');}smart_str_appendc(buf, ':');php_json_pretty_print_char(buf, options, ' ');}// ↑ end 从这里之前都是判断key怎么处理以及元素末尾怎么处理  ↑↑↑↑//继续调用对普通元素编码的 php_json_encode_zval() （实现数组和对象的递归闭环）if (php_json_encode_zval(buf, data, options, encoder) == FAILURE &&!(options & PHP_JSON_PARTIAL_OUTPUT_ON_ERROR)) {PHP_JSON_HASH_APPLY_PROTECTION_DEC(myht);return FAILURE;}} ZEND_HASH_FOREACH_END();}PHP_JSON_HASH_APPLY_PROTECTION_DEC(myht);// 当前深度是否到达了设定的最大深度（默认512）if (encoder->depth > encoder->max_depth) {encoder->error_code = PHP_JSON_ERROR_DEPTH;if (!(options & PHP_JSON_PARTIAL_OUTPUT_ON_ERROR)) {return FAILURE;}}--encoder->depth;/* Only keep closing bracket on same line for empty arrays/objects */if (need_comma) {php_json_pretty_print_char(buf, options, '\n');php_json_pretty_print_indent(buf, options, encoder);}if (r == PHP_JSON_OUTPUT_ARRAY) {smart_str_appendc(buf, ']');} else {smart_str_appendc(buf, '}');}return SUCCESS;
}
/* }}} */
复制代码

分析

看了源码，我得出了一些结论。

  • 只有 null，布尔值，浮点数，整数，字符串才会被直接编码
  • 对象要么实现 JsonSerializable 并定义一个 jsonSerialize() ，要么就被当成一个数组，只会被处理公开非静态属性
  • json_encode() 并不会直接编码数组和对象，而是会递归遍历出所有可遍历的元素，并处理 key
  • 源码中 php_json_encode_zval() 和 php_json_encode_array() 的相互调用，实现了数组和对象遍历的闭环
  • 引用不会被编码

另外，关于 json_encode() 的 options ，我觉得这里处理的技巧非常有趣，巧妙利用位运算来区别多个常量，有兴趣的慢慢看看研究研究。（提示，将 options 每个常量转成二进制来看，json_encode() 接受多个 option 是按位或 | ）

Demo

>>> $a = [1,2,3,4];
=> [1,2,3,4,]
>>> json_encode($a);
=> "[1,2,3,4]"
>>> json_encode((object)$a);
=> "{"0":1,"1":2,"2":3,"3":4}"
>>> json_encode($a,JSON_FORCE_OBJECT);
=> "{"0":1,"1":2,"2":3,"3":4}"
>>> json_encode($a,JSON_FORCE_OBJECT|JSON_PRETTY_PRINT);
=> """{\n"0": 1,\n"1": 2,\n"2": 3,\n"3": 4\n}"""
$arr = array('0'=>'a','1'=>'b','2'=>'c','3'=>'d'
);
echo json_encode($arr);

但是结果是

["a","b","c","d"]

需求是要返回JSON对象，是这样似的

{"0":"a","1":"b","2":"c","3":"d"}

You can do it，you nee add

$arr = array('0'=>'a','1'=>'b','2'=>'c','3'=>'d'
);
echo json_encode((object)$arr);

输出结果

{"0":"a","1":"b","2":"c","3":"d"}

这篇关于[源码分析系列] json_encode() 如何转化一个对象？的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

原文地址:
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.chinasem.cn/article/989464。

相关文章

Python使用Code2flow将代码转化为流程图的操作教程

Python使用Code2flow将代码转化为流程图的操作教程

《Python使用Code2flow将代码转化为流程图的操作教程》Code2flow是一款开源工具,能够将代码自动转换为流程图,该工具对于代码审查、调试和理解大型代码库非常有用,在这篇博客中,我们将深... 目录引言1nVflRA、为什么选择 Code2flow？2、安装 Code2flow3、基本功能演示
阅读更多...
Spring中管理bean对象的方式(专业级说明)

Spring中管理bean对象的方式(专业级说明)

《Spring中管理bean对象的方式(专业级说明)》在Spring框架中,Bean的管理是核心功能,主要通过IoC（控制反转）容器实现,下面给大家介绍Spring中管理bean对象的方式,感兴趣的朋... 目录1.Bean的声明与注册1.1 基于XML配置1.2 基于注解（主流方式）1.3 基于Java
阅读更多...
C++/类与对象/默认成员函数@构造函数的用法

C++/类与对象/默认成员函数@构造函数的用法

《C++/类与对象/默认成员函数@构造函数的用法》：本文主要介绍C++/类与对象/默认成员函数@构造函数的用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录名词概念默认成员函数构造函数概念函数特征显示构造函数隐式构造函数总结名词概念默认构造函数：不用传参就可以
阅读更多...
C++类和对象之默认成员函数的使用解读

C++类和对象之默认成员函数的使用解读

《C++类和对象之默认成员函数的使用解读》：本文主要介绍C++类和对象之默认成员函数的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、默认成员函数有哪些二、各默认成员函数详解默认构造函数析构函数拷贝构造函数拷贝赋值运算符三、默认成员函数的注意事项总结一
阅读更多...
Apache 高级配置实战之从连接保持到日志分析的完整指南

Apache 高级配置实战之从连接保持到日志分析的完整指南

《Apache高级配置实战之从连接保持到日志分析的完整指南》本文带你从连接保持优化开始,一路走到访问控制和日志管理,最后用AWStats来分析网站数据,对Apache配置日志分析相关知识感兴趣的朋友... 目录Apache 高级配置实战：从连接保持到日志分析的完整指南前言 一、Apache 连接保持 - 性
阅读更多...
Linux中的more 和 less区别对比分析

Linux中的more 和 less区别对比分析

《Linux中的more和less区别对比分析》在Linux/Unix系统中,more和less都是用于分页查看文本文件的命令,但less是more的增强版,功能更强大,：本文主要介绍Linu... 目录1. 基础功能对比2. 常用操作对比less 的操作3. 实际使用示例4. 为什么推荐 less？5.
阅读更多...
spring-gateway filters添加自定义过滤器实现流程分析(可插拔)

spring-gateway filters添加自定义过滤器实现流程分析(可插拔)

《spring-gatewayfilters添加自定义过滤器实现流程分析(可插拔)》：本文主要介绍spring-gatewayfilters添加自定义过滤器实现流程分析(可插拔),本文通过实例图... 目录需求背景需求拆解设计流程及作用域逻辑处理代码逻辑需求背景公司要求，通过公司网络代理访问的请求需要做请
阅读更多...
Java集成Onlyoffice的示例代码及场景分析

Java集成Onlyoffice的示例代码及场景分析

《Java集成Onlyoffice的示例代码及场景分析》：本文主要介绍Java集成Onlyoffice的示例代码及场景分析,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 需求场景：实现文档的在线编辑，团队协作总结：两个接口 + 前端页面 + 配置项接口1：一个接口，将o
阅读更多...
golang 对象池sync.Pool的实现

golang 对象池sync.Pool的实现

《golang对象池sync.Pool的实现》：本文主要介绍golang对象池sync.Pool的实现,用于缓存和复用临时对象,以减少内存分配和垃圾回收的压力,下面就来介绍一下,感兴趣的可以了解... 目录sync.Pool的用法原理sync.Pool 的使用示例sync.Pool 的使用场景注意sync.
阅读更多...
IDEA下"File is read-only"可能原因分析及"找不到或无法加载主类"的问题

IDEA下"File is read-only"可能原因分析及"找不到或无法加载主类"的问题

《IDEA下Fileisread-only可能原因分析及找不到或无法加载主类的问题》：本文主要介绍IDEA下Fileisread-only可能原因分析及找不到或无法加载主类的问题,具有很好的参... 目录1.File is read-only”可能原因2.“找不到或无法加载主类”问题的解决总结1.File
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2