【無私分享：ASP.NET CORE 項目實戰（第七章）】文件操做 FileHelper

 

目錄索引　

 

【無私分享：ASP.NET CORE 項目實戰】目錄索引

 

簡介

 

　　在程序設計中，咱們不少狀況下，會用到對文件的操做，在 上一個系列 中，咱們有不少文件基本操做的示例，在Core中有一些改變，主要是咱們經常使用的Server.MapPath()不存在了，不知道後續的版本會不會有，在這裏，咱們只能本身封裝方法去實現。今天，咱們就對一些基本的操做寫了一個 FileHelper 類，供你們探討。在此要感謝覺得不肯意透漏姓名的大神的幫助：@YINYEJUN

 

 

獲取文件的絕對路徑

 

　　 在之前的操做中，這個應該是十分簡單的，能夠經過 System.Web.HttpContext.Current.Server.MapPath("...") 直接獲取，簡介中，咱們講過，這個方法已經不存在了，網上翻閱了不少資料，Server.MapPath 最終調用 HostingEnvironment.MapPath() ，可是，它建立了一個特定選項的 virtualpath 對象，咱們暫時先無論這些原理性的東西，咱們看下如何去實現。

　　

　　咱們這裏須要用到 IHostingEnvironment ，注入的方式有不少，最推薦的是 構造器 的注入，例如：　

　　　　public readonly IHostingEnvironment _Env;

　　　　public FileHelper(IHostingEnvironment Env)
　　　　{
　　　　　　_Env = Env;
　　　　} 

 

可是，現實狀況是，咱們但願這個類裏的方法都是靜態方法，能夠直接調用 FileHelper.MapPath()，固然這不是主要因素，主要因素是 咱們在 其它的幫助類裏也要調用這個方法，好比 咱們在 Uitls 類裏 有個讀取文件內容的方法調用這個方法獲取絕對路徑，在兩種狀況下，構造器的注入顯然是不合適的。

 所以，咱們如何去實現呢？

一：咱們添加兩個靜態類 Extensions 、DI

 

 

二：在Startup.cs 的 Configure 方法中添加：

 

 

　　添加完這兩個類，咱們回到 FileHelper 

　　定義兩個靜態字段：

      DirectorySeparatorChar：目錄分隔符，由於是跨平臺的應用，咱們要判斷目錄分隔符，windows 下是 "\"， Mac OS and Linux 下是 "/"

     _ContentRootPath：包含應用程序的目錄的絕對路徑

　　

　　

　　咱們如今寫一個獲取文件絕對路徑的靜態方法 MapPath(string path)

　　邏輯是：①：判斷是不是絕對路徑，若是是絕對路徑直接返回當前路徑

　　　　       ②：若是不是絕對路徑，咱們經過 Path.Combine 組合路徑，應用程序的目錄的絕對路徑 + 虛擬路徑轉絕對路徑

　　

　　/// <summary>
　　/// 獲取文件絕對路徑
　　/// </summary>
　　/// <param name="path">文件路徑</param>
　　/// <returns></returns>
　　public static string MapPath(string path)
　　{
　　　　return IsAbsolute(path) ? path : Path.Combine(_ContentRootPath , path.TrimStart('~','/').Replace("/", DirectorySeparatorChar));
　　}

 

說明：

_ContentRootPath 是咱們在 開始 獲取的 應用程序的絕對路徑 private static string _ContentRootPath = DI.ServiceProvider.GetRequiredService<IHostingEnvironment>().ContentRootPath;

 對於傳遞進來的 path , 咱們首先用 TrimStart 去除路徑中的「~」和 「/」，而後經過 Replace 替換 目錄分隔符 爲 當前系統的目錄分隔符

IsAbsolute 是咱們定義的方法，判斷當前路徑是否爲絕對路徑（見下文）

 

判斷當前路徑是否爲絕對路徑

　　咱們用了一個簡單的辦法來判斷當前路徑是否爲絕對路徑，咱們獲取系統盤符，windows 的系統盤符爲「：」；Mac OS 和 Linux 沒有盤符的概念都是「/」開始，因此咱們判斷是否包含「\」：

      

 1 　　　　 /// <summary>
 2         /// 是不是絕對路徑
 3         /// windows下判斷 路徑是否包含 ":"
 4         /// Mac OS、Linux下判斷 路徑是否包含 "\"
 5         /// </summary>
 6         /// <param name="path">路徑</param>
 7         /// <returns></returns>
 8         public static bool IsAbsolute(string path)
 9         {
10             return Path.VolumeSeparatorChar == ':' ? path.IndexOf(Path.VolumeSeparatorChar) > 0 : path.IndexOf('\\') > 0;
11         }

 

 

 

　

文件的基本操做（這些操做基本跟之前沒什麼區別，給你們參考一下）

　　

　　全部的路徑，咱們都用到了 IsAbsolute(path) ? path : MapPath(path)，一個三元運算符，用戶判斷若是非絕對路徑轉爲絕對路徑。

　　檢測指定路徑是否存在：

　　

 1 /// <summary>
 2         /// 檢測指定路徑是否存在
 3         /// </summary>
 4         /// <param name="path">路徑</param>
 5         /// <param name="isDirectory">是不是目錄</param>
 6         /// <returns></returns>
 7         public static bool IsExist(string path,bool isDirectory)
 8         {
 9             return isDirectory ? Directory.Exists(IsAbsolute(path) ? path : MapPath(path)) : File.Exists(IsAbsolute(path) ? path : MapPath(path));
10         }

 

　　檢測目錄是否爲空

　

1 /// <summary>
2         /// 檢測目錄是否爲空
3         /// </summary>
4         /// <param name="path">路徑</param>
5         /// <returns></returns>
6         public static bool IsEmptyDirectory(string path)
7         {
8             return Directory.GetFiles(IsAbsolute(path) ? path : MapPath(path)).Length <= 0 && Directory.GetDirectories(IsAbsolute(path) ? path : MapPath(path)).Length <= 0;
9         }

 

 

　　建立文件或目錄

 

 1 /// <summary>
 2         /// 建立目錄或文件
 3         /// </summary>
 4         /// <param name="path">路徑</param>
 5         /// <param name="isDirectory">是不是目錄</param>
 6         public static void CreateFiles(string path, bool isDirectory)
 7         {
 8             try {
 9                 if (!IsExist(path, isDirectory))
10                 {
11                     if (isDirectory)
12                         Directory.CreateDirectory(IsAbsolute(path) ? path : MapPath(path));
13                     else
14                     {
15                         FileInfo file = new FileInfo(IsAbsolute(path) ? path : MapPath(path));
16                         FileStream fs = file.Create();
17                         fs.Dispose();
18                     }
19                 }                   
20             }
21             catch(Exception ex)
22             {
23                 throw ex;
24             }
25         }

 

 

 　　刪除文件或目錄

 

 1 /// <summary>
 2         /// 刪除目錄或文件
 3         /// </summary>
 4         /// <param name="path">路徑</param>
 5         /// <param name="isDirectory">是不是目錄</param>
 6         public static void DeleteFiles(string path, bool isDirectory)
 7         {
 8             try
 9             {
10                 if (!IsExist(path, isDirectory))
11                 {
12                     if (isDirectory)
13                         Directory.Delete(IsAbsolute(path) ? path : MapPath(path));
14                     else
15                         File.Delete(IsAbsolute(path) ? path : MapPath(path));                    
16                 }
17             }
18             catch (Exception ex)
19             {
20                 throw ex;
21             }
22         }

 

　　清空目錄下全部文件及子目錄，依然保留該目錄

　　

 1 /// <summary>
 2         /// 清空目錄下全部文件及子目錄，依然保留該目錄
 3         /// </summary>
 4         /// <param name="path"></param>
 5         public static void ClearDirectory(string path)
 6         {
 7             if(IsExist(path,true))
 8             {
 9                 //目錄下全部文件
10                 string[] files = Directory.GetFiles(IsAbsolute(path) ? path : MapPath(path));
11                 foreach(var file in files)
12                 {
13                     DeleteFiles(file, false);
14                 }
15                 //目錄下全部子目錄
16                 string[] directorys = Directory.GetDirectories(IsAbsolute(path) ? path : MapPath(path));
17                 foreach(var dir in directorys)
18                 {
19                     DeleteFiles(dir, true);
20                 }
21             }
22         }

 

　　複製文件、移動文件

 1 /// <summary>
 2         /// 複製文件內容到目標文件夾
 3         /// </summary>
 4         /// <param name="sourcePath">源文件</param>
 5         /// <param name="targetPath">目標文件夾</param>
 6         /// <param name="isOverWrite">是否能夠覆蓋</param>
 7         public static void Copy(string sourcePath,string targetPath,bool isOverWrite=true)
 8         {
 9             File.Copy(IsAbsolute(sourcePath) ? sourcePath : MapPath(sourcePath), (IsAbsolute(targetPath) ? targetPath : MapPath(targetPath))+ GetFileName(sourcePath), isOverWrite);
10         }

 

 

 1 /// <summary>
 2         /// 移動文件到目標目錄
 3         /// </summary>
 4         /// <param name="sourcePath">源文件</param>
 5         /// <param name="targetPath">目標目錄</param>
 6         public static void Move(string sourcePath, string targetPath)
 7         {
 8             string sourceFileName = GetFileName(sourcePath);
 9             //若是目標目錄不存在則建立
10             if(!IsExist(targetPath, true))
11             {
12                 CreateFiles(targetPath, true);
13             }
14             else
15             {
16                 //若是目標目錄存在同名文件則刪除
17                 if (IsExist(Path.Combine(IsAbsolute(targetPath) ? targetPath : MapPath(targetPath), sourceFileName), false))
18                 {
19                     DeleteFiles(Path.Combine(IsAbsolute(targetPath) ? targetPath : MapPath(targetPath), sourceFileName), true);
20                 }
21             }
22 
23             File.Move(IsAbsolute(sourcePath) ? sourcePath : MapPath(sourcePath), Path.Combine(IsAbsolute(targetPath) ? targetPath : MapPath(targetPath), sourceFileName));
24 
25 
26         }

 

　　獲取文件名和擴展名

 1 /// <summary>
 2         /// 獲取文件名和擴展名
 3         /// </summary>
 4         /// <param name="path">文件路徑</param>
 5         /// <returns></returns>
 6         public static string GetFileName(string path)
 7         {
 8             return Path.GetFileName(IsAbsolute(path) ? path : MapPath(path));
 9         }
10 
11         /// <summary>
12         /// 獲取文件名不帶擴展名
13         /// </summary>
14         /// <param name="path">文件路徑</param>
15         /// <returns></returns>
16         public static string GetFileNameWithOutExtension(string path)
17         {
18             return Path.GetFileNameWithoutExtension(IsAbsolute(path) ? path : MapPath(path));
19         }
20         
21         /// <summary>
22         /// 獲取文件擴展名
23         /// </summary>
24         /// <param name="path">文件路徑</param>
25         /// <returns></returns>
26         public static string GetFileExtension(string path)
27         {
28             return Path.GetExtension(IsAbsolute(path) ? path : MapPath(path));
29         }

 

 

　　修正：

　　

　　對因而否是絕對路徑，咱們在MapPath(string path) 方法中已經作了判斷，因此其它方法沒有必要再次判斷，其他方法中的 IsAbsolute(path) ? path : MapPath(path) 可直接改成 MapPath(path)，

　　感謝@shoufengwei !

 

 

 

  

 

 

但願跟你們一塊兒學習Asp.net Core 

剛開始接觸，水平有限，不少東西都是本身的理解和翻閱網上大神的資料，若是有不對的地方和不理解的地方，但願你們指正！

雖然Asp.net Core 如今很火熱，可是網上的不少資料都是前篇一概的複製，因此有不少問題我也暫時沒有解決，但願你們能共同幫助一下！

 

原創文章 轉載請尊重勞動成果 http://yuangang.cnblogs.com