在Linux系统编程中，经常需要对目录进行遍历操作，以获取目录中的所有文件和子目录。递归遍历目录是一种常见的方法，可以通过使用C语言来实现。本篇博客将详细介绍如何使用C语言实现递归遍历目录的过程，并提供相应的代码示例，同时解释相关函数的使用。
文章目录
- 1. 相关函数介绍
- 1.1 opendir()
- 1.1.1 函数原型、参数和返回值
- 1.1.2 函数示例
- 1.1.3 代码解释
- 1.2 readdir()
- 1.2.1 函数原型、参数、返回值和结构体定义
- 1.2.2 函数示例
- 1.2.3 代码解释
- 1.3 closedir()
- 1.3.1 函数原型、参数和返回值
- 1.3.2 函数示例
- 1.3.3 代码解释
- 1.4 snprintf()
- 1.4.1 函数原型、参数和返回值
- 1.4.2 函数示例
- 1.4.3 代码解释
- 1.5 strcmp()
- 1.5.1 函数原型、参数和返回值
- 1.5.2 函数示例
- 1.5.3 代码解释
- 2. 递归遍历目录实现
- 2.1 示例代码：
- 2.2 代码解释
1. 相关函数介绍
1.1 opendir()
1.1.1 函数原型、参数和返回值
opendir函数用于打开一个目录，并返回一个指向DIR类型的指针，该指针用于后续的目录操作。
原型：
DIR *opendir(const char *path);
参数：
path：要打开的目录的路径。
返回值：
- 返回值：如果成功打开目录，则返回一个指向
DIR类型的指针；如果失败，则返回NULL。
1.1.2 函数示例
下面是一个使用opendir函数打开目录的示例：
#include <stdio.h>
#include <dirent.h>
int main() {
const char *path = "/path/to/directory";
DIR *dir = opendir(path);
if (dir == NULL) {
perror("opendir");
return -1;
}
// 目录操作...
closedir(dir);
return 0;
}
1.1.3 代码解释
在上述示例中，我们首先定义了要打开的目录路径path，然后使用opendir函数打开目录，并将返回的指针存储在dir变量中。接着，我们可以进行一些目录操作，比如使用readdir函数读取目录中的文件。最后，我们使用closedir函数关闭目录。
如果opendir函数执行失败，它会返回NULL，并将错误信息存储在全局变量errno中。我们可以使用perror函数打印出错误信息，以便调试和排查问题
需要注意的是，在使用完DIR类型的指针后，一定要记得使用closedir函数关闭目录，以释放相关的资源。
1.2 readdir()
1.2.1 函数原型、参数、返回值和结构体定义
readdir函数用于读取目录中的文件，并返回一个指向dirent结构体的指针。
原型：
struct dirent *readdir(DIR *dir);
参数：
dir：一个指向已打开目录的指针。
返回值：
- 返回值：如果成功读取到下一个文件，则返回指向
dirent结构体的指针；如果到达目录末尾或发生错误，则返回NULL。
dirent结构体的定义如下：
struct dirent {
ino_t d_ino; // 文件的inode号
off_t d_off; // 文件在目录中的偏移量
unsigned short d_reclen; // 文件名的长度
unsigned char d_type; // 文件的类型
char d_name[256]; // 文件名
};
1.2.2 函数示例
下面是一个使用readdir函数读取目录中文件的示例：
#include <stdio.h>
#include <dirent.h>
int main() {
const char *path = "/path/to/directory";
DIR *dir = opendir(path);
if (dir == NULL) {
perror("opendir");
return -1;
}
struct dirent *entry;
while ((entry = readdir(dir)) != NULL) {
printf("%s\n", entry->d_name);
}
closedir(dir);
return 0;
}
1.2.3 代码解释
在上述示例中，我们首先使用opendir函数打开目录，并将返回的指针存储在dir变量中。然后，我们使用一个循环来读取目录中的每个文件。readdir函数会返回一个指向dirent结构体的指针，我们可以通过访问d_name成员来获取文件名，并进行相应的操作。在示例中，我们简单地使用printf函数打印出文件名。最后，我们使用closedir函数关闭目录。
需要注意的是，当readdir函数返回NULL时，表示已经读取到了目录的末尾，或者发生了错误。因此，我们可以通过判断返回值是否为NULL来确定是否继续读取目录中的文件。
1.3 closedir()
1.3.1 函数原型、参数和返回值
closedir函数用于关闭之前通过opendir函数打开的目录，并释放相关资源。
原型：
int closedir(DIR *dir);
参数：
dir：一个指向已打开目录的指针。
返回值：
- 返回值：如果成功关闭目录，则返回0；如果发生错误，则返回-1。
1.3.2 函数示例
下面是一个使用closedir函数关闭目录的示例：
#include <stdio.h>
#include <dirent.h>
int main() {
const char *path = "/path/to/directory";
DIR *dir = opendir(path);
if (dir == NULL) {
perror("opendir");
return -1;
}
// 目录操作...
if (closedir(dir) == -1) {
perror("closedir");
return -1;
}
return 0;
}
1.3.3 代码解释
在上述示例中，我们首先使用opendir函数打开目录，并将返回的指针存储在dir变量中。接着，我们可以进行一些目录操作。最后，我们使用closedir函数关闭目录，并检查返回值是否为-1，以判断是否发生了错误。
需要注意的是，closedir函数会释放与目录相关的资源，因此在使用完目录后，一定要记得调用closedir函数关闭目录。
1.4 snprintf()
1.4.1 函数原型、参数和返回值
snprintf函数是一个安全的字符串格式化函数，用于将格式化的数据输出到字符串中。
原型：
int snprintf(char *str, size_t size, const char *format, ...);
参数：
str：指向用于存储格式化结果的字符串的指针。size：存储格式化结果的字符串的大小。format：格式化字符串，指定输出的格式。
返回值：
- 返回值：成功时返回写入字符串的字符数（不包括终止符），失败时返回负值。
snprintf函数的工作方式与printf函数类似，但是它会将格式化的结果存储到指定的字符串中，而不是将其输出到标准输出。
1.4.2 函数示例
下面是一个使用snprintf函数的示例：
#include <stdio.h>
int main() {
char buffer[100];
int num = 42;
const char *str = "Hello, world!";
int len = snprintf(buffer, sizeof(buffer), "Number: %d, String: %s", num, str);
if (len >= sizeof(buffer)) {
printf("Buffer is too small\n");
return -1;
}
printf("Formatted string: %s\n", buffer);
return 0;
}
1.4.3 代码解释
在上述示例中，我们首先定义了一个大小为100的字符数组buffer，用于存储格式化结果。然后，我们定义了一个整数变量num和一个字符串变量str，用于传递给格式化字符串。接着，我们使用snprintf函数将格式化的结果存储到buffer中，并将其输出到标准输出。最后，我们检查返回值len是否超过了buffer的大小，以判断是否缓冲区足够大以容纳格式化的结果。
需要注意的是，snprintf函数会根据指定的格式化字符串和参数进行格式化，并将结果存储到指定的字符串中。它会确保格式化的结果不会超出指定的大小，并在必要时自动截断字符串。因此，使用snprintf函数可以避免缓冲区溢出的问题。
1.5 strcmp()
1.5.1 函数原型、参数和返回值
strcmp函数用于比较两个字符串是否相等。
原型：
int strcmp(const char *s1, const char *s2);
参数：
s1：要比较的第一个字符串。s2：要比较的第二个字符串。
返回值：
- 返回值：如果两个字符串相等，则返回0；如果第一个字符串小于第二个字符串，则返回一个负数；如果第一个字符串大于第二个字符串，则返回一个正数。
strcmp函数会按照字典顺序逐个比较两个字符串中的字符，直到找到不相等的字符或者遇到字符串的结束符\0。如果两个字符串相等，则返回0；如果第一个字符串在字典顺序中排在第二个字符串之前，则返回一个负数；如果第一个字符串在字典顺序中排在第二个字符串之后，则返回一个正数。
1.5.2 函数示例
下面是一个使用strcmp函数比较两个字符串的示例：
#include <stdio.h>
#include <string.h>
int main() {
const char *s1 = "Hello";
const char *s2 = "World";
int result = strcmp(s1, s2);
if (result == 0) {
printf("The strings are equal\n");
} else if (result < 0) {
printf("The first string is less than the second string\n");
} else {
printf("The first string is greater than the second string\n");
}
return 0;
}
1.5.3 代码解释
在上述示例中，我们定义了两个字符串s1和s2，然后使用strcmp函数比较它们。根据返回值的不同，我们输出相应的结果。
需要注意的是，strcmp函数比较的是字符串的内容，而不是字符串的地址。因此，即使两个字符串的地址不同，只要它们的内容相同，strcmp函数会返回0。此外，strcmp函数是区分大小写的，如果要进行大小写不敏感的比较，可以使用strcasecmp函数。
2. 递归遍历目录实现
2.1 示例代码：
#include <stdio.h>
#include <dirent.h>
#include <sys/stat.h>
#include <string.h>
void traverse_directory(const char *path) {
DIR *dir;
struct dirent *entry;
struct stat file_stat;
// 打开目录
dir = opendir(path);
if (dir == NULL) {
perror("opendir");
return;
}
// 读取目录中的每个文件
while ((entry = readdir(dir)) != NULL) {
// 构建文件的完整路径
char file_path[1024];
snprintf(file_path, sizeof(file_path), "%s/%s", path, entry->d_name);
// 获取文件的信息
if (lstat(file_path, &file_stat) < 0) {
perror("lstat");
continue;
}
// 判断文件类型
if (S_ISDIR(file_stat.st_mode)) {
// 如果是目录，则递归遍历
if (strcmp(entry->d_name, ".") == 0 || strcmp(entry->d_name, "..") == 0) {
continue;
}
traverse_directory(file_path);
} else {
// 如果是文件，则打印文件名
printf("%s\n", file_path);
}
}
// 关闭目录
closedir(dir);
}
int main(int argc,char *argv[]) {
traverse_directory(argv[]);
return 0;
}
2.2 代码解释
上述代码中，我们定义了一个traverse_directory函数来递归遍历目录。该函数接受一个路径作为参数，首先打开目录，然后读取目录中的每个文件。对于每个文件，我们首先构建文件的完整路径，然后使用lstat函数获取文件的信息。如果文件是一个目录，则递归调用traverse_directory函数；如果文件是一个普通文件，则打印文件名。最后，我们关闭目录。
在main函数中，我们指定要遍历的目录路径，并调用traverse_directory函数进行遍历。
需要注意的是，上述代码中使用了dirent.h和sys/stat.h头文件来操作目录和文件，以及stdio.h和string.h头文件来进行字符串操作。此外，代码中还使用了lstat函数来获取文件的信息，而不是stat函数，这是因为lstat函数可以处理符号链接。
