C#/VB.NET 物件導向技巧研究(一)_Chain Constructors_optional parameters

-
C# /VB.NET  建構子設計中常遇到的冗長設計問題

如下我們建立一個摩托車的類別來詳述一些
還能再改善的程式碼片段徵兆

Code

 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
class Motorcycle
    {
        public int driverIntensity;
        public string driverName;//driver name
        public int driverYear;// driver year

        public void SetDriverName(string name)
        {
            this.driverName = name;
        }

        public void SetDriverYear(int year)
        {
            driverYear = year;
        }

        public Motorcycle(){}

        //冗長的建構子函數.........................
        //確保駕駛安全並限定強度等級不超出10
        public Motorcycle(int intensity)
        {
            if (intensity > 10)
            {
                intensity = 10;
            }
            driverIntensity = intensity;
        }

        public Motorcycle(int intensity , string name)
        {
            if (intensity > 10)
            {
                intensity = 10;
            }
            driverIntensity = intensity;
            this.driverName = name;
        }
        //冗長的建構子函數.........................
        //在兩個overloading建構子中存在著重複多餘的程式碼
        //而且若今天門檻再更換成其他數值則又要額外重複寫。
        
        public void PopAWheely()
        {
            Console.WriteLine("Yeeeeeeeeeee ");
        }
    }


我們可以觀察到  建構子的overloading 函數區塊
一直有重複程式碼出現

就是為了確保機車強度有一定限制而制定的門檻值10該部分判斷流程
但缺乏更改的彈性(比方門檻一變就要改兩函數區塊)
這裡我們進行函數封裝會更加明顯





Code


 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
class Motorcycle2
    {
        public int driverIntensity;
        public string driverName;//driver name
        public int driverYear;// driver year

        public void SetDriverName(string name)
        {
            driverName = name;
        }

        public void SetDriverYear(int year)
        {
            //this.driverYear = year;
            driverYear = year;
        }

        public Motorcycle2() { }

        public Motorcycle2(int intensity)
        {
            SetIntensity(intensity);
        }

        public Motorcycle2(int intensity, string name)
        {
            SetIntensity(intensity);
            driverName = name;
        }

        public void SetIntensity(int intensity)
        {
            if (intensity > 10)
            {
                intensity = 10;
            }
            driverIntensity = intensity;
        }
        public void PopAWheely()
        {
            Console.WriteLine("Yeeeeeeeeeee ");
        }
    }

雖然有比剛剛好一丁點，確實有改善當門檻一變時的多處修改問題。
但若今天又有變多參數時就有一些維護上的困難。

此時就牽涉到「Chain Constructors」(於JAVA也有類似設計技巧的概念)
這個技巧

我們讓一個接受最多參數個數的建構子函數定為「主建構子函數」
並且只在其中實踐必要的業務邏輯流程。

其餘建構子則可透過this關鍵字將對應參數傳遞給主建構子函數中

如此一來，整個類只會有一個建構子需要我們去操心，提升可維護性。





最終優化 Code (此寫法於 .NET 各版本較為廣泛通用)
C#版本

 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
class Motorcycle3
    {
        public int driverIntensity;
        public string driverName;//driver name
        public int driverYear;// driver year

        public void SetDriverName(string name)
        {
            driverName = name;
        }

        public void SetDriverYear(int year)
        {
            driverYear = year;
        }

        public Motorcycle3() { }

        public Motorcycle3(int intensity) : this(intensity , "") { }

        public Motorcycle3(string name) : this(0, name) { }

        //主建構子函數
        public Motorcycle3(int intensity, string name)
        {
            if (intensity > 10)
            {
                intensity = 10;
            }
            driverIntensity = intensity;
            driverName = name;
        }
        public void PopAWheely()
        {
            Console.WriteLine("Yeeeeeeeeeee ");
        }
    }

VB.NET版本


 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
Class Motorcycle3
    Public driverIntensity As Integer
    Public driverName As String
    Public driverYear As Integer

    Public Sub SetDriverName(ByVal name As String)
        driverName = name
    End Sub

    Public Sub SetDriverYear(ByVal year As Integer)
        driverYear = year
    End Sub

    Public Sub New()
    End Sub

    Public Sub New(ByVal intensity As Integer)
        Me.New(intensity, "")
    End Sub

    Public Sub New(ByVal name As String)
        Me.New(0, name)
    End Sub

    Public Sub New(ByVal intensity As Integer, ByVal name As String)
        If intensity > 10 Then
            intensity = 10
        End If

        driverIntensity = intensity
        driverName = name
    End Sub

    Public Sub PopAWheely()
        Console.WriteLine("Yeeeeeeeeeee ")
    End Sub
End Class








一整個建構子函數執行流程

我們於類別各建構子中插入打印資訊觀察運行順序


 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
class Motorcycle4
    {
        public int driverIntensity;
        public string driverName;//driver name
        public int driverYear;// driver year

        public void SetDriverName(string name)
        {
            driverName = name;
        }

        public void SetDriverYear(int year)
        {
            //this.driverYear = year;
            driverYear = year;
        }

        //The chain of constructor
        public Motorcycle4()
        {
            Console.WriteLine("In default ctor");
        }

        public Motorcycle4(int intensity) : this(intensity, "")
        {
            Console.WriteLine("In ctor with int parameter");
        }

        public Motorcycle4(string name) : this(0, name)
        {
            Console.WriteLine("In ctor with string parameter");
        }

        public Motorcycle4(int intensity, string name)
        {
            Console.WriteLine("In Master ctor");
            if (intensity > 10)
            {
                intensity = 10;
            }
            driverIntensity = intensity;
            driverName = name;
        }

        public void PopAWheely()
        {
            for (int i = 0; i <= driverIntensity; i++)
            {
                Console.WriteLine("Yeeeeeee Haaaaaeewww!");
            }
        }
    }




1.物件實體化(呼叫方)後去呼叫只有單一參數形式的建構子函數
2.該建構子函數把傳入的參數內容透過this先傳遞給主建構子函數
並提供呼叫方並未提供參數部分之初始化內容
3.主建構子函數進行處理與賦值
4.返回至最初調用建構子函數區塊執行接下去程式碼


於.NET4.0以上其實還有提供更加簡潔的建構子多載程式寫法
即「Optional Parameters」


Code

C#版(需.NET4.0以上)


 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
class Motorcycle5
    {
        public int driverIntensity;
        public string driverName;//driver name
        public int driverYear;// driver year

        //可選參數之單一建構子函數(.NET4.0以上)
        //Single constructor using optional args
        public Motorcycle5(int intensity = 0 , string name = "")
        {
            if (intensity > 10)
            {
                intensity = 10;
            }
            driverIntensity = intensity;
            driverName = name;
        }

        public void SetDriverName(string name)
        {
            driverName = name;
        }


    }


VB.NET 版本



 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
Class Motorcycle5
    Public driverIntensity As Integer
    Public driverName As String
    Public driverYear As Integer

    Public Sub New(ByVal Optional intensity As Integer = 0, ByVal Optional name As String = "")
        If intensity > 10 Then
            intensity = 10
        End If

        driverIntensity = intensity
        driverName = name
    End Sub

    Public Sub SetDriverName(ByVal name As String)
        driverName = name
    End Sub
End Class









外面調用建議用標前綴的寫法(因為建構子參數順序是有差異的!!!會報錯)
還有請記得順序不要錯!!!(怎麼定義就依照一樣型態下去指定)





 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Motorcycle5 mc5_1 = new Motorcycle5();
            Console.WriteLine("Name= {0} , Intensity={1}", mc5_1.driverName, mc5_1.driverIntensity);

            //單一參數寫法1.指定前綴
            Motorcycle5 mc5_2_1 = new Motorcycle5(name: "Jenny");
            Console.WriteLine("Name= {0} , Intensity={1}", mc5_2_1.driverName, mc5_2_1.driverIntensity);

            Motorcycle5 mc5_3_1 = new Motorcycle5(intensity: 7);
            Console.WriteLine("Name= {0} , Intensity={1}", mc5_3_1.driverName, mc5_3_1.driverIntensity);



            //單一參數寫法2.不指定前綴(依資料型態來區別) -->不建議!!!(順序有差!!!!)
            //Motorcycle5 mc5_2_2 = new Motorcycle5("Jenny");
            //Console.WriteLine("Name= {0} , Intensity={1}", mc5_2_2.driverName, mc5_2_2.driverIntensity);

            Motorcycle5 mc5_3_2 = new Motorcycle5(7);
            Console.WriteLine("Name= {0} , Intensity={1}", mc5_3_2.driverName, mc5_3_2.driverIntensity);



            Motorcycle5 mc5_4 = new Motorcycle5(intensity: 8, name: "Mike");
            Console.WriteLine("Name= {0} , Intensity={1}", mc5_4.driverName, mc5_4.driverIntensity);





參考link:
https://www.industriallogic.com/xp/refactoring/chainConstructors.html


留言

張貼留言

這個網誌中的熱門文章

經得起原始碼資安弱點掃描的程式設計習慣培養(五)_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.汽車車身、引擎、底盤、電系等重要設備變更或調換時， 不需 向公路主管機關申請臨時檢驗。
閱讀完整內容