實現一個 Golang Module Proxy

在前兩篇文章（Golang 模塊獲取包modfetch研讀，Golang模塊代理goproxy.io源碼研讀），我們學習了Golang Module Proxy的工作原理以及實現原理。

本文嘗試獨立實現一個Golang Module Proxy服務。

實現邏輯主要涉及這幾塊內容：

a）main.go 負責服務啟動，服務優雅終止；

b）generate.sh 負責將$GOROOT中的internal包拷貝至當前項目并替換引用路徑；

c）proxy.go 核心邏輯部分，負責工作目錄設定，路徑檢查，Module請求處理。

下面詳細看一下這幾部分的代碼。

1 main.go

頭部的//go:generate注釋指定腳本generate.sh，當執行go generate時，其會調用generate.sh將modfetch包及其依賴包從$GOROOT中的internal文件夾拷貝至當前項目，然后即可以在當前項目直接使用了。

初始化一個http.Server，其Handler使用proxy.go的proxy.Proxy函數。

啟動一個goroutine監聽中斷信號，以便優雅的終止服務（如何優雅的終止一個服務？）。

//go:generate sh generate.sh
package main
import (
 ...
 "github.com/olzhy/goproxy/pkg/proxy"
)
var port = flag.String("serverPort", ":8080", "server port")
func main() {
 // server
 srv := http.Server{
 Addr: *port,
 Handler: proxy.Proxy(),
 }
 // server startup / gracefully shutdown
 ...
 srv.ListenAndServe()
 ...
}

2 generate.sh

generate.sh負責將$GOROOT中的internal包拷貝至當前項目并將引用路徑替換為新的引用路徑。

#!/bin/bash
mkdir internal
# copy dependencies
cp -r $GOROOT/src/cmd/go/internal/modfetch ./internal/
...
cp -r $GOROOT/src/cmd/internal/sys ./internal/
...
# replace import paths
find . -type f -name "*.go" -exec sed -i '' 's#cmd/go/internal/#github.com/olzhy/goproxy/internal/#g' {} ; 
...

3 proxy.go

pkg/proxy/proxy.go提供proxy.Proxy函數。

proxy.go首先會設置工作目錄，啟動后對于一個GET請求，首先會校驗請求路徑，對不滿足規則的請求直接返回404，然后僅對這幾類符合Module請求格式的請求作處理：

a）后綴為“/@v/list”

如GET github.com/olzhy/quote/@v/list

從請求路徑截取mod名稱，調用modfetch.Lookup函數返回所有可用版本。

b）后綴為“/@latest”

如GET github.com/olzhy/quote/@latest

從請求路徑截取mod名稱，調用modfetch.Lookup函數獲取最近一次提交信息。

c）后綴為“.info”

如GET github.com/olzhy/quote/@v/v1.0.0.info

從請求路徑截取mod及version信息，調用modfetch.Stat函數獲取info。

d）后綴為“.mod”

如GET github.com/olzhy/quote/@v/v1.0.0.mod

從請求路徑截取mod及version信息，調用modfetch.GoMod函數獲取mod內容。

e）后綴為“.zip”

如GET github.com/olzhy/quote/@v/v1.0.0.zip

從請求路徑截取mod及version信息，調用modfetch.DownloadZip函數獲取zip文件路徑名稱并提供下載。

package proxy
import (
 ...
 "github.com/olzhy/goproxy/internal/modfetch"
 ...
)
const (
 ListSuffix = "/@v/list"
 LatestSuffix = "/@latest"
 InfoSuffix = ".info"
 ModSuffix = ".mod"
 ZipSuffix = ".zip"
 VInfix = "/@v/"
)
func init() {
 modfetch.PkgMod = ...
 codehost.WorkRoot = ...
}
func Proxy() http.HandlerFunc {
 return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 path := strings.Trim(r.RequestURI, "/")
 // req path validation
 if err := pathValidation(path); nil != err {
 w.WriteHeader(http.StatusBadRequest)
 fmt.Fprintln(w, err)
 return
 }
 switch {
 // suffix is /@v/list
 case strings.HasSuffix(path, ListSuffix):
 ...
 // call modfetch.Lookup(mod)
 lookupVersions(mod)
 ...
 return
 // suffix is /@latest
 case strings.HasSuffix(path, LatestSuffix):
	 ...
 // modfetch.Lookup(mod)
 lookupLatestRev(mod)
 ...
 return
 // suffix is .info
 case strings.HasSuffix(path, InfoSuffix):
 ...
 // call modfetch.Stat(mod, rev)
 loadRev(mod, ver)
 ...
	 return
 // suffix is .mod
 case strings.HasSuffix(path, ModSuffix):
 ...
 // call modfetch.GoMod(mod, rev)
	 loadModContent(mod, ver)
 ...
	 return
 // suffix is .zip
 case strings.HasSuffix(path, ZipSuffix):
 ...
 // call modfetch.DownloadZip(module.Version{Path: mod, Version: rev})
 loadZip(mod, ver)
 ...
	 return
 default:
	 w.WriteHeader(http.StatusBadRequest)
	 fmt.Fprintln(w, "please give me a correct module query")
 }
 })
}

完整實現代碼已提交至GitHub（github.com/olzhy/goproxy），歡迎大家關注。