.Net 中的反射(動態建立類型執行個體) - Part.4

標籤：des   style   http   io   ar   color   os   使用   sp   

動態建立對象

在前面節中，我們先瞭解了反射，然後利用反射查看了類型資訊，並學習了如何建立自訂特性，並利用反射來遍曆它。可以說，前面三節，我們學習的都是反射是什麼，在接下來的章節中，我們將學習反射可以做什麼。在進行更有趣的話題之前，我們先看下如何動態地建立一個對象。

我們建立一個Console控制台項目，叫做Reflection4(因為本文是Part4，你也可以起別的名字)。然後，添加一個示範類，本文中將通過對這個示範類的操作來進行說明：

public class Calculator {

    private int x;
    private int y;

    public Calculator(){
       x = 0;
       y = 0;
    }

    public Calculator(int x, int y) {
       this.x = x;
       this.y = y;
    }
}

1.使用無參數建構函式建立對象

上面這個類非常簡單，它包含兩個建構函式，一個是有參數的建構函式，一個是無參數的建構函式，我們先看看通過反射，使用無參數的建構函式建立對象。建立對象通常有兩種方式，一種是使用Assembly的CreateInstance方法：

Assembly asm = Assembly.GetExecutingAssembly();           
Object obj = asm.CreateInstance("Reflection4.Calculator", true);
// 輸出：Calculator() invoked

CreateInstance的第一個參數代表了要建立的類型執行個體的字串名稱，第二個參數說明是不是大小寫無關(Ignore Case)。注意到CreateInstance返回的是一個Object對象，意味著如果想使用這個對象，需要進行一次類型轉換。

建立對象的另一種方式是調用Activator類的靜態方法CreateInstance：

ObjectHandle handler = Activator.CreateInstance(null, "Reflection4.Calculator");
Object obj = handler.Unwrap();

其中CreateInstance的第一個參數說明是程式集的名稱，為null時表示當前程式集；第二個參數說明要建立的類型名稱。Activator.CreateInstance返回的是一個ObjectHandle對象，必須進行一次Unwrap()才能返回Object類型，進而可以強制轉換成我們需要的類型(本例中是Calculator)。ObjectHandle包含在System.Runtime.Remoting命名空間中，可見它是Remoting相關的，實際上ObjectHandle類只是一個對原類型進行了一個封裝以便進行封送，更多內容可以參見 .Net Remoting(應用程式定義域)—Part.1 這篇文章。

2.使用有參數建構函式建立對象

如果我們想通過有參數的建構函式建立對象，我們可以使用Assembly的CreateInstanc()的重載方法：

// 有參數建構函式建立對象
Assembly asm = Assembly.GetExecutingAssembly();
Object[] parameters = new Object[2];    // 定義建構函式需要的參數
parameters[0] = 3;
parameters[1] = 5;

Object obj = asm.CreateInstance("Reflection4.Calculator", true, BindingFlags.Default, null, parameters, null, null);

// 輸出：Calculator(int x, int y) invoked

我們看一下CreateInstance需要提供的參數：

1. 前兩個在前一小節已經說明過了；
2. BindingFlags在前面我們也用到過，它用於限定對類型成員的搜尋。在這裡指定Default，意思是不使用BingdingFlags的策略(你可以把它理解成null，但是BindingFlags是實值型別，所以不可能為null，必須有一個預設值，而這個Default就是它的預設值)；
3. 接下來的參數是Binder，它封裝了CreateInstance綁定對象(Calculator)的規則，我們幾乎永遠都會傳遞null進去，實際上使用的是預定義的DefaultBinder；
4. 接下來是一個Object[]數群組類型，它包含我們傳遞進去的參數，有參數的建構函式將會使用這些參數；
5. 接下來的參數是一個CultureInfo類型，它包含了關於語言和文化的資訊(簡單點理解就是什麼時候ToString("c")應該顯示“￥”，什麼時候應該顯示“＄”)。

動態調用方法

接下來我們看一下如何動態地調用方法。注意，本文討論的調用不是將上面動態建立好的對象由Object類型轉換成Calculator類型再進行方法調用，這和“常規調用”就沒有區別了，讓我們以.Net Reflection 的方式來進行方法的調用。繼續進行之前，我們為Calculator添加兩個方法，一個執行個體方法，一個靜態方法：

public int Add(){
    int total= 0;
    total = x + y;
    Console.WriteLine("Invoke Instance Method: ");
    Console.WriteLine(String.Format("[Add]: {0} plus {1} equals to {2}", x, y, total));
    return total;
}

public static void Add(int x, int y){
    int total = x + y;
    Console.WriteLine("Invoke Static Method: ");
    Console.WriteLine(String.Format("[Add]: {0} plus {1} equals to {2}", x, y, total));
}

調用方法的方式一般有兩種：

1. 在類型的Type對象上調用InvokeMember()方法，傳遞想要在其上調用方法的對象(也就是剛才動態建立的Calculator類型執行個體)，並指定BindingFlags為InvokeMethod。根據方法簽名，可能還需要傳遞參數。
2. 先通過Type對象的GetMethond()方法，擷取想要調用的方法對象，也就是MethodInfo對象，然後在該對象上調用Invoke方法。根據方法簽名，可能還需要傳遞參數。

需要說明的是，使用InvokeMember不限於調用對象的方法，也可以用於擷取對象的欄位、屬性，方式都是類似的，本文只說明最常見的調用方法。

1.使用InvokeMember調用方法

我們先看第一種方法，代碼很簡單，只需要兩行(注意obj在上節已經建立，是Calculator類型的執行個體)：

Type t = typeof(Calculator);
int result = (int)t.InvokeMember("Add", BindingFlags.InvokeMethod, null, obj, null);
Console.WriteLine(String.Format("The result is {0}", result));

輸出：
Invoke Instance Method:
[Add]: 3 plus 5 equals to 8
The result is 8

在InvokeMember方法中，第一個參數說明了想要調用的方法名稱；第二個參數說明是調用方法(因為InvokeMember的功能非常強大，不光是可以調用方法，還可以擷取/設定 屬性、欄位等。此枚舉的詳情可參看Part.2或者MSDN)；第三個參數是Binder，null說明使用預設的Binder；第四個參數說明是在這個對象上(obj是Calculator類型的執行個體)進行調用；最後一個參數是數群組類型，表示的是方法所接受的參數。

我們在看一下對於靜態方法應該如何調用：

Object[] parameters2 = new Object[2];
parameters2[0] = 6;
parameters2[1] = 9;
t.InvokeMember("Add", BindingFlags.InvokeMethod, null, typeof(Calculator), parameters2);

輸出：
Invoke Static Method:
[Add]: 6 plus 9 equals to 15

我們和上面對比一下：首先，第四個參數傳遞的是 typeof(Calculator)，不再是一個Calculator執行個體類型，這很容易理解，因為我們調用的是一個靜態方法，它不是基於某個具體的類型執行個體的，而是基於類型本身；其次，因為我們的靜態方法需要提供兩個參數，所以我們以數組的形式將這兩個參數進行了傳遞。

2.使用MethodInfo.Invoke調用方法

我們再看下第二種方式，先獲得一個MethodInfo執行個體，然後調用這個執行個體的Invoke方法，我們看下具體如何做：

Type t = typeof(Calculator);
MethodInfo mi = t.GetMethod("Add", BindingFlags.Instance | BindingFlags.Public);
mi.Invoke(obj, null);

輸出：
Invoke Instance Method:
[Add]: 3 plus 5 equals to 8
請按任意鍵繼續. . .

在代碼的第二行，我們先使用GetMethod方法擷取了一個方法對象MethodInfo，指定BindingFlags為Instance和Public，因為有兩個方法都命名為“Add”，所以在這裡指定搜尋條件是必須的。接著我們使用Invoke()調用了Add方法，第一個參數obj是前面建立的Calculator類型執行個體，表明在該執行個體上建立方法；第二個參數為null，說明方法不需要提供參數。

我們再看下如何使用這種方式調用靜態方法：

Type t = typeof(Calculator);
Object[] parameters2 = new Object[2];
parameters2[0] = 6;
parameters2[1] = 9;
MethodInfo mi = t.GetMethod("Add", BindingFlags.Static | BindingFlags.Public);
mi.Invoke(null, parameters2);
// mi.Invoke(t, parameters2);   也可以這樣

輸出：
Invoke Static Method:
[Add]: 6 plus 9 equals to 15

可以看到與上面的大同小異，在GetMethod()方法中，我們指定為搜尋BindingFlags.Static，而不是BindingFlags.Public，因為我們要調用的是靜態Add方法。在Invoke()方法中，需要注意的是第一個參數，不能在傳遞Calculator類型執行個體，而應該傳遞Calculator的Type類型或者直接傳遞null。因為靜態方法不是屬於某個執行個體的。

NOTE：通過上面的例子可以看出：使用反射可以達到最大程度上的多態，舉個例子，你可以在頁面上放置一個DropDownList控制項，然後指定它的Items的value為你某個類的方法的名稱，然後在SelectedIndexChanged事件中，利用value的值來調用類的方法。而在以前，你只能寫一些if else 語句，先判斷DropDownList返回的值，根據值再決定調用哪個方法。使用這種方式，編譯器在代碼運行之前(或者說使用者選擇了某個選項之前)完全不知道哪個方法將被調用，這也就是常說的 遲綁定(Late Binding)。

Coding4Fun：遍曆System.Drawing.Color結構

我們已經講述了太多的基本方法和理論，現在讓我們來做一點有趣的事情：大家知道在Asp.Net中控制項的顏色設定，比如說ForeColor, BackColor等，都是一個System.Draw.Color結構類型。在某些情況下我們需要使用自訂的顏色，那麼我們會使用類似這樣的方式Color.FromRgb(125,25,13)建立一個顏色值。但有時候我們會覺得比較麻煩，因為這個數字太不直觀了，我們甚至需要把這個值貼到PhotoShop中看看是什麼樣的。

這時候，我們可能會想要使用Color結構提供的預設顏色，也就是它的141個靜態屬性，但是這些值依然是以名稱，比如DarkGreen的形式給出的，還是不夠直觀，如果能把它們以色塊的形式輸出到頁面就好了，這樣我們查看起來會方便的多，以後使用也會比較便利。我已經實現了它，可以點擊下面的連結查看：

效果預覽：http://www.tracefact.net/demo/reflection/color.aspx

基本實現

現在我們來看一下實現過程：

先建立頁面Color.aspx(或其他名字)，然後在Head裡添加些樣式控制頁面顯示，再拖放一個Panel控制項進去。樣式表需要注意的是#pnColors div部分，它定義了頁面上將顯示的色塊的樣式；Id為pnHolder的Panel控制項用於裝載我們動態產生的div。

<head>
<style type="text/css">
body{font-size:14px;}
h1{font-size:26px;}
#pnColors div{
    float:left;width:140px;
    padding:7px 0;
    text-align:center;
    margin:3px; 
    border:1px solid #aaa;
    font-size:11px;
    font-family:verdana, arial
}
</style>
</head>

<body>
    <h1>Coding4Fun：使用反射遍曆System.Drawing.Color結構</h1>
    <form id="form1" runat="server">
       <asp:Panel ID="pnColors" runat="server"></asp:Panel>
    </form>
</body>

NOTE：如果將頁面命名為了 Color.aspx，那麼需要在代碼後置檔案中修改類名，比如改成：Reflection_Color，同時頁面頂部也需要修改成Inherits="Reflection_Color"，不然會出現命名衝突的問題。

下一步的思路是這樣的：我們在phColors中添加一系列的div，這些div也就是頁面上我們將要顯示的色塊。我們設定div的文本為 顏色的名稱 和 RGB數值，它的背景色我們設為相應的顏色(色塊的其他樣式，比如寬、邊框、寬度已經在head中定義)。我們知道在Asp.Net中，並沒有一個Div控制項，只有HtmlGenericControl，此時，我們最好定義一個Div讓它繼承自HtmlGenericControl。

public class Div:HtmlGenericControl
{
    private string name;
    
    public Div(Color c)
       : base("div")     // 調用基類建構函式，建立一個 Div
    {
       this.name = c.Name;      // 顏色名稱
       
       // 設定文本
       this.InnerHtml = String.Format("{0}<br />RGB({1},{2},{3})", name, c.R, c.G, c.B);

       int total = c.R + c.G + c.B;
       if (total <= 255)     // 如果底色太暗，前景色彩改為明色調
           this.Style.Add("color", "#eee");

       // 設定背景顏色
       this.Style.Add("background", String.Format("rgb({0},{1},{2})", c.R, c.G, c.B));
    }
}

如同我們前面所描述的，這個Div接受一個Color類型作為建構函式的參數，然後在建構函式中，先設定了它的文本為 顏色名稱 和 顏色的各個數值(通過Color結構的R, G, B屬性獲得)。然後設定了div的背景色為相應的RGB顏色。

NOTE：在上面 if(total<=255)那裡，可能有的顏色本身就很暗，如果這種情況再使用黑色的前景色彩那麼文字會看不清楚，所以我添加了判斷，如果背景太暗，就將前景色彩調的明亮一點。

OK，現在我們到後置代碼中只要做一點點的工作就可以了：

protected void Page_Load(object sender, EventArgs e)
{
    List<Div> list = new List<Div>();

    Type t = typeof(Color);      // 頁首已經包含了 using System.Drawing;
    // 擷取屬性
    PropertyInfo[] properties = t.GetProperties(BindingFlags.Static | BindingFlags.Public);
    Div div;

    // 遍曆屬性
    foreach (PropertyInfo p in properties)
    {
       // 動態獲得屬性
       Color c;          
       c = (Color)t.InvokeMember(p.Name, BindingFlags.GetProperty, null, typeof(Color), null);        
       
       div = new Div(c);
       list.Add(div);
    }

    foreach (Div item in list)   {
       pnColors.Controls.Add(item);
    }
}

上面的代碼是很直白的：先建立一個Div列表，用於儲存即將建立的色塊。然後擷取Color類型的Type執行個體。接著我們使用GetProperties()方法，並指定BindingFlags擷取所有的靜態公用屬性。然後遍曆屬性，並使用InvokeMember()方法擷取了屬性值，因為返回的是一個Object類型，所以我們需要把它強制轉換成一個Color類型。注意在這裡InvokeMember的BindingFlags指定為GetProperty，意為擷取屬性值。第四個參數為typeof(Color)，因為顏色屬性(比如DarkGreen)是靜態，不是針對於某個執行個體的，如果是執行個體，則需要傳遞調用此屬性的類型執行個體。最後，我們根據顏色建立div，並將它加入列表，遍曆列表並逐一加入到Id為pnColors的Panal控制項中。

現在已經OK了，如果開啟頁面，應該可以看到類似這樣的效果：

為列表排序

上面的頁面看上去會比較亂，因為列表大致是按顏色名稱排序的(Transparnet例外)，我們最好可以讓列表基於顏色進行排序。關於列表排序，我在 基於業務對象的排序 一文中已經非常詳細地進行了討論，所以這裡我僅給出實現過程，而不再進行講述。這一小節與反射無關，如果你對排序已經非常熟悉，可以跳過。

在頁面上添加一個RadioButtonList控制項，將AutoPostBack設為true，我們要求可以按名稱和顏色值兩種方式進行排序：

排序：
<asp:RadioButtonList ID="rblSort" runat="server" AutoPostBack="true" RepeatDirection="Horizontal" RepeatLayout="Flow">
    <asp:ListItem Selected="True">Name</asp:ListItem>
     <asp:ListItem>Color</asp:ListItem>        
</asp:RadioButtonList>

在後置代碼中，添加一個枚舉作為排序的依據：

public enum SortBy{
    Name,         // 按名稱排序
    Color         // 暗顏色值排序
}

修改Div類，添加 ColorValue欄位，這個欄位代表顏色的值，並建立巢狀型別ColorComparer，以及方法GetComparer：

public class Div:HtmlGenericControl
{
    private int colorValue;
    private string name;
    
    public Div(Color c)
       : base("div")     // 調用基類建構函式，建立一個 Div
    {
       this.name = c.Name;      // 顏色名稱

       this.colorValue =        // 顏色的色彩值
           c.R * 256 * 256 + c.G * 256 + c.B;
       
       // 設定文本
       this.InnerHtml = String.Format("{0}<br />RGB({1},{2},{3})", name, c.R, c.G, c.B);

       int total = c.R + c.G + c.B;
       if (total <= 255)     // 如果底色太暗，前景色彩改為明色調
           this.Style.Add("color", "#eee");

       // 設定背景顏色
       this.Style.Add("background", String.Format("rgb({0},{1},{2})", c.R, c.G, c.B));
    }
    
    // 返回一個Comparer()用於排序
    public static ColorComparer GetComparer(SortBy sort) {
       return new ColorComparer(sort);
    }

    // 預設以名稱排序
    public static ColorComparer GetComparer() {
       return GetComparer(SortBy.Name);
    }
    
    // 巢狀型別，用於排序
    public class ColorComparer : IComparer<Div>
    {
       private SortBy sort;

       public ColorComparer(SortBy sort) {
           this.sort = sort;
       }

       // 實現IComparer<T>介面，根據sort判斷以何為依據一進排序
       public int Compare(Div x, Div y)
       {
           if (sort == SortBy.Name)
              return String.Compare(x.name, y.name);
           else
              return x.colorValue.CompareTo(y.colorValue);
       }
    }
}

在Page_Load事件上面，我們添加語句，擷取當前的排序依據(枚舉)：

SortBy sort;

if (!IsPostBack) {
    sort = SortBy.Name;
} else {
    sort = (SortBy)Enum.Parse(typeof(SortBy), rblSort.SelectedValue);
}

在將列表輸出到頁面之前，我們調用列表的Sort方法：

list.Sort(Div.GetComparer(sort));   // 對列表進行排序

foreach (Div item in list)   {
    pnColors.Controls.Add(item);
}

好了，所有工作都完成了，再次開啟頁面，可以看到類似如下畫面，我們可以按照名稱或者顏色值來對列表進行排序顯示：

總結

本文分三個部分講述了.Net中反射的一個應用：動態建立對象和調用對象方法(屬性、欄位)。我們先學習最常見的動態建立對象的兩種方式，隨後分別討論了使用Type.InvokeMember()和MethodInfo.Invoke()方法來調用類型的執行個體方法和靜態方法。最後，我們使用反射遍曆了System.Drawing.Color結構，並輸出了顏色值。

感謝閱讀，希望這篇文章能給你帶來協助！

.Net 中的反射(動態建立類型執行個體) - Part.4