Design Pattern_Skill_6_建造者模式(Builder Design Pattern)

-
最近在和同事合作過程，就時常會跟SD 合作。
SD主要工作會負責設計一些DB 的Schema  , 撰寫系統預期流程和規格書、畫面操作互動

SD通常就會向我們這些PG規劃和分配任務、負責監工等等

SD通常會跟院內User 一起討論瞭解需求後
在經過自己的統整、文件撰寫來和PG溝通User需要的是捨麼請幫忙開發

PG可能在開發階段只負責程式撰寫工作而不會cover到系統設計規劃

這之間的關係就好比
找多個工人施工蓋房子和一個監工分配工作任務的工頭一樣







這裡以生產產品為例
一個產品從製造、加工都會有不同製程步驟
如下是要取得待在生產線上工作的特定認證(必須精熟和落實會這些工法)

1
2
3
4
5
6
7
8
public interface IBuilder
{
    void BuildPartA();

    void BuildPartB();

    void BuildPartC();
}

一個產品中會區分不同的組件在製造生產(需透過不同組件組合而成)
不同產品會有需要對應生產不同的組件

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
public class Product
{
    private List<object> lsParts = new List<object>();

    public void Add(string part)
    {
        this.lsParts.Add(part);
    }

    public string ListParts()
    {
        return "Product Parts:" + string.Join(",", lsParts.ToArray()) + "\n";
    }
}

負責在產線中製造、加工的作業工程人員
會實踐具體的特定產品規格生產工法流程

 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
public class ConcreteBuilder : IBuilder
{
    private Product _product = new Product();

    public ConcreteBuilder()
    {
        this.Reset();
    }

    public void Reset()
    {
        this._product = new Product();
    }

    public void BuildPartA()
    {
        this._product.Add("PartA");
    }

    public void BuildPartB()
    {
        this._product.Add("PartB");
    }

    public void BuildPartC()
    {
        this._product.Add("PartC");
    }

    public Product GetProduct()
    {
        Product result = this._product;
        this.Reset();
        return result;
    }

}

一個產線上可能都會有一些負責特定產品的組長
會知曉特定產品的流程
再去負責監工指派給底下作業人員

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
public class Director
{
    private IBuilder _builder;

    public IBuilder Builder { get => _builder; set => _builder = value; }

    //minimal valuable product
    public void buildMinimalValuableProduct()
    {
        this._builder.BuildPartA();
    }

    public void builderFeatureProduct()
    {
        this._builder.BuildPartA();
        this._builder.BuildPartB();
        this._builder.BuildPartC();
    }
}



完整的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
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
82
83
84
85
86
87
88
89
90
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace BuilderPattern
{
    public interface IBuilder
    {
        void BuildPartA();

        void BuildPartB();

        void BuildPartC();
    }

    public class Product
    {
        private List<object> lsParts = new List<object>();

        public void Add(string part)
        {
            this.lsParts.Add(part);
        }

        public string ListParts()
        {
            return "Product Parts:" + string.Join(",", lsParts.ToArray()) + "\n";
        }
    }

    public class ConcreteBuilder : IBuilder
    {
        private Product _product = new Product();

        public ConcreteBuilder()
        {
            this.Reset();
        }

        public void Reset()
        {
            this._product = new Product();
        }

        public void BuildPartA()
        {
            this._product.Add("PartA");
        }

        public void BuildPartB()
        {
            this._product.Add("PartB");
        }

        public void BuildPartC()
        {
            this._product.Add("PartC");
        }

        public Product GetProduct()
        {
            Product result = this._product;
            this.Reset();
            return result;
        }

    }

    public class Director
    {
        private IBuilder _builder;

        public IBuilder Builder { get => _builder; set => _builder = value; }

        //minimal valuable product
        public void buildMinimalValuableProduct()
        {
            this._builder.BuildPartA();
        }

        public void builderFeatureProduct()
        {
            this._builder.BuildPartA();
            this._builder.BuildPartB();
            this._builder.BuildPartC();
        }
    }
}


呼叫端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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace BuilderPattern
{
    class Program
    {
        static void Main(string[] args)
        {
            var builder = new ConcreteBuilder();
            var director = new Director();
            director.Builder = builder;

            Console.WriteLine("Standard basic product:");
            director.buildMinimalValuableProduct();
            Console.WriteLine(builder.GetProduct().ListParts());

            Console.WriteLine("Standard full featured product:");
            director.builderFeatureProduct();
            Console.WriteLine(builder.GetProduct().ListParts());

            // Remember, the Builder pattern can be used without a Director class
            Console.WriteLine("Custom product:");
            builder.BuildPartA();
            builder.BuildPartC();
            Console.WriteLine(builder.GetProduct().ListParts());
            Console.ReadKey();
        }
    }
}


演示結果
我們可以直接指定建構標準最小可行性產品
也可以建構比較多工序的較複雜特色產品
更可以去動態調整不同流程來創建包含不同工序的產品



這裡演示的是所謂「由 Client、Director、Builder 和 Product 形成的」建造者模式

Client就是所謂程式實際呼叫端(就是主程式中間接呼叫的地方)
Builder 是所謂的公產生產可上線負責產品的認證
實作了該介面(認證)代表是具有資格的作業員也就是ConcreteBuilder
Product 就是我們的產品(通常是類似加裝許多部份的集中產物)
Director則是一個監工者(有點類似導演、主管的角色...)




這裡再用一個寫程式工作情境來舉例
Builder模式第一種.
「由 Client、Director、Builder 和 Product 形成的」


一個需求資訊是由多種不同規格、時程要求等組建而成

 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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace BuilderPattern
{
    public class WorkInfo
    {
        private List<string> lsWorkItem = new List<string>();

        public void AddWorkInfo(string workItem)
        {
            lsWorkItem.Add(workItem);
        }

        public IEnumerable<string> GetDetail()
        {
            foreach(var item in lsWorkItem)
            {
                yield return item;
            }
        }
    }
}



在日常需求程式開發過程難免會需要做到
有明確任務需求名稱、時數、備註等等
來對每一個工程師進行需求開發控管

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

namespace BuilderPattern
{
    public interface IDevelopmentBuilder
    {
        void Reset();
        void SetTaskName(string _task_title);
        void SetWorkHour(double _work_hour);
        void SetRemark();
        WorkInfo GetTaskDetail();
    }
}


SD或者PM是負責監工指派的角色

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

namespace BuilderPattern
{
    //SD
    public class WorkInfoDirector
    {

        public WorkInfo CreateWorkInfo(IDevelopmentBuilder developmentBuilder, string task_name,double workHour)
        {
            developmentBuilder.SetTaskName(task_name);
            developmentBuilder.SetWorkHour(workHour);
            developmentBuilder.SetRemark();
            return developmentBuilder.GetTaskDetail();
        }
    }
}



而對應去落實需求資訊紀錄和管理的則是一些PG
這裡我們假設ProgrammerA 負責的都是固定備註
然而可能後續備註會因為不同需求功能、平台、時程而有不同變化
這裡只是暫時做一個簡單演示

 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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace BuilderPattern
{   
    public class ProgrammerA : IDevelopmentBuilder
    {
        private WorkInfo _work_info;
        private string _remark = "要使用C# 跟 MS SQL";

        public ProgrammerA()
        {
            Reset();
        }

        public void Reset()
        {
            _work_info = new WorkInfo();
        }

        public void SetTaskName(string _task_title)
        {
            _work_info.AddWorkInfo(_task_title);
        }

        public void SetWorkHour(double _work_hour)
        {
            string workTime = string.Format("工時:{0}小時", _work_hour);
            _work_info.AddWorkInfo(workTime);
        }

        public void SetRemark()
        {
            string remark = string.Format("備註:{0}",this._remark);
            _work_info.AddWorkInfo(remark);
        }

        public WorkInfo GetTaskDetail()
        {
            return _work_info;
        }
    }
}


呼叫端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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace BuilderPattern
{
    class Program
    {
        static void PrintWorkInfoDetail(IEnumerable<object> workDetail)
        {
            foreach(var item in workDetail)
            {
                Console.WriteLine(item);
            }
            Console.WriteLine("= = = = = = = =");
        }

        static void Main(string[] args)
        {
            var workInfoDirector = new WorkInfoDirector();
            Console.WriteLine("ProgrammerA 工作任務列表");
            var workInfo1 = workInfoDirector.CreateWorkInfo(new ProgrammerA(), "訂單管理報表微調", 2.5);
            var workDetail_1 = workInfo1.GetDetail();
            PrintWorkInfoDetail(workDetail_1);

            var workInfo2 = workInfoDirector.CreateWorkInfo(new ProgrammerA(), "文管系統簽核流程更改", 4);
            var workDetail_2 = workInfo2.GetDetail();
            PrintWorkInfoDetail(workDetail_2);
            Console.ReadKey();
        }
    }
}

在此就能打印出
因應不同需求和相應備註、時程產生的需求開發資訊
(各個實體就這樣被創造出來)



Builder模式第二種.藉由靜態內部類方式實踐
(少監工、派工角色)

將IDevelopmentBuilder裡面定義要實踐的method
改為統一回傳IDevelopmentBuilder本身的函數
具體去落實的ProgrammerA則會在設置完相應返回IDevelopmentBuilder的介面
使後期能夠產生鏈結風格( someBuilder->setValueA(1)->setValueB(2)->create() )
於最後定義返回WorkInfo的單一集中物的型別


WorkInfo則和上述例子不同在於裡面By特定欄位串值一一去實作
而最終一樣加到大的List中給予函數返回

和第一種Builder模式最大差異在於沒有Director的角色
而是可由具體的ProgrammerA , ProgrammerB ,....去自行控制增減調整一些屬性和工作流程

第二種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
 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
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace BuilderPattern2
{
    public interface IDevelopmentBuilder
    {
        IDevelopmentBuilder SetTaskName(string _task_title);
        IDevelopmentBuilder SetWorkHour(double _work_hour);
        IDevelopmentBuilder SetRemark(string _remark);
        WorkInfo Build();
    }


    public class WorkInfo
    {
        private string _task_tile;
        private string _work_hour;
        private string _remark;
        private List<string> lsWorkItem = new List<string>();        

        public IEnumerable<string> GetDetail()
        {
            foreach (var item in lsWorkItem)
            {
                yield return item;
            }
        }

        public void SetTaskName(string _task_title)
        {
            this._task_tile = _task_title;
            lsWorkItem.Add(_task_title);
        }

        public void SetWorkHour(double _work_hour)
        {
            this._work_hour = _work_hour.ToString();
            lsWorkItem.Add(string.Format("工時:{0}小時", _work_hour));
        }

        public void SetRemark(string _remark)
        {
            this._remark = _remark;
            lsWorkItem.Add(string.Format("備註:{0}", this._remark));
        }

    }

    public class ProgrammerA : IDevelopmentBuilder
    {
        private WorkInfo workInfo;
        public ProgrammerA()
        {
            workInfo = new WorkInfo();
        }
       
        public IDevelopmentBuilder SetTaskName(string _task_title)
        {
            workInfo.SetTaskName(_task_title);
            return this;
        }

        public IDevelopmentBuilder SetWorkHour(double _work_hour)
        {
            workInfo.SetWorkHour(_work_hour);
            return this;
        }

        public IDevelopmentBuilder SetRemark(string _remark)
        {
            workInfo.SetRemark(_remark);
            return this;
        }

        public WorkInfo Build()
        {
            return workInfo;
        }
    }


    class Program
    {
        static void PrintWorkInfoDetail(IEnumerable<object> workDetail)
        {
            foreach (var item in workDetail)
            {
                Console.WriteLine(item);
            }
            Console.WriteLine("= = = = = = = =");
        }

        static void Main(string[] args)
        {
            Console.WriteLine("ProgrammerA 工作任務列表");
            WorkInfo workInfo = new ProgrammerA()
                                .SetTaskName("文管系統權限調整")
                                .SetWorkHour(1.5)
                                .SetRemark("需要在11/20之前完成").Build();
            PrintWorkInfoDetail(workInfo.GetDetail());

            Console.WriteLine("ProgrammerA 工作任務列表");
            WorkInfo workInfo_2 = new ProgrammerA()
                                .SetTaskName("業管系統邏輯調整")
                                .SetWorkHour(3.5)
                                .SetRemark("需要在12/10之前完成").Build();
            PrintWorkInfoDetail(workInfo_2.GetDetail());

            WorkInfo workInfo_3 = new ProgrammerA()
                                  .SetTaskName("商標管理系統查詢報錯問題修正").Build();
            PrintWorkInfoDetail(workInfo_3.GetDetail());
            Console.ReadKey();
        }
    }
}






Ref:

Builder in C#
https://refactoring.guru/design-patterns/builder/csharp/example

Builder Pattern In C#
https://www.c-sharpcorner.com/article/builder-pattern-in-c-sharp/

Hierarchically Implementing the Bloch's Builder Pattern in C#
https://www.codeproject.com/Articles/240756/Hierarchically-Implementing-the-Bolchs-Builder-Pat




留言

張貼留言

這個網誌中的熱門文章

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