C# 清理文件名

【问题标题】：C# Sanitize File NameC# 清理文件名
【发布时间】：2010-09-23 11:53:01
【问题描述】：

我最近一直在将一堆 MP3 从不同的位置移动到一个存储库中。我一直在使用 ID3 标签构建新文件名（感谢 TagLib-Sharp！），我注意到我得到了一个System.NotSupportedException：

“不支持给定路径的格式。”

这是由File.Copy() 或Directory.CreateDirectory() 生成的。

很快我就意识到我的文件名需要清理。所以我做了显而易见的事情：

public static string SanitizePath_(string path, char replaceChar)
{
    string dir = Path.GetDirectoryName(path);
    foreach (char c in Path.GetInvalidPathChars())
        dir = dir.Replace(c, replaceChar);

    string name = Path.GetFileName(path);
    foreach (char c in Path.GetInvalidFileNameChars())
        name = name.Replace(c, replaceChar);

    return dir + name;
}

令我惊讶的是，我继续收到异常。原来 ':' 不在Path.GetInvalidPathChars() 的集合中，因为它在路径根中有效。我想这是有道理的——但这一定是一个非常普遍的问题。有没有人有一些清理路径的短代码？这是我想出的最彻底的方法，但感觉可能有点矫枉过正。

    // replaces invalid characters with replaceChar
    public static string SanitizePath(string path, char replaceChar)
    {
        // construct a list of characters that can't show up in filenames.
        // need to do this because ":" is not in InvalidPathChars
        if (_BadChars == null)
        {
            _BadChars = new List<char>(Path.GetInvalidFileNameChars());
            _BadChars.AddRange(Path.GetInvalidPathChars());
            _BadChars = Utility.GetUnique<char>(_BadChars);
        }

        // remove root
        string root = Path.GetPathRoot(path);
        path = path.Remove(0, root.Length);

        // split on the directory separator character. Need to do this
        // because the separator is not valid in a filename.
        List<string> parts = new List<string>(path.Split(new char[]{Path.DirectorySeparatorChar}));

        // check each part to make sure it is valid.
        for (int i = 0; i < parts.Count; i++)
        {
            string part = parts[i];
            foreach (char c in _BadChars)
            {
                part = part.Replace(c, replaceChar);
            }
            parts[i] = part;
        }

        return root + Utility.Join(parts, Path.DirectorySeparatorChar.ToString());
    }

非常感谢任何使此功能更快且更少巴洛克式的改进。

【问题讨论】：

标签： c# validation path sanitize invalid-characters


【解决方案1】：

要清理文件名，您可以这样做

private static string MakeValidFileName( string name )
{
   string invalidChars = System.Text.RegularExpressions.Regex.Escape( new string( System.IO.Path.GetInvalidFileNameChars() ) );
   string invalidRegStr = string.Format( @"([{0}]*\.+$)|([{0}]+)", invalidChars );

   return System.Text.RegularExpressions.Regex.Replace( name, invalidRegStr, "_" );
}

【讨论】：

  • 问题是关于路径，而不是文件名，并且这些无效字符是不同的。
  • 也许吧，但是当我遇到同样的问题时，这段代码肯定对我有帮助:)
  • 另一个潜在的伟大的 SO 用户去散步......这个功能很棒。谢谢 Adrevdm...
  • 好方法。不要忘记保留字仍然会咬你，你会摸不着头脑。来源：Wikipedia Filename reserved words
  • 如果句点位于文件名的末尾，则它们是无效字符，因此GetInvalidFileNameChars 不包括它们。它不会在 Windows 中引发异常，它只是将它们剥离，但如果您期望期间存在，它可能会导致意外行为。我修改了正则表达式来处理这种情况，如果 . 在字符串的末尾，它会被视为无效字符之一。
【解决方案2】：

更短的解决方案：

var invalids = System.IO.Path.GetInvalidFileNameChars();
var newName = String.Join("_", origFileName.Split(invalids, StringSplitOptions.RemoveEmptyEntries) ).TrimEnd('.');

【讨论】：

  • 这比最佳答案要好，尤其是对于可能会根据平台返回不同字符的 ASP.NET Core。
【解决方案3】：

基于 Andre 的出色回答，但考虑到 Spud 对保留字的评论，我制作了这个版本：

/// <summary>
/// Strip illegal chars and reserved words from a candidate filename (should not include the directory path)
/// </summary>
/// <remarks>
/// http://stackoverflow.com/questions/309485/c-sharp-sanitize-file-name
/// </remarks>
public static string CoerceValidFileName(string filename)
{
    var invalidChars = Regex.Escape(new string(Path.GetInvalidFileNameChars()));
    var invalidReStr = string.Format(@"[{0}]+", invalidChars);

    var reservedWords = new []
    {
        "CON", "PRN", "AUX", "CLOCK$", "NUL", "COM0", "COM1", "COM2", "COM3", "COM4",
        "COM5", "COM6", "COM7", "COM8", "COM9", "LPT0", "LPT1", "LPT2", "LPT3", "LPT4",
        "LPT5", "LPT6", "LPT7", "LPT8", "LPT9"
    };

    var sanitisedNamePart = Regex.Replace(filename, invalidReStr, "_");
    foreach (var reservedWord in reservedWords)
    {
        var reservedWordPattern = string.Format("^{0}\\.", reservedWord);
        sanitisedNamePart = Regex.Replace(sanitisedNamePart, reservedWordPattern, "_reservedWord_.", RegexOptions.IgnoreCase);
    }

    return sanitisedNamePart;
}

这些是我的单元测试

[Test]
public void CoerceValidFileName_SimpleValid()
{
    var filename = @"thisIsValid.txt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual(filename, result);
}

[Test]
public void CoerceValidFileName_SimpleInvalid()
{
    var filename = @"thisIsNotValid\3\\_3.txt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual("thisIsNotValid_3__3.txt", result);
}

[Test]
public void CoerceValidFileName_InvalidExtension()
{
    var filename = @"thisIsNotValid.t\xt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual("thisIsNotValid.t_xt", result);
}

[Test]
public void CoerceValidFileName_KeywordInvalid()
{
    var filename = "aUx.txt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual("_reservedWord_.txt", result);
}

[Test]
public void CoerceValidFileName_KeywordValid()
{
    var filename = "auxillary.txt";
    var result = PathHelper.CoerceValidFileName(filename);
    Assert.AreEqual("auxillary.txt", result);
}

【讨论】：

  • 这是一个非常完整的答案，至少对于问题的文件名部分而言，值得更多的支持。
  • 小建议，因为看起来该方法正朝着这个方向发展：添加一个 this 关键字，它成为一个方便的扩展方法。 public static String CoerceValidFileName(这个字符串文件名)
  • 小错误：此方法不会更改没有文件扩展名的保留字（例如COM1），这也是不允许的。建议的修复方法是将 reservedWordPattern 更改为 "^{0}(\\.|$)" 并将替换字符串更改为 "_reservedWord_$1"
  • Clock$. 失败，因为 reservedWordPattern 需要通过 Regex.Escape()
【解决方案4】： 
string clean = String.Concat(dirty.Split(Path.GetInvalidFileNameChars()));

【讨论】：

【解决方案5】：

这里有很多可行的解决方案。只是为了完整起见，这是一种不使用正则表达式，而是使用 LINQ 的方法：

var invalids = Path.GetInvalidFileNameChars();
filename = invalids.Aggregate(filename, (current, c) => current.Replace(c, '_'));

另外，这是一个非常简短的解决方案；）

【讨论】：

  • 我喜欢一个班轮 :)
【解决方案6】：

我正在使用System.IO.Path.GetInvalidFileNameChars()方法检查无效字符，我没有遇到任何问题。

我正在使用以下代码：

foreach( char invalidchar in System.IO.Path.GetInvalidFileNameChars())
{
    filename = filename.Replace(invalidchar, '_');
}

【讨论】：

    【解决方案7】：

    我想以某种方式保留字符，而不仅仅是简单地用下划线替换字符。

    我认为的一种方法是用看起来相似的字符替换字符，这些字符（在我的情况下）不太可能用作常规字符。所以我拿了无效字符列表并找到了类似的东西。

    以下是使用look-a-likes进行编码和解码的函数。

    此代码不包含所有 System.IO.Path.GetInvalidFileNameChars() 字符的完整列表。因此，您可以扩展或使用下划线替换任何剩余的字符。

    private static Dictionary<string, string> EncodeMapping()
{
    //-- Following characters are invalid for windows file and folder names.
    //-- \/:*?"<>|
    Dictionary<string, string> dic = new Dictionary<string, string>();
    dic.Add(@"\", "Ì"); // U+OOCC
    dic.Add("/", "Í"); // U+OOCD
    dic.Add(":", "¦"); // U+00A6
    dic.Add("*", "¤"); // U+00A4
    dic.Add("?", "¿"); // U+00BF
    dic.Add(@"""", "ˮ"); // U+02EE
    dic.Add("<", "«"); // U+00AB
    dic.Add(">", "»"); // U+00BB
    dic.Add("|", "│"); // U+2502
    return dic;
}

public static string Escape(string name)
{
    foreach (KeyValuePair<string, string> replace in EncodeMapping())
    {
        name = name.Replace(replace.Key, replace.Value);
    }

    //-- handle dot at the end
    if (name.EndsWith(".")) name = name.CropRight(1) + "°";

    return name;
}

public static string UnEscape(string name)
{
    foreach (KeyValuePair<string, string> replace in EncodeMapping())
    {
        name = name.Replace(replace.Value, replace.Key);
    }

    //-- handle dot at the end
    if (name.EndsWith("°")) name = name.CropRight(1) + ".";

    return name;
}

    您可以选择自己喜欢的风格。我在 windows 中使用 Character Map 应用程序来选择我的 %windir%\system32\charmap.exe

    当我通过发现进行调整时，我将更新此代码。

    【讨论】：

    • 请注意，有许多字符看起来更相似，例如fullwidth form！＂＃＄％＆＇（）＊＋，－．／：；＜＝＞？＠｛｜｝～或其他形式，例如/SOLIDUS和` ⁄ `FRACTION SLASH，可以直接使用在文件名中没有问题
    • 很高兴看到一个答案，该答案解决了使用相同模式围绕不同无效字符时出现重复文件的风险。我通过使用 ASCII 标记 (0x000) 对文件名进行编码来调整此解决方案。
    【解决方案8】：

    我认为问题在于您首先在错误字符串上调用Path.GetDirectoryName。如果其中包含非文件名字符，.Net 无法判断字符串的哪些部分是目录并抛出。您必须进行字符串比较。

    假设只有文件名不好，而不是整个路径，试试这个：

    public static string SanitizePath(string path, char replaceChar)
{
    int filenamePos = path.LastIndexOf(Path.DirectorySeparatorChar) + 1;
    var sb = new System.Text.StringBuilder();
    sb.Append(path.Substring(0, filenamePos));
    for (int i = filenamePos; i < path.Length; i++)
    {
        char filenameChar = path[i];
        foreach (char c in Path.GetInvalidFileNameChars())
            if (filenameChar.Equals(c))
            {
                filenameChar = replaceChar;
                break;
            }

        sb.Append(filenameChar);
    }

    return sb.ToString();
}

    【讨论】：

      【解决方案9】：

      我过去在这方面取得了成功。

      不错，简短而静态:-)

          public static string returnSafeString(string s)
    {
        foreach (char character in Path.GetInvalidFileNameChars())
        {
            s = s.Replace(character.ToString(),string.Empty);
        }

        foreach (char character in Path.GetInvalidPathChars())
        {
            s = s.Replace(character.ToString(), string.Empty);
        }

        return (s);
    }

      【讨论】：

        【解决方案10】：

        下面是一个基于Andre代码的高效延迟加载扩展方法：

        using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace LT
{
    public static class Utility
    {
        static string invalidRegStr;

        public static string MakeValidFileName(this string name)
        {
            if (invalidRegStr == null)
            {
                var invalidChars = System.Text.RegularExpressions.Regex.Escape(new string(System.IO.Path.GetInvalidFileNameChars()));
                invalidRegStr = string.Format(@"([{0}]*\.+$)|([{0}]+)", invalidChars);
            }

            return System.Text.RegularExpressions.Regex.Replace(name, invalidRegStr, "_");
        }
    }
}

        【讨论】：

          【解决方案11】：

          如果您将目录和文件名附加在一起并对其进行清理而不是单独清理它们，您的代码会更简洁。至于清理 :，只需取字符串中的第二个字符。如果等于“replacechar”，则用冒号替换。由于这个应用程序是供您自己使用的，因此这样的解决方案应该足够了。

          【讨论】：

            【解决方案12】： 
            using System;
using System.IO;
using System.Linq;
using System.Text;

public class Program
{
    public static void Main()
    {
        try
        {
            var badString = "ABC\\DEF/GHI<JKL>MNO:PQR\"STU\tVWX|YZA*BCD?EFG";
            Console.WriteLine(badString);
            Console.WriteLine(SanitizeFileName(badString, '.'));
            Console.WriteLine(SanitizeFileName(badString));
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.ToString());
        }
    }

    private static string SanitizeFileName(string fileName, char? replacement = null)
    {
        if (fileName == null) { return null; }
        if (fileName.Length == 0) { return ""; }

        var sb = new StringBuilder();
        var badChars = Path.GetInvalidFileNameChars().ToList();

        foreach (var @char in fileName)
        {
            if (badChars.Contains(@char)) 
            {
                if (replacement.HasValue)
                {
                    sb.Append(replacement.Value);
                }
                continue; 
            }
            sb.Append(@char);
        }
        return sb.ToString();
    }
}

            【讨论】：

              【解决方案13】：

              基于@fiat 和@Andre 的方法，我也想分享我的解决方案。 主要区别：

              • 它是一种扩展方法
              • regex 在第一次使用时被编译，以节省大量执行时间
              • 保留字被保留
              public static class StringPathExtensions
{
    private static Regex _invalidPathPartsRegex;
    
    static StringPathExtensions()
    {
        var invalidReg = System.Text.RegularExpressions.Regex.Escape(new string(Path.GetInvalidFileNameChars()));
        _invalidPathPartsRegex = new Regex($"(?<reserved>^(CON|PRN|AUX|CLOCK\\$|NUL|COM0|COM1|COM2|COM3|COM4|COM5|COM6|COM7|COM8|COM9|LPT0|LPT1|LPT2|LPT3|LPT4|LPT5|LPT6|LPT7|LPT8|LPT9))|(?<invalid>[{invalidReg}:]+|\\.$)", RegexOptions.Compiled);
    }

    public static string SanitizeFileName(this string path)
    {
        return _invalidPathPartsRegex.Replace(path, m =>
        {
            if (!string.IsNullOrWhiteSpace(m.Groups["reserved"].Value))
                return string.Concat("_", m.Groups["reserved"].Value);
            return "_";
        });
    }
}

              【讨论】：

                猜你喜欢
                • 1970-01-01
                • 2011-05-05
                • 2017-01-30
                • 2016-02-21
                • 2011-07-31
                • 1970-01-01
                • 1970-01-01
                • 1970-01-01
                • 2022-08-22
                相关资源
                最近更新 更多
                热门标签
                Java Python linux javascript Mysql C# Docker 算法 前端 SpringBoot Redis Vue spring 设计模式 .net core .net kubernetes c++ 数据库 数据结构 大数据 js 机器学习 微服务 Android Go 程序员 面试 JVM ASP.net core 云原生 人工智能 后端 PHP git CSS golang k8s Nginx Django mybatis 深度学习 多线程 React 架构 devops 爬虫 云计算 Spring Boot LeetCode