[UWP]在应用开发中安全使用文件资源

Posted 2021-01-27 lonelyxmas

原文:[UWP]在应用开发中安全使用文件资源

在WPF或者UWP应用开发中，有时候会不可避免的需要操作文件系统（创建文件/目录），这时候有几个坑是需要大家注意下的。

创建文件或目录时的非法字符检测

在Windows系统中，我们创建文件时会注意到，某些特殊字符是不可以用作文件名输入的。

那么，同样的，如果你的应用可以提供给用户创建文件/目录的功能，要特别注意的是：你必须对用户键入的文件或者目录名检测，避免用户键入非法字符。

否则，应用可能会遇到下面这个bug：System.IO.FileNotFoundException:“文件名、目录名或卷标语法不正确。”

避免手段其实也很简单，System.IO.Path类中可以获取到所有的非法字符，我们只需要检测文件或目录名，避免出现非法字符就可以了。

不可以在文件名中出现的字符 Path.GetInvalidFileNameChars(）：

char[41] { ‘"‘, ‘<‘, ‘>‘, ‘|‘, ‘‘, ‘u0001‘, ‘u0002‘, ‘u0003‘, ‘u0004‘, ‘u0005‘, ‘u0006‘, ‘a‘, ‘‘, ‘ ‘, ‘ ‘, ‘v‘, ‘f‘, ‘ ‘, ‘u000e‘, ‘u000f‘, ‘u0010‘, ‘u0011‘, ‘u0012‘, ‘u0013‘, ‘u0014‘, ‘u0015‘, ‘u0016‘, ‘u0017‘, ‘u0018‘, ‘u0019‘, ‘u001a‘, ‘u001b‘, ‘u001c‘, ‘u001d‘, ‘u001e‘, ‘u001f‘, ‘:‘, ‘*‘, ‘?‘, ‘\\‘, ‘/‘ }

不可以在路径字符串中出现的字符 Path.GetInvalidPathChars()：

char[36] { ‘"‘, ‘<‘, ‘>‘, ‘|‘, ‘‘, ‘u0001‘, ‘u0002‘, ‘u0003‘, ‘u0004‘, ‘u0005‘, ‘u0006‘, ‘a‘, ‘‘, ‘ ‘, ‘ ‘, ‘v‘, ‘f‘, ‘ ‘, ‘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应用这么久了，第二种情况按理说是不应该出现的，不知道微软方面有没有注意到（或者说是否有官方解决方法，类似转义符什么的？）。如果有了解这个问题的大佬，欢迎在评论区指出！

这篇博文到此结束，谢谢大家！