「設(shè)計模式(六) - Builder模式」
一、可定制化的
電腦的組裝在生活中并不陌生，大家都有電腦，當然需求不一樣配置也不一樣。以Macbook Pro為例，像UI設(shè)計對圖像模塊GPU要求比較高，跑IDEA的對內(nèi)存要求就比較高，可能會加裝32G內(nèi)存更高的就是64G了。如果是對付日常的辦公，刷劇那默認的配置就已經(jīng)足夠了，如8G標配。類似的在軟件開發(fā)過程中，需要根據(jù)需要自定義搭配不同的選擇來構(gòu)建對象的一般能夠用Builder模式很好的解釋，看看具體的定義是怎樣的。
二、Builder模式
[The builder pattern is a design pattern designed to provide a flexible solution to various object creation problems in object-oriented programming. The intent of the Builder design pattern is to separate the construction of a complex object from its representation. It is one of the Gang of Four design patterns.]
通俗的表示：即將一個復(fù)雜對象的構(gòu)建與表示相分離開，同樣的構(gòu)建過程根據(jù)需要可以創(chuàng)建不同的表示。稱之為Builder模式或建造者模式。
三、結(jié)構(gòu)組成
-
結(jié)構(gòu)類圖：
Builder模式.png 構(gòu)造器接口Builder：通常會包含構(gòu)建部件模塊的抽象方法，以及對象創(chuàng)建完成后的結(jié)果方法getResult()。
構(gòu)造器具體實現(xiàn)類ConcreteBuilder：對Builder接口的具體實現(xiàn)，構(gòu)建產(chǎn)品Product各個部件，組裝成完整的產(chǎn)品對象，并通過getResult()返回具體的對象。
產(chǎn)品的抽象接口Product：需要構(gòu)造的對象，一般包含多個組成部分，構(gòu)成較為復(fù)雜的對象。
定制者(指揮者)Director：決定了Product的具體創(chuàng)建組成，例如包含何種組件。指導(dǎo)出Product復(fù)雜對象的創(chuàng)建，類圖表示較為清晰；一般使用Builder來完成創(chuàng)建過程。
四、代碼實現(xiàn)
1.設(shè)計一個簡單的文件導(dǎo)出系統(tǒng)
根據(jù)需要配置對應(yīng)的文檔系統(tǒng)并導(dǎo)出文件，例如導(dǎo)出純文本內(nèi)容.text、.html等文件。
- 元素Element對應(yīng)這里的Product，即產(chǎn)品的接口
public interface Element {
//no method
}
1.為提供默認的方法，由實現(xiàn)類自行決定實現(xiàn)何種細節(jié)。
- 元素Element具體實現(xiàn)類-文本
/**
* Created by Sai
* on: 25/01/2022 00:48.
* Description:
*/
public class Text implements Element {
private final String content;
public Text(String content) {
this.content = content;
}
public String getContent() {
return content;
}
}
- 元素Element具體實現(xiàn)類-圖片
/**
* Created by Sai
* on: 25/01/2022 00:49.
* Description:
*/
public class Image implements Element {
private final String source;
public Image(String source) {
this.source = source;
}
public String getSource() {
return source;
}
}
- 建造器接口Builder，這里既然是文檔類型的建造器，命名規(guī)范一點的話則為DocumentBuilder，下同：
/**
* Created by Sai
* on: 25/01/2022 00:52.
* Description:
*/
public interface DocumentBuilder {
void addText(Text text);
void addImage(Image image);
String getResult();
}
1.分別提供了兩個添加內(nèi)容的方法，addText、addImage。
2.提供一個返回具體內(nèi)容的方法，getResult。
- 建造器的具體實現(xiàn)-純文本文檔建造器
public class TextDocumentBuilder implements DocumentBuilder {
private final StringBuilder builder = new StringBuilder();
@Override
public void addText(Text text) {
builder.append(text.getContent());
}
@Override
public void addImage(Image image) {
//empty implements
}
@Override
public String getResult() {
return builder.toString();
}
}
1.其中純文本內(nèi)容不支持添加圖片，添加圖片方法則未實現(xiàn)，為空方法。
由于html結(jié)構(gòu)相對于純文本來說較為復(fù)雜，包括標簽，段落等等，如果完全依賴于Element不利于擴展，實現(xiàn)起來比較麻煩，因此對于html類型的文檔文件，單獨實現(xiàn)自己的一套元素組件。以Element為媒介動態(tài)添加進去。
單獨實現(xiàn)html特有的元素HtmlElement
public class HtmlElement {
//empty method
}
- Html圖片元素組件HtmlImage繼承自HtmlElement
public class HtmlImage extends HtmlElement {
private final String source;
public HtmlImage(String source) {
this.source = source;
}
@Override
public String toString() {
return String.format("<img src=\"%s\" />", source);
}
}
- Html段落文本組件HtmlParagraph同樣繼承自HtmlElement
public class HtmlParagraph extends HtmlElement {
private final String text;
public HtmlParagraph(String text) {
this.text = text;
}
@Override
public String toString() {
return String.format("<p>%s</p>", text);
}
}
- 一份完整的Html文檔可能包含多種HtmlParagraph與HtmlImage的集合，定義html文檔文件類-HtmlDocument
public class HtmlDocument {
private final List<HtmlElement> elements = new ArrayList<>();
public void add(HtmlElement element) {
elements.add(element);
}
@Override
public String toString() {
var builder = new StringBuilder();
builder.append("<html>");
for (HtmlElement element : elements)
builder.append(element.toString());
builder.append("</html>");
return builder.toString();
}
}
- 對于html建造器的實現(xiàn)：由于html文檔的特殊性，雖然依據(jù)類圖的實現(xiàn)流程需要實現(xiàn)DocumentBuilder接口，顯然僅僅DocumentBuilder中方法并不能很好的滿足需求的定制，但是搭配重新定義一套html文檔組裝規(guī)則(HtmlDocument、HtmlElement、HtmlImage、HtmlParagraph)則能夠很好的完成擴展：
public class HtmlDocumentBuilder implements DocumentBuilder {
private final HtmlDocument document = new HtmlDocument();
@Override
public void addText(Text text) {
document.add(new HtmlParagraph(text.getContent()));
}
@Override
public void addImage(Image image) {
document.add(new HtmlImage(image.getSource()));
}
@Override
public String getResult() {
return document.toString();
}
}
- 完整的文檔導(dǎo)出類-Document
public class Document {
private final List<Element> elements = new ArrayList<>();
public void add(Element element) {
elements.add(element);
}
public void export(DocumentBuilder builder, String fileName) throws IOException {
for (Element element : elements) {
if (element instanceof Text)
builder.addText((Text) element);
else if (element instanceof Image)
builder.addImage((Image) element);
}
var writer = new FileWriter(fileName);
writer.write(builder.getResult());
writer.close();
}
}
- 測試Demo
public class Demo {
public static void show() throws IOException {
var document = new Document();
document.add(new Text("\n\n\n\n快樂二狗??????\nphp才是最好的語言??\n"));
document.add(new Image("pic1.jpg"));
document.export(new HtmlDocumentBuilder(), "sai.html");
//文檔不添加圖片
document.export(new TextDocumentBuilder(), "sai.txt");
}
public static void main(String[] args) throws IOException {
show();
}
}
1.簡單的添加了一個文本內(nèi)容與一個“圖片內(nèi)容”，分別組成了純文本的文檔與Html的文檔，但文本的文檔是沒有添加圖片的。
2.導(dǎo)出的文件在同包下，sai.html和sai.text文件。
-
“純文本文檔”內(nèi)容
文本文檔.png -
“html”文檔
html文檔.png
2.優(yōu)缺點與局限性思考
1.Builder模式很好的將構(gòu)建與表現(xiàn)相分離，客戶端或者Director可以根據(jù)需要靈活的選擇，在同一套構(gòu)建算法下產(chǎn)生不同的產(chǎn)品，使得表現(xiàn)形式與生產(chǎn)的耦合程度降低。
2.具體的構(gòu)建細節(jié)包含在系統(tǒng)內(nèi)部，客戶端僅僅只需要通過對Builder接口的調(diào)用即可完成創(chuàng)建所需要的對象，降低了系統(tǒng)出錯的風(fēng)險。
3.加強了代碼的復(fù)用性。
4.當然缺點也是很明顯的，如果對象太過于復(fù)雜，組裝的配件過多往往不好掌控，造成臃腫，結(jié)構(gòu)也不是很清晰。
5.如果改變產(chǎn)品原有的實現(xiàn)，那么整套流程都需要做出相應(yīng)的調(diào)整，假設(shè)產(chǎn)品本身過于復(fù)雜，那么對于后期的維護是很不利的。在考慮使用時應(yīng)根據(jù)實際情況，對于復(fù)雜且變化頻繁的對象并不適合使用。
五、實際應(yīng)用中的變形
實際使用過程中往往簡化了標準化的構(gòu)建流程，當然也是根據(jù)具體的業(yè)務(wù)場景，一般會省略了Director指導(dǎo)類，Builder接口以及具體的ConcreteBuilder實現(xiàn)類，而直接將Builder作為內(nèi)部類實現(xiàn)在了目標產(chǎn)品類之中。根據(jù)調(diào)用者的選擇得到不同的產(chǎn)品，當然這種比較單一，可以說是最為簡單的一種。僅僅是一種思想上的應(yīng)用，或者說也是一種“取巧”的做法。
- 自身項目中，對于簡單篩選對象的定制：
public class FilterGroup {
private int id;
private String title;
private boolean supportMultiSelected;
private List<FilterOrderDTO> filterFactors;
private FilterGroup(Builder builder) {
if (builder == null) {
return;
}
this.id = builder.id;
this.title = builder.title;
this.supportMultiSelected = builder.supportMultiSelected;
this.filterFactors = builder.filterFactors;
}
public int getId() {
return id;
}
public String getTitle() {
return title;
}
public boolean isSupportMultiSelected() {
return supportMultiSelected;
}
public List<FilterOrderDTO> getFilterFactors() {
return filterFactors;
}
public static class Builder {
private int id;
private String title;
private boolean supportMultiSelected;
private List<FilterOrderDTO> filterFactors;
public Builder setId(int id) {
this.id = id;
return this;
}
public Builder setTitle(String title) {
this.title = title;
return this;
}
public Builder setSupportMultiSelected(boolean supportMultiSelected) {
this.supportMultiSelected = supportMultiSelected;
return this;
}
public Builder setFilterFactors(List<FilterOrderDTO> filterFactors) {
this.filterFactors = filterFactors;
return this;
}
public FilterGroup build() {
return new FilterGroup(this);
}
}
}
1.Builder以靜態(tài)內(nèi)部類的形式存在于產(chǎn)品的內(nèi)部，而產(chǎn)品的特征則是：不同的構(gòu)建組成所對應(yīng)的產(chǎn)品不同，表現(xiàn)出來的性質(zhì)也是不同的。其次Builder中只提供了set方法，而沒有get方法。
2.目標產(chǎn)品FilterGroup的構(gòu)造方法是私有的，并且以Builder為參數(shù)。另外只提供了get方法而沒有set方法。
3.即對于目標的產(chǎn)品的構(gòu)建是通過Builder來完成的，對于用戶它僅僅是“可讀的”。
4.像實際開發(fā)中，這種分部分構(gòu)建產(chǎn)品與整體相分離的可以考慮使用Builder模式，核心思想即為整體構(gòu)建與部件之間的分離，松散產(chǎn)品構(gòu)建與產(chǎn)品表示之間的耦合。
