注意:这个问题是在c#还不支持可选参数的时候提出的(即在c# 4之前)。
我们正在构建一个web API,它是从c#类中编程生成的。该类有方法GetFooBar(int a, int b), API有方法GetFooBar接受查询参数,如&a=foo &b=bar。
类需要支持可选参数,而c#语言不支持这一点。最好的方法是什么?
注意:这个问题是在c#还不支持可选参数的时候提出的(即在c# 4之前)。
我们正在构建一个web API,它是从c#类中编程生成的。该类有方法GetFooBar(int a, int b), API有方法GetFooBar接受查询参数,如&a=foo &b=bar。
类需要支持可选参数,而c#语言不支持这一点。最好的方法是什么?
当前回答
虽然有点晚了,但我一直在寻找这个问题的答案,并最终找到了另一种方法。将web方法的可选参数的数据类型声明为XmlNode类型。如果可选的arg被省略,它将被设置为空,如果它存在,你可以通过调用arg来获取它的字符串值。值,即
[WebMethod]
public string Foo(string arg1, XmlNode optarg2)
{
string arg2 = "";
if (optarg2 != null)
{
arg2 = optarg2.Value;
}
... etc
}
这种方法的另一个优点是。net为ws生成的主页仍然显示参数列表(尽管您确实失去了用于测试的方便文本输入框)。
其他回答
在默认值不可用的情况下,添加可选参数的方法是使用.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);
}
}
}
你可以重载你的方法。一个方法包含一个参数GetFooBar(int a),另一个包含两个参数GetFooBar(int a, int b)
你可以使用方法重载…
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应用程序。
从这个网站:
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”。
一个简单的方法可以让你省略任何位置的任何参数,就是利用可空类型,如下所示:
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