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

这个问题是在c#还不支持可选参数的时候提出的(即在c# 4之前)。

我们正在构建一个web API,它是从c#类中编程生成的。这个类有一个方法GetFooBar(int a, int b), API有一个方法GetFooBar,它接受像&a=foo &b=bar这样的查询参数。

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

791999 次浏览

从这个网站:

https://www.tek-tips.com/viewthread.cfm?qid=1500861

c#确实允许使用[Optional]属性(来自VB,但在c#中没有功能)。你可以有一个这样的方法:

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

在我们的API包装器中,我们检测可选参数(ParameterInfo p.s isoptional)并设置默认值。我们的目标是将参数标记为可选的,而不是使用诸如“;optional"参数名称。

在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
}

你可以使用方法重载…

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

这取决于方法的签名,我给出的例子缺少“int b”方法,因为它将具有与“int a”方法相同的签名。

你可以使用Nullable类型…

GetFooBar(int? a, int? b)

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

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

GetFooBar(params object[] args)

如果你想要使用命名参数,就需要创建一个类型来处理它们,尽管我认为已经有一些这样的web应用程序。

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

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

叫喜欢……

DoSomething(this, that, theOther);

正如stephen提到的,在c#中处理这个问题的典型方法是重载方法。通过创建具有不同参数的方法的多个版本,可以有效地创建可选参数。在具有较少参数的表单中,您通常会调用方法的表单,在调用该方法时使用所有参数设置默认值。

而不是默认参数,为什么不直接从传入的querystring构造一个字典类..一个几乎与asp.net表单处理查询字符串的方式相同的实现。

即请求。查询字符串(“a”)

这将使叶子类与工厂/样板代码解耦。


您可能还想查看Web服务与ASP。网。Web服务是通过c#类的属性自动生成的Web api。

我同意stephenbayer的观点。但由于它是一个webservice,对于最终用户来说,只使用一种形式的webmethod要比使用相同方法的多个版本更容易。我认为在这种情况下,可空类型是可选参数的完美选择。

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
}
}

可选世界

如果希望运行时提供默认参数值,则必须使用反射进行调用。虽然没有这个问题的其他建议那么好,但是与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 });
}
}
}

虽然有点晚了,但我一直在寻找这个问题的答案,并最终找到了另一种方法。将web方法的可选参数的数据类型声明为XmlNode类型。如果可选的arg被省略,它将被设置为空,如果它存在,你可以通过调用arg来获取它的字符串值。值,即

[WebMethod]
public string Foo(string arg1, XmlNode optarg2)
{
string arg2 = "";
if (optarg2 != null)
{
arg2 = optarg2.Value;
}
... etc
}

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

我有一个web服务要写,需要7个参数。每个属性都是由此web服务包装的sql语句的可选查询属性。所以我想到了两个非可选参数的变通方法…都很穷:

method1(param1, param2, param 3, param 4, param 5, param 6, param7) 方法1(param1, param2, param3, param4, param5, param 6) 方法1(param1, param2, param3, param4, param5, param7)…开始看图片。这就是疯狂。太多的组合

现在有一个看起来很尴尬但应该有效的更简单的方法: method1(param1, bool useParam1, param2, bool useParam2,等等…)

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

这是一个黑客,但它会起作用。

令人惊讶的是没有人提到c# 4.0的可选参数是这样工作的:

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

我知道在问这个问题的时候,c# 4.0还不存在。但是这个问题仍然在谷歌的“c#可选参数”中排名第一,所以我认为-这个答案值得在这里。对不起。

我必须在VB中完成。Net 2.0 Web服务。我最终将参数指定为字符串,然后将它们转换为我需要的任何参数。使用空字符串指定了可选参数。虽然不是最干净的方法,但很有效。只是要注意捕获所有可能发生的异常。

你可以在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实现了一个叫做“命名参数”的特性,你实际上可以通过参数的名字来传递参数,当然你可以按照你想要的任何顺序来传递参数:)

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

  • 使用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
    }
    }
    
  • using c# versions previous to c#4.0: you should use constructor chaining (using the :this keyword), where simpler constructors lead to a "master constructor". example:

    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
    }
    }
    

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

一个简单的方法可以让你在任何位置中省略任何参数,就是利用可空类型:

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

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

可选回调参数:

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;
}

你也可以试试这个
1型
YourMethod(int a=0, int b =0) { / /一些代码 代码}< / > < / p > < p >
类型2
public void YourMethod(int?一个,int ?b) { / /一些代码 } < /代码> < / p >

可选参数只是默认参数! 我建议给它们都设置默认参数。 GetFooBar(int a=0, int b=0)如果你没有任何重载方法,将导致a=0,如果你不传递任何值,b=0,如果你传递1个值,将导致,传递值a, 0,如果你传递2个值,第一个将被分配给a,第二个分配给b。

希望这回答了你的问题。

使用重载或使用c# 4.0或更高版本

 private void GetVal(string sName, int sRoll)
{
if (sRoll > 0)
{
// do some work
}
}


private void GetVal(string sName)
{
GetVal("testing", 0);
}

在默认值不可用的情况下,添加可选参数的方法是使用.NET OptionalAttribute类https://learn.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.optionalattribute?view=netframework-4.8

代码示例如下:

namespace OptionalParameterWithOptionalAttribute
{
class Program
{
static void Main(string[] args)
{
//Calling the helper method Hello only with required parameters
Hello("Vardenis", "Pavardenis");
//Calling the helper method Hello with required and optional parameters
Hello("Vardenis", "Pavardenis", "Palanga");
}
public static void Hello(string firstName, string secondName,
[System.Runtime.InteropServices.OptionalAttribute] string  fromCity)
{
string result = firstName + " " + secondName;
if (fromCity != null)
{
result += " from " + fromCity;
}
Console.WriteLine("Hello " + result);
}


}
}

对于大量的可选参数,Dictionary<string,Object>的单个参数可以与ContainsKey方法一起使用。我喜欢这种方法,因为它允许我单独传递一个List<T>T,而不必创建一个完整的其他方法(例如,如果参数被用作过滤器就很好)。

示例(如果不需要可选参数,则传递new Dictionary<string,Object>()):

public bool Method(string ParamA, Dictionary<string,Object> AddlParams) {
if(ParamA == "Alpha" && (AddlParams.ContainsKey("foo") || AddlParams.ContainsKey("bar"))) {
return true;
} else {
return false;
}
}

您可以使用default。

public void OptionalParameters(int requerid, int optinal = default){}