C#中的擴(kuò)展方法詳解
擴(kuò)展方法使你能夠向現(xiàn)有類型“添加”方法,而無需創(chuàng)建新的派生類型、重新編譯或以其他方式修改原始類型。 擴(kuò)展方法是一種特殊的靜態(tài)方法,但可以像擴(kuò)展類型上的實(shí)例方法一樣進(jìn)行調(diào)用。 以上是msdn官網(wǎng)對擴(kuò)展方法的描述,現(xiàn)在我通過一個情景例子來對此進(jìn)行闡釋。假設(shè)一個控制臺程序class Program{}里面的主函數(shù)如下:
static void Main(string[] args) { DateTime now = DateTime.Now; string time = now.ToString("yyyy-mm-dd hh:mm:ss"); Console.WriteLine(time); Console.ReadKey(); }
假設(shè)需求變了,日期的顯示格式要變成"yyyy-mm-dd"這種格式,當(dāng)然只需要初始化time時按下面寫法改寫即可:
string time = now.ToString("yyyy-mm-dd");
但是如果要改變?nèi)掌诟袷降挠泻芏鄠€類呢?每個都要改一次嗎?這樣一旦需求變來變?nèi)ゾ兔λ廊肆?。傳統(tǒng)的解決方式是封裝一個幫助類,在里面寫方法,然后供其他類調(diào)用。
本例在當(dāng)前項(xiàng)目模仿添加一個DateHelper類:public class DateHelper{},在類里面定義方法:
public static string DateToString(DateTime dt) { return dt.ToString("yyyy-mm-dd hh:mm:ss"); }
于是原來的主函數(shù)改寫如下:
static void Main(string[] args) { DateTime now = DateTime.Now; string time = DateHelper.DateToString(now); Console.WriteLine(time); Console.ReadKey(); }
此時如果變需求,只需要改寫DateHelp類里的DateToString()方法就行了,不管有多少個類調(diào)用此方法,都會被影響。問題解決了,可是這樣要調(diào)用另一個類的方法,還是有點(diǎn)麻煩,有沒有什么方法能夠讓我們像now.DateToString()一樣直接調(diào)用呢?當(dāng)然DateTime是微軟寫好的,我們改不了,無法創(chuàng)建想要的實(shí)例方法,于是,便引出了擴(kuò)展方法。
下面是擴(kuò)展方法的要素:
1.此方法必須是一個靜態(tài)方法
2.此方法必須放在靜態(tài)類中
3.此方法的第一個參數(shù)必須以this開頭,并且指定此方法是擴(kuò)展自哪個類型
根據(jù)以上要素,我們DateHelper類改成靜態(tài)類:public static class DateHelper{} ,同時改寫DateToString()方法:
public static string DateToString(this DateTime dt) { return dt.ToString("yyyy-mm-dd hh:mm:ss"); }
此時回到主函數(shù)方法體,輸入"now."便可以看見自動提示有個DateToString()方法,于是代碼可以這樣寫:
static void Main(string[] args) { DateTime now = DateTime.Now; string time = now.DateToString(); Console.WriteLine(time); Console.ReadKey(); }
顯而易見,這樣用起來會更加便捷,而且這樣讓我們看起來確實(shí)就像是被擴(kuò)展類型本身具有的實(shí)例方法一樣,可讀性很高。下面概括一下擴(kuò)展方法的特點(diǎn):
1.擴(kuò)展方法擴(kuò)展自哪個類型,就必須是此類型的變量來使用,其他類型無法使用,本例擴(kuò)展自DateTime類型,就只能是被DateTime類型的變量.出來(now.DateToString())
2.擴(kuò)展方法中的this后面的參數(shù)不屬于方法的參數(shù),本例是無參數(shù),this后面的DateTime dt是指明擴(kuò)展方法擴(kuò)展自何種類型
3.如果擴(kuò)展方法和實(shí)例方法具有相同的簽名,則優(yōu)先調(diào)用實(shí)例方法
4.擴(kuò)展自父類上的方法,可以被子類的對象直接使用
5.擴(kuò)展自接口上的方法,可以被實(shí)現(xiàn)類的對象直接使用
6.擴(kuò)展方法最終還是被編譯器編譯成:靜態(tài)類.靜態(tài)方法(),本例中now.DateToString()最終還是會被編譯成DateHelper.DateToString(now),這是它的本質(zhì)
實(shí)際上,我們可能會遇到這樣的情景,如在接口擴(kuò)展一個方法的時候,所有的原本已實(shí)現(xiàn)該接口的類都要實(shí)現(xiàn)新擴(kuò)展的方法,這樣的改動是一個很麻煩的工作,可以使用擴(kuò)展方法“曲線救國”;而有時候我們想為某個類添加新方法卻不想改動這個類,那么擴(kuò)展方法這種“偽添加”方法的方式就體現(xiàn)出它的價值了。最常見的擴(kuò)展方法是LINQ標(biāo)準(zhǔn)查詢運(yùn)算符,運(yùn)用廣泛,這種方便快捷的方式理應(yīng)博得碼農(nóng)們點(diǎn)1024個贊。
“擴(kuò)展方法使您能夠向現(xiàn)有類型“添加”方法,而無需創(chuàng)建新的派生類型、重新編譯或以其他方式修改原始類型?!?/p>
這是msdn上說的,也就是你可以對String,Int,DataRow,DataTable等這些類型的基礎(chǔ)上增加一個或多個方法,使用時不需要去修改或編譯類型本身的代碼。
先做個例子吧,以String為例,需要在字符串類型中加一個從字符串轉(zhuǎn)為數(shù)值的功能。
以往我們可能是這樣做的,會專門寫一個方法做過轉(zhuǎn)換
public static int StrToInt(string s) { int id; int.TryParse(s, out id);//這里當(dāng)轉(zhuǎn)換失敗時返回的id為0 return id; }
調(diào)用就使用
string s = "abc"; int i = StrToInt(s);
若是String類型有一個名為ToInt()(從字符串轉(zhuǎn)為數(shù)值)的方法,就可以這樣調(diào)用了
string s = "abc"; int i = s.ToInt();
這樣看起來是不是更好,下面來看看具體怎么實(shí)現(xiàn)吧
第一步:
我先創(chuàng)建一個解決方案,一個web應(yīng)用程序(webtest)及一個類庫(W.Common)
在webtest項(xiàng)目添加引用W.Common項(xiàng)目
第二步:在類庫中新建一個名為EString.cs類
using System; using System.Collections.Generic; using System.Linq; using System.Text; namespace W.Common { public static class EString { /// <summary> /// 將字符串轉(zhuǎn)換為Int /// </summary> /// <param name="t"></param> /// <returns>當(dāng)轉(zhuǎn)換失敗時返回0</returns> public static int ToInt(this string t) { int id; int.TryParse(t, out id);//這里當(dāng)轉(zhuǎn)換失敗時返回的id為0 return id; } } }
看了上面的代碼了吧,擴(kuò)展方法規(guī)定類必須是一個靜態(tài)類,EString是一個靜態(tài)類,里面包含的所有方法都必須是靜態(tài)方法。
msdn是這樣規(guī)定擴(kuò)展方法的:“擴(kuò)展方法被定義為靜態(tài)方法,但它們是通過實(shí)例方法語法進(jìn)行調(diào)用的。 它們的第一個參數(shù)指定該方法作用于哪個類型,并且該參數(shù)以 this 修飾符為前綴。”
EString里有一個ToInt的靜態(tài)方法,他接收一個自身參數(shù)this,類型為string,this string必須在方法參數(shù)的第一個位置。
這句話什么意思,即你需要對string擴(kuò)展一個ToInt方法,this是string實(shí)例化后的對象,這可能說的不太清楚,我的表述能力能弱,不要見怪呀。。。通俗的說就是,擴(kuò)展方法跟靜態(tài)類的名稱無關(guān),只需要在一個靜態(tài)類里面定義一個靜態(tài)方法,第一個參數(shù)必須this string開頭。
如果需要你要對DateTime類型擴(kuò)展方法名為IsRange(判斷是否在此時間范圍內(nèi)),代碼如下:
/// <summary> /// 此時間是否在此范圍內(nèi) -1:小于開始時間 0:在開始與結(jié)束時間范圍內(nèi) 1:已超出結(jié)束時間 /// </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; }
這里的擴(kuò)展方法是用this DateTime打頭,那么就可以這樣調(diào)用
time.IsRange(t1,t2);//判斷時間time是否在t1到t2的范圍內(nèi)
當(dāng)前代碼在使用擴(kuò)展方法前需要先引用命名空間
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using W.Common;//這里引用擴(kuò)展方法所在的命名空間 namespace webtest { public partial class _Default : System.Web.UI.Page { protected void Page_Load(object sender, EventArgs e) { use1(); Response.Write("<br />"); use2(); } /// <summary> /// 沒有用擴(kuò)展方法 /// </summary> private void use1() { string s = "abc"; int i = StrToInt(s); Response.Write("沒有用擴(kuò)展方法:" + i); } /// <summary> /// 使用擴(kuò)展方法 /// </summary> private void use2() { string s = "2012"; int i = s.ToInt(); Response.Write("使用擴(kuò)展方法:" + i); } public static int StrToInt(string s) { int id; int.TryParse(s, out id);//這里當(dāng)轉(zhuǎn)換失敗時返回的id為0 return id; } } }
以上是我對擴(kuò)展方法理解及使用,如有不對或不足的地方請多多指正,謝謝啦。。
這我第一次寫文章算是排過版的,用好長時間呀,以前都只是看別人的文章,現(xiàn)在才知道寫一篇好的文章真的不容易呀。
努力學(xué)習(xí),堅持自己的夢想。
相關(guān)文章
基于數(shù)據(jù)類型轉(zhuǎn)換(裝箱與拆箱)與常量詳解
下面小編就為大家分享一篇基于數(shù)據(jù)類型轉(zhuǎn)換(裝箱與拆箱)與常量詳解,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2017-11-11C#中按引用傳遞與按值傳遞的區(qū)別,以及ref與out關(guān)鍵字的用法詳解
以下是對C#中按引用傳遞與按值傳遞的區(qū)別,以及ref與out關(guān)鍵字的用法進(jìn)行了詳細(xì)的分析介紹,需要的朋友可以過來參考下2013-07-07C#中winform控制textbox輸入只能為數(shù)字的方法
這篇文章主要介紹了C#中winform控制textbox輸入只能為數(shù)字的方法,包括使用keyPress事件限制鍵盤輸入以及TextChanged事件限制粘貼等情況,來實(shí)現(xiàn)控制輸入為數(shù)字的功能,需要的朋友可以參考下2015-01-01C#中Forms.Timer、Timers.Timer、Threading.Timer的用法分析
這篇文章主要介紹了C#中Forms.Timer、Timers.Timer、Threading.Timer的用法分析,以實(shí)例形式較為詳細(xì)的講述了.NET Framework里面提供的三種Timer具體用法,需要的朋友可以參考下2014-10-10Unity實(shí)現(xiàn)角色受擊身體邊緣發(fā)光特效
這篇文章主要為大家詳細(xì)介紹了Unity實(shí)現(xiàn)角色受擊身體邊緣發(fā)光特效,文中示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2020-04-04WinForm子窗體訪問父窗體控件的實(shí)現(xiàn)方法
WinForm子窗體訪問父窗體控件的實(shí)現(xiàn)方法,需要的朋友可以參考一下2013-03-03