Joey LIU | NANTSOU

Zero Downtime Reloadable Api Router Written in Go

Sun Mar 10, 2019

為了方便動態去調整部署在雲端Router，設計了一個特殊的api來觸發重置Router的處理。

因為網路上有很多利用go來寫api server的文章和教學，這篇文章的重點就放在如何製作可熱重置的Router。

首先，我們只需要gorilla/mux來實作可熱重置的Router。

要實作可熱重置的Router唯一的困難就是gorilla/mux不支援動態移除已註冊Route。所以唯一的辦法就是用一個新的Router將整個Router替換掉。

我們定義一個struct類型，該類型有mux.Router的屬性以及實作http.Handler這個interface

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

type MockRouter struct {
    mu sync.Mutex
    r *mux.Router
}

func (mr *MockRouter) Swap(r *mux.Router) {
    mr.mu.Lock()
    mr.r = r
    mr.mu.Unlock()
}

func (mr *MockRouter) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    mr.r.ServeHTTP(w, r)
}

另外，為了避免替換掉整個Router，我們可以創建一個Router來專門負責管理想動態變更的Route。

不過得注意的小地方就是，註冊Subrouter時的路徑必須是全路徑。若Subroutine之下有其他的路徑的話，也必須另外處理。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

package main

import (
    "fmt"
    "net/http"
    "github.com/gorilla/mux"
)

func GetExampleHandler(text string) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        _, _ = w.Write([]byte(text))
    } 
}

func main() {

    mainRouter := mux.NewRouter()
    mainRouter.HandleFunc("/main", GetExampleHandler("main"))
    sub := mainRouter.PathPrefix("/sub").Subrouter()
  
    subRouter := mux.NewRouter().PathPrefix("/sub").Subrouter()
    subRouter.HandleFunc("/", GetExampleHandler("sub top"))
    for _, item := range []string{"endpoint1", "endpoint2"} {
        subRouter.HandleFunc("/" + item, GetExampleHandler(item))
    }
  
    // in mux, you need to register subrouter
    // with the same path that the handlers in the main router
    sub.Handle("/", subRouter)

    // if your subrouter has handlers that match
    // other sub paths - you also need to do this
    sub.Handle("/{_:.*}", subRouter)

    http.ListenAndServe(":5050", mainRouter)
}

利用這兩個小技巧的話，就可以實現一個可熱重置的Router。下方的例子就是利用可熱重置的Router來實作一個Mock Api Server。

Mock Api Example

BACK