PHP自定义的 printf 函数新用法

传统用处

第一，你不该该使用 sprintf()，由于该函数不施行任何检查，并且致使很多缓冲区溢出错误。请幸免使用它。

警告

尽大概幸免使用 sprintf()。

然后，你有一些选中。

你知道结果缓冲区的大小

假如你知道缓冲区大小，snprintf() 或者 slprintf() 都可以使用。这些函数虽然在返回上不一样，但是它们的功效是一样的。

这两个都是按照传递的格局来打印，并且不管发生什么，都会通过一个NUL 字节 ‘\0’来终止你的缓冲区。 但是，snprintf() 返回可以使用的字符数，而slprintf()返回可以有效使用的字符数，因此可以检测过小的缓冲区和字符串截断。这个不会运算最后的‘\0’。

这里有个例子，以便你完全清楚：

char foo[8]; /* 8字符大小的缓冲区 */
const char str[] = "Hello world"; /* 12个字符，包括 \0 */
int r;

r = snprintf(foo, sizeof(foo), "%s", str);
/* r = 11 ，即便这里只要7个可打印的字符可写入 foo */

/* foo 的值此刻是 'H' 'e' 'l' 'l' 'o' ' ' 'w' '\0' */

snprintf() 不是一个好用的函数，由于它不同意检查最后的字符串截断。就像上面例子你看到的，明显“Hello world\0”不适合8字节的缓冲区，但是 snprintf() 依然返回11给你，这是 strlen("Hello world\0") 的值。你没有方法检查字符串被截断了。

这是 slprintf()：

char foo[8]; /* 8字符大的缓冲区 */
const char str[] = "Hello world"; /* 12个字符，包括 \0 */
int r;

r = slprintf(foo, sizeof(foo), "%s", str);
/* r = 7 ，由于7个可打印的字符被写入 foo */

/* foo 此刻的值是 'H' 'e' 'l' 'l' 'o' ' ' 'w' '\0' */

使用 slprintf()，结果缓冲区 foo 包括完全雷同的字符串，但是如今返回值为7。7少于 “Hello world” 字符串的11个字符，所以你可以检查它被截断了：

if (slprintf(foo, sizeof(foo), "%s", str) < strlen(str)) {
    /* 发生字符串截断 */
}

记住：

• 这两个函数总是以NUL终止字符串，不管可否截断。终究的字符串是平安的 C 字符串。
• 只要 slprintf()会检查字符串截断。

这两个函数在 main/snprintf.c 中有具体介绍。

你不知道缓冲区大小

此刻假如你不知道结果缓冲区大小，则需要动态分配一个，并且使用spprintf()。记住，你必需本人开释缓冲区。

这是例子：

#include <time.h>

char *result;
int r;

time_t timestamp = time(NULL);

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

/* 此刻结果相似："Here is the date: Thu Jun 15 19:12:51 2017\n" */

efree(result);

spprintf() 返回被打印到结果缓冲区的字符数，不包罗最后的‘\0’， 因此，你知道分配给你的字节数（减一）是多少。

请留意，是使用 ZendMM（恳求分配）分配的，因此应作为恳求的一部分使用，并使用 efree() 而不是free()开释。

留意

Zend 内存治理章节 (ZendMM) 具体介绍怎样通过 PHP 分配动态内存。

假如你想要限制缓冲区大小，则将限制传递给第二个参数，假如你传递 0，意味着无穷制：

#include <time.h>

char *result;
int r;

time_t timestamp = time(NULL);

/* 打印不超越 10 个字节 ||分配超越 11 个字节 */
r = spprintf(&result, 10, "Here is the date: %s", asctime(localtime(&timestamp)));

/* r == 10，并且给结果分配 11 个字节 */

efree(result);

留意

尽大概不要使用动态内存分配。这会影响执机能。假如有选中，则选静态堆栈分配缓冲区。

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

那么 printf() 呢？

假如你需要 printf()，即打印格局化到输出流，则使用php_printf()。该函数在内部使用 spprintf()，因此施行动态分配，以便将其发送到 SAPI 输出（在 CLI 的状况下又称为 stdout），或输出缓冲区（CGI 缓冲区）后将其开释，用于其他 SAPI。

非凡的 PHP printf 格局

记住，PHP 通过本人设计，代替了许多 libc 的 printf() 函数。你可以从阅读源代码中查看易于懂得的参数解析 API。

这意味着解析算法的参数已完全被重写，并且大概与你在 libc 使用的不一样。即，在大多数状况下，不会关注 libc 环境。

大概会使用非凡的格局，就像 “%I64” 打印64位 int，或者“%I32”。你也可以使用 “%Z” 去打印 zval（按照 PHP 规则转换为字符串），这是一个不错的补充。

该格局化程序也认识无限数，并打印 “INF”，或者将非数字打印为 “NAN”。

假如你错误的恳求格局化程序打印一个 NULL 指针，libc 必定会崩溃，而 PHP 会将 “(null)” 作为结果字符串返回。

留意

假如在打印中你看到奇妙的 “(null)” 显现，意味着你将 NULL 指针传递给了 PHP printf 系列函数之一。

Printf() 到 zend_strings

zend_string 作为 PHP 源代码里非常常见的构造，你大概需要 printf() 到 zend_string，而不是传统的 char *。为此，请使用strpprintf()。

该 API 是 zend_string *strpprintf(size_t max_len, const char *format, ...) ，意味着返回zend_string 给你，而不是你盼望的可打印字符数。不外你可以限制使用第一个参数来限制该数（传递 0 表示无限大）；并且你必然要记住将使用 Zend 内存治理分配 zend_string，并因此绑定当前恳求。

明显，该格局 API 与上面看到的同享。

这有个例子：

zend_string *result;

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

/* 对结果做些什么 */

zend_string_release(result);

关于 zend_ API 的注释

您大概会碰到 zend_spprintf() 或 zend_strpprintf() 函数。这些与上面看到的完全雷同。

这只是 Zend 引擎和 PHP 中心之间别离的一部分，这个细节对我们并不重要，由于在源码中，所有内容都是混合在一起的。