时间戳

首页 > 技术文章 > 如何优雅地将printf的打印保存在文件中？

如何优雅地将printf的打印保存在文件中？

Hijack-you 2019-12-06 22:04 原文

我们都知道，一般使用printf的打印都会直接打印在终端，如果想要保存在文件里呢？我想你可能想到的是重定向。例如：

$ program > result.txt

这样printf的输出就存储在result.txt中了。
当然了，如果你既想打印在终端，又想保存在文件，还可以使用tee命令：

program | tee result.txt

注：program为你运行的程序。
不过文本介绍了不是通过命令行的方式，而是通过代码实现。

写文件

你可能会想，那不用printf，直接将打印写入到文件不就可以了？类似于下面这样：

#include<stdio.h>
int main(void)
{
    FILE *fp = fopen("log.txt","w+");
    if(NULL == fp)
    {
        printf("open failed
");
        return -1;
    }
    int a = 10;
    fprintf(fp,"test content %d
",a);
    fclose(fp);
    return 0;
}

不过这需要将原先的printf改用fprintf，修改了最原始的代码。但是本文并不是说明如何实现一个logging功能，而是如何将printf的原始打印保存在文件中。

重定向

实际上，我们的程序在运行起来后，都会有三个文件描述符：
0 标准输入
1 标准输出
2 标准错误
一般标准输出都是都直接输出到终端。
我们可以用一个程序简单观察一下：

#include<stdio.h>
#include <unistd.h>
int main(void)
{
    sleep(20);//为了避免立即退出
    return 0;
}

假设编译出来的程序为test：

$ gcc -o test test.c
$ ./test &
$ ls -l /proc/`pidof test`/fd

pidof test用于获取test进程id，其fd目录可以看到打开的文件描述符, 其输出结果如下：

lrwx------ 1 root root 64 Nov 16 16:26 0 -> /dev/pts/0
lrwx------ 1 root root 64 Nov 16 16:26 1 -> /dev/pts/0
lrwx------ 1 root root 64 Nov 16 16:26 2 -> /dev/pts/0

看到了吗，0，1，2都重定向到了/dev/pts/0，其实就是当前终端。

$ tty
/dev/pts/0

所以如果我们要将printf的打印保存到文件中，实际上就让它重定向到这个文件就可以了。这里我们用到freopen函数：

FILE *freopen(const char *path, const char *mode, FILE *stream);

参数说明：

  • path：需要重定向到的文件名或文件路径。
  • mode：代表文件访问权限的字符串。例如，"r"表示“只读访问”、"w"表示“只写访问”、"a"表示“追加写入”。
  • stream：需要被重定向的文件流。
    那么要完成前面的任务也就很简单了：
#include<stdio.h>
#include <unistd.h>
int main(void)
{
    FILE *fp = freopen("test.log","w",stdout);
    if(NULL == fp)
    {
        printf("reopen failed
");
        return -1;
    }
    printf("bianchengzhuji
");
    printf("shouwangxiansheng
");
    sleep(20);//便于观察
    fclose(fp);
    return 0;
}

重新编译后运行查看其打开的文件描述符：

lrwx------ 1 root root 64 Nov 16 16:34 0 -> /dev/pts/0
lrwx------ 1 root root 64 Nov 16 16:34 1 -> /data/workspaces/test.log
lrwx------ 1 root root 64 Nov 16 16:34 2 -> /dev/pts/0

看到了吗，它现在重定向到test.log了，并且终端也没有printf的打印。随后我们也在文件test.log中看到了下面的内容：

bianchengzhuji

有人可能会有下面的疑问：

  • 怎么恢复？
    首先来看怎么恢复，实际上恢复的原理是类似的，既然最开始它从定向到了/dev/pts/0，那么我们只需要重定向回去就可以了，但是在不同的终端，它的tty名字可能不同，因此需要使用ttyname函数获取原先stdout的tty名字：
int ttyname_r(int fd, char *buf, size_t buflen);

又可以重新定向到/dev/pts/0了：

#include<stdio.h>
#include <unistd.h>
int main(void)
{
    char ttyName[128] = {0};
    ttyname_r(1,ttyName,128);//1为标准输出
    FILE *fp = freopen("test.log","w+",stdout);
    if(NULL == fp)
    {
        printf("reopen failed
");
        return -1;
    }
    printf("bianchengzhuji
");
    printf("shouwangxiansheng
");
    sleep(20);
    freopen(ttyName,"w+",stdout);
    printf("std out to %s
",ttyName);
    fclose(fp);
    return 0;
}

最终运行会发现两个结果：

  • std out to 打印到终端
  • 打开的文件描述符1被重定向到/dev/pts/0
    还有没有别的保存方法呢？
    除了上面这种方式，还有一种方式是使用dup2：
int dup2(int oldfd, int newfd);

它是用来复制文件描述符的，会使得newfd成为oldfd的副本.所以与上面看到不同的是，标准输出和往fd写入的内容，都会存储在文件test.log中：

#include<stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
int main(void)
{
    int fd = open("test.log",O_WRONLY|O_CREAT);
    dup2(fd,1);//1代表标准输出
    printf("bianchengzhuji
");
    printf("shouwangxiansheng
");
    sleep(20);
    close(fd);
    return 0;
}

观察的结果：

lrwx------ 1 root root 64 Nov 17 17:03 0 -> /dev/pts/0
l-wx------ 1 root root 64 Nov 17 17:03 1 -> /data/workspaces/test.log
lrwx------ 1 root root 64 Nov 17 17:03 2 -> /dev/pts/0
l-wx------ 1 root root 64 Nov 17 17:03 3 -> /data/workspaces/test.log

这种情况适合于将标准输出的内容和其他写文件的内容一并保存到文件中。

如何关闭printf打印

实际上非常简单，进程启动后，只需要关闭文件描述符1（标准输出）,2（标准错误）即可。什么情况下会需要呢？有些后台进程有自己的日志记录方式，而不想让printf的信息打印在终端，因此可能会关闭。

总结

文本旨在通过将printf的打印保存在文件中来介绍重定向，以及0，1，2文件描述符。如果你不想保留标准输出，可以将其重定向到/dev/null，如果想保留，且单独保留到特定文件，可以使用freopen，如果想保留，且和其他内容保留到同一文件，使用dup2。

推荐阅读