人妻无码一区二区19P,日本二区三区欧美亚洲国产

主頁(yè) > 知識(shí)庫(kù) > 源碼分析系列之json_encode()如何轉(zhuǎn)化一個(gè)對(duì)象

源碼分析系列之json_encode()如何轉(zhuǎn)化一個(gè)對(duì)象

初步測(cè)試

我們需要新建一個(gè)具有多種屬性的對(duì)象

新建 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__;
    }
}

執(zhí)行打印結(jié)果

echo json_encode(new JsonTest());

輸出

{ "a": "a" }

可以看得出，只有公開非靜態(tài)的屬性被打印出來(lái)了，其他東西（常量、私有變量、方法等等）都丟失了。

思考

在實(shí)際的應(yīng)用中，多數(shù)情況下，我們的屬性都是非公開的，但是我們又想在執(zhí)行 json_encode() 的時(shí)候?qū)⑺蛴〕鰜?lái)，該怎么辦呢？

JsonSerializable

JsonSerializable 是一個(gè) PHP 的 JSON 序列化接口

官方定義

JSON 序列化接口

(PHP 5 >= 5.4.0, PHP 7)

簡(jiǎn)介

實(shí)現(xiàn) JsonSerializable 的類可以在 json_encode() 時(shí)定制他們的 JSON 表示法。

接口摘要

JsonSerializable {
    /* 方法 */
    abstract public jsonSerialize ( void ) : mixed
}

可以看出 php 版本低于 5.4 是沒有這個(gè)接口的

修改 JsonTest 繼續(xù)測(cè)試

修改 JsonTest 讓它實(shí)現(xiàn) JsonSerializable，并為其寫一個(gè) 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;
    }
}

執(zhí)行打印結(jié)果

echo json_encode(new JsonTest());

輸出

{ "a": "a", "e": "e", "d": "d" }

可以看得出，公開屬性和私有屬性都被打印出來(lái)了，方法，常量以及靜態(tài)變量沒有打印出來(lái)（這是因?yàn)轭?class)中靜態(tài)變量和常量的實(shí)現(xiàn)方式是所有對(duì)象共享的，并不具體屬于某個(gè)類）

源碼分析

這部分源碼較多，我會(huì)按照源碼中的 function 來(lái)一個(gè)一個(gè)進(jìn)行分析，注意看代碼塊中的注釋

里邊對(duì)應(yīng)有一些 option 的位運(yùn)算，我先貼出來(lái)每個(gè) option 常量對(duì)應(yīng)的值，是左移

/* json_encode() options */
#define PHP_JSON_HEX_TAG                    (10)
#define PHP_JSON_HEX_AMP                    (11)
#define PHP_JSON_HEX_APOS                   (12)
#define PHP_JSON_HEX_QUOT                   (13)
#define PHP_JSON_FORCE_OBJECT               (14)
#define PHP_JSON_NUMERIC_CHECK              (15)
#define PHP_JSON_UNESCAPED_SLASHES          (16)
#define PHP_JSON_PRETTY_PRINT               (17)
#define PHP_JSON_UNESCAPED_UNICODE          (18)
#define PHP_JSON_PARTIAL_OUTPUT_ON_ERROR    (19)
#define PHP_JSON_PRESERVE_ZERO_FRACTION     (110)
#define PHP_JSON_UNESCAPED_LINE_TERMINATORS (111)

函數(shù)本身

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;
    // 初始化，開辟內(nèi)存空間
	php_json_encode_init(encoder);
	encoder.max_depth = depth;
    // 真正用于編碼的函數(shù)體
	return_code = php_json_encode_zval(buf, val, options, encoder);
	JSON_G(error_code) = encoder.error_code;
	return return_code;
}
/* }}} */

可以看出真正的編碼函數(shù)是 php_json_encode_zval()

php_json_encode_zval()

smart_str_appendl() 是一個(gè)拼接字符串的函數(shù)，第三個(gè)參數(shù)是字符串的長(zhǎng)度

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:
            // 如果對(duì)象實(shí)現(xiàn)了JsonSerializable，就將對(duì)象中的jsonSerialize()返回的結(jié)果進(jìn)行編碼
			if (instanceof_function(Z_OBJCE_P(val), php_json_serializable_ce)) {
				return php_json_encode_serializable_object(buf, val, options, encoder);
			}
            // 如果對(duì)象沒有實(shí)現(xiàn)了JsonSerializable，就執(zhí)行下邊的這個(gè)php_json_encode_array()
			/* fallthrough -- Non-serializable object */
		case IS_ARRAY:
            // 解析數(shù)組
			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()

這個(gè)函數(shù)遞歸編碼數(shù)組及沒有實(shí)現(xiàn)JsonSerializable()的對(duì)象（只編碼對(duì)象的公開屬性）

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用來(lái)表示輸出 `json` 的結(jié)構(gòu)類型是數(shù)組還是對(duì)象
    // 只有自然排序的數(shù)組（['a','b','c']）才有可能被輸出為數(shù)組（考慮option可能為JSON_FORCE_OBJECT）
	if (Z_TYPE_P(val) == IS_ARRAY) {
        // 如果是數(shù)組
		myht = Z_ARRVAL_P(val);
     	// options中有JSON_FORCE_OBJECT 就強(qiáng)制輸出對(duì)象，否則就判斷數(shù)組是不是自然數(shù)組
		r = (options  PHP_JSON_FORCE_OBJECT) ? PHP_JSON_OUTPUT_OBJECT : php_json_determine_array_type(val);
	} else {
		myht = Z_OBJPROP_P(val);
        //對(duì)象就是輸出對(duì)象
		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) {
        //輸出為數(shù)組 就用 [ 做開頭
		smart_str_appendc(buf, '[');
	} else {
        //輸出為對(duì)象 就用 { 做開頭
		smart_str_appendc(buf, '{');
	}
    // 當(dāng)前遞歸的深度
	++encoder->depth;
    // zend_hash_num_elements 返回哈希表中元素的數(shù)量
	i = myht ? zend_hash_num_elements(myht) : 0;
	if (i > 0) {
		zend_string *key;
		zval *data;
		zend_ulong index;
        //遍歷當(dāng)前維度的數(shù)組 如果當(dāng)前元素不是數(shù)組
		ZEND_HASH_FOREACH_KEY_VAL_IND(myht, index, key, data) {
            // ↓ begin 從這里開始都是判斷key怎么處理以及元素末尾怎么處理  ↓↓↓↓
			if (r == PHP_JSON_OUTPUT_ARRAY) {
                //need_comma初始值是0
				if (need_comma) {
					smart_str_appendc(buf, ',');
				} else {
					need_comma = 1;
				}
				//這兩個(gè)方法是option中有JSON_PRETTY_PRINT的時(shí)候才會(huì)執(zhí)行的
				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) {
                        //跳過(guò)受保護(hù)的屬性和私有屬性
						/* Skip protected and private members. */
						continue;
					}
 					//need_comma初始值是0
					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);
                    // 處理字符串屬性的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怎么處理以及元素末尾怎么處理  ↑↑↑↑
            //繼續(xù)調(diào)用對(duì)普通元素編碼的 php_json_encode_zval() （實(shí)現(xiàn)數(shù)組和對(duì)象的遞歸閉環(huán)）
			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);
    // 當(dāng)前深度是否到達(dá)了設(shè)定的最大深度（默認(rèn)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;
}
/* }}} */

分析

看了源碼，我得出了一些結(jié)論。

只有 null，布爾值，浮點(diǎn)數(shù)，整數(shù)，字符串才會(huì)被直接編碼
對(duì)象要么實(shí)現(xiàn) JsonSerializable 并定義一個(gè) jsonSerialize() ，要么就被當(dāng)成一個(gè)數(shù)組，只會(huì)被處理公開非靜態(tài)屬性
json_encode() 并不會(huì)直接編碼數(shù)組和對(duì)象，而是會(huì)遞歸遍歷出所有可遍歷的元素，并處理 key
源碼中 php_json_encode_zval() 和 php_json_encode_array() 的相互調(diào)用，實(shí)現(xiàn)了數(shù)組和對(duì)象遍歷的閉環(huán)
引用不會(huì)被編碼

另外，關(guān)于 json_encode() 的 options ，我覺得這里處理的技巧非常有趣，巧妙利用位運(yùn)算來(lái)區(qū)別多個(gè)常量，有興趣的慢慢看看研究研究。（提示，將 options 每個(gè)常量轉(zhuǎn)成二進(jìn)制來(lái)看，json_encode() 接受多個(gè) 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);

但是結(jié)果是

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

需求是要返回JSON對(duì)象，是這樣似的

{"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);

輸出結(jié)果

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

以上就是源碼分析系列之json_encode()如何轉(zhuǎn)化一個(gè)對(duì)象的詳細(xì)內(nèi)容，更多關(guān)于源碼json_encode()的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章:

Thinkphp 框架基礎(chǔ)之源碼獲取、環(huán)境要求與目錄結(jié)構(gòu)分析
php源碼的安裝方法和實(shí)例
php源碼的使用方法講解
PHP后臺(tái)備份MySQL數(shù)據(jù)庫(kù)的源碼實(shí)例
PHP自動(dòng)生成縮略圖函數(shù)的源碼示例
PHP json_encode中文亂碼解決方法
基于php解決json_encode中文UNICODE轉(zhuǎn)碼問(wèn)題
淺析PHP中json_encode與json_decode的區(qū)別
php讓json_encode不自動(dòng)轉(zhuǎn)義斜杠“/”的方法
關(guān)于php unset對(duì)json_encode的影響詳解
PHP中讓json_encode不自動(dòng)轉(zhuǎn)義斜杠“/”的方法
php json_encode與json_decode詳解及實(shí)例
php中json_encode不兼容JSON_UNESCAPED_UNICODE的解決方案
java解析php函數(shù)json_encode unicode 編碼問(wèn)題

標(biāo)簽：大理蚌埠棗莊衡水江蘇萍鄉(xiāng) 衢州廣元

巨人網(wǎng)絡(luò)通訊聲明：本文標(biāo)題《源碼分析系列之json_encode()如何轉(zhuǎn)化一個(gè)對(duì)象》，本文關(guān)鍵詞；如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問(wèn)題，煩請(qǐng)?zhí)峁┫嚓P(guān)信息告之我們，我們將及時(shí)溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò)，涉及言論、版權(quán)與本站無(wú)關(guān)。