注意:这个问题是在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服务要写,需要7个参数。每个属性都是由此web服务包装的sql语句的可选查询属性。所以我想到了两个非可选参数的变通方法…都很穷:
方法1(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,等等…)
这是一个方法调用,所有参数的值都是必需的,它将处理其中的每种情况。如何从界面使用它也很清楚。
这是一个黑客,但它会起作用。
其他回答
对于大量的可选参数,可以使用ContainsKey方法使用Dictionary<string,Object>的单个参数。我喜欢这种方法,因为它允许我单独传递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;
}
}
从这个网站:
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# 4.0中使用可选参数。 如果我们有这样一个方法:
int MyMetod(int param1, int param2, int param3=10, int param4=20){....}
当你调用这个方法时,你可以像这样跳过参数:
int variab = MyMethod(param3:50; param1:10);
c# 4.0实现了一个叫做“命名参数”的特性,你实际上可以通过参数的名字来传递参数,当然你可以按照你想要的任何顺序来传递参数:)
可选世界
如果希望运行时提供默认参数值,则必须使用反射进行调用。虽然没有这个问题的其他建议那么好,但是与VB.NET兼容。
using System;
using System.Runtime.InteropServices;
using System.Reflection;
namespace ConsoleApplication1
{
public class Class1
{
public static void SayHelloTo([Optional, DefaultParameterValue("world")] string whom)
{
Console.WriteLine("Hello " + whom);
}
[STAThread]
public static void Main(string[] args)
{
MethodInfo mi = typeof(Class1).GetMethod("sayHelloTo");
mi.Invoke(null, new Object[] { Missing.Value });
}
}
}
我同意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
}
}