這篇小文將講述我是如何根據(jù)建造者設(shè)計(jì)模式來(lái)實(shí)現(xiàn)一個(gè)全局Dialog。
如果各位看官還不太了解建造者設(shè)計(jì)模式，建議可以看一下我的上篇文章。
背景
在每個(gè)項(xiàng)目當(dāng)中，都會(huì)封裝一些全局的樣式，比如全局Loading、全局Dialog等。
封裝這些功能是因?yàn)檫@些控件的使用頻率極高。
在我剛接手項(xiàng)目A的時(shí)候，項(xiàng)目A也不例外，擁有著全局的Dialog。
剛開(kāi)始時(shí)我盡量寫(xiě)一些侵入性低、仿照率高的代碼，避免影響到之前的邏輯。并且學(xué)習(xí)著如何使用項(xiàng)目A的框架，這個(gè)過(guò)程我相信大家都是一樣的。
當(dāng)我用到Dialog的時(shí)候，我看到了項(xiàng)目A的全局Dialog，詳細(xì)代碼就不說(shuō)了，給大家看一下項(xiàng)目A全局Dialog中的所有方法：
不知各位看官會(huì)不會(huì)被這么多的構(gòu)造方法給嚇到。
這些構(gòu)造方法都是隨著項(xiàng)目需求的增加而增加的。
大家都知道，一個(gè)完整Dialog包括的元素至少應(yīng)該有：提示圖片、標(biāo)題、描述文字、按鈕等。
但是這些元素都不是必須的：
在C頁(yè)面我彈出的Dialog可能只要做一個(gè)溫馨提示：一行描述文字外加一個(gè)確認(rèn)按鈕。
在D頁(yè)面我可能彈出的是用戶退出登錄的二次確認(rèn)窗口：標(biāo)題+文字+兩個(gè)按鈕。
那么到這里，各位看官就能明白了，為什么會(huì)有那么多的構(gòu)造方法。
沒(méi)錯(cuò)，我們?cè)?strong>new KLCustimDialog()的同時(shí)，需要把所有的參數(shù)都傳入進(jìn)去。
這種寫(xiě)法的問(wèn)題以及維護(hù)成本之高，我就不做過(guò)多描述了，我就簡(jiǎn)單給大家加個(gè)需求：
要求點(diǎn)擊Dialog外部不能取消Dialog。
想想這個(gè)需求下的構(gòu)造方法，要添加幾個(gè)？
基本
當(dāng)我剛看到建造者模式的時(shí)候，我真是又驚又喜，熱血沸騰！
我第一時(shí)間想到的就是重構(gòu)項(xiàng)目A的全局Dialog！
大家都知道，Android中的AlertDialog就是使用建造者模式來(lái)實(shí)現(xiàn)的。
在我模仿構(gòu)思了一波之后，創(chuàng)建Dialog的代碼是這樣的：
Dialog.Builder builder = new Dialog.Builder(context);
builder.setTitle("提示");
builder.setMessage("確認(rèn)退出登錄嗎？");
builder.setLeftText("取消");
builder.setRightText("確認(rèn)");
builder.setOnclickListener(listener);
Dialog dialog = builder.creater();
dialog.show();
這樣寫(xiě)似乎沒(méi)有什么問(wèn)題了。
我們把Dialog的所有元素都默認(rèn)隱藏，在調(diào)用某個(gè)元素的填充方法后，我們就將其顯示出來(lái)。
這樣我們就擺脫了無(wú)限多的構(gòu)造方法，完美！
文章到這里就應(yīng)該結(jié)束了？
怎么可能！我都沒(méi)變形呢！
我見(jiàn)別人的Builder模式都是這樣寫(xiě)的：
Picasso.with(context)
.load(url)
.fit()
.config(XXX)
.placeholder(xxx)
.error(xxx)
.into(imageView);
上述代碼是使用Picasso來(lái)加載url圖片。
一行代碼完成。
帥不帥，想不想學(xué)？
所以我就想能不能用上面作為模板，來(lái)實(shí)現(xiàn)我們的全局Dialog。
話不多說(shuō)，說(shuō)干就干。
變形
完整代碼我已經(jīng)上傳GitHub，看代碼我還是建議各位看官去我的GitHub上看，比較整潔。
最終實(shí)現(xiàn)的效果如下：
首先，讓我們來(lái)回想一下建造者模式的組成：
- Product：產(chǎn)品角色
- Builder：抽象的建造者
- ConcreteBuilder：具體的建造者
- Director：指揮者
接下來(lái)，我們?cè)侔堰@些成員轉(zhuǎn)化為我們的全局Dialog的成員：
- Product：Dialog就是我們制作出來(lái)的產(chǎn)品
- Builder：Dialog參數(shù)拼接抽象
- ConcreteBuilder：Dialog參數(shù)拼接細(xì)節(jié)
- Director：所有用到該Dialog的地方都是指揮者，它們決定著Dialog具體樣式。
思路有了，下面就開(kāi)始動(dòng)手吧，首先我們來(lái)創(chuàng)建Dialog的參數(shù)封裝，里面應(yīng)該有Dialog所有組成元素：
private static class DialogParams {
private Context context;
//標(biāo)題
private String title;
//標(biāo)題字體大小
private int titleSizeSp;
//圖標(biāo)資源
private int imageResource;
//圖標(biāo)寬
private int imageWidth;
//圖標(biāo)高
private int imageHeight;
//消息內(nèi)容
private String message1;
//消息內(nèi)容文字位置
private int message1Gravity = Gravity.CENTER;
//點(diǎn)擊外部是否可以取消
private boolean isCanCancel = true;
//左邊按鈕內(nèi)容
private String leftButtonText;
//左邊按鈕顏色
private int leftBtColor;
//左邊點(diǎn)擊事件
private ConcreteBuilder.ButtonClickLister leftListener;
//右邊按鈕內(nèi)容
private String rightButtontText;
//右邊邊按鈕顏色
private int rightBtColor;
//右邊按鈕點(diǎn)擊事件
private ConcreteBuilder.ButtonClickLister rightListener;
}
我使用了內(nèi)部類(lèi)去實(shí)現(xiàn)了整個(gè)Dialog，整個(gè)Dialog只有一個(gè)類(lèi)，所以所有參數(shù)都是private并且沒(méi)有提供set、get。
并且我為了方便，省略了Builder抽象類(lèi)，直接構(gòu)造了Builder抽象類(lèi)的實(shí)現(xiàn)ConcreteBuilder：
public static class ConcreteBuilder {
//持有Product對(duì)象
private DialogParams p;
ConcreteBuilder(Context context) {
p = new DialogParams();
p.context = context;
}
public ConcreteBuilder title(String text) {
p.title = text;
return builder;
}
public ConcreteBuilder titleSize(int spSize) {
p.titleSizeSp = spSize;
return builder;
}
public ConcreteBuilder imageResource(int imageResource) {
p.imageResource = imageResource;
return builder;
}
public ConcreteBuilder imageWidth(int imageWidth) {
p.imageWidth = imageWidth;
return builder;
}
public ConcreteBuilder imageHeight(int imageHeight) {
p.imageHeight = imageHeight;
return builder;
}
public ConcreteBuilder message(String text) {
p.message1 = text;
return builder;
}
public ConcreteBuilder messageGravity(int gravity) {
p.message1Gravity = gravity;
return builder;
}
public ConcreteBuilder canCancel(boolean isCanCancel) {
p.isCanCancel = isCanCancel;
return builder;
}
public ConcreteBuilder leftBt(String text, ButtonClickLister lister) {
p.leftButtonText = text;
p.leftListener = lister;
return builder;
}
public ConcreteBuilder leftBtColor(int color) {
p.leftBtColor = color;
return builder;
}
public ConcreteBuilder rightBtColor(int color) {
p.rightBtColor = color;
return builder;
}
public ConcreteBuilder rightBt(String text, ButtonClickLister lister) {
p.rightButtontText = text;
p.rightListener = lister;
return builder;
}
void clear() {
p = null;
}
public DialogProduct create() {
return new DialogProduct(p);
}
//按鈕點(diǎn)擊回調(diào)
public interface ButtonClickLister {
void onClick(DialogProduct dialog);
}
}
我們會(huì)發(fā)現(xiàn)每個(gè)參數(shù)拼接方法都會(huì)返回ConcreteBuilder,這里是實(shí)現(xiàn)一行代碼構(gòu)建Dialog的關(guān)鍵。
參考Picasso的書(shū)寫(xiě)方式，明顯可以看出它沒(méi)有進(jìn)行new的行為，說(shuō)明with()一定是靜態(tài)的，隨之with()返回的對(duì)象也必為靜態(tài)。
為了實(shí)現(xiàn)Picasso的書(shū)寫(xiě)方式，我們這里也將ConcreteBuilder靜態(tài)，方便實(shí)現(xiàn)一句話創(chuàng)建Dialog。
接下來(lái)就是Dialog的代碼：
public class DialogProduct extends Dialog {
private TextView tvTitle;
private ImageView ivIcon;
private TextView tvMessage;
private TextView tvButtonLeft;
private TextView tvButtonRight;
private ImageView viewLine;
//持有Builder
private static ConcreteBuilder builder;
//模仿Picasso的書(shū)寫(xiě)方式
public static ConcreteBuilder with(Context context) {
if (builder == null) {
builder = new ConcreteBuilder(context);
}
return builder;
}
private DialogProduct(DialogParams p) {
//設(shè)置沒(méi)有標(biāo)題的Dialog風(fēng)格
super(p.context, R.style.NoTitleDialog);
View contentView = LayoutInflater.from(p.context).inflate(R.layout.dialog_build, null);
setContentView(contentView);
tvTitle = contentView.findViewById(R.id.tv_title);
ivIcon = contentView.findViewById(R.id.iv_icon);
tvMessage = contentView.findViewById(R.id.tv_message);
tvButtonLeft = contentView.findViewById(R.id.tv_button_left);
tvButtonRight = contentView.findViewById(R.id.tv_button_right);
viewLine = contentView.findViewById(R.id.view_line);
//控件默認(rèn)隱藏
tvTitle.setVisibility(View.GONE);
viewLine.setVisibility(View.GONE);
ivIcon.setVisibility(View.GONE);
tvMessage.setVisibility(View.GONE);
tvButtonLeft.setVisibility(View.GONE);
tvButtonRight.setVisibility(View.GONE);
//構(gòu)建Dialog
setTitlText(p.title);
setTitlTextSize(p.titleSizeSp);
setImageResource(p.imageResource);
setImageWidth(p.imageWidth);
setImageHeight(p.imageHeight);
setTvMessage(p.message1);
setTvMessageGravity(p.message1Gravity);
setCancelableFlag(p.isCanCancel);
setLeftText(p.leftButtonText, p.leftListener);
setLeftBtColor(p.leftBtColor);
setRightText(p.rightButtontText, p.rightListener);
setRightBtColor(p.rightBtColor);
}
/**
* 設(shè)置標(biāo)題
*
* @param title 標(biāo)題文字
*/
private void setTitlText(String title) {
if (TextUtils.isEmpty(title)) {
return;
}
tvTitle.setVisibility(View.VISIBLE);
tvTitle.setText(title);
}
//......省略剩余控件代碼
}
寫(xiě)完之后，我們來(lái)看看這個(gè)變形的建造者模式的Dialog是如何創(chuàng)建的：
DialogProduct.with(this)
.title("提示")
.message("您確認(rèn)退出登錄嗎？")
.canCancel(false)
.leftBtColor(getResources().getColor(R.color.color_0090ff))
.rightBtColor(getResources().getColor(R.color.color_f96c59))
.leftBt("取消", new NormalDialog.ConcreteBuilder.ButtonClickLister() {
@Override
public void onClick(NormalDialog dialog) {
dialog.cancel();
}
})
.rightBt("確認(rèn)", new NormalDialog.ConcreteBuilder.ButtonClickLister() {
@Override
public void onClick(NormalDialog dialog) {
Toast.makeText(BuilderActivity.this, "退出登錄成功！", Toast.LENGTH_SHORT).show();
dialog.cancel();
}
})
.create()
.show();
總結(jié)
DialogProduct的代碼我已經(jīng)上傳到了GitHub，各位看官可以自行食用。
這個(gè)Dialog現(xiàn)在也是項(xiàng)目A中的全局Dialog，使用起來(lái)也非常方便。
這里有幾個(gè)細(xì)節(jié)可以和各位看官分享一下：
第一個(gè)就是按鈕的點(diǎn)擊事件設(shè)置，我將其與按鈕文字內(nèi)容的設(shè)置綁定在一起。因?yàn)槲艺J(rèn)為你設(shè)置了按鈕，怎么可能會(huì)沒(méi)有點(diǎn)擊事件？
第二個(gè)就是按鈕中間的分割線，是與右邊按鈕綁定的， 所以當(dāng)只有一個(gè)按鈕時(shí)，我們應(yīng)該使用左邊的按鈕leftBt而不是右邊的。
基本上就是這樣啦！
希望這個(gè)Dialog可以給大家?guī)?lái)一些靈感。
