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

How can you use optional parameters in C#?

注意:这个问题是在c_还不支持可选参数(即c_4之前)的时候提出的。

我们正在构建一个以编程方式从C类生成的Web API。类有方法GetFooBar(int a, int b),API有方法GetFooBar采用查询参数,如&a=foo &b=bar

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


令人惊讶的是,没有人提到C 4.0这样的可选参数:

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

编辑:我知道在问这个问题的时候,C 4.0并不存在。但这个问题在Google中仍然排在"可选参数"的第一位,所以我认为这个答案值得一试。对不起的。


另一个选项是使用params关键字

1
2
3
4
5
6
7
public void DoSomething(params object[] theObjects)
{
  foreach(object o in theObjects)
  {
    // Something with the Objects…
  }
}

叫…

1
DoSomething(this, that, theOther);


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

1
2
3
4
5
void GetFooBar(int a) { int defaultBValue;  GetFooBar(a, defaultBValue); }
void GetFooBar(int a, int b)
{
 // whatever here
}

更新:上面提到的是我使用C 2.0做默认值的方法。我现在正在研究的项目使用的是C 4.0,它现在直接支持可选参数。下面是我在自己的代码中使用的一个示例:

1
2
3
4
5
6
7
8
9
public EDIDocument ApplyEDIEnvelop(EDIVanInfo sender,
                                   EDIVanInfo receiver,
                                   EDIDocumentInfo info,
                                   EDIDocumentType type
                                     = new EDIDocumentType(EDIDocTypes.X12_814),
                                   bool Production = false)
{
   // My code is here
}


从这个网站:

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

c不允许使用[可选]属性(来自vb,虽然在c中不起作用)。所以你可以有这样的方法:

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

在API包装器中,我们检测可选参数(parameterInfo p.isoptional)并设置默认值。目标是将参数标记为可选,而不使用诸如在参数名称中具有"可选"这样的组合。


您可以使用方法重载…

1
2
3
GetFooBar()
GetFooBar(int a)
GetFooBar(int a, int b)

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

可以使用可以为空的类型…

1
GetFooBar(int? a, int? b)

然后,可以使用a.hasValue检查是否设置了参数。

另一个选项是使用"params"参数。

1
GetFooBar(params object[] args)

如果您想使用命名参数,则需要创建一个类型来处理这些参数,尽管我认为Web应用已经存在类似的情况。


您可以使用C 4.0中的可选参数而不必担心。如果我们有这样的方法:

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

调用该方法时,可以跳过以下参数:

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

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


你好可选世界

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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 });
        }
    }
}

一种简单的方法可以让您忽略任何位置的任何参数,它利用了可以为空的类型,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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("-");
}

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

使用此方法后,以下调用都是有效的:

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

以这种方式定义方法时,您可以自由地通过命名参数来设置所需的参数。有关命名参数和可选参数的详细信息,请参阅以下链接:

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


我同意斯蒂芬·拜耳的观点。但是,由于它是一个WebService,最终用户只使用一种形式的WebMethod比使用同一方法的多个版本更容易。我认为在这种情况下,可以为空的类型非常适合于可选参数。

1
2
3
4
5
6
7
8
9
10
11
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
  }  
}


可选参数用于方法。如果需要类的可选参数,并且您是:

  • 使用C 4.0:在类的构造函数中使用可选参数,这是我更喜欢的解决方案,因为它更接近于对方法所做的操作,因此更容易记住。下面是一个例子:

    1
    2
    3
    4
    5
    6
    7
    8
    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关键字),其中更简单的构造函数会导致"主构造函数"。例子:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    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
        }
    }

正如Stephen提到的,在C中处理这一问题的典型方法是重载方法。通过使用不同参数创建方法的多个版本,可以有效地创建可选参数。在参数较少的窗体中,通常使用在调用该方法时设置默认值的所有参数来调用该方法的窗体。


你可以超载你的方法。一种方法包含一个参数GetFooBar(int a),另一种方法包含两个参数GetFooBar(int a, int b)


为什么不从传递的querystring构造dictionary类而不是默认参数呢?与ASP.NET窗体处理查询字符串的方式几乎相同的实现。

即请求.querystring["a"]

这将使叶类与工厂/样板文件代码分离。

您还可能希望使用ASP.NET签出Web服务。Web服务是通过C类上的属性自动生成的Web API。


我有一个需要7个参数的Web服务。每个都是此Web服务包装的SQL语句的可选查询属性。所以我想到了两个解决非可选参数的方法…都很穷:

方法1(参数1、参数2、参数3、参数4、参数5、参数6、参数7)方法1(参数1、参数2、参数3、参数4、参数5、参数6)方法1(参数1、参数2、参数3、参数4、参数5、参数7)…开始看照片。这就是疯狂。组合太多了。

现在,寻找一种更简单的方法,它看起来很尴尬,但应该有效:方法1(param1、bool useparam1、param2、bool useparam2等)

这是一个方法调用,所有参数的值都是必需的,它将处理其中的每个情况。它还清楚如何在界面上使用它。

这是一个黑客,但会奏效的。


可选参数只是默认参数!我建议你给他们两个默认参数。getfoobar(in t a=0,int b=0)如果没有任何重载方法,将导致a=0,b=0如果不传递任何值,如果传递1个值,将导致a、0的传递值,如果传递2个值,则第一个值将分配给a,第二个值将分配给b。

希望能回答你的问题。


我必须在vb.net 2.0 Web服务中执行此操作。最后我将参数指定为字符串,然后将它们转换为我需要的任何参数。使用空字符串指定了可选参数。不是最干净的解决方案,但它起作用了。只是要小心捕获可能发生的所有异常。


因为为了以防万一,如果有人想将回调(或delegate)作为可选参数传递,可以这样做。

可选回调参数:

1
2
3
4
5
6
7
public static bool IsOnlyOneElement(this IList lst, Action callbackOnTrue = (Action)((null)), Action callbackOnFalse = (Action)((null)))
{
    var isOnlyOne = lst.Count == 1;
    if (isOnlyOne && callbackOnTrue != null) callbackOnTrue();
    if (!isOnlyOne && callbackOnFalse != null) callbackOnFalse();
    return isOnlyOne;
}

参加聚会有点晚了,但我一直在寻找这个问题的答案,最终找到了另一种解决办法。将Web方法的可选参数的数据类型声明为xmlnode类型。如果省略了可选的arg,则会将其设置为空;如果存在,则可以通过调用arg.value(即,

1
2
3
4
5
6
7
8
9
10
[WebMethod]
public string Foo(string arg1, XmlNode optarg2)
{
    string arg2 ="";
    if (optarg2 != null)
    {
        arg2 = optarg2.Value;
    }
    ... etc
}

这种方法的另一个优点是.NET为WS生成的主页仍然显示参数列表(尽管您确实丢失了用于测试的方便的文本输入框)。


你也可以试试这个
1型< BR>public void YourMethod(int a=0, int b = 0)
{
//some code
}

< BR>2型< BR>public void YourMethod(int? a, int? b)
{
//some code
}