天天看點

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