字符串格式化函数sprintf和snprintf的区别

sprintf 是 C 语言标准库 <stdio.h> 中的一个函数，主要用于字符串处理。其核心功能是将格式化的数据写入指定的字符串缓冲区。

在使用 sprintf 时，会借助格式控制字符串中的格式符来规定输出数据的格式。常见的格式符有 %d（用于输出整数）、%f（用于输出浮点数）、%c（用于输出字符）、%s（用于输出字符串）等。

int main()
{
char buffer[50];
int num = 123;
int length = sprintf(buffer, "The number is %d", num);
printf("The formatted string is: %s\n", buffer);
printf("The length of the formatted string is: %d\n", length);
return 0;}

sprintf 函数会将格式化后的字符串 "The number is 123" 写入 buffer 数组，并且返回实际写入到缓冲区的字符数量（不包括字符串终止符 '\0'）。

不过，sprintf 存在一个显著的安全隐患，它不会对写入的字符数量进行限制。要求我们在使用时，必须保证目标缓冲区足够大，能够容纳格式化后的字符串，否则就会引发缓冲区溢出问题，可能导致程序崩溃或产生安全漏洞。

sprintf 和 printf 函数在用法上颇为相似，但二者的输出目标不同。printf 函数将格式化的数据输出到标准输出流（通常是屏幕），而 sprintf 则将数据输出到指定的字符串缓冲区。
————————————————

snprintf 同样是 C 语言标准库 <stdio.h> 中的函数，主要作用也是把格式化的字符串存储到一个字符数组中。与 sprintf 不同的是，snprintf 提供了一个额外的参数，用于限制输出的最大字符数，从而避免因格式化字符串过长而引发的缓冲区溢出问题。

snprintf 的返回值规则与 sprintf 不同。如果格式化后的字符串长度小于指定的缓冲区大小 n，snprintf 会将整个字符串写入缓冲区，并返回实际写入的字符数量（不包括字符串终止符 '\0'）；如果格式化后的字符串长度大于或等于 n，snprintf 会将字符串截断，只写入 n - 1 个字符，然后在末尾添加 '\0'，此时返回值为格式化字符串原本应有的长度（即如果缓冲区足够大时会写入的字符数量，不包括 '\0'）。示例代码如下：

int main()
{
char buffer[10];
const char *str = "This is a long string";
int result = snprintf(buffer, sizeof(buffer), "%s", str);
printf("The actual string in buffer is: %s\n", buffer);
printf("The return value of snprintf is: %d\n", result);
return 0;}

由于 buffer 的大小为 10，而要格式化的字符串 "This is a long string" 长度超过了 9（因为要留一个位置给 '\0'），snprintf 会将字符串截断，只写入前 9 个字符，返回值则是 "This is a long string" 的实际长度（不包括 '\0'）。

在实际开发过程中，为了提高程序的安全性和稳定性，建议优先使用 snprintf 来替代 sprintf，以此避免缓冲区溢出带来的风险。

sprintf	返回实际写入缓冲区的字符数（不包括 \0）。如果缓冲区不足，会导致未定义行为。
snprintf	返回想要写入的字符数（不包括 \0），而不是实际写入的字符数。如果缓冲区不足，字符串会被截断。

1. sprintf函数原型
int sprintf(char *str, const char *format, ...);
str：指向字符数组的指针，用于存储格式化后的结果。这个数组必须足够大，以容纳将要生成的字符串及其结尾的空字符（\0）。
format：格式控制字符串，用于指定输出的格式。这个字符串中可以包含普通的字符（它们将被直接复制到输出字符串中），以及格式说明符（这些说明符会被对应的参数值替换）。
...：可变数量的参数，用于指定要输出的数据。这些参数的类型和顺序应该与format字符串中的格式说明符匹配。
返回值：函数返回写入到str指向的字符数组中的字符数（不包括结尾的空字符\0）。如果发生错误，则返回一个负数。
2. snprintf函数原型
int snprintf(char *str, size_t size, const char *format, ...);
参数说明：
str：指向字符数组的指针，用于存储格式化后的字符串。与sprintf不同，snprintf允许通过size参数来限制写入str的字符数，从而防止缓冲区溢出。
size：指定str数组的大小，即snprintf最多可以写入的字符数（包括结尾的空字符\0）。如果格式化后的字符串长度小于size，则整个字符串（包括结尾的\0）都会被写入str；如果大于或等于size，则只有size-1个字符会被写入（并且会在末尾自动添加一个\0），此时返回的将是如果整个字符串都被写入而不考虑size限制时的长度。
format和...：与sprintf中的含义相同，分别表示格式控制字符串和可变数量的参数。
返回值：函数返回如果整个字符串都被写入str（不考虑size限制）时的字符数（不包括结尾的空字符\0）。如果发生错误，则返回一个负数。
snprintf函数相比sprintf提供了额外的安全特性，即通过限制写入的最大字符数来防止缓冲区溢出。这使得snprintf在需要处理不确定长度数据的场景下更加安全和可靠。
————————————————

sprintf 和 snprintf的使用场景各有侧重。

4.1. sprintf 函数使用场景
字符串生成：sprintf 最常见的应用之一是将整数、浮点数、字符串等数据类型格式化为字符串，并保存到字符数组中。这在需要动态生成字符串时非常有用，比如在构造日志文件条目、网络数据包或数据库查询时。

数据转换：在需要将数据类型转换为字符串表示时，sprintf 是一种方便的方法。例如，将整数转换为十六进制字符串，或将浮点数按照特定格式（如保留两位小数）转换为字符串。

格式化输出到文件或网络：虽然 sprintf 直接将格式化的字符串输出到字符数组中，但之后可以很容易地将这个数组的内容写入文件或通过网络发送。

4.2. snprintf 函数使用场景
安全的数据格式化：与 sprintf 相比，snprintf 允许指定目标缓冲区的大小，从而避免了缓冲区溢出的风险。这使得 snprintf 在需要确保程序安全性的场景中成为首选，比如处理来自用户输入的数据或在网络编程中格式化数据。

日志记录：在软件开发中，日志记录是一项重要的功能。使用 snprintf 可以将日志信息按照指定的格式安全地写入日志文件中，确保日志信息的完整性和可读性。

文件写入：与 sprintf 类似，snprintf 也可以用于将数据写入文件中。但由于其提供了缓冲区大小限制，因此在写入文件时更加安全。

网络传输：在网络编程中，经常需要将数据格式化为字符串并通过网络发送。使用 snprintf 可以确保数据在格式化的过程中不会超出指定的缓冲区大小，从而避免了潜在的网络安全问题。

sprintf 适用于不需要担心缓冲区溢出的场景，或者当目标缓冲区足够大时。它的使用更加直接和简单，但需要注意避免缓冲区溢出的问题。
snprintf 适用于需要确保程序安全性的场景，特别是在处理来自用户输入的数据或在网络编程中。它通过允许指定目标缓冲区的大小来防止缓冲区溢出，从而提高了程序的安全性和稳定性。
五、注意事项
sprintf 和 snprintf 是 C 语言中常用的字符串格式化函数，它们在使用时各有注意事项。

5.1. sprintf 函数使用注意事项
缓冲区大小：使用 sprintf 时，必须确保目标缓冲区足够大，以容纳格式化后的字符串，包括结尾的空字符 \0。如果缓冲区太小，将会导致缓冲区溢出，可能引发程序崩溃或安全问题。
格式化字符串与参数匹配：确保格式化字符串中的格式说明符与提供的参数类型完全匹配。例如，%d 用于整数，%s 用于字符串，%f 用于浮点数等。不匹配的类型可能会导致未定义行为或错误的输出结果。
返回值处理：sprintf 函数的返回值是写入的字符数（不包括结尾的空字符 \0）。这个返回值可以用于调试或检查是否发生了截断，但不应直接用于确定缓冲区的大小。
安全性：由于 sprintf 不接受缓冲区大小的参数，因此它本身不提供防止缓冲区溢出的机制。在处理来自不可信源的数据时，应特别小心，以避免潜在的安全风险。
5.2. snprintf 函数使用注意事项
缓冲区大小限制：snprintf 允许指定目标缓冲区的大小，从而防止缓冲区溢出。然而，即使使用了 snprintf，也需要确保提供的缓冲区大小足够大，以容纳格式化后的字符串（包括结尾的空字符 \0）。
返回值检查：snprintf 的返回值是如果目标缓冲区足够大时应该写入的字符数（不包括结尾的空字符 \0）。如果返回值大于或等于提供的缓冲区大小，则表示发生了截断。因此，应检查返回值以确定是否发生了截断，并据此采取适当的措施。
格式化字符串与参数匹配：与 sprintf 一样，snprintf 的格式化字符串中的格式说明符也必须与提供的参数类型完全匹配。
自动添加空字符：snprintf 会在目标缓冲区的末尾自动添加一个空字符 \0 作为字符串的终止符。有助于确保字符串的正确性和安全性。然而，在计算字符串长度时，应注意这个额外的字符。
动态内存分配：如果事先不知道需要多大的缓冲区来存储格式化后的字符串，可以使用动态内存分配（如 malloc 或 calloc）来分配足够的空间。但请务必记得在使用完毕后释放分配的内存。
避免使用可变参数函数：尽量避免在 C++ 中使用像 snprintf 这样的可变参数函数，因为它们很难进行类型检查。在 C++ 中，可以考虑使用 std::stringstream 或 std::format（C++20 引入）等更安全的字符串处理机制。
六、使用示例
6.1. sprintf 使用示例
虽然sprintf在使用时需要特别注意缓冲区溢出的问题，但在知道缓冲区足够大的情况下，它仍然是一个非常方便的函数。

#include <stdio.h>

int main() {
char buffer[100]; // 假设这个缓冲区足够大来存储我们的格式化字符串
int number = 42;
float pi = 3.14159;

// 使用 sprintf 安全地（因为缓冲区足够大）格式化字符串
sprintf(buffer, "The number is %d, and pi is approximately %.2f.", number, pi);

// 输出格式化后的字符串
printf("%s\n", buffer);

return 0;
}
sprintf函数将整数number和浮点数pi格式化为字符串，并将其存储在buffer中。然后，使用printf函数输出这个字符串。注意，这里假设buffer足够大，可以容纳格式化后的字符串。因此，使用sprintf是安全的。

6.2. snprintf 使用示例
#include <stdio.h>

int main() {
char buffer[50]; // 一个中等大小的缓冲区
int number = 123456789;
int chars_written;

// 使用 snprintf 尝试将整数格式化为字符串，同时避免缓冲区溢出
chars_written = snprintf(buffer, sizeof(buffer), "The number is %d.", number);

// 检查是否发生了截断
if (chars_written < sizeof(buffer)) {
// 没有发生截断，可以安全地使用 buffer
printf("%s\n", buffer);
} else {
// 发生了截断，可能需要采取其他措施，比如增加缓冲区大小
printf("Buffer too small, formatted string was truncated.\n");

// 如果需要，可以重新分配一个更大的缓冲区
// 但为了简单起见，这里不展示重新分配的代码

// 尽管如此，我们仍然可以输出部分字符串（但请注意，它可能不是以 '\0' 结尾的）
// 为了安全起见，我们可以手动添加 '\0'
if (chars_written >= sizeof(buffer)) {
buffer[sizeof(buffer) - 1] = '\0'; // 强制添加 '\0'，但可能会覆盖最后一个字符
}
// 注意：上面的做法在 chars_written == sizeof(buffer) 时是安全的，
// 但如果 snprintf 返回了一个大于 buffer 大小的值（虽然这在实际中不太可能发生，
// 因为 snprintf 会考虑到结尾的 '\0'），则上面的代码仍然会丢失最后一个字符。
// 不过，对于大多数情况来说，上面的代码已经足够了。

// 由于我们已经手动添加了 '\0'，现在可以安全地输出了（尽管它可能是不完整的）
printf("Partial output: %s\n", buffer);
}

// 在实际应用中，如果发生了截断，更好的做法可能是记录一个错误，
// 并使用更大的缓冲区重新尝试格式化操作，或者采取其他适当的错误处理措施。

return 0;
}
在上面的snprintf示例中，添加了一个关于如何手动添加'\0'的注释，但正如我所说，这通常不是处理截断的最佳方式。更好的做法是使用足够大的缓冲区来避免截断，或者在发生截断时采取其他恢复措施（如重新分配更大的缓冲区并再次尝试）。

另外，请注意，在大多数情况下，如果snprintf的返回值大于或等于提供的缓冲区大小，那么应该假设缓冲区中的字符串已经被截断，并且可能不是以'\0'结尾的（尽管在实际实现中，snprintf通常会确保在缓冲区末尾添加一个'\0'，但前提是缓冲区至少有一个字符的空间来存储它）。然而，为了确保安全，应该总是准备好处理可能发生的截断情况。
 
参考：https://blog.csdn.net/weixin_37800531/article/details/142071402