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














留言

張貼留言

這個網誌中的熱門文章

經得起原始碼資安弱點掃描的程式設計習慣培養(五)_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協定。 在第一次發出前往特定網站的請求時，攻擊者可以執行中間人攻擊並將用戶轉址到
閱讀完整內容

經得起原始碼資安弱點掃描的程式設計習慣培養(三)_7.Cross Site Scripting(XSS)_Stored XSS_Reflected XSS All Clients

-
圖片
  近期新加入的功能code剛好也被CheckMarx掃出高風險部分的程式碼漏洞 我也踏到這個Issue啦 Cross Site Scripting(XSS)  第一種.Stored XSS 高風險 CheckMarx掃碼報告給的說明[Stored XSS] ============================================================ 風險: 攻擊者可以利用合法存取應用程式提交資料到資料庫。 當另一個使用者隨後存取該資料，網頁可能會被改寫且惡意腳本可能會被啟動。 發生原因: 從資料庫中的資料建立網頁。資料直接嵌入至HTML的頁面，利用瀏覽器顯示。 資料可能源自於其他使用者的輸入。 如果資料包含HTML片段或Javascript，使用者無法分辨是否為預期的頁面。 該漏洞主因為未先對嵌入資料庫中的資料進行編碼(Encode) 來預防瀏覽器將其當為HTML的格式而非純文字。 如何避免: 1.驗證所有資料，無論其來源為何。驗證應基於白名單：僅接受預定結構的資訊，而不是拒絕不良的樣式(Patterns)。  應確認：  ● 資料型態  ● 大小  ● 範圍  ● 格式  ● 期望值  2. 驗證無法取代編碼. 輸出嵌入之前，不論其來源， 將所有動態資料進行編碼. 編碼方式應該是上下文相關的. 例如: ● HTML內容使用HTML的編碼方式  ● HTML編碼特性是將資料輸出到特性的值 ● JavaScript的編碼方式為伺服器產生的Javascript  3.考慮使用ESAPI的編碼庫，或它的內置功能。對於舊版的ASP.NET，請考慮使用AntiXSS.  4.在HTTP類型對應的表頭， 明確定義整個頁面的字元編碼.  5. 設置 httpOnly 標誌於會期資訊，以防止利用XSS來竊取資訊. ============================================================ 這裡報告描述是指我對傳進來字串參數直接拋給DAL處裡的類別執行查詢 這裡缺乏對輸入進來的字串參數做一些查檢判斷 也建議在帶入時對參數也做一些html encode處理 這裡用AntiXSS來Encode 第二種.Reflected XSS All Clients 高風險 CheckMarx掃碼報告給的說明[Reflecte
閱讀完整內容

(2021年度)駕訓學科筆試準備題庫歸納分析_法規是非題

-
圖片
  若是出現 「必須」、「必需」、「...必...」、「應由」、「應先」、「應...」 則很高機率是圈 是非通常只要是如下字眼 「不必」+動詞 、「不需」「不須」、「可不」、「可以不」、「可立即」 有出現或符合的都選叉 (X)1.違規記點又不登記在駕照上，所以可以 不必理會 而任意違反交通規則。 (X)2.發生重大交通事故，為迅速恢復交通，清除現場，可 不必等待 肇事處理機關之指示，即可進行。 (X)3.道路駕駛練習，行車前 不必實施 車輛安全檢查，因為那是駕駛教練的工作。 (X)4.開車前， 不必檢查 機件安全，但在行駛中要隨時注意儀錶功能顯示，確保行車安全。 (X)5.煞車油若經常低於"MIN"線，只要添加即可， 不必到修理廠檢修 。 (X)6.冷卻系統只要副水箱在滿水位，主水箱 不必檢查 也不會有問題。 (X)7.引擎冷卻水內含有防凍液或防銹劑，可 不必更換 。 (X)8.儀錶板上的「燃油油量錶」之指針高度，已經降低至「E」點，橘色的「低油料警示燈」點亮時， 不必急著加油 ，到達目的地後再行補充燃油即可。 (X)9.有安全氣囊裝備的汽車， 不必繫 安全帶。 (X)10.煞車時有異音，是正常的情況， 不必檢修 。 (X)11.汽車定期檢驗 不必檢驗 車輛故障標誌，所以隨車不一定要帶車輛故障標誌。 (X)12.開車時 不必理會 義交之指揮，一切以號誌為主。 (X)13.汽車經過隧道，因隧道內燈光明亮視線良好，為省電可 不必開亮 頭燈。 (X)14.駕駛人只求技術優良，對遵守交通規則 不必太重視 。 (X)15.在開車前， 不必檢查 機件，以免耽誤行車時間。 (X)16.遇幼童專用車、校車、身心障礙者用特製車或教練車， 不必禮讓 。 (X)17.行車 不必攜帶 隨車工具。 (X)18.行車起駛前進， 不必顯示 方向燈。 (X)19.汽車通過鐵路平交道，前後兩車間， 不必保持 距離。 (X)20.夜間將車輛停放在無燈光設備及照明不清之道路時，亦 不必顯示 停車燈光或反光標識。 (X)21.在夜間或有霧靄、雨雪、風沙及晝晦時，把車輛停在路旁， 不必顯示 停車燈光或反光標識。 (X)22.汽車駕駛人，僅需具有優良駕駛技術， 不需 具備急救的常識和技能。 (X)23.汽車車身、引擎、底盤、電系等重要設備變更或調換時， 不需 向公路主管機關申請臨時檢驗。
閱讀完整內容