如何在C#中使用可选参数？

Question

^{注意:当C#尚未支持可选参数时(即在C#4之前),就会询问此问题.}

我们正在构建一个通过C#类以编程方式生成的Web API.该类有方法GetFooBar(int a, int b),API有一个GetFooBar接受查询参数的方法&a=foo &b=bar.

这些类需要支持可选参数,C#语言不支持这些参数.什么是最好的方法？

Answer 1

惊讶没有人提到C#4.0可选参数的工作原理如下:

public void SomeMethod(int a, int b = 0)
{
   //some code
}

编辑:我知道在问到这个问题的时候,C#4.0并不存在.但是这个问题在Google中仍然排在"C#可选参数"的第一位,所以我想 - 这个答案值得在这里.抱歉.

Answer 2

另一种选择是使用params关键字

public void DoSomething(params object[] theObjects)
{
  foreach(object o in theObjects)
  {
    // Something with the Objects…
  }
}

叫做......

DoSomething(this, that, theOther);

Answer 3

在C#中,我通常会使用多种形式的方法:

void GetFooBar(int a) { int defaultBValue;  GetFooBar(a, defaultBValue); }
void GetFooBar(int a, int b)
{
 // whatever here
}

更新: 上面提到的是我用C#2.0做默认值的方式.我现在正在使用的项目是使用C#4.0,它现在直接支持可选参数.这是我在我自己的代码中使用的一个例子:

public EDIDocument ApplyEDIEnvelop(EDIVanInfo sender, 
                                   EDIVanInfo receiver, 
                                   EDIDocumentInfo info,
                                   EDIDocumentType type 
                                     = new EDIDocumentType(EDIDocTypes.X12_814),
                                   bool Production = false)
{
   // My code is here
}

Answer 4

从这个网站:

http://www.tek-tips.com/viewthread.cfm?qid=1500861&page=1

C#允许使用[Optional]属性(来自VB,但在C#中不起作用).所以你可以有这样的方法:

using System.Runtime.InteropServices;
public void Foo(int a, int b, [Optional] int c)
{
  ...
}

在我们的API包装器中,我们检测可选参数(ParameterInfo p.IsOptional)并设置默认值.目标是将参数标记为可选参数,而不是像参数名称中的"可选"那样使用kludges.

Answer 5

你可以使用方法重载...

GetFooBar()
GetFooBar(int a)
GetFooBar(int a, int b)

这取决于方法签名,我给出的示例缺少"int b"only方法,因为它将具有与"int a"方法相同的签名.

你可以使用Nullable类型......

GetFooBar(int? a, int? b)

然后,您可以使用a.HasValue检查是否已设置参数.

另一种选择是使用'params'参数.

GetFooBar(params object[] args)

如果你想使用命名参数,则需要创建一个类型来处理它们,尽管我认为对于web应用程序已经有类似的东西了.

Answer 6

您可以在C#4.0中使用可选参数而无需担心.如果我们有一个像这样的方法:

int MyMetod(int param1, int param2, int param3=10, int param4=20){....}

当你调用方法时,你可以跳过这样的参数:

int variab = MyMethod(param3:50; param1:10);

C#4.0实现了一个名为"命名参数"的功能,您实际上可以按名称传递参数,当然您可以按照您想要的顺序传递参数:)

Answer 7

Hello Optional World

如果希望运行时提供默认参数值,则必须使用反射来进行调用.不像这个问题的其他建议那么好,但与VB.NET兼容.

using System;
using System.Runtime.InteropServices;
using System.Reflection;

namespace ConsoleApplication1
{
    class Class1
    {
        public static void sayHelloTo(
            [Optional,
            DefaultParameterValue("world")] string whom)
        {
            Console.WriteLine("Hello " + whom);
        }

        [STAThread]
        static void Main(string[] args)
        {
            MethodInfo mi = typeof(Class1).GetMethod("sayHelloTo");
            mi.Invoke(null, new Object[] { Missing.Value });
        }
    }
}

Answer 8

一种允许您在任何位置省略任何参数的简单方法是利用可空类型,如下所示:

public void PrintValues(int? a = null, int? b = null, float? c = null, string s = "")
{
    if(a.HasValue)
        Console.Write(a);
    else
        Console.Write("-");

    if(b.HasValue)
        Console.Write(b);
    else
        Console.Write("-");

    if(c.HasValue)
        Console.Write(c);
    else
        Console.Write("-");

    if(string.IsNullOrEmpty(s)) // Different check for strings
        Console.Write(s);
    else
        Console.Write("-");
}

字符串已经是可以为空的类型,因此它们不需要？.

使用此方法后,以下调用均有效:

PrintValues (1, 2, 2.2f);
PrintValues (1, c: 1.2f);
PrintValues(b:100);
PrintValues (c: 1.2f, s: "hello");
PrintValues();

当您定义一种方法时,您可以通过命名它们来自由设置所需的参数.有关命名参数和可选参数的更多信息,请参阅以下链接:

命名和可选参数(C#编程指南)@ MSDN

Answer 9

我同意斯蒂芬巴尔.但由于它是一个Web服务,最终用户只使用一种形式的web方法比使用同一方法的多个版本更容易.我认为在这种情况下,Nullable Types非常适合可选参数.

public void Foo(int a, int b, int? c)
{
  if(c.HasValue)
  {
    // do something with a,b and c
  }
  else
  {
    // do something with a and b only
  }  
}

Answer 10

可选参数用于方法.如果你需要一个类的可选参数,你是:

• 使用c#4.0:在类的构造函数中使用可选参数,这是我更喜欢的解决方案,因为它更接近于使用方法所做的事情,因此更容易记住.这是一个例子:

  class myClass
  {
      public myClass(int myInt = 1, string myString =
                             "wow, this is cool: i can have a default string")
      {
          // do something here if needed
      }
  }
  

• 使用c#4.0之前的c#版本:你应该使用构造函数链接(使用:this关键字),其中更简单的构造函数导致"主构造函数".例:

  class myClass
  {
      public myClass()
      {
      // this is the default constructor
      }
  
      public myClass(int myInt)
          : this(myInt, "whatever")
      {
          // do something here if needed
      }
      public myClass(string myString)
          : this(0, myString)
      {
          // do something here if needed
      }
      public myClass(int myInt, string myString)
      {
          // do something here if needed - this is the master constructor
      }
  }