最近整理了一下公司规范,其中“函数的参数个数不宜超过4个”这一条在推广的时候有些争议,在能完成任务的情况下参数越少肯定越好,这本身没什么可争议的,但这样做可能会在编程时带来困难,争议点在是否值得这样做。我觉得为了让使用函数者更简单这样做还是值得,至于编程时的困难往往是因为我们不熟悉一些减少参数的方法,这里总结几条供大家参考:
1、使用结构来封装参数
例子:添加用户
原函数体:AddUser(string userName,string password,string address,string phone,int age)
重构:添加一个User类:
class User
{
public string UserName { get; set; }
public string Password { get; set; }
public string Address { get; set; }
public string Phone { get; set; }
public int Age { get; set; }
}
将AddUser改为:AddUser(User user)
存在的问题:如果添加的这个类没有其他地方用,常常会觉得这样做并不值得,这时我们可以考虑使用匿名类封装参数的方法。
2、使用属性来替换参数
如果将1中的AddUser方法置于User类中,那么AddUser方法中的user参数都可以省掉了,有的时候可能为了减少某些方法的参数个数而添加某些属性。面向对象设计中,对象应该自己负责自己,而且应该清楚定义责任。某个方法参数太多的原因可能是这个方法写在了他不该存在的地方,GRASP原则中讲的“信息专家”模式很多情况下可以减少参数的个数。
例子:帐户转账
原函数:Transfer(Account from,Account to,decimal money)
重构:
代码
public class TransferProcess
{
private Account From;
private Account To;
public TransferProcess(Account from, Account to)
{
this.From = from;
this.To = to;
}
public void Transfer(decimal money)
{
if (money<From.Money)
{
From.Money = From.Money - money;
To.Money = To.Money + money;
//更新数据库
}
else
{
throw new Exception("超出余额");
}
}
}
注:信息专家模式是面向对象设计的最基本原则,我们设计对象(类)的时候,如果某个类拥有完成某个职责所需要的所有信息,那么这个职责就应该分配给这个类来实现。这时,这个类就是相对于这个职责的信息专家。
3、使用私有函数
调用某个函数时往往并不需要很多的交互参数,但我们提供参数时则需要提供所有的情况,这时我们可以把函数分类,将最复杂的函数封装成私有的,而暴露出来的简单函数调用这些复杂函数完成功能。我们来看看mvc中的TextBox方法的实现方式:
代码
public static string TextBox(this HtmlHelper htmlHelper, string name, object value, IDictionary<string, object> htmlAttributes) {
return InputHelper(htmlHelper, InputType.Text, name, value, (value == null) /* useViewData */, false /* isChecked */, true /* setId */, true /* isExplicitValue */, htmlAttributes);
}
private static string InputHelper(this HtmlHelper htmlHelper, InputType inputType, string name, object value, bool useViewData, bool isChecked, bool setId, bool isExplicitValue, IDictionary<string, object> htmlAttributes) {
if (String.IsNullOrEmpty(name)) {
throw new ArgumentException(MvcResources.Common_NullOrEmpty, "name");
}
TagBuilder tagBuilder = new TagBuilder("input");
... ...
但有时我们为了给调用者最大的灵活性,可能也会把最复杂的那个函数重载暴露出来。
4、params 关键字
指定在参数数目可变处,采用参数的方法参数。
用法:
代码
static void Main(string[] args)
{
UseParams(1, 2, 3);
}
public static void UseParams(params int[] list)
{
for (int i = 0; i < list.Length; i++)
{
Console.WriteLine(list[i]);
}
Console.WriteLine();
}
这种方法实际上并没有减少参数的个数,只是简化了函数体。
5、使用匿名类封装参数
准备知识:我们先来看看RouteValueDictionary
代码
static void Main(string[] args)
{
RouteValueDictionary r = new RouteValueDictionary(new { id=1,name="lfm"});
foreach (var item in r)
{
Console.WriteLine("{0}:{1}", item.Key, item.Value);
}
//Console.WriteLine();
}
结果:
id:1
name:lfm
RouteValueDictionary可以将实例的属性名及属性值存入到字典中。
mvc中很多地方使用这种方式传递参数。
比如: <%= Html.ActionLink("Details", "Details", new { id=item.id })%>
ActionLink方法体中就是使用RouteValueDictionary将匿名对象进行了分解,然后将其拼装到链接上。