C#_Extension Method技巧

-
 

C#預設有些函數功能在使用上可能會覺得有些微不足
因此偶而會想自行做擴充

擴充方法可讓您在現有類型中「加入」方法，而不需要建立新的衍生類型、重新編譯，或是修改原始類型。

別於自行定義的function  ，其可讓我們在現有的內建物件中做擴展方法。

可以在專案新增一個Extention目錄並額外新增一個class取名為CustomExtention
用public static修飾 裡面自行建立的各種method也必須是public static


Case.1 兩個Dictionary Merge的功能擴充
我想要實作Dictionary A 去merge Dictionary B返回一個合併的Dictionary的功能
由於.net Dictionary本身型別內建沒提供該功能


CustomExtension.cs

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ExtensionMethodApp.Extension
{
    public static class CustomExtension
    {
		public static Dictionary<Key, Value> MergeDic<Key, Value>(this Dictionary<Key, Value> left, Dictionary<Key, Value> right)
		{
			if (left == null)
			{
				throw new ArgumentNullException("Can't merge into a null dictionary");
			}
			else if (right == null)
			{
				return left;
			}

			foreach (var kvp in right)
			{
				if (!left.ContainsKey(kvp.Key))
				{
					left.Add(kvp.Key, kvp.Value);
				}
			}

			return left;
		}

	}
}



外部在使用時候引用該命名空間
using ExtensionMethodApp.Extension;

Program.cs

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
using ExtensionMethodApp.Extension;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ExtensionMethodApp
{
    class Program
    {
        static void Main(string[] args)
        {
            Dictionary<string, string> dicA = new Dictionary<string, string>();
            dicA.Add("A", "Almond");
            dicA.Add("B", "Berry");

            Dictionary<string, string> dicB = new Dictionary<string, string>();
            dicA.Add("C", "Cherry");
            dicA.Add("D", "Damson");

            Dictionary<string,string> dicRes = dicA.MergeDic(dicB);

            Console.ReadKey();
        }
    }
}







Case.2 判斷字串內文是否為Json格式的String 擴充
這裡我們補安裝完Newtonsoft.Json並引入相應namespace
於CustomExtension新增程式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ExtensionMethodApp.Extension
{
    public static class CustomExtension
    {
		public static Dictionary<Key, Value> MergeDic<Key, Value>(this Dictionary<Key, Value> left, Dictionary<Key, Value> right)
		{
			if (left == null)
			{
				throw new ArgumentNullException("Can't merge into a null dictionary");
			}
			else if (right == null)
			{
				return left;
			}

			foreach (var kvp in right)
			{
				if (!left.ContainsKey(kvp.Key))
				{
					left.Add(kvp.Key, kvp.Value);
				}
			}

			return left;
		}

        /// <summary>
        /// Determine input string is json format
        /// </summary>
        /// <param name="value"></param>
        /// <returns></returns>
        public static bool IsJsonFormat(this string value)
        {
            if (string.IsNullOrWhiteSpace(value))
                return false;

            if ((value.StartsWith("{") && value.EndsWith("}")) ||
                (value.StartsWith("[") && value.EndsWith("]")))
            {
                try
                {
                    var obj = JToken.Parse(value);
                    return true;
                }
                catch (JsonReaderException)
                {
                    return false;
                }
            }
            return false;
        }



    }
}



在外部調用測試是否為json格式時候就可以這樣子來判斷

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
using ExtensionMethodApp.Extension;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ExtensionMethodApp
{
    class Program
    {
        static void Main(string[] args)
        {
            string str_json = "";
            if (str_json.IsJsonFormat())
            {

            }
            else
            {
                str_json = "{'name':'John', 'age':30, 'car':null}";
                if (str_json.IsJsonFormat())
                {

                }
            }
            Console.ReadKey();
        }
    }
}





Case.3 Enum想要取實際的字串值定義而非原本的數字
實務上enum會因為相關的資料而去特別定義再一起的資料結構
然而直接透過enum預設數值編號不太容易識別
也會希望直接取得enum對應的字串值

C# Enum中我們可以自定義客製的attribute標記在enum項目上
比方像DescriptionAttribute

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
using ExtensionMethodApp.Extension;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ExtensionMethodApp
{
    class Program
    {
        public enum ContentTypeOption
        {
            [Description("application/x-www-form-urlencoded")]
            form_urlencoded,
            [Description("application/json")]
            json_format,
            [Description("application/xml")]
            xml_format,
            [Description("application/exchange+xml")]
            ex_xml_format,
            [Description("application/pdf")]
            pdf_format,
            [Description("application/msword")]
            msword_format,
            [Description("multipart/form-data")]
            multipart_form_data,
            [Description("text/plain")]
            text_plain,
            [Description("text/html")]
            text_html,
            [Description("text/xml")]
            text_xml,
            [Description("image/gif")]
            image_gif,
            [Description("image/png")]
            image_png,
            [Description("image/jpeg")]
            image_jpeg,
        }

        static void Main(string[] args)
        {
            ContentTypeOption contentTypeOption = ContentTypeOption.image_jpeg;            

            Console.ReadKey();
        }
    }
}



但功能仍不太足夠
因為我們想要去取得該字串描述的實質定義

此時我們可先去自己建立客製的Attribute

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ExtensionMethodApp.Extension
{
    public class StringValueAttribute : Attribute
    {
        public string StringValue { get; protected set; }

        public StringValueAttribute(string value)
        {
            this.StringValue = value;
        }
    }
}


之後再添增於enum項目中

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
using ExtensionMethodApp.Extension;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ExtensionMethodApp
{
    class Program
    {
        public enum ContentTypeOption
        {
            [StringValueAttribute("application/x-www-form-urlencoded")]
            form_urlencoded,
            [StringValueAttribute("application/json")]
            json_format,
            [StringValueAttribute("application/xml")]
            xml_format,
            [StringValueAttribute("application/exchange+xml")]
            ex_xml_format,
            [StringValueAttribute("application/pdf")]
            pdf_format,
            [StringValueAttribute("application/msword")]
            msword_format,
            [StringValueAttribute("multipart/form-data")]
            multipart_form_data,
            [StringValueAttribute("text/plain")]
            text_plain,
            [StringValueAttribute("text/html")]
            text_html,
            [StringValueAttribute("text/xml")]
            text_xml,
            [StringValueAttribute("image/gif")]
            image_gif,
            [StringValueAttribute("image/png")]
            image_png,
            [StringValueAttribute("image/jpeg")]
            image_jpeg,
        }

        static void Main(string[] args)
        {
            ContentTypeOption contentTypeOption = ContentTypeOption.image_jpeg;            

            Console.ReadKey();
        }
    }
}


接著進行Extension Method的擴充設計
由於有運用到Reflection的api因此
using System.Reflection;記得引入

在此擴充GetStringValue
用於直接取得enum item的string attribute

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;
using System.Threading.Tasks;

namespace ExtensionMethodApp.Extension
{
    public static class CustomExtension
    {
        /// <summary>
        /// Will get the string value for a given enums value, this will
        /// only work if you assign the StringValue attribute to
        /// the items in your enum.
        /// </summary>
        /// <param name="value"></param>
        /// <returns></returns>
        public static string GetStringValue(this Enum value)
        {
            Type type = value.GetType();
            FieldInfo fieldInfo = type.GetField(value.ToString());
            StringValueAttribute[] attribs = fieldInfo.GetCustomAttributes(typeof(StringValueAttribute), false) as StringValueAttribute[];
            return attribs.Length > 0 ? attribs[0].StringValue : null;
        }


        public static Dictionary<Key, Value> MergeDic<Key, Value>(this Dictionary<Key, Value> left, Dictionary<Key, Value> right)
		{
			if (left == null)
			{
				throw new ArgumentNullException("Can't merge into a null dictionary");
			}
			else if (right == null)
			{
				return left;
			}

			foreach (var kvp in right)
			{
				if (!left.ContainsKey(kvp.Key))
				{
					left.Add(kvp.Key, kvp.Value);
				}
			}

			return left;
		}

        /// <summary>
        /// Determine input string is json format
        /// </summary>
        /// <param name="value"></param>
        /// <returns></returns>
        public static bool IsJsonFormat(this string value)
        {
            if (string.IsNullOrWhiteSpace(value))
                return false;

            if ((value.StartsWith("{") && value.EndsWith("}")) ||
                (value.StartsWith("[") && value.EndsWith("]")))
            {
                try
                {
                    var obj = JToken.Parse(value);
                    return true;
                }
                catch (JsonReaderException)
                {
                    return false;
                }
            }
            return false;
        }



    }
}



而在外部調用時候就能成功把string 屬性的定義取出









擴充方法 (C# 程式設計手冊)
https://docs.microsoft.com/zh-tw/dotnet/csharp/programming-guide/classes-and-structs/extension-methods














留言

張貼留言

這個網誌中的熱門文章

何謂淨重(Net Weight)、皮重(Tare Weight)與毛重(Gross Weight)

-
圖片
當談到貨物的重量時，往往會分成所謂的淨重(Net Weight)與毛重(Gross Weight)。 會有以下公式關係存在 淨重=毛重-皮重(包裝物的重量) 毛重=淨重+皮重 淨重( Net Weight 縮寫為N.W.) 指物品本身的重量，不包括容器或包裝材料的重量。 凈重是國際貿易中最常見的計重辦法。 例如，如果運輸原材料，原材料的重量就是所運輸貨物的淨重。包裝原材料的容器或包裝不計入淨重。同樣地，當我們考慮一罐豆子時，罐子內所含物品的重量就算作淨重。因此，淨重將包括豆子、罐頭里的任何液體，以及保存豆子所含的物品。 大多數 以重量為計價的貨物買賣 ，採用此計價方法。 若合同中並未明確規範以何種方式計量和計價時，按慣例以凈重計價。 毛重( Gross Weight 縮寫G.W.) 貨物連同它的包裝的重量，是你托運的所有物品的總重量。 皮重(Tare Weight) 指商品外包裝材料的重量(即運輸包裝的重量)，不包括內包裝材料和襯墊物的重量。 比方一個空的貨櫃、容器、或任何包裝材料的重量。 Net Net Weight純淨重 (指從Net Weight中扣除內包裝後的重量) 進出口商品為了因應運輸及消費需求, 一般都有內包裝與外包裝。 一般在買賣合同與信用狀中,通常只要求於裝箱單上註明Gross Weight和Net Weight即可, 但有些L/C 要求 Net Net Weight,大多是海關徵收從量稅時的依據 運輸重量對於航運業或者航空運輸等各自都通用這些術語 為何特別在意重量? 主要就在於會影響像是傳輸安全乘載限制。 就運輸層面(不同方式的運輸) 航空運輸：對機長而言，毛重包括皮重、產品淨重以及飛機、燃料、乘客和機組人員的重量。 公路/鐵路運輸:對於火車車長而言，毛重包括產品淨重、皮重和運輸車輛的重量。 水路航運運輸：對船長而言，毛重就是淨重和皮重之和。 就公司ERP成本角度 成本一般都會採用 "淨重" 主要是因為若用毛重，可能會有輔材不可控因素存在 比方一個 5cm 固定塑膠件，今天用一個 10cm 紙箱測重，明天用一個 100cm 紙箱測重，那可能就容易導致ERP資料比較會失真。 就物流層面來探討 通常還會有一名詞即所謂「實際重量」(Actual Weight) 根據稱重(過磅)所得到的重量，實際重量分為實際毛重(Gross Weig...
閱讀完整內容

Architecture(架構) 和 Framework(框架) 有何不同?_軟體設計前的事前規劃的藍圖概念

-
圖片
一個應用程式(軟體) 不管是  互動拍照 也好、 投影也好、車牌偵測... 舞台演唱會後方電視牆的互動應用程序、 粒子特效、3D或2D遊戲  等等 開發者通常都需要在一開始做規劃 ㄟ  假設我今天要寫 跟影像有關 可能需要偵測、可能需要提取前景、可能需要偵測圓形 之類的 我有  emgucv 、AForge.Net、 opencv 等等可以用 但是 假設我今天要做的應用程序是需要有視窗介面的~~ emgucv 跟 C# windows form 媒合性 就很高 而且直接在 visual studio 做開發 opencv 我可能還需要依賴 Qt 之類等等  framework 假設我今天是要寫一個 演唱會電視牆互動粒子特效 可能就會挑   openframeworks  、 processing 、kinect 來寫互動 Achitecture  --->全稱 :  Software Architecture   軟體架構 Achitecture   由好多 framework 組成 軟體架構（Software Architecture）是一種軟體在開發前的設計藍圖， 用來告訴軟體的結構，功能，介面，用法，與其他系統的構連以及資料交換等等規範， 但它並沒有叫你要用什麼方式實作， 因此軟體架構通常會產生文件，圖樣，原型以及規格等， 就是沒有可用的程式碼，因為那不是軟體架構應該有的東西， 就像蓋房子時是給你藍圖，而不是一幢蓋好的房子。 軟體框架（Framework):是一個已經成形的方法，而且有程式碼實體 （例如鋼構工法也是要有鋼材才能做），並且會告訴你要如何使用它 （即 Framework Documentation，MSDN Library 即為一最佳例子）
閱讀完整內容

經得起原始碼資安弱點掃描的程式設計習慣培養(五)_Missing HSTS Header

-
圖片
  接續前幾篇系列 經得起原始碼資安弱點掃描的程式設計習慣培養(一)_OWASP Top 10(十大網站安全風險)_學習寫更安全程式碼的網站推薦 經得起原始碼資安弱點掃描的程式設計習慣培養(二)_8.Insecure Deserialization ：不安全的反序列化漏洞ASP.NET處理方式 經得起原始碼資安弱點掃描的程式設計習慣培養(三)_7.Cross Site Scripting(XSS)_Stored XSS_Reflected XSS All Clients 經得起原始碼資安弱點掃描的程式設計習慣培養(四)_1.Injection注入攻擊_SQL Injection)_order by 語句正確參數化套入 最近又遇到被若安掃描到高風險要修正的程式碼啦.... 一看這還真是搞不懂該怎麼修呢 HSTS(HTTP Strict Transport Security)  主要是一份國際標準規格 (RFC 6797) 的網際網路瀏覽安全機制， 用於宣告瀏覽器與伺服器之間通訊方式必須強制採用 TLS/SSL 加密通道。 只要從伺服器端送出一個 Strict-Transport-Security 標頭 (Header) 給瀏覽器，即可告知瀏覽器於未來的某段時間內一律使用 SSL 來和該網站連接 (設定可涵蓋所有子域名網站)， 一旦發生憑證失效情況，使用者將無法再瀏覽該網站，如此一來便可大幅減少中間人攻擊的問題發生。 再更白話一點 HSTS Header 就是負責將 http 強制轉為 https CheckMarx掃碼報告給的說明 ============================================================ 風險: 如果web config沒有設置HSTS表頭、"max-age"(有效期)不足一年， 或沒有設定"includeSubDomains"(包含所有子網域)，可能會使用戶容易遭受中間人攻擊。 發生原因: 許多使用者只要在瀏覽器的網址列輸入網域名稱(Domain Name)即可瀏覽網站， 並沒有輸入協定(Protocol)的名稱。 瀏覽器會自動假設使用者使用的是HTTP協定而不是有加密機制的HTTPS協定。 在第一次發出前往特定網站的請求時，攻擊者可以執行中間人攻擊並將用戶轉址到...
閱讀完整內容