Dependency Injection原理與實踐(一)

-
在目前軟體開發過程中，往往計畫趕不上變化。
需求一而再再而三改
不再可能是等所有規格資訊完整後才開始開發
因此篹體工程師就需要練習撰寫一些
可維護性較高、可調整性高的程式碼來因應需求的頻繁變化
或因應環境升級而導致的第三方套件的不支援(版本只cover4~5年)

在諸多不確定性情境下
而造就的一種程式撰寫手法

Dependency Injection(DI) 目的在於解除物件與物件間，兩者的直接相依關係。


注入又分為
Constructor DI
Property DI
Method DI

在此用一個員工的Model Class、DAL Class的開發來看差別

我們想透過一專門操控員工的業務邏輯層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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace DependencyInjectionExample
{
    public class Employee
    {
        public int ID { get; set; }
        public string Name { get; set; }
        public string Department { get; set; }
    }

    public class EmployeeDAL
    {
        public List<Employee> GetAllEmployees()
        {
            List<Employee> ListEmployees = new List<Employee>();
            //Get the Employees from the Database
            //for now we are hard coded the employees
            ListEmployees.Add(new Employee() { ID = 1, Name = "Pranaya", Department = "IT" });
            ListEmployees.Add(new Employee() { ID = 2, Name = "Kumar", Department = "HR" });
            ListEmployees.Add(new Employee() { ID = 3, Name = "Rout", Department = "Payroll" });
            return ListEmployees;
        }
    }

    public class EmployeeBL
    {
        public EmployeeDAL employeeDAL;
        public List<Employee> GetAllEmployees()
        {
            employeeDAL = new EmployeeDAL();
            return employeeDAL.GetAllEmployees();
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            EmployeeBL employeeBL = new EmployeeBL();
            List<Employee> lsEmp = employeeBL.GetAllEmployees();

            foreach (Employee emp in lsEmp)
            {
                Console.WriteLine("ID  = {0}, Name = {1}, Department = {2}", emp.ID, emp.Name, emp.Department);
            }
            Console.ReadKey();
        }
    }
}

這裡可看到
EmployeeBL Class 必須依賴 EmployeeDAL 中定義的method GetAllEmployees
而這也導致EmployeeBL 跟 EmployeeDAL兩Class是極高耦合(牽一髮動全身)
當一個要改另一個也會需要一起改
(一個情境假設今天跟某公司合併、併購之類的要回收該公司資料庫
要整併一切的員工資料時候、或者不同廠區、分公司的員工清單要額外劃分時候)


Constructor DI
這裡我們透過Constructor DI技巧來解決此情境的問題
我們不希望直接在EmployeeBL Class 指定具體的Class

我們先針對EmployeeDAL 做調整

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
public interface IEmployeeDAL
{
    List<Employee> GetAllEmployees();
}

public class EmployeeDAL : IEmployeeDAL
{
    public List<Employee> GetAllEmployees()
    {
        List<Employee> ListEmployees = new List<Employee>();
        //Get the Employees from the Database
        //for now we are hard coded the employees
        ListEmployees.Add(new Employee() { ID = 1, Name = "Pranaya", Department = "IT" });
        ListEmployees.Add(new Employee() { ID = 2, Name = "Kumar", Department = "HR" });
        ListEmployees.Add(new Employee() { ID = 3, Name = "Rout", Department = "Payroll" });
        return ListEmployees;
    }
}

在目前案例EmployeeDAL 屬於我們要注入的物件(dependency object)
因此宣告一Interface 命名為IEmployeeDAL
只要是實作此介面的一律要實作GetAllEmployees的方法
針對EmployeeDAL 去implement 此interface

(在此有個重點就是藉由interface形式來實踐注入才可具有彈性)


在來需要調整EmployeeBL

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
public class EmployeeBL
{
    //public EmployeeDAL employeeDAL;
    public IEmployeeDAL employeeDAL;
    public EmployeeBL(IEmployeeDAL employeeDAL)
    {
        this.employeeDAL = employeeDAL;
    }

    public List<Employee> GetAllEmployees()
    {
        //employeeDAL = new EmployeeDAL();
        return employeeDAL.GetAllEmployees();
    }
}

於Constructor 中傳入Interface
間接去Call GetAllEmployees方法
往後只要是有實作該interface的物件皆可傳入做後續使用

呼叫端程式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
class Program
{
    static void Main(string[] args)
    {
        EmployeeBL employeeBL = new EmployeeBL(new EmployeeDAL());
        List<Employee> lsEmp = employeeBL.GetAllEmployees();
        foreach (Employee emp in lsEmp)
        {
            Console.WriteLine("ID  = {0}, Name = {1}, Department = {2}", emp.ID, emp.Name, emp.Department);
        }
        Console.ReadKey();
    }
}




Property DI

設定好注入目標鎖定在EmployeeBL中的私有欄位employeeDAL去產生公有的property
並於setter做DI處理

 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
public class EmployeeBL
{
    private IEmployeeDAL employeeDAL;
    public IEmployeeDAL employeeDataObj
    {
        get
        {
            if(employeeDataObj == null)
            {
                throw new Exception("Employee is not initialized");
            }
            else
            {
                return employeeDAL;
            }                
        }
        set
        {
            employeeDAL = value;
        }
    }
    public List<Employee> GetAllEmployees()
    {
        return employeeDAL.GetAllEmployees();
    }
}

屬性注入的呼叫端

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
class Program
{
    static void Main(string[] args)
    {
        EmployeeBL employeeBL = new EmployeeBL();
        employeeBL.employeeDataObj = new EmployeeDAL();

        List<Employee> lsEmp = employeeBL.GetAllEmployees();
        foreach (Employee emp in lsEmp)
        {
            Console.WriteLine("ID  = {0}, Name = {1}, Department = {2}", emp.ID, emp.Name, emp.Department);
        }
        Console.ReadKey();
    }
}


一樣也可達成更具有彈性獲取員工清單的目的


何時要使用constructor DI 何時要用property DI呢?
從較大宗設計角度來看constructor DI比較可以確保
在呼叫任一dependency object的method之前都有做好初始化的動作(較不會跑null exception)
實際應用也較少用property DI


除非既有物件中有一堆method 只支援objectA
而我需要擴充新method支援objectB的時候
此時若用constructor DI就會變得很辛苦
每個既有在龐大專案中已實體化的物件都必須做修改


Method DI

注入目標鎖定在EmployeeBL中的GetAllEmployees 方法
從外部一樣是傳入只要有實作interface 的物件


 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public class EmployeeBL
{
    private IEmployeeDAL employeeDAL;
    
    public List<Employee> GetAllEmployees(IEmployeeDAL employeeDAL)
    {
        this.employeeDAL = employeeDAL;
        return this.employeeDAL.GetAllEmployees();
    }
}

class Program
{
    static void Main(string[] args)
    {
        EmployeeBL employeeBL = new EmployeeBL();
        List<Employee> lsEmp = employeeBL.GetAllEmployees(new EmployeeDAL());
        foreach (Employee emp in lsEmp)
        {
            Console.WriteLine("ID  = {0}, Name = {1}, Department = {2}", emp.ID, emp.Name, emp.Department);
        }
        Console.ReadKey();
    }
}

當整個class沒有跟需依賴的物件有任何依賴時但其中一個 method必須依賴特定物件時採用。



Ref:
Dependency Injection in C#
https://dotnettutorials.net/lesson/dependency-injection-design-pattern-csharp/
Property and Method Dependency Injection in C#
https://dotnettutorials.net/lesson/setter-dependency-injection-design-pattern-csharp/






留言

張貼留言

這個網誌中的熱門文章

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

(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.汽車車身、引擎、底盤、電系等重要設備變更或調換時， 不需 向公路主管機關申請臨時檢驗。
閱讀完整內容

經得起原始碼資安弱點掃描的程式設計習慣培養(三)_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
閱讀完整內容