引言

在C和C++开发中，我们经常会用到printf来进行字符串的格式化，例如printf("format string %d, %d", 1, 2);，这样的格式化只是用于打印调试信息。printf函数实现的是接收可变参数，然后解析格式化的字符串，最后输出到控制台。那么问题来了，当我们需要实现一个函数，根据传入的可变参数来生成格式化的字符串，应该怎么办呢？

你可以在这里看到更好的排版

正文

可变参数

首先来一个可变参数使用示例，testVariadic方法接收int行的可变参数，并以可变参数为-1表示结束。va_list用于遍历可变参数，va_start方法接收两个参数，第一个为va_list，第二个为可变参数前一个参数，下面的例子里该参数为a。

/**   下面是 <stdarg.h> 里面重要的几个宏定义如下：   typedef char* va_list;   void va_start ( va_list ap, prev_param ); // ANSI version   type va_arg ( va_list ap, type );   void va_end ( va_list ap );   va_list 是一个字符指针，可以理解为指向当前参数的一个指针，取参必须通过这个指针进行。   <Step 1> 在调用参数表之前，定义一个 va_list 类型的变量，(假设va_list 类型变量被定义为ap)；   <Step 2> 然后应该对ap 进行初始化，让它指向可变参数表里面的第一个参数，这是通过 va_start 来实现的，第一个参数是 ap 本身，第二个参数是在变参表前面紧挨着的一个变量,即“...”之前的那个参数；   <Step 3> 然后是获取参数，调用va_arg，它的第一个参数是ap，第二个参数是要获取的参数的指定类型，然后返回这个指定类型的值，并且把 ap 的位置指向变参表的下一个变量位置；   <Step 4> 获取所有的参数之后，我们有必要将这个 ap 指针关掉，以免发生危险，方法是调用 va_end，他是输入的参数 ap 置为 NULL，应该养成获取完参数表之后关闭指针的习惯。说白了，就是让我们的程序具有健壮性。通常va_start和va_end是成对出现。   */  //-1表示可变参数结束  void receiveVariadic(int a, ...) {      va_list list;      va_start(list, a);      int arg = a;      while (arg != -1) {          arg = va_arg(list, int);          printf("%d ", arg);      }      printf("n");      va_end(list);  }    //test  void testVari()  {      printf("------%s------n", __FUNCTION__);      //-1表示可变参数结束      receiveVariadic(1, 2, 3, 4, 5, 6, -1);  }

运行结果

------testVari------  2 3 4 5 6 -1

格式化字符串

好了，我们已经介绍了怎样实现一个接收可变参数的C函数，接下来介绍根据接收的可变参数来格式化字符串。这里介绍两种方式，第一种是利用宏定义，第二种通过函数的方式来实现。

通过宏定义的方式

en…让咱们先来看看第一个版本的宏，这个宏定义对于不熟悉宏的人来说可能看着有点费劲，不过不要怕，稍后会做解释，代码如下：

#define myFormatStringByMacro_WithoutReturn(format, ...)   do {       int size = snprintf(NULL, 0, format, ##__VA_ARGS__);      size++;       char *buf = (char *)malloc(size);       snprintf(buf, size, format, ##__VA_ARGS__);       printf("%s", buf);       free(buf);   } while(0)

宏基础知识

首先需要介绍宏用到的知识：, 这个的作用是可换行定义宏，毕竟如果一行很长的宏可读性很差，使用方式在换行时加上即可。第二个是介绍(format, ...)，这里的...是预定义的宏，用于接收可变参数，就像是printf函数一样。接着介绍##__VA_ARGS__，同样的__VA_ARGS__也是预定义的宏，表示接收到的...传入的可变参数。##的作用是用来处理未传入可变参数的情况，当没有传入可变参数的时候，编译器或通过优化将snprintf(NULL, 0, format, ##__VA_ARGS__);优化为snprintf(NULL, 0, format);。你可以理解为没有可变参数时，##前的逗号,与__VA_ARGS__都被“干掉了”。

你一定会觉得困惑，为什么要写do-while语句呢？这是为了宏的健壮性，如果使用宏的人像下面这样使用的话，就会出问题

#define testMarco(a, b)   int _a = a + 1;   int _b = b + 1;   printf("n%d", _a + _b);     void test()  {      if (1 > 0)          testMarco(1, 2);  }

上面的代码连编译都不会通过, 会报错如下:

如果手动展开这个宏的话，会变成这个样子，问题就显而易见了。但是如果if语句加上了{}的话，就不会有问题，可以看出规范写法是多么的重要?（皮一下很开心）。

void test()  {      if (1 > 0)          int _a = 1 + 1; int _b = 2 + 1; printf("n%d", _a + _b);;  }

加上do-while以后就不一样，加上do-while后的代码如下：

#define testMarco(a, b)   do {   int _a = a + 1;   int _b = b + 1;   printf("n%d", _a + _b);   } while(0)    void test()  {      if (1 > 0)          testMarco(1, 2);  }

预处理之后代码如下：

//展开后的代码  void test()  {      if (1 > 0)          do { int _a = 1 + 1; int _b = 2 + 1; printf("n%d", _a + _b); } while(0);  }

好了，宏的基础知识就介绍这么多了，接下来进入正题。

代码解析

为了方便阅读，原谅我在这里再贴一遍宏定义的代码：

#define myFormatStringByMacro_WithoutReturn(format, ...)   do {       int size = snprintf(NULL, 0, format, ##__VA_ARGS__);      size++;       char *buf = (char *)malloc(size);       snprintf(buf, size, format, ##__VA_ARGS__);       printf("%s", buf);       free(buf);   } while(0)

首先，介绍一下snprintf()函数，此函数的定义如下：

/**     @param __str 接收格式化结果的指针   @param __size 接收的size   @param __format 格式化的字符串   @param ... 可变参数   @return 返回格式化后实际上写入的大小a，a <= __size   */  int     snprintf(char * __restrict __str, size_t __size, const char * __restrict __format, ...) __printflike(3, 4);

为了方便理解，使用方式是这个样子的：

void testSnprintf()  {      printf("------%s------n", __FUNCTION__);      char des[50];      int size = snprintf(des, 50, "less length %d", 50);      printf("size:%dn", size);  }

运行结果：

------testSnprintf------  size:14

snprintf函数还有一个用法是__str和__size分别传入NULL和0，返回值会是格式化字符串的实际长度，可以通过这个方式来获取正确的格式化size，从而避免malloc多余的空间，造成空间浪费。同时返回的size是不包含结束符