正确的方法来限制可能的字符串参数值并在intellisense中查看它们

时间:2013-12-05 18:05:12

标签: c# asp.net function methods arguments

环境:Visual Studio 2012,.NET 4 Framework,ASP.NET Web应用程序(C#)

我想知道最好的,最可行的方法来完成将传入的参数(任何类型... int,string等等)限制为预定义的一组所需值。我想知道业界公认的最佳方式。

(以下代码不起作用 - 只是为了更好地说明问题)
假设我有一个这样的实用程序类:

public class Utilities
{
    public string ConvertFromBytes(int intNumBytes, string strOutputUnit)
    {
        //determine the desired output
        switch(strOutputUnit.ToUpper())
        {
            case "KB":
                //Kilobytes - do something
                break;
            case "MB":
                //Megabytes - do something
                break;
            case "GB":
                //Gigabytes - do something
                break;
        }
        //Finish converting and return file size string in desired format...
    }
}

然后,在我的一个页面中,我有类似的东西:

Utilities ut = new Utilities();
strConvertedFilesize = ut.ConvertFromBytes(1024,

我想知道的是,在上面的代码行中,对我来说最好的方法是使“KB”,“MB”或“GB”是唯一可能的字符串值可以为“strOutputUnit”参数输入? (和)最好用智能感知显示可能的可用选项?


更新:JaredPar我正在使用您的建议,并提出了以下重写代码:

public class Utilities
{
        public enum OutputUnit { 
                          KB,
                          MB,
                          GB
                        }

        public string ConvertFromBytes(int intNumBytes, OutputUnit ou)
        {
            //determine the desired output
            switch (ou)
            {
                case OutputUnit.KB:
                    //Kilobytes - do something
                    break;
                case OutputUnit.MB:
                    //Megabytes - do something
                    break;
                case OutputUnit.GB:
                    //Gigabytes - do something
                    break;
                default:
                    //do something crazy
                    break;
            }
            //Finish converting and return file size string in desired format...
            return "";
        }
}

并称之为:

Utilities ut = new Utilities();
string strConvertedFilesize = ut.ConvertFromBytes(1024, Utilities.OutputUnit.MB);

以上方法是使用枚举作为参数的最有效方法吗?在上面的行中,必须输入“Utilities.OutputUnit”。我的方法调用中的一部分感觉有点笨拙...当然我总是可以分配较短的名字,但有没有什么方法可以更好地简化上述内容?

BTW谢谢大家的答案。 JaredPar我会选择你的,因为它是正确的,并且排在第一位。其他答案非常信息丰富且有用,但感谢所有人。

5 个答案:

答案 0 :(得分:10)

在这种情况下,您应该使用String而不是enum

enum OutputUnit { 
  KB,
  MB,
  GB
}

这将使开发人员更明确地选择输入参数。当然,这不是一个简单的操作,因为开发人员总是可以通过直接从enum

转换来创建无效的int
OutputUnit u = (OutputUnit)10000;

答案 1 :(得分:4)

除了在特定情况下使用enum之外,您还可以从更一般的说明中看一下(绝不是包容性的 - 这有多种方法):

以下是Jon Skeet关于代码合同的文章:http://www.infoq.com/articles/code-contracts-csharp

按合同设计的文本 - 可以说是关于O-O设计的最佳整本书 - 是Bertrand MeyerObject-Oriented Software Construction, 2nd ed.。 Eiffel语言的核心是契约式设计:Eiffel/Eiffel Studio是一个完整的Eiffel IDE,可以生成符合CLR的程序集。

答案 2 :(得分:2)

这正是枚举的用途:

public enum SizeUnit { KB, MB, GB }

答案 3 :(得分:1)

Enum,正如其他几个人所建议的那样,是迄今为止最常见和最公认的实现目标的方法。

您可以看到另一种不常见的方法,但功能非常强大:

Code Contracts

代码契约提供了与许多单元测试类似的结构。他们擅长的地方是他们在Visual Studio中也有一些IDE支持,以帮助调用您的方法的人知道预期值(合同)是什么。当允许值的潜在范围非常大时,代码契约很有用,因此枚举会很麻烦。缺点是代码合同尚未得到普遍支持或认可。

答案 4 :(得分:0)

我建议你不要使用枚举,主要是因为你的switch语句有一个“做某事”的部分,这使得你似乎想要多态。这可能有点矫枉过正,但你应该考虑权衡,至少。

你会在.Net框架中找到很多枚举类的例子。我给出的例子是Unit类型(从技术上讲它是一个结构,但仍适用于该点)。它使用静态成员枚举{Point,Pixel,Percentage}。它还实现了一些方法,因此您可以使用多态而不是switch语句。它还实现了一个Parse方法,该方法可以用作工厂从字符串中获取所需的对象。