类设计：允许类既用作对象又提供公共静态方法

Question

我有一个愚蠢的小类“FileSystemSize”，它既可以用作对象，也可以通过公共静态方法使用。每种情况下的输出相似，但并不相同。

该类最初是静态的，但我添加了将其初始化为对象的可能性，以便允许在未来版本中使用新的“便捷方法”进行扩展，而不需要太多的参数解析。例如，我有 GetKBString()、GetMBString() 等...方法可以按照我想要的方式方便地格式化文件大小（作为字符串）。该类在内部将文件字节大小存储为双精度。

我有点困惑这是否有道理。看来我应该将其分为静态版本和对象版本，就像 Microsoft 对 Directory 和 DirectoryInfo 所做的那样。然而，对我来说，将所有这些都放在一个地方并使用一个不会弄错的名称似乎更容易 - 应该清楚 FileSystemSize 的作用是什么？是否有任何我未预料到的维护影响？那是什么味道？

var mypath = @"C:\mypath";

var filesystemsize = new FileSystemSize(mypath);
string kilobytes = filesystemsize.GetKBString();
string megabytes = filesystemsize.GetMBString();
double bytes = filesystemsize.ByteSize;

double staticbytes = FileSystemSize.GetDirectoryBytesSize(new DirectoryInfo(mypath));
double statickilobytes = FileSystemSize.ConvertSize(staticbytes, "KB");

Answer 1

从另一个角度来看：为什么要将 String/Number/UI 格式化方法放入 FileSystemSize 方法中？

虽然它可以用于文件，但这是一项通用功能，恕我直言，应该在组织良好的库中的其他地方找到它 - 就像路径函数不是 .net 中的文件或目录类的一部分一样，我将把字符串或数学实用程序类中的“格式化数字”方法。

将对象的职责分开，您可能会发现在这种情况下不需要混合静态和非静态成员。

Answer 2

一个很好的测试：如果您问自己和我们是否可以，那么很可能不行。

对于类的用户来说，通过类访问某些方法而通过对象访问其他方法可能并不自然，特别是当第二个方法实际上并不需要类的实例属性时。他们很可能会感到困惑，并会说：“WTF 这个程序员这么做了？！”。

如果您喜欢使用扩展方法或通过子类化来扩展类的可能性，我建议使用所有实例方法。

Answer 3

由于 FileSystemSize 中没有太多状态，这不是扩展方法的完美候选者吗？

我个人会提供扩展来将数字格式化为文件大小字符串，并使用 enum 来指定如何格式化文件大小：

public static class FileSystemSize
{
    public static long GetDirectoryBytesSize(string path);
}

public static class NumberExtensions
{
    public static string FormatAsFileSize(
        this long fileSize, FileSizeStringFormat format);
}

public enum FileSizeStringFormat
{
    KiloByte,
    MegaByte,
}

Answer 4

如果您使用 C# 3.0，则使用扩展方法和 IFormatProvider 可能会更好地表达您的意图。在代码中，这可能是 FileInfo 和 DirectoryInfo ToString 方法的扩展方法，因此它们会读取如下内容：

var directorySize = myDirectory.ToString("GB");
var fileSize = myFile.ToString("MB");

对于您尝试执行的操作，上面的代码感觉更自然。

看看以下内容如何为您服务。其中一些需要进行测试（我想到了递归方法 DirectoryInfoExtender.GetDirectorySize）。如果您需要能够编写诸如 Console.WriteLine("{0:GB}", fileInfo) 之类的语句，您也可以考虑编写 IFormatProvider。

另请注意，我故意省略了这些可公开访问的方法的空检查和异常处理。

public static class DirectoryInfoExtender
{
    public static string ToString(this DirectoryInfo d, string format, int fractionalDigits)
    {
        double fileSize = GetDirectorySize(d);
        return FileSizeConverter.GetFileSizeString(fileSize, format, fractionalDigits);
    }

    public static double GetDirectorySize(DirectoryInfo d)
    {    
        var files = d.GetFiles();
        var directories = d.GetDirectories();

        if(files.Length == 0 && directories.Length == 0)
        {
            return 0;
        }
        else
        {
            double size = 0;

            foreach(var file in files)
            {
                size += file.Length;
            }

            foreach(var directory in directories)
            {
                size += GetDirectorySize(directory);
            }
        }

        return size;
    }
}


public static class FileInfoExtender
{
    public static string ToString(this FileInfo f, string format, int fractionalDigits)
    {
        return FileSizeConverter.GetFileSizeString(f.Length, format, fractionalDigits);
    }
}

public class FileSizeConverter
{
    public static string GetFileSizeString(double fileSize, string format, int fractionalDigits)
    {
        long divisor;
        string sizeIndicator;

        switch(format.ToLower().Trim())
        {
            case "gb":
                divisor = (long)Math.Pow(2, 30);
                sizeIndicator = "gigabytes";
                break;
            case "mb":
                divisor = (long) Math.Pow(2, 20);
                sizeIndicator = "megabytes";
                break;
            case "kb":
                divisor = (long)Math.Pow(2, 10);
                sizeIndicator = "kilobytes";
                break;
            default:
                divisor = 1;
                sizeIndicator = "bytes";
                break;
        }

        return String.Format("{0:N" + fractionalDigits +"} {1}", fileSize / divisor, sizeIndicator);
    }
}

Answer 5

标准气味是静态方法的使用 - 如果您在代码中使用这些方法，这使得维护变得困难。

恕我直言，另一个味道是：类名不清楚它实际的作用。根据您的描述，它旨在格式化数据，在这种情况下，我会在类名称中提及它。