Clean Code_Note9_Replace Switch Statement With Subclasses

-
 
switch case 應該在寫程式時很常用到
那往往也會讓程式碼看起來比較有結構性但也可能因為太長導致不好維護，甚至很多重複性值的程式。


以下是一個案例

 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
namespace CleanUpConditionals
{
    public class ReplaceSwitchStatementWithSubclasses
    {
        public ReplaceSwitchStatementWithSubclasses()
        {
            var lowLevelManager = new Manager(Manager.LOW_LEVEL, 30000);
            decimal salary = lowLevelManager.GetMonthlySalary(0);
        }

        class Manager
        {
            public const int LOW_LEVEL = 0;
            public const int MIDDLE_LEVEL = 1;
            public const int TOP_LEVEL = 2;

            private int _managerLevel;
            private decimal _baseSalary;

            public Manager(int level, decimal baseSalary)
            {
                _managerLevel = level;
                _baseSalary = baseSalary;
            }

            public decimal GetMonthlySalary(int numberOfPeopleInDepartment)
            {
                switch (_managerLevel)
                {
                    case LOW_LEVEL:
                        return _baseSalary;
                    case MIDDLE_LEVEL:
                        return _baseSalary * 1.25M ;
                    case TOP_LEVEL:
                        return (_baseSalary * 1.25M) + (decimal)(numberOfPeopleInDepartment * 0.05);
                    default:
                        return 0;
                }
            }
        }
    }
}


想像一下今天又再擴充另一個method叫做GetManagerTitle()的method
然後一樣會因為managerLevel有差異又要再次重複寫switch case


 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
namespace CleanUpConditionals
{
    public class ReplaceSwitchStatementWithSubclasses
    {
        public ReplaceSwitchStatementWithSubclasses()
        {
            var lowLevelManager = new Manager(Manager.LOW_LEVEL, 30000);
            decimal salary = lowLevelManager.GetMonthlySalary(0);
        }

        class Manager
        {
            public const int LOW_LEVEL = 0;
            public const int MIDDLE_LEVEL = 1;
            public const int TOP_LEVEL = 2;

            private int _managerLevel;
            private decimal _baseSalary;

            public Manager(int level, decimal baseSalary)
            {
                _managerLevel = level;
                _baseSalary = baseSalary;
            }

            public decimal GetMonthlySalary(int numberOfPeopleInDepartment)
            {
                switch (_managerLevel)
                {
                    case LOW_LEVEL:
                        return _baseSalary;
                    case MIDDLE_LEVEL:
                        return _baseSalary * 1.25M ;
                    case TOP_LEVEL:
                        return (_baseSalary * 1.25M) + (decimal)(numberOfPeopleInDepartment * 0.05);
                    default:
                        return 0;
                }
            }

            public string GetManagerTitle()
            {
                switch (_managerLevel)
                {
                    case LOW_LEVEL:
                        return "Low Level Manager";
                    case MIDDLE_LEVEL:
                        return "Middle Level Manager";
                    case TOP_LEVEL:
                        return "Top Level Manager";
                    default:
                        return "";
                }
            }
        }
    }
}


switch case 瘋狂不斷重複的情況，這時可以去新建一個abstract ManagerLevel class
將分支判斷處理移至當中統一實作


簡化GetMonthlySalary之後的程式
處理流程思維:
我們可將不同case處理情境額外抽離出sub class各自都代表某種ManagerLevel
那最上層去繼承自abstract base class也就是ManagerLevel ，
ManagerLevel 會去統一實作判定是隸屬哪種階層的判斷。
接著各個sub class只要繼承後依序實作最上層定義要具體實作的method即可。
換言之，每個case 的sub 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
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
using System;

namespace CleanUpConditionals
{
    public class ReplaceSwitchStatementWithSubclasses
    {
        public ReplaceSwitchStatementWithSubclasses()
        {
            var lowLevelManager = new Manager(ManagerLevel.LOW_LEVEL, 30000);
            decimal salary = lowLevelManager.GetMonthlySalary(0);
        }

        abstract class ManagerLevel
        {
            public const int LOW_LEVEL = 0;
            public const int MIDDLE_LEVEL = 1;
            public const int TOP_LEVEL = 2;

            public static ManagerLevel GetManagerLevel(int managerLevel)
            {
                switch (managerLevel)
                {
                    case LOW_LEVEL:
                        return new LowManagerLevel();
                    case MIDDLE_LEVEL:
                        return new MiddleManagerLevel();
                    case TOP_LEVEL:
                        return new TopManagerLevel();
                    default:
                        throw new ArgumentException("Level is not supported");
                }
            }
            public abstract decimal GetBaseMonthlySalary(decimal baseSalary,int numberOfPeopleInDepartment);
        }

        class LowManagerLevel : ManagerLevel
        {
            public override decimal GetBaseMonthlySalary(decimal baseSalary, int numberOfPeopleInDepartment)
            {
                return baseSalary;
            }
        }

        class MiddleManagerLevel : ManagerLevel
        {
            public override decimal GetBaseMonthlySalary(decimal baseSalary, int numberOfPeopleInDepartment)
            {
                return baseSalary * 1.25M;
            }
        }

        class TopManagerLevel : ManagerLevel
        {
            public override decimal GetBaseMonthlySalary(decimal baseSalary, int numberOfPeopleInDepartment)
            {
                return (baseSalary * 1.25M) + (decimal)(numberOfPeopleInDepartment * 0.05);
            }
        }

        class Manager
        {
            private int _managerLevel;
            private decimal _baseSalary;
            private ManagerLevel _managerLevelObj;

            public Manager(int level, decimal baseSalary)
            {
                _managerLevel = level;
                _managerLevelObj = ManagerLevel.GetManagerLevel(level);
                _baseSalary = baseSalary;
            }

            public decimal GetMonthlySalary(int numberOfPeopleInDepartment)
            {
                return _managerLevelObj.GetBaseMonthlySalary(_baseSalary, numberOfPeopleInDepartment);
            }

            public string GetManagerTitle()
            {
                switch (_managerLevel)
                {
                    case ManagerLevel.LOW_LEVEL:
                        return "Low Level Manager";
                    case ManagerLevel.MIDDLE_LEVEL:
                        return "Middle Level Manager";
                    case ManagerLevel.TOP_LEVEL:
                        return "Top Level Manager";
                    default:
                        return "";
                }
            }
        }
    }
}


接續處理解化GetManagerTitle()
一樣就是在ManagerLevel Base Class中定義抽象方法
再去每個sub 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
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
using System;

namespace CleanUpConditionals
{
    public class ReplaceSwitchStatementWithSubclasses
    {
        public ReplaceSwitchStatementWithSubclasses()
        {
            var lowLevelManager = new Manager(ManagerLevel.LOW_LEVEL, 30000);
            decimal salary = lowLevelManager.GetMonthlySalary(0);
        }

        abstract class ManagerLevel
        {
            public const int LOW_LEVEL = 0;
            public const int MIDDLE_LEVEL = 1;
            public const int TOP_LEVEL = 2;

            public static ManagerLevel GetManagerLevel(int managerLevel)
            {
                switch (managerLevel)
                {
                    case LOW_LEVEL:
                        return new LowManagerLevel();
                    case MIDDLE_LEVEL:
                        return new MiddleManagerLevel();
                    case TOP_LEVEL:
                        return new TopManagerLevel();
                    default:
                        throw new ArgumentException("Level is not supported");
                }
            }
            public abstract decimal GetBaseMonthlySalary(decimal baseSalary,int numberOfPeopleInDepartment);
            public abstract string GetBaseManagerTitle();

        }

        class LowManagerLevel : ManagerLevel
        {
            public override string GetBaseManagerTitle()
            {
                return "Low Level Manager";
            }

            public override decimal GetBaseMonthlySalary(decimal baseSalary, int numberOfPeopleInDepartment)
            {
                return baseSalary;
            }
        }

        class MiddleManagerLevel : ManagerLevel
        {
            public override string GetBaseManagerTitle()
            {
                return "Middle Level Manager";
            }
            public override decimal GetBaseMonthlySalary(decimal baseSalary, int numberOfPeopleInDepartment)
            {
                return baseSalary * 1.25M;
            }
        }

        class TopManagerLevel : ManagerLevel
        {
            public override string GetBaseManagerTitle()
            {
                return "Top Level Manager";
            }
            public override decimal GetBaseMonthlySalary(decimal baseSalary, int numberOfPeopleInDepartment)
            {
                return (baseSalary * 1.25M) + (decimal)(numberOfPeopleInDepartment * 0.05);
            }
        }

        class Manager
        {
            private int _managerLevel;
            private decimal _baseSalary;
            private ManagerLevel _managerLevelObj;

            public Manager(int level, decimal baseSalary)
            {
                _managerLevel = level;
                _managerLevelObj = ManagerLevel.GetManagerLevel(level);
                _baseSalary = baseSalary;
            }

            public decimal GetMonthlySalary(int numberOfPeopleInDepartment)
            {
                return _managerLevelObj.GetBaseMonthlySalary(_baseSalary, numberOfPeopleInDepartment);
            }

            public string GetManagerTitle()
            {
                return _managerLevelObj.GetBaseManagerTitle();
            }
        }
    }
}



























留言

張貼留言

這個網誌中的熱門文章

何謂淨重(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協定。 在第一次發出前往特定網站的請求時，攻擊者可以執行中間人攻擊並將用戶轉址到...
閱讀完整內容