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/






留言

張貼留言

這個網誌中的熱門文章

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