C#中的扩展方法详解

更新时间：2014年09月04日 09:18:39 投稿：hebedich

“扩展方法使您能够向现有类型“添加”方法，而无需创建新的派生类型、重新编译或以其他方式修改原始类型。”这是msdn上说的，也就是你可以对String,Int,DataRow,DataTable等这些类型的基础上增加一个或多个方法，使用时不需要去修改或编译类型本身的代码。

扩展方法使你能够向现有类型“添加”方法，而无需创建新的派生类型、重新编译或以其他方式修改原始类型。扩展方法是一种特殊的静态方法，但可以像扩展类型上的实例方法一样进行调用。以上是msdn官网对扩展方法的描述，现在我通过一个情景例子来对此进行阐释。假设一个控制台程序class Program{}里面的主函数如下：

static void Main(string[] args)
    {
      DateTime now = DateTime.Now;
      string time = now.ToString("yyyy-mm-dd hh:mm:ss"); 
      Console.WriteLine(time);
      Console.ReadKey();
    }

假设需求变了，日期的显示格式要变成"yyyy-mm-dd"这种格式，当然只需要初始化time时按下面写法改写即可：

string time = now.ToString("yyyy-mm-dd");
但是如果要改变日期格式的有很多个类呢？每个都要改一次吗？这样一旦需求变来变去就忙死人了。传统的解决方式是封装一个帮助类，在里面写方法，然后供其他类调用。

本例在当前项目模仿添加一个DateHelper类:public class DateHelper{}，在类里面定义方法：

public static string DateToString(DateTime dt)
    {
      return dt.ToString("yyyy-mm-dd hh:mm:ss");
    }

于是原来的主函数改写如下：

static void Main(string[] args)
    {
      DateTime now = DateTime.Now;
      string time = DateHelper.DateToString(now);
      Console.WriteLine(time);
      Console.ReadKey();
    }

此时如果变需求，只需要改写DateHelp类里的DateToString()方法就行了，不管有多少个类调用此方法，都会被影响。问题解决了，可是这样要调用另一个类的方法，还是有点麻烦，有没有什么方法能够让我们像now.DateToString()一样直接调用呢？当然DateTime是微软写好的，我们改不了，无法创建想要的实例方法，于是，便引出了扩展方法。
下面是扩展方法的要素：

1.此方法必须是一个静态方法

2.此方法必须放在静态类中

3.此方法的第一个参数必须以this开头，并且指定此方法是扩展自哪个类型

根据以上要素，我们DateHelper类改成静态类：public static class DateHelper{} ，同时改写DateToString()方法：

public static string DateToString(this DateTime dt)
    {
      return dt.ToString("yyyy-mm-dd hh:mm:ss");
    }

此时回到主函数方法体，输入"now."便可以看见自动提示有个DateToString()方法，于是代码可以这样写：

static void Main(string[] args)
    {
      DateTime now = DateTime.Now; 
      string time = now.DateToString();
      Console.WriteLine(time);
      Console.ReadKey();
    }

显而易见，这样用起来会更加便捷，而且这样让我们看起来确实就像是被扩展类型本身具有的实例方法一样，可读性很高。下面概括一下扩展方法的特点：

1.扩展方法扩展自哪个类型，就必须是此类型的变量来使用，其他类型无法使用，本例扩展自DateTime类型，就只能是被DateTime类型的变量.出来(now.DateToString())
2.扩展方法中的this后面的参数不属于方法的参数，本例是无参数，this后面的DateTime dt是指明扩展方法扩展自何种类型
3.如果扩展方法和实例方法具有相同的签名，则优先调用实例方法
4.扩展自父类上的方法，可以被子类的对象直接使用
5.扩展自接口上的方法，可以被实现类的对象直接使用
6.扩展方法最终还是被编译器编译成：静态类.静态方法()，本例中now.DateToString()最终还是会被编译成DateHelper.DateToString(now)，这是它的本质

实际上，我们可能会遇到这样的情景，如在接口扩展一个方法的时候，所有的原本已实现该接口的类都要实现新扩展的方法，这样的改动是一个很麻烦的工作，可以使用扩展方法“曲线救国”；而有时候我们想为某个类添加新方法却不想改动这个类，那么扩展方法这种“伪添加”方法的方式就体现出它的价值了。最常见的扩展方法是LINQ标准查询运算符，运用广泛，这种方便快捷的方式理应博得码农们点1024个赞。

“扩展方法使您能够向现有类型“添加”方法，而无需创建新的派生类型、重新编译或以其他方式修改原始类型。”

这是msdn上说的，也就是你可以对String,Int,DataRow,DataTable等这些类型的基础上增加一个或多个方法，使用时不需要去修改或编译类型本身的代码。

先做个例子吧，以String为例，需要在字符串类型中加一个从字符串转为数值的功能。

以往我们可能是这样做的，会专门写一个方法做过转换

public static int StrToInt(string s)
{
  int id;
  int.TryParse(s, out id);//这里当转换失败时返回的id为0
  return id;
}

调用就使用

string s = "abc";
int i = StrToInt(s);

若是String类型有一个名为ToInt()（从字符串转为数值）的方法，就可以这样调用了

string s = "abc";
int i = s.ToInt();

这样看起来是不是更好，下面来看看具体怎么实现吧

第一步：

我先创建一个解决方案，一个web应用程序(webtest)及一个类库(W.Common)

在webtest项目添加引用W.Common项目

第二步：在类库中新建一个名为EString.cs类

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
 
namespace W.Common
{
  public static class EString
  {
    /// <summary>
    /// 将字符串转换为Int
    /// </summary>
    /// <param name="t"></param>
    /// <returns>当转换失败时返回0</returns>
    public static int ToInt(this string t)
    {
      int id;
      int.TryParse(t, out id);//这里当转换失败时返回的id为0
      return id;
    }
  }
}

看了上面的代码了吧，扩展方法规定类必须是一个静态类，EString是一个静态类，里面包含的所有方法都必须是静态方法。

msdn是这样规定扩展方法的：“扩展方法被定义为静态方法，但它们是通过实例方法语法进行调用的。它们的第一个参数指定该方法作用于哪个类型，并且该参数以 this 修饰符为前缀。”

EString里有一个ToInt的静态方法，他接收一个自身参数this，类型为string，this string必须在方法参数的第一个位置。

这句话什么意思，即你需要对string扩展一个ToInt方法，this是string实例化后的对象，这可能说的不太清楚，我的表述能力能弱，不要见怪呀。。。通俗的说就是，扩展方法跟静态类的名称无关，只需要在一个静态类里面定义一个静态方法，第一个参数必须this string开头。

如果需要你要对DateTime类型扩展方法名为IsRange（判断是否在此时间范围内），代码如下：

/// <summary>
  /// 此时间是否在此范围内 -1:小于开始时间 0:在开始与结束时间范围内 1:已超出结束时间
  /// </summary>
  /// <param name="t"></param>
  /// <param name="startTime"></param>
  /// <param name="endTime"></param>
  /// <returns></returns>
  public static int IsRange(this DateTime t, DateTime startTime, DateTime endTime)
  {
    if (((startTime - t).TotalSeconds > 0))
    {
      return -1;
    }
 
    if (((endTime - t).TotalSeconds < 0))
    {
      return 1;
    }
 
    return 0;
  }

这里的扩展方法是用this DateTime打头，那么就可以这样调用

time.IsRange(t1,t2);//判断时间time是否在t1到t2的范围内
当前代码在使用扩展方法前需要先引用命名空间

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using W.Common;//这里引用扩展方法所在的命名空间
 
namespace webtest
{
  public partial class _Default : System.Web.UI.Page
  {
    protected void Page_Load(object sender, EventArgs e)
    {
      use1();
      Response.Write("<br />");
      use2();
    }
 
    /// <summary>
    /// 没有用扩展方法
    /// </summary>
    private void use1()
    {
      string s = "abc";
      int i = StrToInt(s);
      Response.Write("没有用扩展方法:" + i);
    }
 
    /// <summary>
    /// 使用扩展方法
    /// </summary>
    private void use2()
    {
      string s = "2012";
      int i = s.ToInt();
      Response.Write("使用扩展方法:" + i);
    }
 
    public static int StrToInt(string s)
    {
      int id;
      int.TryParse(s, out id);//这里当转换失败时返回的id为0
      return id;
    }
  }
}

　　以上是我对扩展方法理解及使用，如有不对或不足的地方请多多指正，谢谢啦。。

　　这我第一次写文章算是排过版的，用好长时间呀，以前都只是看别人的文章，现在才知道写一篇好的文章真的不容易呀。

　　努力学习，坚持自己的梦想。

您可能感兴趣的文章:

C#使用RichTextBox实现替换文字及改变字体颜色功能示例
这篇文章主要介绍了C#使用RichTextBox实现替换文字及改变字体颜色功能,结合实例形式洗了C#中RichTextBox组件文字替换及改变字体颜色相关操作技巧,需要的朋友可以参考下
2019-02-02
图文详解C#中的协变与逆变
“协变”是指能够使用与原始指定的派生类型相比,派生程度更大的类型,“逆变”则是指能够使用派生程度更小的类型,这篇文章主要给大家介绍了关于C#中协变与逆变的相关资料,需要的朋友可以参考下
2022-02-02
C#使用ZXing实现二维码和条形码的生成
这篇文章主要为大家详细介绍了C#如何使用ZXing实现二维码和条形码的生成与识别,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
2023-11-11
c# 在windows中操作IIS设置FTP服务器的示例
这篇文章主要介绍了c# 在windows中操作IIS设置FTP服务器的示例，帮助大家更好的理解和学习使用c#，感兴趣的朋友可以了解下
2021-03-03
js事件模型与自定义事件实例解析
JavaScript一个最简单的事件模型，需要有事件绑定与触发，还有事件删除。本文将对其具体实现代码进行解析，需要的朋友一起来看下吧
2016-12-12
C#加密解密文件小工具实现代码
一个文件夹加密小工具，该工具是操作文件夹名称的方法实现文件夹的一般加密，文件夹中的文件（视频、图片等）都原封不动的保存在那里
2012-05-05
猜数字小游戏C#实现代码
这篇文章主要为大家详细介绍了C#实现猜数字小游戏的代码，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-12-12
C#控制键盘按键的常用方法
这篇文章主要介绍了C#控制键盘按键的常用方法,涉及C#针对键盘大写、滚动、数字的开启与锁定等功能,非常简单实用,需要的朋友可以参考下
2015-05-05
Winform在DataGridView中显示图片
本文主要介绍在DataGridView如何显示图片，简单实用，需要的朋友可以参考下。
2016-05-05
C#中累加器函数Aggregate用法实例
这篇文章主要介绍了C#中累加器函数Aggregate用法,实例分析了C#中累加器的实现与使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-07-07