デザインパターン～Facade～

設計

1. はじめに

GoFのデザインパターンにおける、Facadeパターンについてまとめます。

2. Facadeパターンとは

Facadeという英単語は、正面という意味になります。
大きなプログラムを使って処理を行うためには、関係しあっているたくさんのクラスを適切に制御しなければなりません。その処理を行うための窓口を用意しておけば、たくさんのクラスを個別に制御しなくてよくなります。
Facadeパターンは、複雑なシステムに対してシンプルな窓口を用意する方式です。
GoFのデザインパターンでは、構造に関するデザインパターンに分類されます。

3. サンプルクラス図

4. サンプルプログラム

ユーザーのWebページを作成するプログラムです。

4-1. PageMakerクラス

メールアドレスからユーザーのWebページを作成するクラスです。このクラスがFacadeになります。

package pagemaker;

import java.io.FileWriter;
import java.io.IOException;
import java.util.Properties;

public class PageMaker {

    private PageMaker() {}

    public static void makeWelcomePage(String mailaddr, String filename) {
        try {
            Properties mailprop = Database.getProperties("maildata");
            String username = mailprop.getProperty(mailaddr);
            HtmlWriter writer = new HtmlWriter(new FileWriter(filename));
            writer.title("Welcome to " + username + "'s page!");
            writer.paragraph(username + "のページへようこそ。");
            writer.paragraph("メールまっていますね。");
            writer.mailto(mailaddr, username);
            writer.close();
            System.out.println(filename + " is created for " + mailaddr + " (" + username + ")");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

4-2. HtmlWriterクラス

HTMLファイルを作成するクラスです。

package pagemaker;

import java.io.IOException;
import java.io.Writer;

public class HtmlWriter {

    private Writer writer;

    public HtmlWriter(Writer writer) {
        this.writer = writer;
    }

    public void title(String title) throws IOException {
        writer.write("<html>");
        writer.write("<head>");
        writer.write("<title>" + title + "</title>");
        writer.write("</head>");
        writer.write("<body>\n");
        writer.write("<h1>" + title + "</h1>\n");
    }

    public void paragraph(String msg) throws IOException {
        writer.write("<p>" + msg + "</p>\n");
    }

    public void link(String href, String caption) throws IOException {
        paragraph("<a href=\"" + href + "\">" + caption + "</a>");
    }

    public void mailto(String mailaddr, String username) throws IOException {
        link("mailto:" + mailaddr, username);
    }

    public void close() throws IOException {
        writer.write("</body>");
        writer.write("</html>\n");
        writer.close();
    }
}

4-3. Databaseクラス

メールアドレスからユーザー名を得るうクラスです。

package pagemaker;

import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;

public class Database {

    private Database() {}

    public static Properties getProperties(String dbname) {
        String filename = dbname + ".txt";
        Properties prop = new Properties();
        try {
            prop.load(new FileInputStream(filename));
        } catch (IOException e) {
            System.out.println("Warning: " + filename + " is not found.");
        }
        return prop;
    }
}

4-4. maildataデータベース

データベースファイルです。

tanaka@test.com=Taro Tanaka
yamada@test.com=Hanako Yamada
suzuki@test.com=Daisuke Suzuki

4-5. Mainクラス

メイン処理を行うクラスです。

import pagemaker.PageMaker;

public class Main {
    public static void main(String[] args) {
        PageMaker.makeWelcomePage("tanaka@test.com", "welcome.html");
    }
}

4-6. 実行結果

5. メリット

クラスやメソッドがたくさんあると、プログラマはどれを使ってよいか迷ったり、呼び出し順に注意したりしなければならなくなります。注意しなければならないということはその分、間違えやすいということになります。 Facadeパターンを使うことで、インターフェースを少なくし、複雑なものを単純に見せることができます。インターフェースの数が少ないというのは、外部との結合が疎であるという表現もできます。つまり、ゆるやかな結合となり、パッケージを部品として再利用しやすくしてくれます。

6. GitHub

https://github.com/i-tanaka730/design_pattern

7. デザインパターン一覧

GoFのデザインパターンまとめ

8. 参考

今回の記事、及びサンプルプログラムは、以下の書籍を元に作成させて頂きました。

Java言語で学ぶデザインパターン入門

大変分かりやすく、勉強になりました。感謝申し上げます。デザインパターンやサンプルプログラムについての説明が詳細に書かれていますので、是非書籍の方もご覧ください。

デザインパターン ～Facade～