前言
在使用一些熱門第三方框架的時候势篡,我們往往會發(fā)現(xiàn)饶辙,比如okHttp的client乾戏,初始化retrofit 對象迂苛,初始化 glide 對象等等,都用了這樣:
Retrofit.Builder()
.baseUrl(baseUrl)
.client(getClient())
.addConverterFactory(FastJsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
如此簡潔明了的使用方式歧蕉,如此靈活多變的鏈?zhǔn)秸{(diào)用灾部,它的具體思想是怎樣的呢,來一起掀起它的神秘面紗
介紹
定義
造者模式(Builder Pattern):將一個復(fù)雜對象的構(gòu)建與它的表示分離惯退,使得同樣的構(gòu)建過程可以創(chuàng)建不同的表示赌髓。
建造者模式是一步一步創(chuàng)建一個復(fù)雜的對象,它允許用戶只通過指定復(fù)雜對象的類型和內(nèi)容就可以構(gòu)建它們催跪,用戶不需要知道內(nèi)部的具體構(gòu)建細(xì)節(jié)锁蠕。建造者模式屬于對象創(chuàng)建型模式。根據(jù)中文翻譯的不同懊蒸,建造者模式又可以稱為生成器模式荣倾。
主要作用
在用戶不知道對象的建造過程和細(xì)節(jié)的情況下就可以直接創(chuàng)建復(fù)雜的對象。
- 用戶只需要給出指定復(fù)雜對象的類型和內(nèi)容骑丸;
- 建造者模式負(fù)責(zé)按順序創(chuàng)建復(fù)雜對象(把內(nèi)部的建造過程和細(xì)節(jié)隱藏起來)
解決的問題
- 方便用戶創(chuàng)建復(fù)雜的對象(不需要知道實現(xiàn)過程)
- 代碼復(fù)用性 & 封裝性(將對象構(gòu)建過程和細(xì)節(jié)進(jìn)行封裝 & 復(fù)用)
模式原理
- 指揮者(Director)直接和客戶(Client)進(jìn)行需求溝通舌仍;
- 溝通后指揮者將客戶創(chuàng)建產(chǎn)品的需求劃分為各個部件的建造請求(Builder)妒貌;
- 將各個部件的建造請求委派到具體的建造者(ConcreteBuilder);
- 各個具體建造者負(fù)責(zé)進(jìn)行產(chǎn)品部件的構(gòu)建铸豁;
- 最終構(gòu)建成具體產(chǎn)品(Product)灌曙。
優(yōu)缺點
優(yōu)點
易于解耦
將產(chǎn)品本身與產(chǎn)品創(chuàng)建過程進(jìn)行解耦,可以使用相同的創(chuàng)建過程來得到不同的產(chǎn)品节芥。也就說細(xì)節(jié)依賴抽象在刺。易于精確控制對象的創(chuàng)建
將復(fù)雜產(chǎn)品的創(chuàng)建步驟分解在不同的方法中,使得創(chuàng)建過程更加清晰易于拓展
增加新的具體建造者無需修改原有類庫的代碼头镊,易于拓展蚣驼,符合“開閉原則“。
每一個具體建造者都相對獨立相艇,而與其他的具體建造者無關(guān)颖杏,因此可以很方便地替換具體建造者或增加新的具體建造者,用戶使用不同的具體建造者即可得到不同的產(chǎn)品對象坛芽。
缺點
- 建造者模式所創(chuàng)建的產(chǎn)品一般具有較多的共同點输玷,其組成部分相似;如果產(chǎn)品之間的差異性很大靡馁,則不適合使用建造者模式,因此其使用范圍受到一定的限制机久。
- 如果產(chǎn)品的內(nèi)部變化復(fù)雜臭墨,可能會導(dǎo)致需要定義很多具體建造者類來實現(xiàn)這種變化,導(dǎo)致系統(tǒng)變得很龐大膘盖。
應(yīng)用場景
- 需要生成的產(chǎn)品對象有復(fù)雜的內(nèi)部結(jié)構(gòu)胧弛,這些產(chǎn)品對象具備共性;
- 隔離復(fù)雜對象的創(chuàng)建和使用侠畔,并使得相同的創(chuàng)建過程可以創(chuàng)建不同的產(chǎn)品结缚。
示例
Builder模式是怎么來的
考慮這樣一個場景,假如有一個類(****User****)软棺,里面有很多屬性红竭,并且你希望這些類的屬性都是不可變的(final),就像下面的代碼:
public class User {
private final String firstName; // 必傳參數(shù)
private final String lastName; // 必傳參數(shù)
private final int age; // 可選參數(shù)
private final String phone; // 可選參數(shù)
private final String address; // 可選參數(shù)
}
在這個類中喘落,有些參數(shù)是必要的茵宪,而有些參數(shù)是非必要的。就好比在注冊用戶時瘦棋,用戶的姓和名是必填的稀火,而年齡、手機號和家庭地址等是非必需的赌朋。那么問題就來了凰狞,如何創(chuàng)建這個類的對象呢篇裁?
一種可行的方案就是實用構(gòu)造方法。第一個構(gòu)造方法只包含兩個必需的參數(shù)赡若,第二個構(gòu)造方法中达布,增加一個可選參數(shù),第三個構(gòu)造方法中再增加一個可選參數(shù)斩熊,依次類推往枣,直到構(gòu)造方法中包含了所有的參數(shù)。
public User(String firstName, String lastName) {
this(firstName, lastName, 0);
}
public User(String firstName, String lastName, int age) {
this(firstName, lastName, age, "");
}
public User(String firstName, String lastName, int age, String phone) {
this(firstName, lastName, age, phone, "");
}
public User(String firstName, String lastName, int age, String phone, String address) {
this.firstName = firstName;
this.lastName = lastName;
this.age = age;
this.phone = phone;
this.address = address;
}
這樣做的好處只有一個:可以成功運行粉渠。但是弊端很明顯:
- 參數(shù)較少的時候問題還不大分冈,一旦參數(shù)多了,代碼可讀性就很差霸株,并且難以維護(hù)雕沉。
- 對調(diào)用者來說也很麻煩。如果我只想多傳一個address參數(shù)去件,還必需給age坡椒、phone設(shè)置默認(rèn)值。而且調(diào)用者還會有這樣的困惑:我怎么知道第四個String類型的參數(shù)該傳address還是phone尤溜?
第二種解決辦法就出現(xiàn)了倔叼,我們同樣可以根據(jù)JavaBean的習(xí)慣,設(shè)置一個空參數(shù)的構(gòu)造方法宫莱,然后為每一個屬性設(shè)置setters和getters方法丈攒。就像下面一樣:
public class User {
private String firstName; // 必傳參數(shù)
private String lastName; // 必傳參數(shù)
private int age; // 可選參數(shù)
private String phone; // 可選參數(shù)
private String address; // 可選參數(shù)
public User() {
}
public String getFirstName() {
return firstName;
}
public String getLastName() {
return lastName;
}
public int getAge() {
return age;
}
public String getPhone() {
return phone;
}
public String getAddress() {
return address;
}
}
這種方法看起來可讀性不錯,而且易于維護(hù)授霸。作為調(diào)用者巡验,創(chuàng)建一個空的對象,然后只需傳入我感興趣的參數(shù)碘耳。那么缺點呢显设?也有兩點:
- 對象會產(chǎn)生不一致的狀態(tài)。當(dāng)你想要傳入5個參數(shù)的時候辛辨,你必需將所有的setXX方法調(diào)用完成之后才行捕捂。然而一部分的調(diào)用者看到了這個對象后,以為這個對象已經(jīng)創(chuàng)建完畢愉阎,就直接食用了绞蹦,其實User對象并沒有創(chuàng)建完成。
- ****User****類是可變的了榜旦,不可變類所有好處都不復(fù)存在幽七。
終于輪到主角上場的時候了,利用Builder模式溅呢,我們可以解決上面的問題澡屡,代碼如下:
public class User {
private final String firstName; // 必傳參數(shù)
private final String lastName; // 必傳參數(shù)
private final int age; // 可選參數(shù)
private final String phone; // 可選參數(shù)
private final String address; // 可選參數(shù)
private User(UserBuilder builder) {
this.firstName = builder.firstName;
this.lastName = builder.lastName;
this.age = builder.age;
this.phone = builder.phone;
this.address = builder.address;
}
public String getFirstName() {
return firstName;
}
public String getLastName() {
return lastName;
}
public int getAge() {
return age;
}
public String getPhone() {
return phone;
}
public String getAddress() {
return address;
}
public static class UserBuilder {
private final String firstName;
private final String lastName;
private int age;
private String phone;
private String address;
public UserBuilder(String firstName, String lastName) {
this.firstName = firstName;
this.lastName = lastName;
}
public UserBuilder age(int age) {
this.age = age;
return this;
}
public UserBuilder phone(String phone) {
this.phone = phone;
return this;
}
public UserBuilder address(String address) {
this.address = address;
return this;
}
public User build() {
return new User(this);
}
}
}
有幾個重要的地方需要強調(diào)一下:
- ****User****類的構(gòu)造方法是私有的猿挚。也就是說調(diào)用者不能直接創(chuàng)建User對象。
- ****User****類的屬性都是不可變的驶鹉。所有的屬性都添加了final修飾符绩蜻,并且在構(gòu)造方法中設(shè)置了值。并且室埋,對外只提供getters方法办绝。
- Builder模式使用了鏈?zhǔn)秸{(diào)用∫ο可讀性更佳孕蝉。
- Builder的內(nèi)部類構(gòu)造方法中只接收必傳的參數(shù),并且該必傳的參數(shù)適用了final修飾符腌逢。
相比于前面兩種方法降淮,Builder模式擁有其所有的優(yōu)點,而沒有上述方法中的缺點搏讶〖驯睿客戶端的代碼更容易寫,并且更重要的是媒惕,可讀性非常好系吩。唯一可能存在的問題就是會產(chǎn)生多余的Builder對象,消耗內(nèi)存妒蔚。然而大多數(shù)情況下我們的Builder內(nèi)部類使用的是靜態(tài)修飾的(static)淑玫,所以這個問題也沒多大關(guān)系。
現(xiàn)在面睛,讓我們看看如何創(chuàng)建一個User對象呢?
new User.UserBuilder("金", "坷垃")
.age(25)
.phone("3838438")
.address("奧格瑞瑪")
.build();
關(guān)于Builder的一點說明
線程安全問題
由于Builder是非線程安全的尊搬,所以如果要在Builder內(nèi)部類中檢查一個參數(shù)的合法性叁鉴,必需要在對象創(chuàng)建完成之后再檢查。
正確的寫法:
public User build() {
User user = new user(this);
if (user.getAge() > 120) {
throw new IllegalStateException(“Age out of range”); // 線程安全
}
return user;
}
下面的代碼是非線程安全的:
public User build() {
if (age > 120) {
throw new IllegalStateException(“Age out of range”); // 非線程安全
}
return new User(this);
}
Android源碼中的建造者模式
在Android源碼中愁茁,我們最常用到的Builder模式就是AlertDialog.Builder烁峭, 使用該Builder來構(gòu)建復(fù)雜的AlertDialog對象句柠。簡單示例如下 :
//顯示基本的AlertDialog
private void showDialog(Context context) {
AlertDialog.Builder builder = new AlertDialog.Builder(context);
builder.setIcon(R.drawable.icon);
builder.setTitle("Title");
builder.setMessage("Message");
builder.setPositiveButton("Button1",
new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
setTitle("點擊了對話框上的Button1");
}
});
builder.setNeutralButton("Button2",
new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
setTitle("點擊了對話框上的Button2");
}
});
builder.setNegativeButton("Button3",
new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
setTitle("點擊了對話框上的Button3");
}
});
builder.create().show(); // 構(gòu)建AlertDialog, 并且顯示
}
那么它的內(nèi)部是如何實現(xiàn)的呢常侣,讓我們看一下部分源碼:
// AlertDialog
public class AlertDialog extends Dialog implements DialogInterface {
// Controller, 接受Builder成員變量P中的各個參數(shù)
private AlertController mAlert;
// 構(gòu)造函數(shù)
protected AlertDialog(Context context, int theme) {
this(context, theme, true);
}
// 4 : 構(gòu)造AlertDialog
AlertDialog(Context context, int theme, boolean createContextWrapper) {
super(context, resolveDialogTheme(context, theme), createContextWrapper);
mWindow.alwaysReadCloseOnTouchAttr();
mAlert = new AlertController(getContext(), this, getWindow());
}
// 實際上調(diào)用的是mAlert的setTitle方法
@Override
public void setTitle(CharSequence title) {
super.setTitle(title);
mAlert.setTitle(title);
}
// 實際上調(diào)用的是mAlert的setCustomTitle方法
public void setCustomTitle(View customTitleView) {
mAlert.setCustomTitle(customTitleView);
}
public void setMessage(CharSequence message) {
mAlert.setMessage(message);
}
// AlertDialog其他的代碼省略
// ************ Builder為AlertDialog的內(nèi)部類 *******************
public static class Builder {
// 1 : 存儲AlertDialog的各個參數(shù), 例如title, message, icon等.
private final AlertController.AlertParams P;
// 屬性省略
/**
* Constructor using a context for this builder and the {@link AlertDialog} it creates.
*/
public Builder(Context context) {
this(context, resolveDialogTheme(context, 0));
}
public Builder(Context context, int theme) {
P = new AlertController.AlertParams(new ContextThemeWrapper(
context, resolveDialogTheme(context, theme)));
mTheme = theme;
}
// Builder的其他代碼省略 ......
// 2 : 設(shè)置各種參數(shù)
public Builder setTitle(CharSequence title) {
P.mTitle = title;
return this;
}
public Builder setMessage(CharSequence message) {
P.mMessage = message;
return this;
}
public Builder setIcon(int iconId) {
P.mIconId = iconId;
return this;
}
public Builder setPositiveButton(CharSequence text, final OnClickListener listener) {
P.mPositiveButtonText = text;
P.mPositiveButtonListener = listener;
return this;
}
public Builder setView(View view) {
P.mView = view;
P.mViewSpacingSpecified = false;
return this;
}
// 3 : 構(gòu)建AlertDialog, 傳遞參數(shù)
public AlertDialog create() {
// 調(diào)用new AlertDialog構(gòu)造對象, 并且將參數(shù)傳遞個體AlertDialog
final AlertDialog dialog = new AlertDialog(P.mContext, mTheme, false);
// 5 : 將P中的參數(shù)應(yīng)用的dialog中的mAlert對象中
P.apply(dialog.mAlert);
dialog.setCancelable(P.mCancelable);
if (P.mCancelable) {
dialog.setCanceledOnTouchOutside(true);
}
dialog.setOnCancelListener(P.mOnCancelListener);
if (P.mOnKeyListener != null) {
dialog.setOnKeyListener(P.mOnKeyListener);
}
return dialog;
}
}
}
可以看到弹渔,通過Builder來設(shè)置AlertDialog中的title, message, button等參數(shù)胳施, 這些參數(shù)都存儲在類型為AlertController.AlertParams的成員變量P中,AlertController.AlertParams中包含了與之對應(yīng)的成員變量肢专。在調(diào)用Builder類的create函數(shù)時才創(chuàng)建AlertDialog, 并且將Builder成員變量P中保存的參數(shù)應(yīng)用到AlertDialog的mAlert對象中舞肆,即P.apply(dialog.mAlert)代碼段焦辅。我們看看apply函數(shù)的實現(xiàn) :
public void apply(AlertController dialog) {
if (mCustomTitleView != null) {
dialog.setCustomTitle(mCustomTitleView);
} else {
if (mTitle != null) {
dialog.setTitle(mTitle);
}
if (mIcon != null) {
dialog.setIcon(mIcon);
}
if (mIconId >= 0) {
dialog.setIcon(mIconId);
}
if (mIconAttrId > 0) {
dialog.setIcon(dialog.getIconAttributeResId(mIconAttrId));
}
}
if (mMessage != null) {
dialog.setMessage(mMessage);
}
if (mPositiveButtonText != null) {
dialog.setButton(DialogInterface.BUTTON_POSITIVE, mPositiveButtonText,
mPositiveButtonListener, null);
}
if (mNegativeButtonText != null) {
dialog.setButton(DialogInterface.BUTTON_NEGATIVE, mNegativeButtonText,
mNegativeButtonListener, null);
}
if (mNeutralButtonText != null) {
dialog.setButton(DialogInterface.BUTTON_NEUTRAL, mNeutralButtonText,
mNeutralButtonListener, null);
}
if (mForceInverseBackground) {
dialog.setInverseBackgroundForced(true);
}
// For a list, the client can either supply an array of items or an
// adapter or a cursor
if ((mItems != null) || (mCursor != null) || (mAdapter != null)) {
createListView(dialog);
}
if (mView != null) {
if (mViewSpacingSpecified) {
dialog.setView(mView, mViewSpacingLeft, mViewSpacingTop, mViewSpacingRight,
mViewSpacingBottom);
} else {
dialog.setView(mView);
}
}
}
實際上就是把P中的參數(shù)挨個的設(shè)置到AlertController中, 也就是AlertDialog中的mAlert對象椿胯。從AlertDialog的各個setter方法中我們也可以看到筷登,實際上也都是調(diào)用了mAlert對應(yīng)的setter方法。在這里哩盲,Builder同時扮演了上文中提到的builder前方、ConcreteBuilder、Director的角色廉油,簡化了Builder模式的設(shè)計惠险。
總結(jié)
其核心思想是將一個“復(fù)雜對象的構(gòu)建算法”與它的“部件及組裝方式”分離,使得構(gòu)件算法和組裝方式可以獨立應(yīng)對變化娱两;復(fù)用同樣的構(gòu)建算法可以創(chuàng)建不同的表示莺匠,不同的構(gòu)建過程可以復(fù)用相同的部件組裝方式。
Builder模式目的將一個復(fù)雜對象的構(gòu)建與它的表示分離十兢,使得同樣的構(gòu)建過程可以創(chuàng)建不同的表示趣竣。