Lab 13-5: From #ifdef #else #endif to Abstract Factory Pattern

練習運用 Abstract Factory 設計樣板 (Design Pattern)

練習運用 Singleton 設計樣板

練習運用抽象類別定義共同的操作介面, 客戶端只需要運用抽象的操作介面來操作物件, 可以和實際運作的類別切割開來, 這是 Open-Closed Principle 和 Dependency Inversion Principle 的基本運用, 運用界面繼承實現 Factoring 方式的程式碼重用。

運用前處理器指令避免重複程式碼

這是一個概念性的應用程式，只有兩種圖形介面元件：選單 (Menu) 和按鈕 (Button)，假設有兩個類別實作 Qt 環境中的選單和按鈕，另外兩個類別實作 Win32 環境中的選單和按鈕，所有這些圖形介面類別都繼承共同的父類別 Widget，Widget 類別中提供所有衍生類別共通的操作介面函式 draw()

#define QT

#include <iostream>
using std::cout;

class Widget
{
public:
    virtual void draw() = 0;
};

class QtButton : public Widget
{
public:
    void draw() { cout << "QtButton\n"; }
};

class QtMenu : public Widget
{
public:
    void draw() { cout << "QtMenu\n"; }
};

class Win32Button : public Widget
{
public:
    void draw() { cout << "Win32Button\n"; }
};

class Win32Menu : public Widget
{
public:
    void draw() { cout << "Win32Menu\n"; }
};

void display_window_one()
{
#ifdef QT
    Widget* w[] = { new QtMenu,
                                  new QtButton };
#else // WIN32
    Widget* w[] = { new Win32Menu,
                                  new Win32Button };
#endif
    w[0]->draw();  w[1]->draw();
}

void display_window_two()
{
#ifdef QT
    Widget* w[] = { new QtMenu,
                                  new QtButton,
                                  new QtButton };
#else // WIN32
    Widget* w[] = { new Win32Menu,
                                  new Win32Button,
                                  new Win32Button };
#endif
    w[0]->draw();  w[1]->draw();  w[2]->draw();
}

int main()
{
#ifdef QT
    Widget* w = new QtButton;
#else // WIN32
    Widget* w = new Win32Button;
#endif
    w->draw();

    display_window_one();
    display_window_two();
}

我們不希望運用前處理器指令來選擇操作平台，因為在增加一種平台的時候，客戶端程式 (main(), display_window_one(), display_window_two()) 都需要增加 #ifdef 選項，都需要重新編譯, 對於這樣的按鈕 (Button) 和選單 (Menu) 類別來說，客戶端應用程式是很多很多的，不是像我們這個範例裡只有三個函式

甚至我們根本不希望客戶端程式知道實際上使用的類別名稱 (QtXxxx, Win32Xxxx), 這樣子才能夠讓客戶端程式和實作 GUI 的子系統切割開來。

如此在增加一種平台的時候，例如 MacXxxxx，所有的客戶端程式可以完全不需要修改，但是功能卻增加了，這又是 Open-Closed Principle 的運用。

我們運用 Abstract Factory 樣板來設計, 下面是 Abstract Factory 的類別圖

在這個樣板中，客戶端 (Client) 運用抽象類別 AbstractFactory 的界面來取得需要的抽象 Button 或是 Menu 物件, 基本上客戶端程式設計時完全根據這些抽象類別的定義來寫, 不需要考量最後實作這些圖形化界面的環境是什麼, 這是所謂的 Design by Contract (DbC) 的設計方法, 這些抽象類別在程式擴充的時候是不會變動的, 或是說這些界面雖然是伺服端的界面, 但是在概念上是屬於客戶端的。

最後執行時需要產生一個 AbstractFactory 的子類別物件，運用它實作的方法 createButton(), createMenu() 產生實體的 Button 以及 Menu 的子類別的物件。

首先請定義 Button 以及 Menu 類別，在 Button 類別中定義 virtual void drawPressed() 介面函式，在 Menu 類別中定義 virtual void drawEnabled() 介面函式，這個 drawPressed() 介面是所有 Button 的衍生類別需要實作的共同操作介面，主要是當按鍵被按下時，需要畫出不同的狀態代表按鍵被按下了，同樣地 virtual void drawEnabled() 介面是所有 Menu 的衍生類別需要實作的共同操作介面，修改 QtButton, Win32Button, QtMenu, 以及 Win32Menu 的父類別 ，這四個類別裡個別都需要實作 drawEnabled() 或是 drawPressed() 介面，我們還是用 cout << "...." 來抽象地代表這些函式實際完成的動作。

請注意: Widget, Button, Menu 這些抽象類別很重要，因為我們希望把客戶端程式碼和實際的 QtButton, Win32Button, QtMenu, Win32Menu 這些和平台相關的實作類別切割開來 (切斷耦合的關係 (decoupling), 希望以後在新增其它介面例如 MacButton, MacMenu 時, 客戶端程式碼不需要修改, 後續 OCP 才能順利運用)。那麼客戶端程式如何操作這些實體的介面物件呢? 就是透過抽象類別裡定義的介面函式來操作，例如只要是 Button 的衍生類別的物件，一定會支援 draw() 和 drawPressed() 的功能。

接下來請參考上面的類別圖，定義 AbstractFactory 抽象類別, 具有 virtual 介面 createButton() 以及 createMenu()

定義 QtFactory 繼承 AbstractFactory, 實作 createButton() 函式，產生 QtButton 物件，實作 createMenu() 函式，產生 QtMenu 物件

定義 Win32Factory 繼承 AbstractFactory, 實作 createButton() 函式，產生 Win32Button 物件，實作 createMenu() 函式，產生 Win32Menu 物件

QtFactory 以及 Win32Factory 請運用 Singleton 樣板 來保證整個系統運作過程中只有唯一的一個 QtFactory 物件，或是唯一的一個 Win32Factory 物件，如下圖一個 Singleton 類別只會產生唯一的物件，QtFactory 或是 Win32Factory 類別產生的物件是工廠，工廠只需要一個就可以達成生產很多產品的功能

如上圖，Singleton 類別裡有一個 static 的資料成員 m_instance，這個資料成員記錄的就是這個類別唯一的物件，常常是在 main() 函式開始執行之前或是在第一次呼叫 getInstance() 時會初始化，有一個 static 的 Singleton *getInstance() 函式，會回傳 m_instance 的指標。建構元、拷貝建構元、和設定運算子都不是 public 的，如此可以避免別的類別裡錯誤地產生 Singleton 類別的物件

需要運用 Dependency Inversion Principle 把 客戶端 程式 與 QtFactory, QtButton, QtMenu 或是 Win32Factory, Win32Button, Win32Menu 這些物件切割開來，希望客戶端程式 不需要知道 QtButton 或是 Win32Button, 只需要知道 Button 類別，這也就是定義 Widget, Button, 和 Menu 抽象類別的目的, 如此後續我們擴充 MacFactory, MacButton, MacMenu，擴充 MotifFactory, MotifButton, MotifMenu，或是擴充 GtkFactory, GtkButton, GtkMenu 時，才能夠維持 OCP 的原則，不要更改客戶端的程式

int main()
{
    AbstractFactory* factory;
    string platform;

    do
    {
        cout << "Qt or Win32? ";
        cin >> platform;
    }
    while (platform!="Qt" && platform!="Win32");

    factory = AbstractFactory::getInstance(platform);

    Button *w = factory->createButton();
    w->draw();
    w->drawPressed();
    delete w;

    Window win1(*factory, "First Window", 1);
    Window win2(*factory, "Second Window", 2);
    win1.draw();
    win2.draw();
    return 0;
}

請注意: 上面程式片段中，為了讓客戶端程式完全不知道個別 Factory 的類別名稱，在 AbstractFactory 類別裡設計一個 static AbstractFactory *getInstance(string platform) 的靜態成員，根據傳遞進來的 platform 字串，回傳適當的 AbstractFactory 物件的指標，例如

AbstractFactory *AbstractFactory::getInstance(string platform)
{
    if (platform == "Qt")
        return QtFactory::getInstance();
    else if (...) 
        ...
}

根據 display_window_one() 和 display_window_two() 這兩個客戶端的函式，請設計一個 Window 類別取代，建構元需要傳入一個 AbstractFactory 物件的參考，一個視窗的標題文字，以及視窗中有幾個按鈕，這個客戶端類別的介面需要配合步驟七裡的程式碼

    Window win1(*factory, "First Window", 1);
    Window win2(*factory, "Second Window", 2);
    win1.draw();
    win2.draw();

請擴充上面的類別架構，假設現在客戶要求同樣的程式能夠有 Mac OSX 的版本，請在不修改客戶端 Windows 類別, 也不修改 Widget, Button, Menu 類別的前提下，（main() 函式裡似乎需要有一點點修改，通常如果不希望改 main() 函式，也可以改由 config 檔案裡讀取環境設定），增加 MacFactory, MacButton, MacMenu 類別來擴充功能，完成以後的範例執行程式如下

參考執行程式

請助教檢查後, 將所完成的 專案 (只需保留 .cpp, .h, .sln 以及 .vcxproj 檔案即可; 刪除掉 .suo, .sdf, .filters, .users, debug\ 資料匣, 以及 ipch\ 資料匣下的所有內容) 壓縮起來, 選擇 Lab13-5上傳, 後面的實習課程可能需要使用這裡所完成的程式。

Fundamental Theorem of Software Engineering (FTSE)

"We can solve any problem by introducing an extra level of indirection."

by Andrew Koenig

在這裡你會看到運用抽象類別來建立額外的中間層軟體

先前你學過用來建立 indirection 的語法還包括 迴圈、函式、變數指標、函式指標...