GO语言的修饰器编程

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

我们先来看一个示例：

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

<code>package main</code>

<code>import </code><code>"fmt"</code>

<code>func decorator(f func(s string)) func(s string) {</code>

<code></code><code>return</code> <code>func(s string) {</code>

<code></code><code>fmt.Println(</code><code>"Started"</code><code>)</code>

<code></code><code>f(s)</code>

<code></code><code>fmt.Println(</code><code>"Done"</code><code>)</code>

<code></code><code>}</code>

<code>}</code>

<code>func Hello(s string) {</code>

<code></code><code>fmt.Println(s)</code>

<code>func main() {</code>

<code></code><code>decorator(Hello)(</code><code>"Hello, World!"</code><code>)</code>

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

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

<code>hello := decorator(Hello)</code>

<code>hello(</code><code>"Hello"</code><code>)</code>

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

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

<code>import (</code>

<code></code><code>"fmt"</code>

<code></code><code>"reflect"</code>

<code></code><code>"runtime"</code>

<code></code><code>"time"</code>

<code>)</code>

<code>type SumFunc func(int64, int64) int64</code>

<code>func getFunctionName(i interface{}) string {</code>

<code></code><code>return</code> <code>runtime.FuncForPC(reflect.ValueOf(i).Pointer()).Name()</code>

<code>func timedSumFunc(f SumFunc) SumFunc {</code>

<code></code><code>return</code> <code>func(start, end int64) int64 {</code>

<code></code><code>defer func(t </code><code>time</code><code>.Time) {</code>

<code></code><code>fmt.Printf(</code><code>"--- Time Elapsed (%s): %v ---\n"</code><code>,</code>

<code></code><code>getFunctionName(f), </code><code>time</code><code>.Since(t))</code>

<code></code><code>}(</code><code>time</code><code>.Now())</code>

<code></code><code>return</code> <code>f(start, end)</code>

<code>func Sum1(start, end int64) int64 {</code>

<code></code><code>var sum int64</code>

<code></code><code>sum = 0</code>

<code></code><code>if</code> <code>start &gt; end {</code>

<code></code><code>start, end = end, start</code>

<code></code><code>for</code> <code>i := start; i &lt;= end; i++ {</code>

<code></code><code>sum += i</code>

<code></code><code>return</code> <code>sum</code>

<code>func Sum2(start, end int64) int64 {</code>

<code></code><code>return</code> <code>(end - start + 1) * (end + start) / 2</code>

<code></code><code>sum1 := timedSumFunc(Sum1)</code>

<code></code><code>sum2 := timedSumFunc(Sum2)</code>

<code></code><code>fmt.Printf(</code><code>"%d, %d\n"</code><code>, sum1(-10000, 10000000), sum2(-10000, 10000000))</code>

关于上面的代码，有几个事说明一下：

1）有两个 Sum 函数，<code>Sum1()</code> 函数就是简单的做个循环，<code>Sum2()</code> 函数动用了数据公式。（注意：start 和 end 有可能有负数的情况）

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

3）修饰器函数是 <code>timedSumFunc()</code>

运行后输出：

<code>$ go run </code><code>time</code><code>.</code><code>sum</code><code>.go</code>

<code>--- Time Elapsed (main.Sum1): 3.557469ms ---</code>

<code>--- Time Elapsed (main.Sum2): 291ns ---</code>

<code>49999954995000, 49999954995000</code>

1.近期整理了20G资源，包含产品/运营/测试/程序员/市场等，互联网从业者【工作必备干货技巧、行业专业书籍、面试真题宝典等】，获取方式：

微信扫码关注公众号“非典型互联网”，转发文章到朋友圈，截图发至公众号后台，即可获取干货资源链接；

2.互联网人交流群：

关注公众号“非典型互联网”，在公众号后台回复“入群”，人脉共享，一起交流；

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

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

<code></code><code>"log"</code>

<code></code><code>"net/http"</code>

<code></code><code>"strings"</code>

<code>func WithServerHeader(h http.HandlerFunc) http.HandlerFunc {</code>

<code></code><code>return</code> <code>func(w http.ResponseWriter, r *http.Request) {</code>

<code></code><code>log</code><code>.Println(</code><code>"---&gt;WithServerHeader()"</code><code>)</code>

<code></code><code>w.Header().Set(</code><code>"Server"</code><code>, </code><code>"HelloServer v0.0.1"</code><code>)</code>

<code></code><code>h(w, r)</code>

<code>func hello(w http.ResponseWriter, r *http.Request) {</code>

<code></code><code>log</code><code>.Printf(</code><code>"Recieved Request %s from %s\n"</code><code>, r.URL.Path, r.RemoteAddr)</code>

<code></code><code>fmt.Fprintf(w, </code><code>"Hello, World! "</code><code>+r.URL.Path)</code>

<code></code><code>http.HandleFunc(</code><code>"/v1/hello"</code><code>, WithServerHeader(hello))</code>

<code></code><code>err := http.ListenAndServe(</code><code>":8080"</code><code>, nil)</code>

<code></code><code>if</code> <code>err != nil {</code>

<code></code><code>log</code><code>.Fatal(</code><code>"ListenAndServe: "</code><code>, err)</code>

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

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

54

55

56

57

58

59

60

61

62

63

64

65

66

67

<code>func WithAuthCookie(h http.HandlerFunc) http.HandlerFunc {</code>

<code></code><code>log</code><code>.Println(</code><code>"---&gt;WithAuthCookie()"</code><code>)</code>

<code></code><code>cookie := &amp;http.Cookie{Name: </code><code>"Auth"</code><code>, Value: </code><code>"Pass"</code><code>, Path: </code><code>"/"</code><code>}</code>

<code></code><code>http.SetCookie(w, cookie)</code>

<code>func WithBasicAuth(h http.HandlerFunc) http.HandlerFunc {</code>

<code></code><code>log</code><code>.Println(</code><code>"---&gt;WithBasicAuth()"</code><code>)</code>

<code></code><code>cookie, err := r.Cookie(</code><code>"Auth"</code><code>)</code>

<code></code><code>if</code> <code>err != nil || cookie.Value != </code><code>"Pass"</code> <code>{</code>

<code></code><code>w.WriteHeader(http.StatusForbidden)</code>

<code></code><code>return</code>

<code>func WithDebugLog(h http.HandlerFunc) http.HandlerFunc {</code>

<code></code><code>log</code><code>.Println(</code><code>"---&gt;WithDebugLog"</code><code>)</code>

<code></code><code>r.ParseForm()</code>

<code></code><code>log</code><code>.Println(r.Form)</code>

<code></code><code>log</code><code>.Println(</code><code>"path"</code><code>, r.URL.Path)</code>

<code></code><code>log</code><code>.Println(</code><code>"scheme"</code><code>, r.URL.Scheme)</code>

<code></code><code>log</code><code>.Println(r.Form[</code><code>"url_long"</code><code>])</code>

<code></code><code>for</code> <code>k, v := range r.Form {</code>

<code></code><code>log</code><code>.Println(</code><code>"key:"</code><code>, k)</code>

<code></code><code>log</code><code>.Println(</code><code>"val:"</code><code>, strings.Join(v, </code><code>""</code><code>))</code>

<code></code><code>http.HandleFunc(</code><code>"/v1/hello"</code><code>, WithServerHeader(WithAuthCookie(hello)))</code>

<code></code><code>http.HandleFunc(</code><code>"/v2/hello"</code><code>, WithServerHeader(WithBasicAuth(hello)))</code>

<code></code><code>http.HandleFunc(</code><code>"/v3/hello"</code><code>, WithServerHeader(WithBasicAuth(WithDebugLog(hello))))</code>

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

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

<code>type HttpHandlerDecorator func(http.HandlerFunc) http.HandlerFunc</code>

<code>func Handler(h http.HandlerFunc, decors ...HttpHandlerDecorator) http.HandlerFunc {</code>

<code></code><code>for</code> <code>i := range decors {</code>

<code></code><code>d := decors[len(decors)-1-i] </code><code>// iterate in reverse</code>

<code></code><code>h = d(h)</code>

<code></code><code>return</code> <code>h</code>

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

<code>http.HandleFunc(</code><code>"/v4/hello"</code><code>, Handler(hello,</code>

<code></code><code>WithServerHeader, WithBasicAuth, WithDebugLog))</code>

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

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

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

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

<code>func Decorator(decoPtr, fn interface{}) (err error) {</code>

<code></code><code>var decoratedFunc, targetFunc reflect.Value</code>

<code></code><code>decoratedFunc = reflect.ValueOf(decoPtr).Elem()</code>

<code></code><code>targetFunc = reflect.ValueOf(fn)</code>

<code></code><code>v := reflect.MakeFunc(targetFunc.Type(),</code>

<code></code><code>func(in []reflect.Value) (out []reflect.Value) {</code>

<code></code><code>fmt.Println(</code><code>"before"</code><code>)</code>

<code></code><code>out = targetFunc.Call(in)</code>

<code></code><code>fmt.Println(</code><code>"after"</code><code>)</code>

<code></code><code>})</code>

<code></code><code>decoratedFunc.Set(v)</code>

上面这个 <code>Decorator()</code> 需要两个参数，

第一个是出参 <code>decoPtr</code> ，就是完成修饰后的函数

第二个是入参 <code>fn</code> ，就是需要修饰的函数

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

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

<code>func foo(a, b, c </code><code>int</code><code>) </code><code>int</code> <code>{</code>

<code></code><code>fmt.Printf(</code><code>"%d, %d, %d \n"</code><code>, a, b, c)</code>

<code></code><code>return</code> <code>a + b + c</code>

<code>func bar(a, b string) string {</code>

<code></code><code>fmt.Printf(</code><code>"%s, %s \n"</code><code>, a, b)</code>

<code></code><code>return</code> <code>a + b</code>

然后，我们可以这样做：

<code>type MyFoo func(</code><code>int</code><code>, </code><code>int</code><code>, </code><code>int</code><code>) </code><code>int</code>

<code>var myfoo MyFoo</code>

<code>Decorator(&amp;myfoo, foo)</code>

<code>myfoo(1, 2, 3)</code>

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

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

<code>mybar := bar</code>

<code>Decorator(&amp;mybar, bar)</code>

<code>mybar(</code><code>"hello,"</code><code>, </code><code>"world!"</code><code>)</code>

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

作者：陈皓，博客地址：https://coolshell.cn/articles/18190.html