java設計模式之模板方法

轉載請注明出處：http://blog.csdn.net/guolin_blog/article/details/8744002

今天你還是像往常一樣來上班，一如既往地開始了你的編程工作。

項目經理告訴你，今天想在服務器端增加一個新功能，希望寫一個方法，能對Book對象進行處理，將Book對象的所有字段以XML格式進行包裝，這樣以后可以方便與客戶端進行交互。並且在包裝開始前和結束后要打印日志，這樣方便調試和問題定位。

沒問題！你覺得這個功能簡直是小菜一碟，非常自信地開始寫起代碼。

Book對象代碼如下：

public class Book {

    private String bookName;

    private int pages;

    private double price;

    private String author;

    private String isbn;

    public String getBookName() {
        return bookName;
    }

    public void setBookName(String bookName) {
        this.bookName = bookName;
    }

    public int getPages() {
        return pages;
    }

    public void setPages(int pages) {
        this.pages = pages;
    }

    public double getPrice() {
        return price;
    }

    public void setPrice(double price) {
        this.price = price;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getIsbn() {
        return isbn;
    }

    public void setIsbn(String isbn) {
        this.isbn = isbn;
    }

}

 

然后寫一個類專門用於將Book對象包裝成XML格式：

public class Formatter {

    public String formatBook(Book book) {
        System.out.println("format begins");
        String result = "";
        result += "<book_name>" + book.getBookName() + "</book_name>\n";
        result += "<pages>" + book.getPages() + "</pages>\n";
        result += "<price>" + book.getPrice() + "</price>\n";
        result += "<author>" + book.getAuthor() + "</author>\n";
        result += "<isbn>" + book.getIsbn() + "</isbn>\n";
        System.out.println("format finished");
        return result;
    }

}

調用代碼如下：

public class Test {

    public static void main(String[] args) throws Exception {
        Book book = new Book();
        book.setBookName("Thinking in Java");
        book.setPages(880);
        book.setPrice(68);
        book.setAuthor("Bruce Eckel");
        book.setIsbn("9787111213826");
        Formatter formatter = new Formatter();
        String result = formatter.formatBook(book);
        System.out.println(result);
    }

}

你寫好了之后，迫不及待地開始運行，運行結果也完全符合你的期望。

項目經理看完后，對你非常滿意，小伙效率很高的嘛！你也非常的得意。

不過兩天之后，項目經理又找到了你，他說之前沒有考慮到需要交互的客戶端還包括手機設備，而手機設備都比較吃流量，用XML格式來傳輸太耗流量了，想最好能改成使用JSON格式傳輸。但是之前的XML格式也要保留，最好可以由客戶端指定使用哪種格式。

你有些不開心，心里低估着，為什么一開始不考慮周全呢，現在又要改遺留代碼。但對方畢竟是領導，你還是要服從命令的，於是你開始修改Formatter類：

public class Formatter {

    public static final int XML = 0;

    public static final int JSON = 1;

    public String formatBook(Book book, int format) {
        System.out.println("format begins");
        String result = "";
        if (format == XML) {
            result += "<book_name>" + book.getBookName() + "</book_name>\n";
            result += "<pages>" + book.getPages() + "</pages>\n";
            result += "<price>" + book.getPrice() + "</price>\n";
            result += "<author>" + book.getAuthor() + "</author>\n";
            result += "<isbn>" + book.getIsbn() + "</isbn>\n";
        } else if (format == JSON) {
            result += "{\n";
            result += "\"book_name\" : \"" + book.getBookName() + "\",\n";
            result += "\"pages\" : \"" + book.getPages() + "\",\n";
            result += "\"price\" : \"" + book.getPrice() + "\",\n";
            result += "\"author\" : \"" + book.getAuthor() + "\",\n";
            result += "\"isbn\" : \"" + book.getIsbn() + "\",\n";
            result += "}";
        }
        System.out.println("format finished");
        return result;
    }

}

 

調用代碼如下：

public class Test {

    public static void main(String[] args) throws Exception {
        Book book = new Book();
        book.setBookName("Thinking in Java");
        book.setPages(880);
        book.setPrice(68);
        book.setAuthor("Bruce Eckel");
        book.setIsbn("9787111213826");
        Formatter formatter = new Formatter();
        String result = formatter.formatBook(book, Formatter.XML);
        System.out.println(result);
        result = formatter.formatBook(book, Formatter.JSON);
        System.out.println(result);
    }

}

再次運行程序，得到了以下結果。

項目經理看到運行結果后開心地說：“太好了，這正是我想要的！” 

可是你這次卻沒有那么開心，你覺得代碼已經有些混亂了，XML格式的邏輯和JSON格式的邏輯混淆在一起，非常不利於閱讀，而且如果以后還需要擴展功能也會非常困難。好在傳輸格式一般也就XML和JSON了，應該不會再有什么擴展了，你這樣安慰自己道。

 

但幻想總會被現實打破，“我最近聽說有個YAML格式挺好玩的.......” 項目經理說道。這個時候你已經有想打人的沖動了！！！

 

很多時候就是這樣，在公司里寫的代碼亂七八糟，質量極差，很大一部分原因就是因為需求變來變去。我們不斷在原有代碼基礎上補充各種后續加入的情況，在一行行新增的if語句下面，我們的代碼變得不堪入目。當然，我們作為程序員，對於需求這種東西沒有太多的話語權，在這方面我們無能為力。但是我們可以盡量地把程序的架構設計好，讓我們寫出的代碼更具有擴展性，這樣就可以應對各種需求變更了。

 

下面你將要使用23種設計模式中的模板方法來改進以上程序。

首先將Formatter中的代碼進行修改，如下所示：

public abstract class Formatter {

    public String formatBook(Book book, int format) {
        beforeFormat();
        String result = formating(book);
        afterFormat();
        return result;
    }

    protected void beforeFormat() {
        System.out.println("format begins");
    }

    protected abstract String formating(Book book);

    protected void afterFormat() {
        System.out.println("format finished");
    }

}

你會發現format_book方法只有四步，第一步調用before_format，去打印格式轉換前的日志。第二步調用formating，這個方法是個抽象方法，用於處理具體的轉換邏輯，因此每一個繼承自Formatter的子類都需要重寫此方法，來實現各自的轉換邏輯。第三步調用after_format，去打印格式轉換后的日志。第四步返回result。由於類中存在了抽象方法，我們也就需要把Formatter聲明成抽象類。

 

然后要定義專門的子類來處理每種傳輸格式的具體邏輯，這樣不同傳輸格式的邏輯可以從一個方法里分離開，明顯便於閱讀和理解。

定義類XMLFormatter繼承自Formatter，里面加入處理XML格式的具體邏輯：

public class XMLFormatter extends Formatter {

    @Override
    protected String formating(Book book) {
        String result = "";
        result += "<book_name>" + book.getBookName() + "</book_name>\n";
        result += "<pages>" + book.getPages() + "</pages>\n";
        result += "<price>" + book.getPrice() + "</price>\n";
        result += "<author>" + book.getAuthor() + "</author>\n";
        result += "<isbn>" + book.getIsbn() + "</isbn>\n";
        return result;
    }

}

 

定義類JSONFormatter繼承自Formatter，里面加入處理JSON格式的具體邏輯：

public class JSONFormatter extends Formatter {

    @Override
    protected String formating(Book book) {
        String result = "";
        result += "{\n";
        result += "\"book_name\" : \"" + book.getBookName() + "\",\n";
        result += "\"pages\" : \"" + book.getPages() + "\",\n";
        result += "\"price\" : \"" + book.getPrice() + "\",\n";
        result += "\"author\" : \"" + book.getAuthor() + "\",\n";
        result += "\"isbn\" : \"" + book.getIsbn() + "\",\n";
        result += "}";
        return result;
    }

}

最后調用代碼如下：

public class Test {

    public static void main(String[] args) throws Exception {
        Book book = new Book();
        book.setBookName("Thinking in Java");
        book.setPages(880);
        book.setPrice(68);
        book.setAuthor("Bruce Eckel");
        book.setIsbn("9787111213826");
        XMLFormatter xmlFormatter = new XMLFormatter();
        String result = xmlFormatter.formatBook(book);
        System.out.println(result);
        JSONFormatter jsonFormatter = new JSONFormatter();
        result = jsonFormatter.formatBook(book);
        System.out.println(result);
    }

}

 

運行之后，你會發現運行結果和修改前代碼的運行結果完全相同。但是使用模板方法之后，代碼的可讀性有了很大的提高，因為處理格式轉換的代碼都放到了各自的類當中，而不是全部塞進一個方法中。並且在擴展性上也有了很大的提升，比如你開始感興趣項目經理說的YAML格式了。

 

定義類YAMLFormatter繼承自Formatter，里面加入處理YAML格式的具體邏輯：

public class YAMLFormatter extends Formatter {

    @Override
    protected String formating(Book book) {
        String result = "";
        result += "book_name: " + book.getBookName() + "\n";
        result += "pages: " + book.getPages() + "\n";
        result += "price: " + book.getPrice() + "\n";
        result += "author: " + book.getAuthor() + "\n";
        result += "isbn: " + book.getIsbn() + "\n";
        return result;
    }

}

 

調用代碼只需要加入：

YAMLFormatter yamlFormatter = new YAMLFormatter();
String result = yamlFormatter.formatBook(book);
System.out.println(result);

好了，令人頭疼的YAML格式就這樣被支持了，只需要在調用的時候決定是實例化XMLFormatter，JSONFormatter還是YAMLFormatter，就可以按照相應的規格進行格式轉換了。而且整體的代碼很有條理，看起來也很舒心。這個時候，你會輕松地向項目經理調侃一句，還有需要支持的格式嗎？

 

模板方法： 定義一個操作中的算法的骨架，而將一些步驟延遲到子類中，模板方法使得子類可以不改變一個算法的結構即可重定義該算法的某些特定步驟。