【Github原始碼】
《上一篇》 介紹了Xmtool工具庫中的圖形驗證碼類庫,今天我們繼續為大家介紹其中的擴充套件動態物件類庫。
擴充套件動態物件是整個工具庫中最重要的一個設計。在軟體開發過程中,我們經常需要定義各種各樣的資料物件;例如:用於引數傳遞的資料實體類、用於介面返回結果的Json物件等等。
// 人員資料實體定義
public class Person
{
public string Name { get; set; } = null;
public int Age { get; set; } = 0;
}
當我們遇到的場景越多、越複雜,我們需要定義和維護的這種類也會更多;這無疑是一種負擔,且這個過程相當枯燥和乏味。在編譯型程式語言Javascript中,變數是沒有強制指定型別的,使用者使用時可以隨意賦值;這讓開發人員在使用過程中會非常靈活且方便;參考這種特性,並基於系統DynamicMetaObject物件,我們封裝了DynamicObjectExt物件,我們稱之為擴充套件動態物件,它實現了無需定義直接賦值的形式使用資料物件,像Javascript中一樣簡單和靈活,幫我們簡化了大量的定義過程。
// 直接建立物件,並根據實際資料物件結構進行賦值即可
dynamic person = Xmtool.DynamicObject();
person.Name = "softwaiter";
person.Age = 18;
// TODO
除了這種基本能力之外,擴充套件物件中還提供了豐富的方法,用於對動態物件進行更多的判斷和控制,使之能夠滿足各種各樣的應用場景。
1. this屬性
說明:根據指定屬性名稱獲取屬性值。
dynamic person = Xmtool.DynamicObject();
person.Name = "softwaiter";
person.Age = 18;
Console.WriteLine(pernson["Name"]); // 列印Name屬性值,輸出softwaiter
2. TrySetValue方法
public bool TrySetValue(string name, object value)
說明:嘗試為指定name的屬性賦值,賦值成功返回true;否則返回false。
引數:
name:準備賦值的屬性名稱。
value:屬性賦值內容。
3. TryGetValue方法
public bool TryGetValue(string name, out object result)
說明:嘗試從指定name的屬性獲取值,獲取成功返回true;否則返回false。
引數:
name:準備取值的屬性名稱。
result:獲取到的屬性值;為獲取到將返回null。
4. GetValue方法
public object GetValue(string name)
說明:返回指定name的屬性值;不存在找到則返回null。
引數:
name:屬性名稱。
5. GetValueByPath方法
public object GetValueByPath(string path)
說明:GetValue方法的擴充套件,GetValueByPath能獲取多層級屬性的值。
引數:
path:多層級屬性路徑,中間用“.”連線。
dynamic person = Xmtool.DynamicObject();
person.Name = "softwaiter";
person.Age = 18;
person.Pet = Xmtool.DynamicObject();
person.Pet.Name = "Tom";
person.Pet.Kind = "Cat";
Console.WriteLine(pernson.GetValueByPath("Pet.Name")); // 列印寵物名稱,輸出Tom
6. SetValue方法
public object SetValue(string name, object value)
說明:為指定name的屬性設定值。
引數:
name:準備設定值得屬性名稱。
value:屬性值內容。
7. SetValueByPath方法
public bool SetValueByPath(string path, object value)
說明:SetValue方法的擴充套件,SetValueByPath能設定多層級屬性的值。
引數:
path:多層級屬性路徑,中間用“.”連線。
value:屬性值內容。
dynamic person = Xmtool.DynamicObject();
person.Name = "softwaiter";
person.Age = 18;
person.Pet = Xmtool.DynamicObject();
person.Pet.Name = "Tom";
person.Pet.Kind = "Cat";
person.SetValueByPath("Pet.Name", "Chika");
Console.WriteLine(pernson.GetValueByPath("Pet.Name")); // 列印寵物名稱,輸出Chika
8. Has方法
public bool Has(string key)
說明:判斷是否包含指定屬性。
引數:
key:屬性名稱。
9. HasPath方法
public bool HasPath(string path)
說明:Has方法的擴充套件,HasPath能判斷多層級屬性是否存在。
引數:
path:多層級屬性路徑,中間用“.”連線。
dynamic person = Xmtool.DynamicObject();
person.Name = "softwaiter";
person.Age = 18;
person.Pet = Xmtool.DynamicObject();
person.Pet.Name = "Tom";
person.Pet.Kind = "Cat";
if (person.HasPath("Pet.Name"))
{
// TODO
}
10. Remove方法
public bool Remove(string key)
說明:從物件上刪除指定的屬性。
引數:
key:屬性名稱。
11. RemovePath方法
public bool RemovePath(string path)
說明:Remove方法的擴充套件,RemovePath能刪除多層級屬性。
引數:
path:多層級屬性路徑,中間用“.”連線。
dynamic person = Xmtool.DynamicObject();
person.Name = "softwaiter";
person.Age = 18;
person.Pet = Xmtool.DynamicObject();
person.Pet.Name = "Tom";
person.Pet.Kind = "Cat";
person.RemovePath("Pet.Kind");
if (person.HasPath("Pet.Kind")) // 將返回false
{
// TODO
}
12. ToString方法
public override string ToString()
說明:將物件序列化為JSON字串並返回;常用於API介面結果返回。
dynamic person = Xmtool.DynamicObject();
person.Name = "softwaiter";
person.Age = 18;
string json = person.ToString();
Console.WriteLine(json); // 輸出{"Name":"softwaiter","Age":18}
13. ToXMLString方法
public string ToXMLString(string defaultNS = "")
說明:將物件序列化為XML字串並返回。
引數:
defaultNS:預設名稱空間。
dynamic person = Xmtool.DynamicObject();
person.Name = "softwaiter";
person.Age = 18;
string xml = person.ToXMLString();
Console.WriteLine(xml); //輸出<xml><Name>softwaiter</Name><Age>18</Age></xml>
string xml2 = person.ToXMLString("http://www.xmltool.com");
Console.WriteLine(xml2); //輸出<xml xmlns="http://www.xmltool.com"><Name>softwaiter</Name><Age>18</Age></xml>