手把手教您实现一个Golang Module Proxy

olzhy · · 2391 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

在前两篇文章(<a href="https://studygolang.com/articles/21377">Golang 模块获取包modfetch研读</a>,<a href="https://studygolang.com/articles/21379">Golang模块代理goproxy.io源码研读</a>),我们学习了Golang Module Proxy的工作原理以及实现原理。 本文尝试独立实现一个Golang Module Proxy服务。 实现逻辑主要涉及这几块内容: a)<a href="https://github.com/olzhy/goproxy/blob/master/main.go" rel="noopener" target="_blank">main.go </a> 负责服务启动,服务优雅终止; b)<a href="https://github.com/olzhy/goproxy/blob/master/generate.sh" rel="noopener" target="_blank">generate.sh</a> 负责将$GOROOT中的internal包拷贝至当前项目并替换引用路径; c)<a href="https://github.com/olzhy/goproxy/blob/master/pkg/proxy/proxy.go" rel="noopener" target="_blank">proxy.go</a> 核心逻辑部分,负责工作目录设定,路径检查,Module请求处理。 下面详细看一下这几部分的代码。 **1 main.go** 头部的//go:generate注释指定脚本generate.sh,当执行go generate时,其会调用generate.sh将modfetch包及其依赖包从$GOROOT中的internal文件夹拷贝至当前项目,然后即可以在当前项目直接使用了。 初始化一个http.Server,其Handler使用proxy.go的proxy.Proxy函数。 启动一个goroutine监听中断信号,以便优雅的终止服务(<a href="https://leileiluoluo.com/posts/golang-shutdown-server-gracefully.html">如何优雅的终止一个服务?</a>)。 ``` //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() ... } ``` <strong>2 generate.sh</strong> 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(<a href="https://github.com/olzhy/goproxy" rel="noopener" target="_blank">github.com/olzhy/goproxy</a>),欢迎大家关注。 此外该服务已部署至服务器,欢迎大家使用<a href="https://golangcenter.com" rel="noopener" target="_blank">https://golangcenter.com</a>。 原文链接:https://leileiluoluo.com/posts/implement-a-golang-module-proxy.html

有疑问加站长微信联系(非本文作者))

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889

2391 次点击  
加入收藏 微博
2 回复  |  直到 2019-06-23 18:30:49
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传