詳解C#編程中的反射機(jī)制與方法
編輯推薦《C#實(shí)用基礎(chǔ)教程》
Reflection,中文翻譯為反射。這是.Net中獲取運(yùn)行時(shí)類型信息的方式,.Net的應(yīng)用程序由幾個(gè)部分:‘程序集(Assembly)’、‘模塊(Module)’、‘類型(class)’組成,而反射提供一種編程的方式,讓程序員可以在程序運(yùn)行期獲得這幾個(gè)組成部分的相關(guān)信息,例如:Assembly類可以獲得正在運(yùn)行的裝配件信息,也可以動(dòng)態(tài)的加載裝配件,以及在裝配件中查找類型信息,并創(chuàng)建該類型的實(shí)例。Type類可以獲得對(duì)象的類型信息,此信息包含對(duì)象的所有要素:方法、構(gòu)造器、屬性等等,通過(guò)Type類可以得到這些要素的信息,并且調(diào)用之。MethodInfo包含方法的信息,通過(guò)這個(gè)類可以得到方法的名稱、參數(shù)、返回值等,并且可以調(diào)用之。諸如此類,還有FieldInfo、EventInfo等等,這些類都包含在System.Reflection命名空間下。
一、Type類于獲取類型信息
System.Type 類對(duì)于反射起著核心的作用。當(dāng)反射請(qǐng)求加載的類型時(shí),公共語(yǔ)言運(yùn)行庫(kù)將為它創(chuàng)建一個(gè) Type。您可以使用 Type 對(duì)象的方法、字段、屬性和嵌套類來(lái)查找有關(guān)該類型的所有信息。
大家運(yùn)行一下下面的代碼根據(jù)結(jié)果分析一下就能比較清楚的理解Type了
獲取類型信息
namespace ConsoleApplication2
{
class Program
{
static void Main(string[] args)
{
MyClass m = new MyClass();
Type type = m.GetType();
Console.WriteLine("類型名:" + type.Name);
Console.WriteLine("類全名:"+type.FullName);
Console.WriteLine("命名空間名:"+type.Namespace);
Console.WriteLine("程序集名:"+type.Assembly);
Console.WriteLine("模塊名:"+type.Module);
Console.WriteLine("基類名:"+type.BaseType);
Console.WriteLine("是否類:"+type.IsClass);
Console.WriteLine("類的公共成員:");
MemberInfo[] memberInfos = type.GetMembers();//得到所有公共成員
foreach (var item in memberInfos)
{
Console.WriteLine("{0}:{1}",item.MemberType,item);
}
}
}
class MyClass
{
public string m;
public void test()
{ }
public int MyProperty { get; set; }}
}
二、獲取程序集元數(shù)據(jù)
Assembly類定義了一個(gè)程序集,它是一個(gè)可重用、無(wú)版本沖突并且可自我描述的公共語(yǔ)言運(yùn)行庫(kù)應(yīng)用程序構(gòu)造塊。因?yàn)槌绦蚣惺鞘褂迷獢?shù)據(jù)進(jìn)行自我描述的,所以我們就能通過(guò)其元數(shù)據(jù)得到程序集內(nèi)部的構(gòu)成。結(jié)合Assembly和反射能夠獲取程序集的元數(shù)據(jù),但是首先要將程序集裝入內(nèi)存中??梢允褂肁ssembly類的多種靜態(tài)Load方法加載程序集。
下面的程序顯示程序集的信息
public static void Main()
{
//獲取當(dāng)前執(zhí)行代碼的程序集
Assembly assem = Assembly.GetExecutingAssembly();Console.WriteLine("程序集全名:"+assem.FullName);
Console.WriteLine("程序集的版本:"+assem.GetName().Version);
Console.WriteLine("程序集初始位置:"+assem.CodeBase);
Console.WriteLine("程序集位置:"+assem.Location);
Console.WriteLine("程序集入口:"+assem.EntryPoint);Type[] types = assem.GetTypes();
Console.WriteLine("程序集下包含的類型:");
foreach (var item in types)
{
Console.WriteLine("類:"+item.Name);
}
}
三、動(dòng)態(tài)加載類型
早綁定是在編譯時(shí)綁定對(duì)象類型,而晚綁定是在運(yùn)行時(shí)才綁定對(duì)象的類型。利用反射可以實(shí)現(xiàn)晚綁定,即動(dòng)態(tài)加載類型,并調(diào)用他們的方法,下邊是MSDN中的一個(gè)例子,詳細(xì)的解釋信息見(jiàn)注釋
動(dòng)態(tài)加載類型
namespace ConsoleApplication2
{
public class Example
{
private int factor;
public Example(int f)
{
factor = f;
}public int SampleMethod(int x)
{
Console.WriteLine("\nExample.SampleMethod({0}) executes.", x);
return x * factor;
}public static void Main()
{
//獲取當(dāng)前執(zhí)行代碼的程序集
Assembly assem = Assembly.GetExecutingAssembly();Console.WriteLine("Assembly Full Name:");
Console.WriteLine(assem.FullName);// The AssemblyName type can be used to parse the full name.
AssemblyName assemName = assem.GetName();
Console.WriteLine("\nName: {0}", assemName.Name);
Console.WriteLine("Version: {0}.{1}",
assemName.Version.Major, assemName.Version.Minor);
Console.WriteLine("\nAssembly CodeBase:");
Console.WriteLine(assem.CodeBase);
// 從程序集眾創(chuàng)建一個(gè)Example實(shí)例并且用object類型的引用o指向它,同時(shí)調(diào)用一個(gè)輸入?yún)?shù)的構(gòu)造函數(shù)
Object o = assem.CreateInstance("ConsoleApplication2.Example", false,
BindingFlags.ExactBinding,
null, new Object[] { 2 }, null, null);//構(gòu)造Example類的一個(gè)晚綁定的方法SampleMethod
MethodInfo m = assem.GetType("ConsoleApplication2.Example").GetMethod("SampleMethod");
//調(diào)用剛才實(shí)例化好的Example對(duì)象o中的SampleMethod方法,傳入的參數(shù)為42
Object ret = m.Invoke(o, new Object[] { 42 });
Console.WriteLine("SampleMethod returned {0}.", ret);Console.WriteLine("\nAssembly entry point:");
Console.WriteLine(assem.EntryPoint);
}
}
反射特性:
[Table(Name="dbo.[User]")] |
當(dāng)C#編譯器發(fā)現(xiàn)這個(gè)屬性有一個(gè)特性Table時(shí),首先會(huì)把字符串Attribute添加到這個(gè)名稱的后面,形成一個(gè)組合名稱TableAttribute,然后在其搜索路徑的所有命名空間中搜索有相同類名的類。但要注意,如果該特性名結(jié)尾是Attribute,編譯器就不會(huì)把該字符串加到組合名稱中。所有的特性都是從System.Attribute類型上面派生的。
接著我們來(lái)看一下Table特性的定制格式
[AttributeUsageAttribute(AttributeTargets.Class,Inherited=true,AllowMultiple=false)] |
在定義類型時(shí)使用System.AttributeUsage特性來(lái)表明這個(gè)自定義特性的使用范圍,這里使用了Class樣式,表示TableAttribute特性只能用在其它的Class類型前面,若放置在Interface或Struct類型前面,或者放在對(duì)象成員的前面則會(huì)出現(xiàn)編譯錯(cuò)誤。這里還是用語(yǔ)句 AllowMultiple=false 語(yǔ)句來(lái)表明對(duì)于一個(gè)類型,該特性只能用一次,若一個(gè)Class類型前面出現(xiàn)多個(gè)TableAttribute,則會(huì)出現(xiàn)編譯錯(cuò)誤。若設(shè)置AllowMultiple=true,則該特性可以多次定義,也就是一個(gè)Class類型前面可以出現(xiàn)多個(gè)相同類型的特性。不過(guò)這里我們假設(shè)一個(gè)對(duì)象只能映射到一個(gè)數(shù)據(jù)表上,沒(méi)有多重映射,因此就指明對(duì)同一個(gè)類型該特性不能多次使用。Inherited參數(shù)設(shè)定為true,就表示應(yīng)用到類或接口上的特性也可以自動(dòng)應(yīng)用到所派生的類或接口上。
我們?cè)倏匆幌露ㄖ芓albeAttribute特性的完整例子:
[AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
public class TableAttribute : Attribute
{
//保存表名的字段
private string _tableName;public TableAttribute()
{
}public TableAttribute(string tableName)
{
this._tableName = tableName;
}///
/// 映射的表名(表的全名:模式名.表名)
///
public string TableName
{
set
{
this._tableName = value;
}
get
{
return this._tableName;
}
}
}
特性也是一個(gè)Class類型,可以有多個(gè)構(gòu)造函數(shù),就像C#的new語(yǔ)句一樣,我們向類型附加特性時(shí)可以使用不同的初始化參數(shù)來(lái)指明使用特性的那個(gè)構(gòu)造函數(shù)。我們附加特性時(shí)還可以使用“屬性名=屬性值”的方法來(lái)直接指明特性的屬性值。該特性中定義了一個(gè)TableName屬性,該屬性就是被修飾的對(duì)象所映射的數(shù)據(jù)庫(kù)表的名稱。
下面我們舉一個(gè)使用特性來(lái)進(jìn)行O/RMapping的例子,也就是將對(duì)象轉(zhuǎn)化成Sql語(yǔ)句
用戶類:
User類
[Table("User")] |
表特性
[AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
public class TableAttribute : Attribute
{
//保存表名的字段
private string _tableName;public TableAttribute()
{
}public TableAttribute(string tableName)
{
this._tableName = tableName;
}///
/// 映射的表名(表的全名:模式名.表名)
///
public string TableName
{
set
{
this._tableName = value;
}
get
{
return this._tableName;
}
}
}
列特性:
[AttributeUsageAttribute(AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
public class ColumAttribute : Attribute
{
private string _columName;private DbType _dbType ;
public ColumAttribute()
{
}public ColumAttribute(string columName)
: this()
{
this._columName = columName;
}
public ColumAttribute(string columName, DbType dbType)
: this(columName)
{
this._dbType = dbType;
}//列名
public virtual string ColumName
{
set
{
this._columName = value;
}
get
{
return this._columName;
}
}//描述一些特殊的數(shù)據(jù)庫(kù)類型
public DbType DbType
{
get { return _dbType; }
set { _dbType = value; }
}}
ORMHelp
public class ORMHelp
{
public void Insert(object table)
{
Type type = table.GetType();
//定義一個(gè)字典來(lái)存放表中字段和值的對(duì)應(yīng)序列
DictionarycolumValue = new Dictionary ();
StringBuilder SqlStr=new StringBuilder();
SqlStr.Append("insert into ");
//得到表名子
TableAttribute temp = (TalbeAttribute)type.GetCustomAttributes(typeof(TalbeAttribute), false).First();
SqlStr.Append(temp.TableName);
SqlStr.Append("(");
PropertyInfo[] Propertys=type.GetProperties();
foreach (var item in Propertys)
{
object[] attributes = item.GetCustomAttributes(false);
foreach (var item1 in attributes)
{
//獲得相應(yīng)屬性的值
string value= table.GetType().InvokeMember(item.Name, System.Reflection.BindingFlags.GetProperty, null, table, null).ToString();
ColumAttribute colum = item1 as ColumAttribute;
if (colum != null)
{
columValue.Add(colum.ColumName,value);
}
}
}
//拼插入操作字符串
foreach (var item in columValue)
{
SqlStr.Append(item.Key);
SqlStr.Append(",");}
SqlStr.Remove(SqlStr.Length-1, 1);
SqlStr.Append(") values('");
foreach (var item in columValue)
{
SqlStr.Append(item.Value);
SqlStr.Append("','");
}
SqlStr.Remove(SqlStr.Length - 2, 2);
SqlStr.Append(")");
Console.WriteLine(SqlStr.ToString());
}
}
SqlStr中的內(nèi)容為insert into User(userID,UserName) values('1','lfm')
前端使用代碼:
前端代碼
static void Main(string[] args) |
應(yīng)用
例子這個(gè)東西其實(shí)挺難弄得,弄個(gè)簡(jiǎn)單的,雖然能說(shuō)明問(wèn)題但卻容易讓人覺(jué)得沒(méi)實(shí)用價(jià)值,弄個(gè)有實(shí)用價(jià)值卻又往往牽扯很多別的技術(shù)甚至牽扯很多業(yè)務(wù)邏輯,看起來(lái)很復(fù)雜很難懂。在這里我盡量追求幾個(gè)有實(shí)用價(jià)值又不復(fù)雜的例子。
#p#
1、使用反射通過(guò)讀取配置文件來(lái)動(dòng)態(tài)的創(chuàng)建相關(guān)類的對(duì)象
我們先來(lái)看看Main函數(shù)和需要?jiǎng)討B(tài)加載的對(duì)象在同一個(gè)程序集的情況
結(jié)構(gòu)圖:
接口
interface ILog
{
bool Write(string message);
bool Write(Exception ex);
}
TextFileLog
class TextFileLog : ILog
{
public bool Write(string message)
{
string fileDir = ConfigurationManager.AppSettings["LogTarget"].ToString();
using (StreamWriter w = File.AppendText(fileDir))
{
// w.Write(" Log Entry : ");
w.WriteLine("發(fā)生時(shí)間{0}", DateTime.Now.ToLocalTime().ToString());
w.WriteLine("日志內(nèi)容為:{0}", message);
w.WriteLine("-------------------------------");
// Update the underlying file.
w.Flush();
w.Close();
}
return true;
}
public bool Write(Exception ex)
{
Write(ex.Message);
return true;
}
}
XmlFileLog
class XmlFileLog : ILog
{
public bool Write(string message)
{
string xmlFilePath = ConfigurationManager.AppSettings["LogTarget"].ToString();
if (File.Exists(xmlFilePath))
{
XmlDocument doc = new XmlDocument();
doc.Load(xmlFilePath);
XmlDocumentFragment docFrag = doc.CreateDocumentFragment();
XmlNode nod = doc.SelectSingleNode("Logs");
docFrag.InnerXml = "
nod.AppendChild(docFrag);
doc.Save(xmlFilePath);
return true;
}
else
{
XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true; //設(shè)置縮進(jìn)
settings.ConformanceLevel = ConformanceLevel.Auto;
settings.IndentChars = " ";
settings.OmitXmlDeclaration = false;
using (XmlWriter writer = XmlWriter.Create(xmlFilePath, settings))
{
//Start writing the XML document
writer.WriteStartDocument(false);
//Start with the root element
writer.WriteStartElement("Logs");
writer.WriteStartElement("Log");
writer.WriteStartElement("Time");
writer.WriteString(DateTime.Now.ToLocalTime().ToString());
writer.WriteEndElement();
writer.WriteStartElement("Message");
writer.WriteString(message);
writer.WriteEndElement();
writer.WriteEndElement();
writer.WriteEndDocument();
//Flush the object and write the XML data to the file
writer.Flush();
return true;
}
}
}
public bool Write(Exception ex)
{
Write(ex.Message);
return true;
}
}
App.config配置
<configuration>
<appSettings>
<add key="LogType" value="LogClassLibrary.TextFileLog"/>
<!--
本程序集配置
<add key="LogType" value="ConsoleApplication2.Log例子.TextFileLog"/>
-->
<!-- XmlFileLog TextFileLog-->
<add key="LogTarget" value="c:\log.txt"/>
</appSettings>
</configuration>
主程序
public static void Main() |
如果在不同的程序集下,那主函數(shù)和配置會(huì)略有不同
不同程序集主函數(shù)
public static void Main() |
這部分源碼下載
2、插件編程技術(shù)
插件是指遵循一定的接口規(guī)范、可以動(dòng)態(tài)加載和運(yùn)行的程序模塊。從上面的例子可以看出,通過(guò)反射可以非常方便的動(dòng)態(tài)加載程序集。因此,利用反射的動(dòng)態(tài)加載代碼能力,可以很容易的實(shí)現(xiàn)插件。插件編程的要點(diǎn)是使用接口來(lái)定義插件的功能特征。插件的宿主程序通過(guò)接口來(lái)確認(rèn)、裝載和執(zhí)行插件的功能,實(shí)現(xiàn)插件功能的所有類都必須實(shí)現(xiàn)定義插件的接口。
這里只是選貼一部分代碼,詳細(xì)分析請(qǐng)看源碼
結(jié)構(gòu)圖
接口部分
接口
public interface IHost
{
ListPlugins { get; }
int LoadPlugins(string path);
ILog GetLog(string name);}
public interface ILog
{
bool Write(string message);
bool Write(Exception ex);}
public class Host : IHost
{
private Listplugins = new List ();
#region IHost 成員public List
Plugins
{
get { return plugins; }
}public int LoadPlugins(string path)
{
string[] assemblyFiles = Directory.GetFiles(path, "*.dll");
foreach (var file in assemblyFiles)
{
Assembly assembly = Assembly.LoadFrom(file);
foreach (var type in assembly.GetExportedTypes())
{
if (type.IsClass && typeof(ILog).IsAssignableFrom(type))
{
ILog plugin = Activator.CreateInstance(type) as ILog;
plugins.Add(plugin);}
}
}
return plugins.Count;
}public ILog GetLog(string name)
{
foreach (var item in plugins)
{
if (item.GetType().ToString()==name)
{
return item;
}
}
return null;
}#endregion
}
ILog的實(shí)現(xiàn)和上例基本一樣,請(qǐng)參考主程序代碼static void Main(string[] args)
{
Host.Host host = new Host.Host();
host.LoadPlugins(".");
InterfaceLayer.ILog log = host.GetLog(ConfigurationManager.AppSettings["LogType"].ToString());
log.Write(new Exception("異常測(cè)試"));
}
插件編程源碼下載
3、分析對(duì)象,得到對(duì)象中的屬性值
大家使用應(yīng)都用過(guò)asp.net中的DropdownList,在綁定其值的時(shí)候絕大多數(shù)情況下我們做的都是同樣的事情,獲得數(shù)據(jù)源,根據(jù)數(shù)據(jù)源中的某些列綁定控件,下邊我們來(lái)說(shuō)說(shuō)通用情況的處理方式。我們只需要提供數(shù)據(jù)集合,以及需要綁定到控件的兩個(gè)屬性(text,value)名即可。
public class DDlControl
{
private ListControl underlyingList;public DDlControl(ListControl underlyingList)
{
this.underlyingList = underlyingList;
}public void Add(IDDL ddl)
{
underlyingList.Items.Add(new ListItem(ddl.Name, ddl.Value));
}
public void Add(T t, string nameStr, string valueStr)
{
string name = Convert.ToString(t.GetType().InvokeMember
(nameStr, System.Reflection.BindingFlags.GetProperty, null, t, null));
string value = Convert.ToString(t.GetType().InvokeMember
(valueStr, System.Reflection.BindingFlags.GetProperty, null, t, null));
Add(new DDLStruct(name,value));
}
public void Clear()
{
underlyingList.Items.Clear();
}public IDDL SelectedItem
{
get
{
ListItem item = underlyingList.SelectedItem;
return new DDLStruct(item.Text, item.Value);
}
}public void BindTo
(IEnumerable list, string nameStr, string valueStr)
{
Clear();
foreach (var item in list)
{
Add(item, nameStr, valueStr);
}
}
public string SelectValue
{
get
{
return underlyingList.SelectedValue;
}
set
{
underlyingList.SelectedValue=value;
}
}
}
public struct DDLStruct
{
public DDLStruct(string name, string value)
{
this.name = name;
this.value = value;
}
private string name;
private string value;
public string Name
{
get { return name; }
}public string Value
{
get { return value; }
}
}
【編輯推薦】