【.Net实用方法总结】 整理并总结System.IO中Directory类及其方法介绍

简介: 本文主要介绍System.IO命名空间的Directory类,介绍其常用的方法和示例说明。
🐋作者简介:博主是一位.Net开发者,同时也是RPA和低代码平台的践行者。
🦀专栏简介:博主针对.Net开发和C站问答过程中遇到的问题进行总结,形成本专栏,希望可以帮助到您解决问题。
🐶座右铭:总有一天你所坚持的会反过来拥抱你。

11.jpg

🌈写在前面:

本文主要介绍System.IO命名空间的Directory 类,介绍其常用的方法和示例说明。


👉本文关键字:System.IO、Directory类、文件或目录路径信息、方法示例、C#

1️⃣ System.IO命名空间

.NET中的IO操作命名空间,包含允许读写文件数据流的类型以及提供基本文件和目录支持的类型。

我们在.NET中的IO操作,经常需要调用一下几个类。

  • FileStream类

​ 文件流类,负责大文件的拷贝,读写。

  • Path类

​ Path类中方法,基本都是对字符串(文件名)的操作,与实际文件没多大关系。

  • File类

    File类可以进行一些对小文件拷贝、剪切操作,还能读一些文档文件。

  • Dirctory类

    目录操作,创建文件、删除目录,获取目录下文件名等等。

2️⃣ Directory类

♈ 定义

公开用于通过目录和子目录进行创建、移动和枚举的静态方法。 此类不能被继承。

public static class Directory

♉ 常用方法

CreateDirectory(String) 在指定路径中创建所有目录和子目录,除非它们已经存在
public static System.IO.DirectoryInfo CreateDirectory (string path);

参数

path

string

要创建的目录。

返回

DirectoryInfo

一个表示在指定路径的目录的对象。 无论指定路径的目录是否已经存在,都将返回此对象。

示例

        // Specify the directory you want to manipulate.
        string path = @"c:\MyDir";

        try
        {
            // Determine whether the directory exists.
            if (Directory.Exists(path))
            {
                Console.WriteLine("That path exists already.");
                return;
            }

            // Try to create the directory.
            DirectoryInfo di = Directory.CreateDirectory(path);
            Console.WriteLine("The directory was created successfully at {0}.", Directory.GetCreationTime(path));

            // Delete the directory.
            di.Delete();
            Console.WriteLine("The directory was deleted successfully.");
        }
        catch (Exception e)
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
        finally {}

补充

创建任何目录和所有目录 path ,除非它们已存在,或者某些部分 path 无效。 如果目录已存在,此方法不会创建新目录,但它返回 DirectoryInfo 现有目录的对象。

path 参数指定目录路径,而不是文件路径。

Delete(String) 从指定路径删除空目录
public static void Delete (string path);

参数

path

string

要移除的空目录的名称。 此目录必须可写且为空。

示例

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string subPath = @"C:\NewDirectory\NewSubDirectory";

            try
            {
                Directory.CreateDirectory(subPath);
                Directory.Delete(subPath);

                bool directoryExists = Directory.Exists(@"C:\NewDirectory");
                bool subDirectoryExists = Directory.Exists(subPath);

                Console.WriteLine("top-level directory exists: " + directoryExists);
                Console.WriteLine("sub-directory exists: " + subDirectoryExists);
            }
            catch (Exception e)
            {
                Console.WriteLine("The process failed: {0}", e.Message);
            }
        }
    }
}
Delete(String, Boolean) 删除指定的目录,并删除该目录中的所有子目录和文件(如果表示)
public static void Delete (string path, bool recursive);

参数

path

string

要删除的目录的名称。

recursive

bool

若要删除 path 中的目录、子目录和文件,则为 true;否则为 false

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string topPath = @"C:\NewDirectory";
            string subPath = @"C:\NewDirectory\NewSubDirectory";

            try
            {
                Directory.CreateDirectory(subPath);

                using (StreamWriter writer = File.CreateText(subPath + @"\example.txt"))
                {
                    writer.WriteLine("content added");
                }

                Directory.Delete(topPath, true);

                bool directoryExists = Directory.Exists(topPath);

                Console.WriteLine("top-level directory exists: " + directoryExists);
            }
            catch (Exception e)
            {
                Console.WriteLine("The process failed: {0}", e.Message);
            }
        }
    }
}
EnumerateFiles(String) 返回指定路径中的完整文件名的可枚举集合
public static System.Collections.Generic.IEnumerable<string> EnumerateFiles (string path);

参数

path

string

要搜索的目录的相对或绝对路径。 此字符串不区分大小写。

返回

IEnumerable

一个可枚举集合,它包含目录中 path 指定的文件的完整名称(包括路径)。

示例

以下示例演示如何检索目录中的所有文件并将其移动到新目录。 移动文件后,它们不再存在于原始目录中。

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string sourceDirectory = @"C:\current";
            string archiveDirectory = @"C:\archive";

            try
            {
                var txtFiles = Directory.EnumerateFiles(sourceDirectory);

                foreach (string currentFile in txtFiles)
                {
                    string fileName = currentFile.Substring(sourceDirectory.Length + 1);
                    Directory.Move(currentFile, Path.Combine(archiveDirectory, fileName));
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}

以下示例枚举指定目录中的文件,读取文件的每一行,如果它包含字符串“Europe”,则显示该行。

using System;
using System.Collections.Generic;
using System.Linq;
using System.IO;

class Program
{
    static void Main(string[] args)
    {
        try
        {
            // LINQ query for all files containing the word 'Europe'.
            var files = from file in
                Directory.EnumerateFiles(@"\\archives1\library\")
                where file.ToLower().Contains("europe")
                select file;

            foreach (var file in files)
            {
                Console.WriteLine("{0}", file);
            }
            Console.WriteLine("{0} files found.", files.Count<string>().ToString());
        }
        catch (UnauthorizedAccessException UAEx)
        {
            Console.WriteLine(UAEx.Message);
        }
        catch (PathTooLongException PathEx)
        {
            Console.WriteLine(PathEx.Message);
        }
    }
}
EnumerateFiles(String, String) 返回指定路径中与搜索模式匹配的完整文件名的可枚举集合
public static System.Collections.Generic.IEnumerable<string> EnumerateFiles (string path, string searchPattern);

参数

path

string

要搜索的目录的相对或绝对路径。 此字符串不区分大小写。

searchPattern

string

要与 path 中的文件名匹配的搜索字符串。 此参数可以包含有效文本路径和通配符(* 和 ?)的组合,但不支持正则表达式。例如,"*.txt"

返回

IEnumerable

一个可枚举集合,它包含目录中 path 指定的文件的完整名称(包括路径)。

示例

以下示例演示如何检索目录中的具有“.txt”扩展名文件并将其移动到新目录。 移动文件后,它们不再存在于原始目录中。

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string sourceDirectory = @"C:\current";
            string archiveDirectory = @"C:\archive";

            try
            {
                var txtFiles = Directory.EnumerateFiles(sourceDirectory, "*.txt");

                foreach (string currentFile in txtFiles)
                {
                    string fileName = currentFile.Substring(sourceDirectory.Length + 1);
                    Directory.Move(currentFile, Path.Combine(archiveDirectory, fileName));
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}

以下示例枚举具有“.txt”扩展名的指定目录中的文件,读取文件的每一行,并在包含字符串“Europe”的情况下显示该行。

using System;
using System.Linq;
using System.IO;

class Program
{
    static void Main(string[] args)
    {
        try
        {
            // LINQ query for all .txt files containing the word 'Europe'.
            var files = from file in Directory.EnumerateFiles(@"\\archives1\library\", "*.txt")
                where file.ToLower().Contains("europe")
                select file;

            foreach (var file in files)
            {
                Console.WriteLine("{0}", file);
            }
            Console.WriteLine("{0} files found.", files.Count<string>().ToString());
        }
            
        catch (UnauthorizedAccessException UAEx)
        {
            Console.WriteLine(UAEx.Message);
        }
        catch (PathTooLongException PathEx)
        {
            Console.WriteLine(PathEx.Message);
        }
    }
}
EnumerateFiles(String, String, SearchOption) 返回指定路径中与搜索模式匹配的完整文件名的可枚举集合,还可以搜索子目录
public static System.Collections.Generic.IEnumerable<string> EnumerateFiles (string path, string searchPattern, System.IO.SearchOption searchOption);

参数

path

string

要搜索的目录的相对或绝对路径。 此字符串不区分大小写。

searchPattern

string

要与 path 中的文件名匹配的搜索字符串。 此参数可以包含有效文本路径和通配符(* 和 ?)的组合,但不支持正则表达式。例如,"*.txt"

searchOption

SearchOption

指定搜索操作是应仅包含当前目录还是应包含所有子目录的枚举值之一。 默认值是 TopDirectoryOnly

返回

IEnumerable

一个可枚举集合,它包含目录中 path 指定的文件的完整名称(包括路径)。

示例

以下示例演示如何检索目录及其子目录中的所有文本文件,并将其移动到新目录。 移动文件后,它们不再存在于原始目录中。

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string sourceDirectory = @"C:\current";
            string archiveDirectory = @"C:\archive";

            try
            {
                var txtFiles = Directory.EnumerateFiles(sourceDirectory, "*.txt", SearchOption.AllDirectories);

                foreach (string currentFile in txtFiles)
                {
                    string fileName = currentFile.Substring(sourceDirectory.Length + 1);
                    Directory.Move(currentFile, Path.Combine(archiveDirectory, fileName));
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}
Exists(String) 确定给定路径是否引用磁盘上的现有目录
public static bool Exists (string? path);

参数

path

string

文件或目录的路径。

返回

bool

如果 path 指向现有目录,则为 true;如果该目录不存在或者在尝试确定指定目录是否存在时出错,则为 false

示例

以下示例在命令行上采用文件或目录名称数组,确定其名称类型,并相应地处理它。

// For File.Exists, Directory.Exists
using System;
using System.IO;
using System.Collections;

public class RecursiveFileProcessor
{
    public static void Main(string[] args)
    {
        foreach(string path in args)
        {
            if(File.Exists(path))
            {
                // This path is a file
                ProcessFile(path);
            }
            else if(Directory.Exists(path))
            {
                // This path is a directory
                ProcessDirectory(path);
            }
            else
            {
                Console.WriteLine("{0} is not a valid file or directory.", path);
            }
        }
    }

    // Process all files in the directory passed in, recurse on any directories
    // that are found, and process the files they contain.
    public static void ProcessDirectory(string targetDirectory)
    {
        // Process the list of files found in the directory.
        string [] fileEntries = Directory.GetFiles(targetDirectory);
        foreach(string fileName in fileEntries)
            ProcessFile(fileName);

        // Recurse into subdirectories of this directory.
        string [] subdirectoryEntries = Directory.GetDirectories(targetDirectory);
        foreach(string subdirectory in subdirectoryEntries)
            ProcessDirectory(subdirectory);
    }

    // Insert logic for processing found files here.
    public static void ProcessFile(string path)
    {
        Console.WriteLine("Processed file '{0}'.", path);    
    }
}
GetCreationTime(String) 获取目录的创建日期和时间
public static DateTime GetCreationTime (string path);

参数

path

string

目录的路径。

返回

DateTime

一个设置为指定目录的创建日期和时间的结构。 该值用本地时间表示。

示例

以下示例获取指定目录的创建时间。

using System;
using System.IO;

class Test
{
    public static void Main()
    {
        try
        {
            // Get the creation time of a well-known directory.
            DateTime dt = Directory.GetCreationTime(Environment.CurrentDirectory);

            // Give feedback to the user.
            if (DateTime.Now.Subtract(dt).TotalDays > 364)
            {
                Console.WriteLine("This directory is over a year old.");
            }
            else if (DateTime.Now.Subtract(dt).TotalDays > 30)
            {
                Console.WriteLine("This directory is over a month old.");
            }
            else if (DateTime.Now.Subtract(dt).TotalDays <= 1)
            {
                Console.WriteLine("This directory is less than a day old.");
            }
            else
            {
                Console.WriteLine("This directory was created on {0}", dt);
            }
        }
        catch (Exception e)
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}
GetCurrentDirectory() 获取应用程序的当前工作目录
public static string GetCurrentDirectory ();

返回

string

一个字符串,该字符串包含当前工作目录的绝对路径且不以反斜杠 () 结尾。

示例

下面的示例演示如何使用 GetCurrentDirectory 方法。

using System;
using System.IO;

class Test
{
    public static void Main()
    {
        try
        {
            // Get the current directory.
            string path = Directory.GetCurrentDirectory();
            string target = @"c:\temp";
            Console.WriteLine("The current directory is {0}", path);
            if (!Directory.Exists(target))
            {
                Directory.CreateDirectory(target);
            }

            // Change the current directory.
            Environment.CurrentDirectory = (target);
            if (path.Equals(Directory.GetCurrentDirectory()))
            {
                Console.WriteLine("You are in the temp directory.");
            }
            else
            {
                Console.WriteLine("You are not in the temp directory.");
            }
        }
        catch (Exception e)
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}
GetDirectoryRoot(String) 返回指定路径的卷信息、根信息或两者同时返回
public static string GetDirectoryRoot (string path);

参数

path

string

文件或目录的路径。

返回

string

包含指定路径的卷信息、根信息或同时包括这两者的字符串。

示例

// This sample shows how to set the current directory and how to determine
// the root directory.
using System;
using System.IO;

namespace IOSamples
{
  public class DirectoryRoot
  {
    public static void Main()
    {
    // Create string for a directory. This value should be an existing directory
    // or the sample will throw a DirectoryNotFoundException.
      string dir = @"C:\test";        
      try
      {
          //Set the current directory.
          Directory.SetCurrentDirectory(dir);
      }
      catch (DirectoryNotFoundException e)
      {
          Console.WriteLine("The specified directory does not exist. {0}", e);
      }
    // Print to console the results.
      Console.WriteLine("Root directory: {0}", Directory.GetDirectoryRoot(dir));
      Console.WriteLine("Current directory: {0}", Directory.GetCurrentDirectory());
    }
  }
}
// The output of this sample depends on what value you assign to the variable dir.
// If the directory c:\test exists, the output for this sample is:
// Root directory: C:\
// Current directory: C:\test
此方法获取由其返回 GetFullPathpath完全限定路径名称,并返回根目录信息。 不存在指定的路径。
GetFiles 返回指定目录中文件的名称(包括其路径)
public static string[] GetFiles (string path);

参数

path

string

要搜索的目录的相对或绝对路径。 此字符串不区分大小写。

返回

string[]

一个包含指定目录中的文件的完整名称(包含路径)的数组,如果未找到任何文件,则为空数组。

示例

以下示例演示如何使用 GetFiles 该方法从用户指定的位置返回文件名。 此示例配置为捕获此方法常见的所有错误。

// For Directory.GetFiles and Directory.GetDirectories
// For File.Exists, Directory.Exists
using System;
using System.IO;
using System.Collections;

public class RecursiveFileProcessor
{
    public static void Main(string[] args)
    {
        foreach(string path in args)
        {
            if(File.Exists(path))
            {
                // This path is a file
                ProcessFile(path);
            }
            else if(Directory.Exists(path))
            {
                // This path is a directory
                ProcessDirectory(path);
            }
            else
            {
                Console.WriteLine("{0} is not a valid file or directory.", path);
            }
        }
    }

    // Process all files in the directory passed in, recurse on any directories
    // that are found, and process the files they contain.
    public static void ProcessDirectory(string targetDirectory)
    {
        // Process the list of files found in the directory.
        string [] fileEntries = Directory.GetFiles(targetDirectory);
        foreach(string fileName in fileEntries)
            ProcessFile(fileName);

        // Recurse into subdirectories of this directory.
        string [] subdirectoryEntries = Directory.GetDirectories(targetDirectory);
        foreach(string subdirectory in subdirectoryEntries)
            ProcessDirectory(subdirectory);
    }

    // Insert logic for processing found files here.
    public static void ProcessFile(string path)
    {
        Console.WriteLine("Processed file '{0}'.", path);    
    }
}

补充

EnumerateFiles GetFiles方法如下所示:使用 EnumerateFiles时,可以在返回整个集合之前开始枚举名称集合;使用 GetFiles时,必须等待返回整个名称数组,然后才能访问数组。 因此,使用许多文件和目录时, EnumerateFiles 可以更高效。

GetFiles(String, String)) 等重载方法与上文EnumerateFiles方法类似,不过多赘述。

GetLastAccessTime(String) 返回上次访问指定文件或目录的日期和时间
public static DateTime GetLastAccessTime (string path);

参数

path

string

要获取其访问日期和时间信息的文件或目录。

返回

DateTime

一个结构,它被设置为上次访问指定文件或目录的日期和时间。 该值用本地时间表示。

SetLastAccessTime(String, DateTime) 设置上次访问指定文件或目录的日期和时间
public static void SetLastAccessTime (string path, DateTime lastAccessTime);

参数

path

string

要获取其访问日期和时间信息的文件或目录。

lastAccessTime

DateTime

一个对象,它包含要为 path 的访问日期和时间设置的值。 该值用本地时间表示。

示例

using System;
using System.IO;

class Test
{
    public static void Main()
    {
        try
        {
            string path = @"c:\MyDir";
            if (!Directory.Exists(path))
            {
                Directory.CreateDirectory(path);
            }
            Directory.SetLastAccessTime(path, new DateTime(1985,5,4));

            // Get the last access time of a well-known directory.
            DateTime dt = Directory.GetLastAccessTime(path);
            Console.WriteLine("The last access time for this directory was {0}", dt);
            
            // Update the last access time.
            Directory.SetLastAccessTime(path, DateTime.Now);
            dt = Directory.GetLastAccessTime(path);
            Console.WriteLine("The last access time for this directory was {0}", dt);
        }

        catch (Exception e)
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}
Move(String, String) 将文件或目录及其内容移到新位置
public static void Move (string sourceDirName, string destDirName);

参数

sourceDirName

string

要移动的文件或目录的路径。

destDirName

string

新位置 sourceDirName 的路径或其内容。 如果 sourceDirName 是文件,那么 destDirName 也必须是文件名。

示例

以下示例演示如何将目录及其所有文件移动到新目录。 移动原始目录后不再存在。

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            string sourceDirectory = @"C:\source";
            string destinationDirectory = @"C:\destination";

            try
            {
                Directory.Move(sourceDirectory, destinationDirectory);
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
    }
}

补充

此方法使用指定 destDirName 的名称创建新目录,并将文件和目录的内容 sourceDirName移动到新创建的目标目录。 然后, sourceDirName 它会删除该目录。

如果尝试将目录移动到已存在的目录,将发生一个 IOException 目录。

♊ 注解

Directory 类用于典型的操作,例如复制、移动、重命名、创建和删除目录。

类的 Directory 静态方法对所有方法执行安全检查。 如果要多次重复使用对象,请考虑改用相应的实例方法 DirectoryInfo ,因为安全检查并不总是必要的。

如果只执行一个与目录相关的操作,则使用静态 Directory 方法而不是相应的 DirectoryInfo 实例方法可能更有效。 大多数 Directory 方法都需要你正在操作的目录的路径。

备注

DirectoryInfo 实例方法将在下一篇博客中总结。

类的 Directory 静态方法对所有方法执行安全检查。 如果要多次重复使用对象,请考虑改用相应的实例方法 DirectoryInfo ,因为安全检查并不总是必要的。

♋ 更多方法

更多方法请查阅官方文档 Directory 类

⭐写在结尾:

文章中出现的任何错误请大家批评指出,一定及时修改。

希望写在这里的小伙伴能给个三连支持

相关文章
|
5月前
|
IDE API 开发工具
拦截|篡改|伪造.NET类库中不限于public的类和方法
本文除了回顾拦截.NET类库中的方法,实现方法参数的篡改、方法返回结果的伪造,再着重介绍.NET类库中非public类及方法如何拦截。
拦截|篡改|伪造.NET类库中不限于public的类和方法
|
8月前
|
C#
.NET Core反射获取带有自定义特性的类,通过依赖注入根据Attribute元数据信息调用对应的方法
.NET Core反射获取带有自定义特性的类,通过依赖注入根据Attribute元数据信息调用对应的方法
107 0
|
开发框架 JSON 前端开发
【C#】.net core2.1,自定义全局类对API接口和视图页面产生的异常统一处理
在开发一个网站项目时,异常处理和过滤功能是最基础的模块 本篇文章就来讲讲,如何自定义全局异常类来统一处理
195 0
|
JSON 数据格式
【.NET开发福音】使用Visual Studio将JSON格式数据自动转化为对应的类
【.NET开发福音】使用Visual Studio将JSON格式数据自动转化为对应的类
527 0
【.NET开发福音】使用Visual Studio将JSON格式数据自动转化为对应的类
|
缓存 移动开发 C#
【.Net实用方法总结】 整理并总结System.IO中TextWriter类及其方法介绍
本文主要介绍System.IO命名空间的TextWriter类,介绍其常用的方法和示例说明。
|
C# 开发者 索引
【.Net实用方法总结】 整理并总结System.IO中TextReader类及其方法介绍
本文主要介绍System.IO命名空间的TextReader类,介绍其常用的方法和示例说明。
|
存储 缓存 C#
【.Net实用方法总结】 整理并总结System.IO中StringWriter类及其方法介绍
本文主要介绍System.IO命名空间的StringWriter类,介绍其常用的方法和示例说明。
|
10月前
|
缓存 前端开发 JavaScript
采用.Net Core技术框架开发的医院云LIS平台源码,B/S架构
基于B/S架构的医学实验室检验系统源码,整个系统的运行基于WEB层面,只需要在对应的工作台安装一个浏览器软件有外网即可访问。全套系统采用云部署模式,部署一套可支持多家医院检验科共同使用。 采用.Net Core新的技术框架、DEV报表、前端js封装、分布式文件存储、分布式缓存等,支持LIS独立部署,Docker部署等多种方式。
|
安全 NoSQL MongoDB
.Net线程同步技术解读
C#开发者(面试者)都会遇到lock(Monitor),Mutex,Semaphore,SemaphoreSlim这四个与锁相关的C#类型,本文期望以最简洁明了的方式阐述四种对象的区别。
.Net线程同步技术解读
|
移动开发 负载均衡 前端开发
2022届软件技术专业毕业生就业岗位分析(.Net方向)(7)
2022届软件技术专业毕业生就业岗位分析(.Net方向)(7)
123 0
2022届软件技术专业毕业生就业岗位分析(.Net方向)(7)