如何从任意字符串生成有效的Windows文件名？

Question

我有一个像“Foo：Bar”这样的字符串我想用作文件名，但在Windows上，文件名中不允许使用“：”字符。

有没有一种方法可以将“Foo：Bar”变成像“Foo-Bar”这样的东西？

Answer 1

尝试这样的事情：

string fileName = "something";
foreach (char c in System.IO.Path.GetInvalidFileNameChars())
{
   fileName = fileName.Replace(c, '_');
}

修改

由于GetInvalidFileNameChars()将返回10或15个字符，因此最好使用StringBuilder而不是简单的字符串;原始版本需要更长时间并消耗更多内存。

Answer 2

fileName = fileName.Replace(":", "-") 

然而，“：”不是Windows的唯一非法字符。您还必须处理：

/, \, :, *, ?, ", <, > and |

这些包含在System.IO.Path.GetInvalidFileNameChars（）;

中

另外（在Windows上），“。”不能是文件名中唯一的字符（“。”，“..”，“...”等都无效）。使用“。”命名文件时要小心，例如：

echo "test" > .test.

将生成名为“.test”的文件

最后，如果你真的想要正确地做事，那么你需要注意一些special file names。 在Windows上，您无法创建名为的文件：

CON, PRN, AUX, CLOCK$, NUL
COM0, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9
LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and LPT9.

Answer 3

效率不高，但更有趣：）

    var fileName = "foo:bar";
    var invalidChars = System.IO.Path.GetInvalidFileNameChars();
    var cleanFileName = new string(fileName.Where(m => !invalidChars.Contains(m)).ToArray<char>());

Answer 4

如果有人想要基于StringBuilder的优化版本，请使用此功能。包括rkagerer的诀窍作为选项。

static char[] _invalids;

/// <summary>Replaces characters in <c>text</c> that are not allowed in 
/// file names with the specified replacement character.</summary>
/// <param name="text">Text to make into a valid filename. The same string is returned if it is valid already.</param>
/// <param name="replacement">Replacement character, or null to simply remove bad characters.</param>
/// <param name="fancy">Whether to replace quotes and slashes with the non-ASCII characters ” and ⁄.</param>
/// <returns>A string that can be used as a filename. If the output string would otherwise be empty, returns "_".</returns>
public static string MakeValidFileName(string text, char? replacement = '_', bool fancy = true)
{
    StringBuilder sb = new StringBuilder(text.Length);
    var invalids = _invalids ?? (_invalids = Path.GetInvalidFileNameChars());
    bool changed = false;
    for (int i = 0; i < text.Length; i++) {
        char c = text[i];
        if (invalids.Contains(c)) {
            changed = true;
            var repl = replacement ?? '\0';
            if (fancy) {
                if (c == '"')       repl = '”'; // U+201D right double quotation mark
                else if (c == '\'') repl = '’'; // U+2019 right single quotation mark
                else if (c == '/')  repl = '⁄'; // U+2044 fraction slash
            }
            if (repl != '\0')
                sb.Append(repl);
        } else
            sb.Append(c);
    }
    if (sb.Length == 0)
        return "_";
    return changed ? sb.ToString() : text;
}

Answer 5

迭戈确实有正确的解决方案，但那里有一个非常小的错误。使用的string.Replace的版本应该是string.Replace（char，char），没有string.Replace（char，string）

我无法编辑答案，或者我只是做了一些小改动。

所以它应该是：

string fileName = "something";
foreach (char c in System.IO.Path.GetInvalidFileNameChars())
{
   fileName = fileName.Replace(c, '_');
}

Answer 6

这是迭戈的回答。

如果你不害怕Unicode，你可以通过用类似它们的有效Unicode符号替换无效字符来保持更高的保真度。这是我最近涉及木材切割清单的项目中使用的代码：

static string MakeValidFilename(string text) {
  text = text.Replace('\'', '’'); // U+2019 right single quotation mark
  text = text.Replace('"',  '”'); // U+201D right double quotation mark
  text = text.Replace('/', '⁄');  // U+2044 fraction slash
  foreach (char c in System.IO.Path.GetInvalidFileNameChars()) {
    text = text.Replace(c, '_');
  }
  return text;
}

这会生成1⁄2” spruce.txt而不是1_2_ spruce.txt

等文件名

是的，它确实有效：

警告Emptor

我知道这个技巧可以在NTFS上运行，但很惊讶它发现它也适用于FAT和FAT32分区。这是因为long filenames是stored in Unicode，甚至as far back是Windows 95 / NT。我在Win7，XP甚至基于Linux的路由器上进行了测试，他们出现了。不能在DOSBox中说同样的内容。

那就是说，在你坚持下去之前，先考虑一下你是否真的需要额外的保真度。 Unicode外观可能会混淆人们或旧程序，例如旧操作系统依赖codepages。

Answer 7

以下是使用string fileName = "something"; Path.GetInvalidFileNameChars() .Aggregate(fileName, (current, c) => current.Replace(c, '_')); jquery的已接受答案的一个版本：

javascript

Answer 8

这是一个使用StringBuilder和IndexOfAny并使用批量追加以获得完全效率的版本。它还返回原始字符串，而不是创建重复的字符串。

最后但并非最不重要的是，它有一个switch语句，可以返回相似的字符，您可以按照自己的方式进行自定义。查看Unicode.org's confusables lookup以查看您可能拥有的选项，具体取决于字体。

public static string GetSafeFilename(string arbitraryString)
{
    var invalidChars = System.IO.Path.GetInvalidFileNameChars();
    var replaceIndex = arbitraryString.IndexOfAny(invalidChars, 0);
    if (replaceIndex == -1) return arbitraryString;

    var r = new StringBuilder();
    var i = 0;

    do
    {
        r.Append(arbitraryString, i, replaceIndex - i);

        switch (arbitraryString[replaceIndex])
        {
            case '"':
                r.Append("''");
                break;
            case '<':
                r.Append('\u02c2'); // '˂' (modifier letter left arrowhead)
                break;
            case '>':
                r.Append('\u02c3'); // '˃' (modifier letter right arrowhead)
                break;
            case '|':
                r.Append('\u2223'); // '∣' (divides)
                break;
            case ':':
                r.Append('-');
                break;
            case '*':
                r.Append('\u2217'); // '∗' (asterisk operator)
                break;
            case '\\':
            case '/':
                r.Append('\u2044'); // '⁄' (fraction slash)
                break;
            case '\0':
            case '\f':
            case '?':
                break;
            case '\t':
            case '\n':
            case '\r':
            case '\v':
                r.Append(' ');
                break;
            default:
                r.Append('_');
                break;
        }

        i = replaceIndex + 1;
        replaceIndex = arbitraryString.IndexOfAny(invalidChars, i);
    } while (replaceIndex != -1);

    r.Append(arbitraryString, i, arbitraryString.Length - i);

    return r.ToString();
}

它不会检查.，..或保留名称，例如CON，因为它不清楚替换应该是什么。

Answer 9

另一个简单的解决方案：

private string MakeValidFileName(string original, char replacementChar = '_')
{
  var invalidChars = new HashSet<char>(Path.GetInvalidFileNameChars());
  return new string(original.Select(c => invalidChars.Contains(c) ? replacementChar : c).ToArray());
}

Answer 10

一个简单的单行代码：

var validFileName = Path.GetInvalidFileNameChars().Aggregate(fileName, (f, c) => f.Replace(c, '_'));

如果要重复使用，可以将其包装为扩展方法。

public static string ToValidFileName(this string fileName) => Path.GetInvalidFileNameChars().Aggregate(fileName, (f, c) => f.Replace(c, '_'));

Answer 11

清理一点我的代码并进行一些重构......我为字符串类型创建了一个扩展名：

public static string ToValidFileName(this string s, char replaceChar = '_', char[] includeChars = null)
{
  var invalid = Path.GetInvalidFileNameChars();
  if (includeChars != null) invalid = invalid.Union(includeChars).ToArray();
  return string.Join(string.Empty, s.ToCharArray().Select(o => o.In(invalid) ? replaceChar : o));
}

现在使用起来更容易：

var name = "Any string you want using ? / \ or even +.zip";
var validFileName = name.ToValidFileName();

如果要使用与“_”不同的字符替换，可以使用：

var validFileName = name.ToValidFileName(replaceChar:'#');

你可以添加字符替换..例如你不想要空格或逗号：

var validFileName = name.ToValidFileName(includeChars: new [] { ' ', ',' });

希望它有所帮助...

干杯

Answer 12

我今天需要这样做...在我的情况下，我需要将客户名称与最终.kmz文件的日期和时间连接起来。我的最终解决方案是：

 string name = "Whatever name with valid/invalid chars";
 char[] invalid = System.IO.Path.GetInvalidFileNameChars();
 string validFileName = string.Join(string.Empty,
                            string.Format("{0}.{1:G}.kmz", name, DateTime.Now)
                            .ToCharArray().Select(o => o.In(invalid) ? '_' : o));

如果将空格字符添加到无效数组中，甚至可以替换空格。

也许这不是最快的，但由于性能不是问题，我发现它优雅且易于理解。

干杯！

Answer 13

我需要一个不会产生冲突的系统，因此我无法将多个字符映射到一个字符。我结束了：

public static class Extension
{
    /// <summary>
    /// Characters allowed in a file name. Note that curly braces don't show up here
    /// becausee they are used for escaping invalid characters.
    /// </summary>
    private static readonly HashSet<char> CleanFileNameChars = new HashSet<char>
    {
        ' ', '!', '#', '$', '%', '&', '\'', '(', ')', '+', ',', '-', '.',
        '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '=', '@',
        'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
        'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
        '[', ']', '^', '_', '`',
        'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
        'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
    };

    /// <summary>
    /// Creates a clean file name from one that may contain invalid characters in 
    /// a way that will not collide.
    /// </summary>
    /// <param name="dirtyFileName">
    /// The file name that may contain invalid filename characters.
    /// </param>
    /// <returns>
    /// A file name that does not contain invalid filename characters.
    /// </returns>
    /// <remarks>
    /// <para>
    /// Escapes invalid characters by converting their ASCII values to hexadecimal
    /// and wrapping that value in curly braces. Curly braces are escaped by doubling
    /// them, for example '{' => "{{".
    /// </para>
    /// <para>
    /// Note that although NTFS allows unicode characters in file names, this
    /// method does not.
    /// </para>
    /// </remarks>
    public static string CleanFileName(this string dirtyFileName)
    {
        string EscapeHexString(char c) =>
            "{" + (c > 255 ? $"{(uint)c:X4}" : $"{(uint)c:X2}") + "}";

        return string.Join(string.Empty,
                           dirtyFileName.Select(
                               c =>
                                   c == '{' ? "{{" :
                                   c == '}' ? "}}" :
                                   CleanFileNameChars.Contains(c) ? $"{c}" :
                                   EscapeHexString(c)));
    }
}

Answer 14

您可以使用sed命令执行此操作：

 sed -e "
 s/[?()\[\]=+<>:;©®”,*|]/_/g
 s/"$'\t'"/ /g
 s/–/-/g
 s/\"/_/g
 s/[[:cntrl:]]/_/g"