[UWP]在應用開發中安全使用檔案資源
在WPF或者UWP應用開發中,有時候會不可避免的需要操作檔案系統(建立檔案/目錄),這時候有幾個坑是需要大家注意下的。
建立檔案或目錄時的非法字元檢測
在Windows系統中,我們建立檔案時會注意到,某些特殊字元是不可以用作檔名輸入的。
那麼,同樣的,如果你的應用可以提供給使用者建立檔案/目錄的功能,要特別注意的是:你必須對使用者鍵入的檔案或者目錄名檢測,避免使用者鍵入非法字元。
否則,應用可能會遇到下面這個bug:System.IO.FileNotFoundException:“檔名、目錄名或卷標語法不正確。”
避免手段其實也很簡單,System.IO.Path類中可以獲取到所有的非法字元,我們只需要檢測檔案或目錄名,避免出現非法字元就可以了。
不可以在檔名中出現的字元 Path.GetInvalidFileNameChars():
char[41] { '"', '<', '>', '|', '\0', '\u0001', '\u0002', '\u0003', '\u0004', '\u0005', '\u0006', '\a', '\b', '\t', '\n', '\v', '\f', '\r', '\u000e', '\u000f', '\u0010', '\u0011', '\u0012', '\u0013', '\u0014', '\u0015', '\u0016', '\u0017', '\u0018', '\u0019', '\u001a', '\u001b', '\u001c', '\u001d', '\u001e', '\u001f', ':', '*', '?', '\\', '/' }
不可以在路徑字串中出現的字元 Path.GetInvalidPathChars():
char[36] { '"', '<', '>', '|', '\0', '\u0001', '\u0002', '\u0003', '\u0004', '\u0005', '\u0006', '\a', '\b', '\t', '\n', '\v', '\f', '\r', '\u000e', '\u000f', '\u0010', '\u0011', '\u0012', '\u0013', '\u0014', '\u0015', '\u0016', '\u0017', '\u0018', '\u0019', '\u001a', '\u001b', '\u001c', '\u001d', '\u001e', '\u001f' }
這裡給大家提供一個小竅門,使用C#互動視窗(VS2015及更高版本都可以使用),可以快速檢視程式碼片段執行結果。
在XAML中引用外部資源時的非法字元檢測
此外,在開發WPF或者UWP應用時,如果我們需要在XAML中引入外部資源URI,那麼情況會比較特殊一點。
有時候儘管你的檔名或者路徑URI均沒有包含Windows檔案系統中的非法字元,應用仍有可能崩潰。這是因為,在XAML中定義了一些不允許出現的字元,這些字元與Windows檔案系統中的非法字元不盡相同。
這些字元是:
{ ';' , '/' , '?' , ':' , '@' , '&' , '=' , '+' , '$' , ',','<' , '>' , '#' , '%' , '"' }
例如‘#’,它在檔案系統中是合法字元,但是卻不能出現在XAML中引入的外部資源URI字串裡。
這個問題在邵猛大佬的《WPF 圖片顯示中的保留字元問題》中也是有講到的,但是文章中沒有給到解決方法。
在某些情況下,如開發應用時,我們允許使用者上傳圖片到應用資料夾下作為資源使用,我們可以在拷貝資源時通過排除/替換檔名裡非法字元的方法來避免這個BUG。
public static class XamlUriHelper
{
private static readonly char[] Excluded = { ';' , '/' , '?' , ':' , '@' , '&' , '=' , '+' , '$' , ',','<' , '>' , '#' , '%' , '"' };
public static string GetValidName(string fileName)
{
foreach (var item in Excluded)
{
fileName = fileName.Replace(item, '_');
}
return fileName;
}
}
結尾
上面說到的兩種情況,第一種是比較好處理的,而第二種需要一些折中的處理手段。另外吐槽一點,XAML應用這麼久了,第二種情況按理說是不應該出現的,不知道微軟方面有沒有注意到(或者說是否有官方解決方法,類似轉義符什麼的?)。如果有了解這個問題的大佬,歡迎在評論區指出!
這篇博文到此結束,謝謝大家!