C#中Directory.GetFiles()函数详解(定义、参数、使用方法等)

在C#编程中，文件和目录操作是常见的任务之一。Directory.GetFiles()函数用于获取指定目录中的文件列表，广泛应用于文件管理、日志处理、自动化脚本等场景。理解Directory.GetFiles()的定义、参数及其使用方法，对于高效管理和处理文件具有重要意义。

本文将详细探讨Directory.GetFiles()函数的相关内容，帮助读者全面了解这一重要工具的功能和应用场景，并掌握如何在实际项目中灵活应用这些知识。

一、Directory.GetFiles()函数的定义

1. 定义与功能

Directory.GetFiles()是C#中System.IO命名空间下的一个静态方法，用于返回指定目录中所有文件的路径。该函数提供了多种重载形式，允许用户根据不同的需求进行灵活配置。

语法：

public static string[] GetFiles(string path);
public static string[] GetFiles(string path, string searchPattern);
public static string[] GetFiles(string path, string searchPattern, SearchOption searchOption);

作用：返回指定目录中所有文件的路径，支持通过搜索模式和搜索选项进行过滤和递归搜索。

1. 常用重载形式

GetFiles(string path)：返回指定目录中所有文件的路径。

string[] files = Directory.GetFiles("C:\\example");

GetFiles(string path, string searchPattern)：返回指定目录中符合搜索模式的文件路径。

string[] files = Directory.GetFiles("C:\\example", "*.txt");

GetFiles(string path, string searchPattern, SearchOption searchOption)：返回指定目录中符合搜索模式的文件路径，并根据搜索选项决定是否递归搜索子目录。

string[] files = Directory.GetFiles("C:\\example", "*.txt", SearchOption.AllDirectories);

二、Directory.GetFiles()函数的参数详解

1. path 参数

定义：指定要搜索的目录路径，可以是绝对路径或相对路径。

类型：string

示例：

string[] files = Directory.GetFiles("C:\\example");

注意事项：确保提供的路径有效且可访问，否则会抛出异常（如DirectoryNotFoundException、UnauthorizedAccessException）。

使用Path.Combine方法构建路径，以确保跨平台兼容性。

string path = Path.Combine("C:", "example");
string[] files = Directory.GetFiles(path);

1. searchPattern 参数
   

定义：指定搜索模式，用于过滤符合条件的文件。默认为*.*，表示所有文件。

类型：string

常见模式：*.*：匹配所有文件。

*.txt：匹配所有文本文件。

file?.txt：匹配名为file1.txt、file2.txt等的文件。

file[0-9].txt：匹配名为file1.txt、file2.txt等的文件。

示例：

string[] textFiles = Directory.GetFiles("C:\\example", "*.txt");

1. searchOption 参数
   

定义：指定搜索选项，控制是否递归搜索子目录。默认为SearchOption.TopDirectoryOnly，即只搜索指定目录。

类型：SearchOption

常用值：SearchOption.TopDirectoryOnly：只搜索指定目录。

SearchOption.AllDirectories：递归搜索指定目录及其所有子目录。

示例：

string[] allTextFiles = Directory.GetFiles("C:\\example", "*.txt", SearchOption.AllDirectories);

1. 返回值
   

类型：string[]

说明：返回一个包含指定目录中所有文件路径的字符串数组。如果目录为空或不存在，则返回空数组。

三、Directory.GetFiles()函数的使用方法

1. 获取指定目录中的所有文件

最简单的用法是获取指定目录中的所有文件，不使用任何搜索模式或选项。

using System;
using System.IO;
class Program {
    static void Main() {
        string[] files = Directory.GetFiles("C:\\example");
        foreach (string file in files) {
            Console.WriteLine(file);
        }
    }
}

1. 使用搜索模式过滤文件
   

通过提供搜索模式，可以仅获取特定类型的文件。例如，获取所有文本文件（.txt）：

using System;
using System.IO;
class Program {
    static void Main() {
        string[] textFiles = Directory.GetFiles("C:\\example", "*.txt");
        foreach (string file in textFiles) {
            Console.WriteLine(file);
        }
    }
}

1. 递归搜索子目录
   

通过设置searchOption参数为SearchOption.AllDirectories，可以递归搜索指定目录及其所有子目录中的文件。

using System;
using System.IO;
class Program {
    static void Main() {
        string[] allTextFiles = Directory.GetFiles("C:\\example", "*.txt", SearchOption.AllDirectories);
        foreach (string file in allTextFiles) {
            Console.WriteLine(file);
        }
    }
}

1. 处理异常
   

在实际应用中，可能会遇到各种异常情况，如目录不存在、权限不足等。建议在调用Directory.GetFiles()时进行异常处理，确保程序的健壮性。

using System;
using System.IO;
class Program {
    static void Main() {
        try {
            string[] files = Directory.GetFiles("C:\\example");
            foreach (string file in files) {
                Console.WriteLine(file);
            }
        } catch (DirectoryNotFoundException ex) {
            Console.WriteLine("目录未找到: " + ex.Message);
        } catch (UnauthorizedAccessException ex) {
            Console.WriteLine("访问权限不足: " + ex.Message);
        } catch (Exception ex) {
            Console.WriteLine("发生错误: " + ex.Message);
        }
    }
}

1. 获取文件信息
   

除了获取文件路径外，有时还需要获取更多文件信息，如文件名、扩展名、创建时间等。可以通过FileInfo类来实现。

using System;
using System.IO;
class Program {
    static void Main() {
        string[] files = Directory.GetFiles("C:\\example");
        foreach (string file in files) {
            FileInfo fileInfo = new FileInfo(file);
            Console.WriteLine($"文件名: {fileInfo.Name}");
            Console.WriteLine($"扩展名: {fileInfo.Extension}");
            Console.WriteLine($"创建时间: {fileInfo.CreationTime}");
        }
    }
}

1. 结合LINQ进行复杂查询
   

通过结合LINQ（Language Integrated Query），可以对获取的文件列表进行更复杂的筛选和处理。

using System;
using System.IO;
using System.Linq;
class Program {
    static void Main() {
        string[] files = Directory.GetFiles("C:\\example", "*.*", SearchOption.AllDirectories);
        var filteredFiles = files.Where(f => f.EndsWith(".txt") && new FileInfo(f).Length > 1024);
        foreach (string file in filteredFiles) {
            Console.WriteLine(file);
        }
    }
}

1. 异步获取文件列表
   

在处理大目录或网络驱动器时，同步调用可能会影响性能。可以使用异步方法Directory.GetFilesAsync（需自行实现）或EnumerateFiles配合async/await关键字来提高性能。

using System;
using System.IO;
using System.Threading.Tasks;
class Program {
    static async Task Main() {
        string directoryPath = "C:\\example";
        string searchPattern = "*.txt";
        SearchOption searchOption = SearchOption.AllDirectories;
        // 使用 EnumerateFiles 进行异步遍历
        var files = await Task.Run(() => Directory.EnumerateFiles(directoryPath, searchPattern, searchOption));
        foreach (string file in files) {
            Console.WriteLine(file);
        }
    }
}

综上所述，Directory.GetFiles()函数是C#中用于获取指定目录中文件列表的重要工具。通过合理使用其参数和相关方法，可以实现高效、灵活的文件管理操作。

声明：所有来源为“聚合数据”的内容信息，未经本网许可，不得转载！如对内容有异议或投诉，请与我们联系。邮箱：marketing@think-land.com