在说什么是扩展方法之前我们先来说说为什么要用扩展方法。
首先我们定义一个 Person 类:
public class Person { /// <summary> /// 出生日期 /// </summary> public DateTime BirthTime { get; set; } /// <summary> /// 死亡日期 /// </summary> public DateTime? DeathTime { get; set; } //、、、、、、 }
加入这个类来自第三方的dll引用,且现在我们需要添加一个方法 GetAge 获取年龄。你可能会想到自己定一个子类继承:
public class MyPerson : Person { public int GetAge() { if (DeathTime.HasValue) return (DeathTime.Value - BirthTime).Days / 365; else return (DateTime.Now - BirthTime).Days / 365; } }
是的,这样可以实现我们的需求。不过实现新增的方法就去继承真的是最合适的吗(暂且不说)? 如果上面定义的密封类呢? public sealed class Person ,这个时候是不能继承的,我们只能另想办法。
随意写个静态类:
public static class ExtensionClass { public static int GetAge(Person person) { if (person.DeathTime.HasValue) return (person.DeathTime.Value - person.BirthTime).Days / 365; else return (DateTime.Now - person.BirthTime).Days / 365; }
然后调用 age = ExtensionClass.GetAge(p); ,是的看似不错。可是这和我们说的扩展方法有什么关系呢?下面就是见证奇迹的时候了。
其他的任何地方都不变,唯一变化的是在参数前面加里this关键字。对,是的,仅仅如此它就变成了我们今天要讲的扩展方法。
调用如: var age = p.GetAge(); 相比上面的 age = ExtensionClass.GetAge(p); 更简单明了。
这里我们说的是在需要扩展密封类的方法时,我们可以使用到扩展方法。还有一种情况就是,在需要扩展接口的时候时候我们更加需要。比如,需要扩展IList的排序。我们要么写个扩展方法,要么是继承实现接口(会强制要求实现接口下的所有方法)。我想你心中已经有了答案选择哪种方式。
扩展方法到底是什么
我们看到上面使用的扩展方法,有没有感觉很神奇。仅仅多添加了一个this关键字就直接可以当成扩展方法使用了。那扩展方法到底是什么东东,看了上面代码好像和静态方法有着说不清道不明的关系。下面我们继续分析:
分别定义一个静态方法和一个扩展方法
public static class ExtensionClass { public static int GetAge2(Person person) { if (person.DeathTime.HasValue) return (person.DeathTime.Value - person.BirthTime).Days / 365; else return (DateTime.Now - person.BirthTime).Days / 365; } public static int GetAge(this Person person) { if (person.DeathTime.HasValue) return (person.DeathTime.Value - person.BirthTime).Days / 365; else return (DateTime.Now - person.BirthTime).Days / 365; }
分别调用:
var p = new Person() { BirthTime = DateTime.Parse("1990-07-19") }; var age = p.GetAge(); age = ExtensionClass.GetAge2(p);
编译后的IL代码:
我们看到反编译成IL之后发现两者并无不同。所以,我理解成(扩展方法本质上就是静态方法,之所以出现扩展方法是C#以另外一种形式表现静态方法而已。只有有何妙用下面会继续讲解)。且 编译后
同样带上了静态类名。
扩展方法可以做些什么
- 把已有的静态方法转成扩展方法:如:
public static bool IsNullOrEmpty(this string str) { return string.IsNullOrEmpty(str); }
调用:
string str = null; var isNull = str.IsNullOrEmpty();
感觉相比期静态方法调用要优雅,更接近我们的自然语言。
- 可以编写很多的帮助类,如(以string为例):
/// <summary> /// 转DateTime /// </summary> /// <param name="str"></param> /// <returns></returns> public static DateTime? MyToDateTime(this string str) { if (string.IsNullOrEmpty(str)) return null; else return DateTime.Parse(str); } /// <summary> /// 转double /// </summary> /// <param name="str"></param> /// <returns></returns> public static double MyToDouble(this string str) { if (string.IsNullOrEmpty(str)) return -1; else return double.Parse(str); } /// <summary> /// 转int /// </summary> /// <param name="str"></param> /// <returns></returns> public static int MyToInt(this string str) { if (string.IsNullOrEmpty(str)) return -1; else return int.Parse(str); } /// <summary> /// 指示指定的字符串是 null 还是 System.String.Empty 字符串。 /// </summary> /// <param name="str"></param> /// <returns></returns> public static bool IsNullOrEmpty(this string str) { return string.IsNullOrEmpty(str); } /// <summary> /// 如果字符串为null,则返回空字符串。(否则返回原字符串) /// </summary> /// <param name="str"></param> /// <returns></returns> public static string GetValueOrEmpty(this string str) { if (str.IsNullOrEmpty()) return string.Empty; return str; }