Go语言的修饰器编程

之前写过一篇《Python修饰器的函数式编程》,这种模式很容易的可以把一些函数装配到另外一些函数上,可以让你的代码更为的简单,也可以让一些“小功能型”的代码复用性更高,让代码中的函数可以像乐高玩具那样自由地拼装。所以,一直以来,我对修饰器decoration这种编程模式情有独钟,这里写一篇Go语言相关的文章。

看过Python修饰器那篇文章的同学,一定知道这是一种函数式编程的玩法——用一个高阶函数来包装一下。多唠叨一句,关于函数式编程,可以参看我之前写过一篇文章《函数式编程》,这篇文章主要是,想通过从过程式编程的思维方式过渡到函数式编程的思维方式,从而带动更多的人玩函数式编程,所以,如果你想了解一下函数式编程,那么可以移步先阅读一下。所以,Go语言的修饰器编程模式,其实也就是函数式编程的模式。

不过,要提醒注意的是,Go 语言的“糖”不多,而且又是强类型的静态无虚拟机的语言,所以,无法做到像 Java 和 Python 那样的优雅的修饰器的代码。当然,也许是我才才疏学浅,如果你知道有更多的写法,请你一定告诉我。先谢过了。

简单示例

我们先来看一个示例:

package main</p>
<p>import &quot;fmt&quot;</p>
<p>func decorator(f func(s string)) func(s string) {</p>
<p> return func(s string) {<br /> fmt.Println(&quot;Started&quot;)<br /> f(s)<br /> fmt.Println(&quot;Done&quot;)<br /> }<br />
}</p>
<p>func Hello(s string) {<br /> fmt.Println(s)<br />
}</p>
<p>func main() {<br /> decorator(Hello)(&quot;Hello, World!&quot;)<br />
}

我们可以看到,我们动用了一个高阶函数 decorator(),在调用的时候,先把 Hello() 函数传进去,然后其返回一个匿名函数,这个匿名函数中除了运行了自己的代码,也调用了被传入的 Hello() 函数。

这个玩法和 Python 的异曲同工,只不过,有些遗憾的是,Go 并不支持像 Python 那样的 @decorator 语法糖。所以,在调用上有些难看。当然,如果你要想让代码容易读一些,你可以这样:

hello := decorator(Hello)<br />
hello(&quot;Hello&quot;)

我们再来看一个和计算运行时间的例子:

package main</p>
<p>import (<br /> &quot;fmt&quot;<br /> &quot;reflect&quot;<br /> &quot;runtime&quot;<br /> &quot;time&quot;<br />
)</p>
<p>type SumFunc func(int64, int64) int64</p>
<p>func getFunctionName(i interface{}) string {<br /> return runtime.FuncForPC(reflect.ValueOf(i).Pointer()).Name()<br />
}</p>
<p>func timedSumFunc(f SumFunc) SumFunc {<br /> return func(start, end int64) int64 {</p>
<p> defer func(t time.Time) {<br /> fmt.Printf(&quot;--- Time Elapsed (%s): %v ---\n&quot;,<br /> getFunctionName(f), time.Since(t))<br /> }(time.Now())</p>
<p> return f(start, end)<br /> }<br />
}</p>
<p>func Sum1(start, end int64) int64 {<br /> var sum int64<br /> sum = 0<br /> if start &gt; end {<br /> start, end = end, start<br /> }<br /> for i := start; i &lt;= end; i++ {<br /> sum += i<br /> }<br /> return sum<br />
}</p>
<p>func Sum2(start, end int64) int64 {<br /> if start &gt; end {<br /> start, end = end, start<br /> }<br /> return (end - start + 1) * (end + start) / 2<br />
}</p>
<p>func main() {</p>
<p> sum1 := timedSumFunc(Sum1)<br /> sum2 := timedSumFunc(Sum2)</p>
<p> fmt.Printf(&quot;%d, %d\n&quot;, sum1(-10000, 10000000), sum2(-10000, 10000000))<br />
}

关于上面的代码,有几个事说明一下:

1)有两个 Sum 函数,Sum1() 函数就是简单的做个循环,Sum2() 函数动用了数据公式。(注意:start 和 end 有可能有负数的情况)

2)代码中使用了 Go 语言的反射机器来获取函数名。

3)修饰器函数是 timedSumFunc()

运行后输出:

<br />
$ go run time.sum.go<br />
--- Time Elapsed (main.Sum1): 3.557469ms ---<br />
--- Time Elapsed (main.Sum2): 291ns ---<br />
49999954995000, 49999954995000<br />

HTTP 相关的一个示例

我们再来看一个处理 HTTP 请求的相关的例子。

先看一个简单的 HTTP Server 的代码。

<br />
package main</p>
<p>import (<br /> &quot;fmt&quot;<br /> &quot;log&quot;<br /> &quot;net/http&quot;<br /> &quot;strings&quot;<br />
)</p>
<p>func WithServerHeader(h http.HandlerFunc) http.HandlerFunc {<br /> return func(w http.ResponseWriter, r *http.Request) {<br /> log.Println(&quot;---&gt;WithServerHeader()&quot;)<br /> w.Header().Set(&quot;Server&quot;, &quot;HelloServer v0.0.1&quot;)<br /> h(w, r)<br /> }<br />
}</p>
<p>func hello(w http.ResponseWriter, r *http.Request) {<br /> log.Printf(&quot;Recieved Request %s from %s\n&quot;, r.URL.Path, r.RemoteAddr)<br /> fmt.Fprintf(w, &quot;Hello, World! &quot;+r.URL.Path)<br />
}</p>
<p>func main() {<br /> http.HandleFunc(&quot;/v1/hello&quot;, WithServerHeader(hello))<br /> err := http.ListenAndServe(&quot;:8080&quot;, nil)<br /> if err != nil {<br /> log.Fatal(&quot;ListenAndServe: &quot;, err)<br /> }<br />
}

上面代码中使用到了修饰模式,WithServerHeader() 函数就是一个 Decorator,其传入一个 http.HandlerFunc,然后返回一个改写的版本。上面的例子还是比较简单,用 WithServerHeader() 就可以加入一个 Response 的 Header。

于是,这样的函数我们可以写出好些个。如下所示,有写 HTTP 响应头的,有写认证 Cookie 的,有检查认证Cookie的,有打日志的……

package main</p>
<p>import (<br /> &quot;fmt&quot;<br /> &quot;log&quot;<br /> &quot;net/http&quot;<br /> &quot;strings&quot;<br />
)</p>
<p>func WithServerHeader(h http.HandlerFunc) http.HandlerFunc {<br /> return func(w http.ResponseWriter, r *http.Request) {<br /> log.Println(&quot;---&gt;WithServerHeader()&quot;)<br /> w.Header().Set(&quot;Server&quot;, &quot;HelloServer v0.0.1&quot;)<br /> h(w, r)<br /> }<br />
}</p>
<p>func WithAuthCookie(h http.HandlerFunc) http.HandlerFunc {<br /> return func(w http.ResponseWriter, r *http.Request) {<br /> log.Println(&quot;---&gt;WithAuthCookie()&quot;)<br /> cookie := &amp;http.Cookie{Name: &quot;Auth&quot;, Value: &quot;Pass&quot;, Path: &quot;/&quot;}<br /> http.SetCookie(w, cookie)<br /> h(w, r)<br /> }<br />
}</p>
<p>func WithBasicAuth(h http.HandlerFunc) http.HandlerFunc {<br /> return func(w http.ResponseWriter, r *http.Request) {<br /> log.Println(&quot;---&gt;WithBasicAuth()&quot;)<br /> cookie, err := r.Cookie(&quot;Auth&quot;)<br /> if err != nil || cookie.Value != &quot;Pass&quot; {<br /> w.WriteHeader(http.StatusForbidden)<br /> return<br /> }<br /> h(w, r)<br /> }<br />
}</p>
<p>func WithDebugLog(h http.HandlerFunc) http.HandlerFunc {<br /> return func(w http.ResponseWriter, r *http.Request) {<br /> log.Println(&quot;---&gt;WithDebugLog&quot;)<br /> r.ParseForm()<br /> log.Println(r.Form)<br /> log.Println(&quot;path&quot;, r.URL.Path)<br /> log.Println(&quot;scheme&quot;, r.URL.Scheme)<br /> log.Println(r.Form[&quot;url_long&quot;])<br /> for k, v := range r.Form {<br /> log.Println(&quot;key:&quot;, k)<br /> log.Println(&quot;val:&quot;, strings.Join(v, &quot;&quot;))<br /> }<br /> h(w, r)<br /> }<br />
}<br />
func hello(w http.ResponseWriter, r *http.Request) {<br /> log.Printf(&quot;Recieved Request %s from %s\n&quot;, r.URL.Path, r.RemoteAddr)<br /> fmt.Fprintf(w, &quot;Hello, World! &quot;+r.URL.Path)<br />
}</p>
<p>func main() {<br /> http.HandleFunc(&quot;/v1/hello&quot;, WithServerHeader(WithAuthCookie(hello)))<br /> http.HandleFunc(&quot;/v2/hello&quot;, WithServerHeader(WithBasicAuth(hello)))<br /> http.HandleFunc(&quot;/v3/hello&quot;, WithServerHeader(WithBasicAuth(WithDebugLog(hello))))<br /> err := http.ListenAndServe(&quot;:8080&quot;, nil)<br /> if err != nil {<br /> log.Fatal(&quot;ListenAndServe: &quot;, err)<br /> }<br />
}

多个修饰器的 Pipeline

在使用上,需要对函数一层层的套起来,看上去好像不是很好看,如果需要 decorator 比较多的话,代码会比较难看了。嗯,我们可以重构一下。

重构时,我们需要先写一个工具函数——用来遍历并调用各个 decorator:

type HttpHandlerDecorator func(http.HandlerFunc) http.HandlerFunc</p>
<p>func Handler(h http.HandlerFunc, decors ...HttpHandlerDecorator) http.HandlerFunc {<br /> for i := range decors {<br /> d := decors[len(decors)-1-i] // iterate in reverse<br /> h = d(h)<br /> }<br /> return h<br />
}

然后,我们就可以像下面这样使用了。

http.HandleFunc(&quot;/v4/hello&quot;, Handler(hello,<br /> WithServerHeader, WithBasicAuth, WithDebugLog))

这样的代码是不是更易读了一些?pipeline 的功能也就出来了。

泛型的修饰器

不过,对于 Go 的修饰器模式,还有一个小问题 —— 好像无法做到泛型,就像上面那个计算时间的函数一样,其代码耦合了需要被修饰的函数的接口类型,无法做到非常通用,如果这个事解决不了,那么,这个修饰器模式还是有点不好用的。

因为 Go 语言不像 Python 和 Java,Python是动态语言,而 Java 有语言虚拟机,所以他们可以干好些比较变态的事,然而 Go 语言是一个静态的语言,这意味着其类型需要在编译时就要搞定,否则无法编译。不过,Go 语言支持的最大的泛型是 interface{} 还有比较简单的 reflection 机制,在上面做做文章,应该还是可以搞定的。

废话不说,下面是我用 reflection 机制写的一个比较通用的修饰器(为了便于阅读,我删除了出错判断代码)

func Decorator(decoPtr, fn interface{}) (err error) {<br /> var decoratedFunc, targetFunc reflect.Value</p>
<p> decoratedFunc = reflect.ValueOf(decoPtr).Elem()<br /> targetFunc = reflect.ValueOf(fn)</p>
<p> v := reflect.MakeFunc(targetFunc.Type(),<br /> func(in []reflect.Value) (out []reflect.Value) {<br /> fmt.Println(&quot;before&quot;)<br /> out = targetFunc.Call(in)<br /> fmt.Println(&quot;after&quot;)<br /> return<br /> })</p>
<p> decoratedFunc.Set(v)<br /> return<br />
}

上面的代码动用了 reflect.MakeFunc() 函数制出了一个新的函数其中的 targetFunc.Call(in) 调用了被修饰的函数。关于 Go 语言的反射机制,推荐官方文章 —— 《The Laws of Reflection》,在这里我不多说了。

上面这个 Decorator() 需要两个参数,

  • 第一个是出参 decoPtr ,就是完成修饰后的函数
  • 第二个是入参 fn ,就是需要修饰的函数

这样写是不是有些二?的确是的。不过,这是我个人在 Go 语言里所能写出来的最好的的代码了。如果你知道更多优雅的,请你一定告诉我!

好的,让我们来看一下使用效果。首先假设我们有两个需要修饰的函数:

func foo(a, b, c int) int {<br /> fmt.Printf(&quot;%d, %d, %d \n&quot;, a, b, c)<br /> return a + b + c<br />
}</p>
<p>func bar(a, b string) string {<br /> fmt.Printf(&quot;%s, %s \n&quot;, a, b)<br /> return a + b<br />
}

然后,我们可以这样做:

<br />
type MyFoo func(int, int, int) int<br />
var myfoo MyFoo<br />
Decorator(&amp;myfoo, foo)<br />
myfoo(1, 2, 3)<br />

你会发现,使用 Decorator() 时,还需要先声明一个函数签名,感觉好傻啊。一点都不泛型,不是吗?

嗯。如果你不想声明函数签名,那么你也可以这样

mybar := bar<br />
Decorator(&amp;mybar, bar)<br />
mybar(&quot;hello,&quot;, &quot;world!&quot;)

好吧,看上去不是那么的漂亮,但是 it works。看样子 Go 语言目前本身的特性无法做成像 Java 或 Python 那样,对此,我们只能多求 Go 语言多放糖了!

Again, 如果你有更好的写法,请你一定要告诉我。

(全文完)


关注CoolShell微信公众账号可以在手机端搜索文章

(转载本站文章请注明作者和出处 酷 壳 – CoolShell ,请勿用于任何商业用途)

——=== 访问 酷壳404页面 寻找遗失儿童。 ===——