如何为可切换输出端的类printf日志函数定义const char *format参数

要实现支持格式化调用的日志函数，完全匹配现有代码框架的改造逻辑没有额外折中方案，核心依托C标准库的可变参数机制实现，具体步骤如下：

1. 函数参数的正确定义 #

按照C语言可变参数的语法规则，函数参数需要满足以下要求：

• 必须至少有1个固定参数，作为可变参数栈的定位锚点，这里采用和printf系列函数完全一致的设计：第一个参数为格式化字符串指针const char *format
• 固定参数之后跟上可变参数占位符...，对应任意数量的日志内容参数
  最终函数原型为：
  int log_informations(const char *format, ...)

2. 函数内部的输出逻辑适配 #

普通的fprintf/printf无法直接处理函数接收到的可变参数列表，需要配套使用同系列、专门接收va_list类型参数的输出函数：

• 引入头文件<stdarg.h>，获取可变参数处理的宏定义
• 在函数内部定义va_list类型变量，用于遍历可变参数列表
• 用va_start宏关联格式化字符串和可变参数列表，定位参数栈的起始位置
• 文件分支用vfprintf替代原逻辑的fprintf，传入已打开的文件指针、格式化字符串、可变参数列表
• 控制台分支用vprintf替代原逻辑的printf，传入格式化字符串、可变参数列表
• 所有分支处理完成后，用va_end宏清理可变参数列表，避免栈内存异常

3. 补全后的完整可运行代码 #

#include <stdio.h>
#include <stdarg.h>

int useFile;
int log_informations(const char *format, ...)
{
    va_list ap;
    va_start(ap, format);

    if(useFile)
    {
        // open/close FILE *pf omitted
        vfprintf(pf, format, ap);
    }
    else
    {
        vprintf(format, ap);
    }

    va_end(ap);
    return 0;
}

int main()
{
    int answer = 42;
    log_informations("The answer is %d.", answer);
    return 0;
}

关键注意事项 #

• 禁止将可变参数占位符...直接传给fprintf/printf，这两个函数的形参是离散实参列表而非va_list类型，直接传递会造成栈参数解析错位，引发输出异常或程序崩溃
• 可变参数处理完成后必须执行va_end，在部分编译器/平台上省略该步骤会出现栈内存泄漏、函数返回地址被篡改的问题
• 格式化字符串参数建议加上const修饰，既可以匹配字符串字面量的传入场景，也能借助编译器的格式化字符串检查，减少参数类型不匹配的潜在bug

内容的提问来源于stack exchange，提问作者Francesco Pagani