PHP自定義的printf函數(shù)的作用是什么

這篇文章主要介紹了PHP自定義的printf函數(shù)的作用是什么，具有一定借鑒價(jià)值，需要的朋友可以參考下。希望大家閱讀完這篇文章后大有收獲。下面讓小編帶著大家一起了解一下。

大家都知道 libc 的 printf() 及其家族。本章節(jié)將詳細(xì)介紹 PHP 聲明和使用的許多克隆，它們的目標(biāo)是什么，為什么使用它們，以及何時(shí)使用它們。

注意

Libc 中關(guān)于 printf() 及其朋友的文檔位于此處。

你知道這些函數(shù)很有用，但有時(shí)無法提供足夠的功能。另外，你知道向 printf()添加格式字符串并非易事，沒有便攜性和有安全風(fēng)險(xiǎn)。

PHP 添加了自己的類似于 printf 的函數(shù)，取代了 libc 的，并且由內(nèi)部開發(fā)者使用。他們主要添加新的格式，并使用 zend_string代替 char *等等，讓我們一起來看看。

警告

你必須掌握 libc 默認(rèn)printf() 格式。請閱讀它們的文檔。

注意

添加了這些函數(shù)以 取代 libc 函數(shù)，意味著如果你使用了sprintf()，不會使用到 libc 的sprintf()，而是 PHP 取代了。除了傳統(tǒng)的 printf()外，其他內(nèi)容均被替換。

傳統(tǒng)用途

首先，你不應(yīng)該使用 sprintf()，因?yàn)樵摵瘮?shù)不執(zhí)行任何檢查，并且導(dǎo)致許多緩沖區(qū)溢出錯(cuò)誤。請避免使用它。

警告

盡可能避免使用 sprintf()。

然后，你有一些選擇。

你知道結(jié)果緩沖區(qū)的大小

如果你知道緩沖區(qū)大小，snprintf() 或者 slprintf() 都可以使用。這些函數(shù)雖然在返回上不同，但是它們的功能是一樣的。

這兩個(gè)都是根據(jù)傳遞的格式來打印，并且無論發(fā)生什么，都會通過一個(gè)NUL 字節(jié) ‘\0’來終止你的緩沖區(qū)。 但是，snprintf() 返回可以使用的字符數(shù)，而slprintf()返回可以有效使用的字符數(shù)，因此可以檢測過小的緩沖區(qū)和字符串截?cái)?。這個(gè)不會計(jì)算最后的‘\0’。

這里有個(gè)例子，以便你完全明白：

char foo[8]; /* 8字符大小的緩沖區(qū) */
const char str[] = "Hello world"; /* 12個(gè)字符，包含 \0 */
int r;

r = snprintf(foo, sizeof(foo), "%s", str);
/* r = 11 ，即使這里只有7個(gè)可打印的字符可寫入 foo */

/* foo 的值現(xiàn)在是 'H' 'e' 'l' 'l' 'o' ' ' 'w' '\0' */

snprintf() 不是一個(gè)好用的函數(shù)，因?yàn)樗辉试S檢查最后的字符串截?cái)?。就像上面例子你看到的，顯然“Hello world\0”不適合8字節(jié)的緩沖區(qū)，但是 snprintf() 仍然返回11給你，這是 strlen("Hello world\0") 的值。你沒有辦法檢查字符串被截?cái)嗔恕?/p>

這是 slprintf()：

char foo[8]; /* 8字符大的緩沖區(qū) */
const char str[] = "Hello world"; /* 12個(gè)字符，包含 \0 */
int r;

r = slprintf(foo, sizeof(foo), "%s", str);
/* r = 7 ，因?yàn)?個(gè)可打印的字符被寫入 foo */

/* foo 現(xiàn)在的值是 'H' 'e' 'l' 'l' 'o' ' ' 'w' '\0' */

使用 slprintf()，結(jié)果緩沖區(qū) foo 包含完全相同的字符串，但是如今返回值為7。7少于 “Hello world” 字符串的11個(gè)字符，所以你可以檢查它被截?cái)嗔耍?/p>

if (slprintf(foo, sizeof(foo), "%s", str) < strlen(str)) {
    /* 發(fā)生字符串截?cái)?*/
}

記?。?/p>

• 這兩個(gè)函數(shù)總是以NUL終止字符串，不管是否截?cái)?。最終的字符串是安全的 C 字符串。
• 只有 slprintf()會檢查字符串截?cái)唷?/li>

這兩個(gè)函數(shù)在 main/snprintf.c 中有詳細(xì)介紹。

你不知道緩沖區(qū)大小

現(xiàn)在如果你不知道結(jié)果緩沖區(qū)大小，則需要?jiǎng)討B(tài)分配一個(gè)，并且使用spprintf()。記住，你必須自己釋放緩沖區(qū)。

這是例子：

#include <time.h>

char *result;
int r;

time_t timestamp = time(NULL);

r = spprintf(&result, 0, "Here is the date: %s", asctime(localtime(&timestamp)));

/* 現(xiàn)在結(jié)果類似："Here is the date: Thu Jun 15 19:12:51 2017\n" */

efree(result);

spprintf() 返回被打印到結(jié)果緩沖區(qū)的字符數(shù)，不包括最后的‘\0’， 因此，你知道分配給你的字節(jié)數(shù)（減一）是多少。

請注意，是使用 ZendMM（請求分配）分配的，因此應(yīng)作為請求的一部分使用，并使用 efree() 而不是free()釋放。

注意

Zend 內(nèi)存管理章節(jié) (ZendMM) 詳細(xì)介紹如何通過 PHP 分配動態(tài)內(nèi)存。

如果你想要限制緩沖區(qū)大小，則將限制傳遞給第二個(gè)參數(shù)，如果你傳遞 0，意味著無限制：

#include <time.h>

char *result;
int r;

time_t timestamp = time(NULL);

/* 打印不超過 10 個(gè)字節(jié) ||分配超過 11 個(gè)字節(jié) */
r = spprintf(&result, 10, "Here is the date: %s", asctime(localtime(&timestamp)));

/* r == 10，并且給結(jié)果分配 11 個(gè)字節(jié) */

efree(result);

注意

盡可能不要使用動態(tài)內(nèi)存分配。這會影響執(zhí)性能。如果有選擇，則選靜態(tài)堆棧分配緩沖區(qū)。

spprintf()寫在 main/spprintf.c 中。

那么 printf() 呢？

如果你需要 printf()，即打印格式化到輸出流，則使用php_printf()。該函數(shù)在內(nèi)部使用 spprintf()，因此執(zhí)行動態(tài)分配，以便將其發(fā)送到 SAPI 輸出（在 CLI 的情況下又稱為 stdout），或輸出緩沖區(qū)（CGI 緩沖區(qū)）后將其釋放，用于其他 SAPI。

特殊的 PHP printf 格式

記住，PHP 通過自己設(shè)計(jì)，取代了很多 libc 的 printf() 函數(shù)。你可以從閱讀源代碼中查看易于理解的參數(shù)解析 API。

這意味著解析算法的參數(shù)已完全被重寫，并且可能與你在 libc 使用的不同。即，在大多數(shù)情況下，不會關(guān)注 libc 環(huán)境。

可能會使用特殊的格式，就像 “%I64” 打印64位 int，或者“%I32”。你也可以使用 “%Z” 去打印 zval（根據(jù) PHP 規(guī)則轉(zhuǎn)換為字符串），這是一個(gè)不錯(cuò)的補(bǔ)充。

該格式化程序也認(rèn)識無窮數(shù)，并打印 “INF”，或者將非數(shù)字打印為  “NAN”。

如果你錯(cuò)誤的請求格式化程序打印一個(gè) NULL 指針，libc 肯定會崩潰，而 PHP 會將 “(null)” 作為結(jié)果字符串返回。

注意

如果在打印中你看到神奇的 “(null)” 出現(xiàn)，意味著你將 NULL 指針傳遞給了 PHP printf 系列函數(shù)之一。

Printf() 到 zend_strings

zend_string 作為 PHP 源代碼里非常常見的結(jié)構(gòu)，你可能需要 printf() 到 zend_string，而不是傳統(tǒng)的 char *。為此，請使用strpprintf()。

該 API 是 zend_string *strpprintf(size_t max_len, const char *format, ...) ，意味著返回zend_string 給你，而不是你期望的可打印字符數(shù)。不過你可以限制使用第一個(gè)參數(shù)來限制該數(shù)（傳遞 0 表示無窮大）；并且你一定要記住將使用 Zend 內(nèi)存管理分配 zend_string，并因此綁定當(dāng)前請求。

顯然，該格式 API 與上面看到的共享。

這有個(gè)例子：

zend_string *result;

result = strpprintf(0, "You are using PHP %s", PHP_VERSION);

/* 對結(jié)果做些什么 */

zend_string_release(result);

關(guān)于 zend_ API 的注釋

您可能會遇到 zend_spprintf() 或 zend_strpprintf() 函數(shù)。這些與上面看到的完全相同。

這只是 Zend 引擎和 PHP 核心之間分離的一部分，這個(gè)細(xì)節(jié)對我們并不重要，因?yàn)樵谠创a中，所有內(nèi)容都是混合在一起的。

感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享PHP自定義的printf函數(shù)的作用是什么內(nèi)容對大家有幫助，同時(shí)也希望大家多多支持億速云，關(guān)注億速云行業(yè)資訊頻道，遇到問題就找億速云，詳細(xì)的解決方法等著你來學(xué)習(xí)!