扩展方法及常见错误

扩展方法简介：
这个世界上总是存在着很多奇妙的东西。然而，在这部分所介绍的扩展方法就是其中之一。从字面上看可能读者很难猜透“扩展方法”是什么意思。然而，看了下面的例子，就会感觉到非常的奇妙。

namespace ExtMethod
{
    public class Class1
    {
       public String s = "bill";
    }
    public class Class2 : Class1
   {
   }
   public static class AnyClassName
   {
       public static String getName(this Class1 class1)
       {
         return class1.s + class1.s;  
       }
   }

   public partial class Form1 : Form
   {
      
       private void button1_Click(object sender, EventArgs e)
       {
         Class1 c = new Class1();
         MessageBox.Show(c.getName());          
         Class2 c = new Class2();
         MessageBox.Show(c.getName());          
       }
   }
}

看到上面的代码，也许很多人会感到奇怪，在Class1和Class2中并没有getName方法，怎么在调用时出来个getName方法呢？实际上，这就是扩展方法的用法，从本质上说，扩展方法就是将静态方法（必须声明成static）插入到某个类和其子类中（也就是说，在这些类中可以使用在外部定义的静态方法）。那么要往哪个类中插入呢？这就要在定义静态方法时指定了。大家可以看看getName方法的第一个参数，使用了this关键字，这就表明这个方法是一个扩展方法，后面的类型就是要插入该方法的类，在本例中是Class1，也就是说在Class1及其子类中都可以使用getName方法。上面的调用代码也相当于下面的代码：

Class2 c = new Class2();
MessageBox.Show(AnyClassName.getName(c));

但使用c.getName可能会更好一些，而且也降低了对静态方法所在的类(AnyClassName)的依赖性。

在使用扩展方法时应注意以下几点：

1.   扩展方法所在的类名可以是任意合法的类名。

2.   扩展方法所在的类必须和使用扩展方法的代码在同一个命名空间里，否则无法编译通过。

3.   在本例中，Class1和Class2只能声明成public，因为AnyClassName被声明为public。如果AnyClassName不加修饰符，Class1和Class2也可以不加修饰符，当然，也可以被声明为public。也就是说，Class1和Class2必须有比AnyClassName具有更强的访问性。如下面代码所示：

class Class1
{
       public String s = "bill";
}
class Class2 : Class1
{
}
static class AnyClassName   // 这时如果前面加public是无法编译通过的。
{
       public static String getName(this Class1 class1)
       {
         return class1.s + class1.s;  
       }
}

4. 如果在Class1或Class2中已经有getName方法了，那么Class1或Class2中的getName优先级更高。也就是说，扩展方法是无法覆盖原类中的同名（参数名和类型也相同）的方法的。

扩展方法尤其在很多类需要同样的方法，而这些类又无法继承其它类时特别有用。当然，在要对某个类进行扩展，但我们并没有源代码时，扩展方法也可以派上用场。


常见错误：
错误 1 扩展方法必须在非泛型静态类中定义 
解决：类要定义为静态类。    public static class ExtDropdownlist

错误 2 扩展方法必须是静态的
解决：public static void AddItem(this DropDownList list, string item)

错误 3 无法定义新的扩展方法，因为找不到编译器所需的类型“System.Runtime.CompilerServices.ExtensionAttribute”。是否缺少对 System.Core.dll 的引用? 
解决：需要.netframework3.5的版本支持。

以下为调试通过的扩展类：

using System.Web.UI.WebControls;
namespace TestExt.Ext
{
    public static class ExtDropdownlist
    {
        public static void AddItem(this DropDownList list, string item)
        {
            list.Items.Add(new ListItem(item, list.Items.Count.ToString()));
        }
    }
}

以下为调用页面：

using System;
using TestExt.Ext;
namespace TestExt
{
    public partial class _Default : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            DropDownList1.AddItem("item");
        }
    }
}

生成html页面内容如下：

<select name="DropDownList1" id="DropDownList1">
<option value="0">item</option>
</select>