GoF給裝飾者模式的定義

上一篇：【Go實(shí)現(xiàn)】實(shí)踐GoF的23種設(shè)計(jì)模式：原型模式

簡單的分布式應(yīng)用系統(tǒng)（示例代碼工程）：https://github.com/ruanrunxue/Practice-Design-Pattern--Go-Implementation

簡介

我們經(jīng)常會(huì)遇到“給現(xiàn)有對(duì)象/模塊新增功能”的場景，比如 http router 的開發(fā)場景下，除了最基礎(chǔ)的路由功能之外，我們常常還會(huì)加上如日志、鑒權(quán)、流控等 middleware。如果你查看框架的源碼，就會(huì)發(fā)現(xiàn) middleware 功能的實(shí)現(xiàn)用的就是裝飾者模式（Decorator Pattern）。

GoF給裝飾者模式的定義如下：

Decorators provide a flexible alternative to subclassing for extending functionality. Attach additional responsibilities to an object dynamically.

簡單來說，裝飾者模式通過組合的方式，提供了能夠動(dòng)態(tài)地給對(duì)象/模塊擴(kuò)展新功能的能力。理論上，只要沒有限制，它可以一直把功能疊加下去，具有很高的靈活性。

如果寫過 Java，那么一定對(duì) I/O Stream 體系不陌生，它是裝飾者模式的經(jīng)典用法，客戶端程序可以動(dòng)態(tài)地為原始的輸入輸出流添加功能，比如按字符串輸入輸出，加入緩沖等，使得整個(gè) I/O Stream 體系具有很高的可擴(kuò)展性和靈活性。

UML 結(jié)構(gòu)

場景上下文

在簡單的分布式應(yīng)用系統(tǒng)（示例代碼工程）中，我們?cè)O(shè)計(jì)了 Sidecar 邊車模塊，它的用處主要是為了 1）方便擴(kuò)展network.Socket的功能，如增加日志、流控等非業(yè)務(wù)功能；2）讓這些附加功能對(duì)業(yè)務(wù)程序隱藏起來，也即業(yè)務(wù)程序只須關(guān)心看到network.Socket接口即可。

代碼實(shí)現(xiàn)

Sidecar 的這個(gè)功能場景，很適合使用裝飾者模式來實(shí)現(xiàn)，代碼如下：

//demo/network/socket.go
packagenetwork

//關(guān)鍵點(diǎn)1:定義被裝飾的抽象接口
//Socket網(wǎng)絡(luò)通信Socket接口
typeSocketinterface{
//Listen在endpoint指向地址上起監(jiān)聽
Listen(endpointEndpoint)error
//Close關(guān)閉監(jiān)聽
Close(endpointEndpoint)
//Send發(fā)送網(wǎng)絡(luò)報(bào)文
Send(packet*Packet)error
//Receive接收網(wǎng)絡(luò)報(bào)文
Receive(packet*Packet)
//AddListener增加網(wǎng)絡(luò)報(bào)文監(jiān)聽者
AddListener(listenerSocketListener)
}

//關(guān)鍵點(diǎn)2:提供一個(gè)默認(rèn)的基礎(chǔ)實(shí)現(xiàn)
typesocketImplstruct{
listenerSocketListener
}

funcDefaultSocket()*socketImpl{
return&socketImpl{}
}

func(s*socketImpl)Listen(endpointEndpoint)error{
returnInstance().Listen(endpoint,s)
}
...//socketImpl的其他Socket實(shí)現(xiàn)方法


//demo/sidecar/flowctrl_sidecar.go
packagesidecar

//關(guān)鍵點(diǎn)3:定義裝飾器，實(shí)現(xiàn)被裝飾的接口
//FlowCtrlSidecarHTTP接收端流控功能裝飾器，自動(dòng)攔截Socket接收?qǐng)?bào)文，實(shí)現(xiàn)流控功能
typeFlowCtrlSidecarstruct{
//關(guān)鍵點(diǎn)4:裝飾器持有被裝飾的抽象接口作為成員屬性
socketnetwork.Socket
ctx*flowctrl.Context
}

//關(guān)鍵點(diǎn)5:對(duì)于需要擴(kuò)展功能的方法，新增擴(kuò)展功能
func(f*FlowCtrlSidecar)Receive(packet*network.Packet){
httpReq,ok:=packet.Payload().(*http.Request)
//如果不是HTTP請(qǐng)求，則不做流控處理
if!ok{
f.socket.Receive(packet)
return
}
//流控后返回429TooManyRequest響應(yīng)
if!f.ctx.TryAccept(){
httpResp:=http.ResponseOfId(httpReq.ReqId()).
AddStatusCode(http.StatusTooManyRequest).
AddProblemDetails("enterflowctrlstate")
f.socket.Send(network.NewPacket(packet.Dest(),packet.Src(),httpResp))
return
}
f.socket.Receive(packet)
}

//關(guān)鍵點(diǎn)6:不需要擴(kuò)展功能的方法，直接調(diào)用被裝飾接口的原生方法即可
func(f*FlowCtrlSidecar)Close(endpointnetwork.Endpoint){
f.socket.Close(endpoint)
}
...//FlowCtrlSidecar的其他方法

//關(guān)鍵點(diǎn)7:定義裝飾器的工廠方法，入?yún)楸谎b飾接口
funcNewFlowCtrlSidecar(socketnetwork.Socket)*FlowCtrlSidecar{
return&FlowCtrlSidecar{
socket:socket,
ctx:flowctrl.NewContext(),
}
}

//demo/sidecar/all_in_one_sidecar_factory.go
//關(guān)鍵點(diǎn)8:使用時(shí)，通過裝飾器的工廠方法，把所有裝飾器和被裝飾者串聯(lián)起來
func(aAllInOneFactory)Create()network.Socket{
returnNewAccessLogSidecar(NewFlowCtrlSidecar(network.DefaultSocket()),a.producer)
}

總結(jié)實(shí)現(xiàn)裝飾者模式的幾個(gè)關(guān)鍵點(diǎn)：

1. 定義需要被裝飾的抽象接口，后續(xù)的裝飾器都是基于該接口進(jìn)行擴(kuò)展。
2. 為抽象接口提供一個(gè)基礎(chǔ)實(shí)現(xiàn)。
3. 定義裝飾器，并實(shí)現(xiàn)被裝飾的抽象接口。
4. 裝飾器持有被裝飾的抽象接口作為成員屬性。“裝飾”的意思是在原有功能的基礎(chǔ)上擴(kuò)展新功能，因此必須持有原有功能的抽象接口。
5. 在裝飾器中，對(duì)于需要擴(kuò)展功能的方法，新增擴(kuò)展功能。
6. 不需要擴(kuò)展功能的方法，直接調(diào)用被裝飾接口的原生方法即可。
7. 為裝飾器定義一個(gè)工廠方法，入?yún)楸谎b飾接口。
8. 使用時(shí)，通過裝飾器的工廠方法，把所有裝飾器和被裝飾者串聯(lián)起來。

擴(kuò)展

Go 風(fēng)格的實(shí)現(xiàn)

在 Sidecar 的場景上下文中，被裝飾的Socket是一個(gè)相對(duì)復(fù)雜的接口，裝飾器通過實(shí)現(xiàn)Socket接口來進(jìn)行功能擴(kuò)展，是典型的面向?qū)ο箫L(fēng)格。

如果被裝飾者是一個(gè)簡單的接口/方法/函數(shù)，我們可以用更具 Go 風(fēng)格的實(shí)現(xiàn)方式，考慮前文提到的 http router 場景。如果你使用原生的net/http進(jìn)行 http router 開發(fā)，通常會(huì)這么實(shí)現(xiàn)：

funcmain(){
//注冊(cè)/hello的router
http.HandleFunc("/hello",hello)
//啟動(dòng)http服務(wù)器
http.ListenAndServe("localhost:8080",nil)
}

//具體的請(qǐng)求處理邏輯，類型是http.HandlerFunc
funchello(whttp.ResponseWriter,r*http.Request){
w.Write([]byte("hello,world"))
}

其中，我們通過http.HandleFunc來注冊(cè)具體的 router，hello是具體的請(qǐng)求處理方法。現(xiàn)在，我們想為該 http 服務(wù)器增加日志、鑒權(quán)等通用功能，那么可以把func(w http.ResponseWriter, r *http.Request)作為被裝飾的抽象接口，通過新增日志、鑒權(quán)等裝飾器完成功能擴(kuò)展。

//demo/network/http/http_handle_func_decorator.go

//關(guān)鍵點(diǎn)1:確定被裝飾接口，這里為原生的http.HandlerFunc
typeHandlerFuncfunc(ResponseWriter,*Request)

//關(guān)鍵點(diǎn)2:定義裝飾器類型，是一個(gè)函數(shù)類型，入?yún)⒑头祷刂刀际莌ttp.HandlerFunc函數(shù)
typeHttpHandlerFuncDecoratorfunc(http.HandlerFunc)http.HandlerFunc

//關(guān)鍵點(diǎn)3:定義裝飾函數(shù)，入?yún)楸谎b飾的接口和裝飾器可變列表
funcDecorate(hhttp.HandlerFunc,decorators...HttpHandlerFuncDecorator)http.HandlerFunc{
//關(guān)鍵點(diǎn)4:通過for循環(huán)遍歷裝飾器，完成對(duì)被裝飾接口的裝飾
for_,decorator:=rangedecorators{
h=decorator(h)
}
returnh
}

//關(guān)鍵點(diǎn)5:實(shí)現(xiàn)具體的裝飾器
funcWithBasicAuth(hhttp.HandlerFunc)http.HandlerFunc{
returnfunc(whttp.ResponseWriter,r*http.Request){
cookie,err:=r.Cookie("Auth")
iferr!=nil||cookie.Value!="Pass"{
w.WriteHeader(http.StatusForbidden)
return
}
//關(guān)鍵點(diǎn)6:完成功能擴(kuò)展之后，調(diào)用被裝飾的方法，才能將所有裝飾器和被裝飾者串起來
h(w,r)
}
}

funcWithLogger(hhttp.HandlerFunc)http.HandlerFunc{
returnfunc(whttp.ResponseWriter,r*http.Request){
log.Println(r.Form)
log.Printf("path%s",r.URL.Path)
h(w,r)
}
}

funchello(whttp.ResponseWriter,r*http.Request){
w.Write([]byte("hello,world"))
}

funcmain(){
//關(guān)鍵點(diǎn)7:通過Decorate函數(shù)完成對(duì)hello的裝飾
http.HandleFunc("/hello",Decorate(hello,WithLogger,WithBasicAuth))
//啟動(dòng)http服務(wù)器
http.ListenAndServe("localhost:8080",nil)
}

上述的裝飾者模式的實(shí)現(xiàn)，用到了類似于Functional Options的技巧，也是巧妙利用了 Go 的函數(shù)式編程的特點(diǎn)，總結(jié)下來有如下幾個(gè)關(guān)鍵點(diǎn)：

1. 確定被裝飾的接口，上述例子為http.HandlerFunc。
2. 定義裝飾器類型，是一個(gè)函數(shù)類型，入?yún)⒑头祷刂刀际潜谎b飾接口，上述例子為func(http.HandlerFunc) http.HandlerFunc。
3. 定義裝飾函數(shù)，入?yún)楸谎b飾的接口和裝飾器可變列表，上述例子為Decorate方法。
4. 在裝飾方法中，通過for循環(huán)遍歷裝飾器，完成對(duì)被裝飾接口的裝飾。這里是用來類似Functional Options的技巧，一定要注意裝飾器的順序！
5. 實(shí)現(xiàn)具體的裝飾器，上述例子為WithBasicAuth和WithLogger函數(shù)。
6. 在裝飾器中，完成功能擴(kuò)展之后，記得調(diào)用被裝飾者的接口，這樣才能將所有裝飾器和被裝飾者串起來。
7. 在使用時(shí)，通過裝飾函數(shù)完成對(duì)被裝飾者的裝飾，上述例子為Decorate(hello, WithLogger, WithBasicAuth)。

Go 標(biāo)準(zhǔn)庫中的裝飾者模式

在 Go 標(biāo)準(zhǔn)庫中，也有一個(gè)運(yùn)用了裝飾者模式的模塊，就是context，其中關(guān)鍵的接口如下：

packagecontext

//被裝飾接口
typeContextinterface{
Deadline()(deadlinetime.Time,okbool)
Done()<-chanstruct{}
Err()error
Value(keyany)any
}

//cancel裝飾器
typecancelCtxstruct{
Context//被裝飾接口
musync.Mutex
doneatomic.Value
childrenmap[canceler]struct{}=
errerror
}
//cancel裝飾器的工廠方法
funcWithCancel(parentContext)(ctxContext,cancelCancelFunc){
//...
c:=newCancelCtx(parent)
propagateCancel(parent,&c)
return&c,func(){c.cancel(true,Canceled)}
}

//timer裝飾器
typetimerCtxstruct{
cancelCtx//被裝飾接口
timer*time.Timer

deadlinetime.Time
}
//timer裝飾器的工廠方法
funcWithDeadline(parentContext,dtime.Time)(Context,CancelFunc){
//...
c:=&timerCtx{
cancelCtx:newCancelCtx(parent),
deadline:d,
}
//...
returnc,func(){c.cancel(true,Canceled)}
}
//timer裝飾器的工廠方法
funcWithTimeout(parentContext,timeouttime.Duration)(Context,CancelFunc){
returnWithDeadline(parent,time.Now().Add(timeout))
}

//value裝飾器
typevalueCtxstruct{
Context//被裝飾接口
key,valany
}
//value裝飾器的工廠方法
funcWithValue(parentContext,key,valany)Context{
ifparent==nil{
panic("cannotcreatecontextfromnilparent")
}
//...
return&valueCtx{parent,key,val}
}

使用時(shí)，可以這樣：

//使用時(shí)，可以這樣
funcmain(){
ctx:=context.Background()
ctx=context.WithValue(ctx,"key1","value1")
ctx,_=context.WithTimeout(ctx,time.Duration(1))
ctx=context.WithValue(ctx,"key2","value2")
}

不管是 UML 結(jié)構(gòu)，還是使用方法，context模塊都與傳統(tǒng)的裝飾者模式有一定出入，但也不妨礙context是裝飾者模式的典型運(yùn)用。還是那句話，學(xué)習(xí)設(shè)計(jì)模式，不能只記住它的結(jié)構(gòu)，而是學(xué)習(xí)其中的動(dòng)機(jī)和原理。

典型使用場景

• I/O 流，比如為原始的 I/O 流增加緩沖、壓縮等功能。
• Http Router，比如為基礎(chǔ)的 Http Router 能力增加日志、鑒權(quán)、Cookie等功能。
• ......

優(yōu)缺點(diǎn)

優(yōu)點(diǎn)

1. 遵循開閉原則，能夠在不修改老代碼的情況下擴(kuò)展新功能。
2. 可以用多個(gè)裝飾器把多個(gè)功能組合起來，理論上可以無限組合。

缺點(diǎn)

1. 一定要注意裝飾器裝飾的順序，否則容易出現(xiàn)不在預(yù)期內(nèi)的行為。
2. 當(dāng)裝飾器越來越多之后，系統(tǒng)也會(huì)變得復(fù)雜。

與其他模式的關(guān)聯(lián)

裝飾者模式和代理模式具有很高的相似性，但是兩種所強(qiáng)調(diào)的點(diǎn)不一樣。前者強(qiáng)調(diào)的是為本體對(duì)象添加新的功能；后者強(qiáng)調(diào)的是對(duì)本體對(duì)象的訪問控制。

裝飾者模式和適配器模式的區(qū)別是，前者只會(huì)擴(kuò)展功能而不會(huì)修改接口；后者則會(huì)修改接口。

文章配圖

可以在用Keynote畫出手繪風(fēng)格的配圖中找到文章的繪圖方法。

審核編輯 ：李倩