将文件路径转换为文件 URI？

Question

.NET Framework 是否有任何方法可以将路径（例如 "C:\whatever.txt"）转换为文件 URI（例如 "file:///C:/whatever.txt）。 txt”）？

System.Uri 类有相反的情况（从文件 URI 到绝对路径），但据我所知，没有任何东西可以转换为文件 URI。

此外，这不是 ASP.NET 应用程序。

Answer 1

System.Uri 构造函数能够解析完整文件路径并将其转换为 URI 样式路径。所以你可以执行以下操作：

var uri = new System.Uri("c:\\foo");
var converted = uri.AbsoluteUri;

Answer 2

似乎没有人意识到，没有一个 System.Uri 构造函数能够正确处理某些带有百分号的路径。

new Uri(@"C:\%51.txt").AbsoluteUri;

这将为您提供 "file:///C:/Q.txt" 而不是 "file:///C:/%2551.txt"。

已弃用的 dontEscape 参数的值都没有任何区别，并且指定 UriKind 也会给出相同的结果。尝试使用 UriBuilder 也没有帮助：

new UriBuilder() { Scheme = Uri.UriSchemeFile, Host = "", Path = @"C:\%51.txt" }.Uri.AbsoluteUri

这也会返回 "file:///C:/Q.txt" 。

据我所知，该框架实际上缺乏任何正确执行此操作的方法。

我们可以尝试通过用正斜杠替换反斜杠并将路径提供给 Uri.EscapeUriString - 即，

new Uri(Uri.EscapeUriString(filePath.Replace(Path.DirectorySeparatorChar, '/'))).AbsoluteUri

这似乎一开始可行，但如果你给它路径 C:\a b.txt 那么你最终会得到 file:///C:/a%2520b.txt 而不是 file:///C:/a%20b.txt - 不知何故，它决定应该解码某些序列，但不解码其他序列。现在我们可以自己添加 "file:///" 前缀，但这无法考虑 \\remote\share\foo.txt 这样的 UNC 路径 - 什么Windows 上普遍接受的做法是将它们转换为 file://remote/share/foo.txt 形式的伪 URL，因此我们也应该考虑到这一点。

EscapeUriString 也存在无法转义 '#' 字符的问题。在这一点上，我们似乎别无选择，只能从头开始制定自己的方法。所以这就是我的建议：

public static string FilePathToFileUrl(string filePath)
{
  StringBuilder uri = new StringBuilder();
  foreach (char v in filePath)
  {
    if ((v >= 'a' && v <= 'z') || (v >= 'A' && v <= 'Z') || (v >= '0' && v <= '9') ||
      v == '+' || v == '/' || v == ':' || v == '.' || v == '-' || v == '_' || v == '~' ||
      v > '\xFF')
    {
      uri.Append(v);
    }
    else if (v == Path.DirectorySeparatorChar || v == Path.AltDirectorySeparatorChar)
    {
      uri.Append('/');
    }
    else
    {
      uri.Append(String.Format("%{0:X2}", (int)v));
    }
  }
  if (uri.Length >= 2 && uri[0] == '/' && uri[1] == '/') // UNC path
    uri.Insert(0, "file:");
  else
    uri.Insert(0, "file:///");
  return uri.ToString();
}

故意将 + 和 : 保留为未编码，因为这似乎是 Windows 上通常的做法。它还仅对 latin1 进行编码，因为 Internet Explorer 无法理解文件 url 中的 unicode 字符（如果进行了编码）。

Answer 3

上述解决方案在 Linux 上不起作用。

使用 .NET Core，尝试执行 new Uri("/home/foo/README.md") 会导致异常：

Unhandled Exception: System.UriFormatException: Invalid URI: The format of the URI could not be determined.
   at System.Uri.CreateThis(String uri, Boolean dontEscape, UriKind uriKind)
   at System.Uri..ctor(String uriString)
   ...

您需要向 CLR 提供一些有关您拥有的 URL 类型的提示。

这有效：

Uri fileUri = new Uri(new Uri("file://"), "home/foo/README.md");

...fileUri.ToString() 返回的字符串是 "file:///home/foo/README.md"

这适用于 Windows，也。

new Uri(new Uri("file://"), @"C:\Users\foo\README.md").ToString()

...发出 "file:/ //C:/Users/foo/README.md"

Answer 4

VB.NET：

Dim URI As New Uri("D:\Development\~AppFolder\Att\1.gif")

不同的输出：

URI.AbsolutePath   ->  D:/Development/~AppFolder/Att/1.gif  
URI.AbsoluteUri    ->  file:///D:/Development/~AppFolder/Att/1.gif  
URI.OriginalString ->  D:\Development\~AppFolder\Att\1.gif  
URI.ToString       ->  file:///D:/Development/~AppFolder/Att/1.gif  
URI.LocalPath      ->  D:\Development\~AppFolder\Att\1.gif

一条线：

New Uri("D:\Development\~AppFolder\Att\1.gif").AbsoluteUri

输出：file:///D:/Development/~AppFolder/Att/1.gif

Answer 5

至少在 .NET 4.5+ 中你还可以这样做：

var uri = new System.Uri("C:\\foo", UriKind.Absolute);

Answer 6

不幸的是，@poizan42 的答案没有考虑到我们生活在 Unicode 世界中的事实，并且根据 RFC3986 它的限制性太大。
@pierre-arnaud 和 @jaredpar 接受的答案依赖于 System.Uri 构造函数，该构造函数必须处理 Uri 的太多组件才能管理文件名的可变性，并且在百分比字符和其他情况下表现不佳。
其他答案要么过于简单化，要么根本没有用。最好的应该是@is4，但是在发布这篇文章的第一个版本之后，我在为我编写的测试用例中一起测试了它，并且它在许多 Unicode 字符上失败了。

就我而言，我开始研究 @poizan42 代码以及评论哪些有效、哪些无效的各种答案，因此我采取了略有不同的方法。

首先，我认为输入字符串是有效的文件路径，因此我在测试中使用所有有效的 unicode 字符和代理项对以编程方式创建了路径。通过这一点，我验证了至少 Path.GetInvalidFileNameChars() 似乎至少在 Windows 中返回了正确的设置。
然后，我将这些路径传递给我按照 ABNF 路径规则实现的方法，您可以在 https://www.ietf.org/rfc/rfc3986.txt。

我将其结果与 UriBuilder 生成的结果进行比较，这就是最终的修复：

public static string FilePathToFileUrl(string path)
{
    return new UriBuilder("file",string.Empty)
        {
            Path = path
                .Replace("%",$"%{(int)'%':X2}")
                .Replace("[",$"%{(int)'[':X2}")
                .Replace("]",$"%{(int)']':X2}"),
        }
        .Uri
        .AbsoluteUri;
}

这完全未优化并执行三个替换，因此请随意将其转换为 Span 或 StringBuilder。

Answer 7

UrlCreateFromPath 来救援！好吧，不完全是，因为它不支持扩展和 UNC 路径格式，但这并不难克服：

public static Uri FileUrlFromPath(string path)
{
    const string prefix = @"\\";
    const string extended = @"\\?\";
    const string extendedUnc = @"\\?\UNC\";
    const string device = @"\\.\";
    const StringComparison comp = StringComparison.Ordinal;
    
    if(path.StartsWith(extendedUnc, comp))
    {
        path = prefix+path.Substring(extendedUnc.Length);
    }else if(path.StartsWith(extended, comp))
    {
        path = prefix+path.Substring(extended.Length);
    }else if(path.StartsWith(device, comp))
    {
        path = prefix+path.Substring(device.Length);
    }
    
    int len = 1;
    var buffer = new StringBuilder(len);
    int result = UrlCreateFromPath(path, buffer, ref len, 0);
    if(len == 1) Marshal.ThrowExceptionForHR(result);
    
    buffer.EnsureCapacity(len);
    result = UrlCreateFromPath(path, buffer, ref len, 0);
    if(result == 1) throw new ArgumentException("Argument is not a valid path.", "path");
    Marshal.ThrowExceptionForHR(result);
    return new Uri(buffer.ToString());
}

[DllImport("shlwapi.dll", CharSet=CharSet.Auto, SetLastError=true)]
static extern int UrlCreateFromPath(string path, StringBuilder url, ref int urlLength, int reserved);

如果路径以特殊前缀开头，它就会被删除。尽管文档没有提及，但即使缓冲区较小，该函数也会输出 URL 的长度，因此我首先获取长度，然后分配缓冲区。

我的一些非常有趣的观察是，虽然 \\\device\path 正确地转换为 file://device/path，特别是< code>\\\localhost\path 被转换为 file:///path。

与 Uri 构造函数不同，WinApi 函数设法对特殊字符进行编码，但不对 Unicode 特定字符进行编码。在这种情况下，AbsoluteUri 包含正确编码的 URL，而 OriginalString 可用于保留 Unicode 字符。

Answer 8

解决方法很简单。只需使用 Uri().ToString() 方法并对空格（如果有）进行百分比编码即可。

string path = new Uri("C:\my exampleㄓ.txt").ToString().Replace(" ", "%20");

正确返回file:///C:/my%20exampleㄓ.txt