Golang 学习 -- “听写” gorilla/context

2023年10月4日 195次阅读 来源: 王谙然

我觉得 看书 -> 练习 -> 看源码 -> 实现 ，是一个可行的螺旋式学习节奏。

当我看一本书并且跟着书上的实例走完一遍后，发现自己的好像没什么可学的了，这时候我一般会先看看书上的东西我是否能全部举一反三，然后会计划看源码，应为看开源库可以让我们犹如有一个高手老师和朋友，而且还能感受相当丰富的实战技巧。

由于 Golang 足够简洁，所以有很多小而精悍的开源库，其实就一两个文件啦。但是对于初学者来说相当受用。

最重要的心态：看 Golang 代码基本不有太大的心智负担，所以，不、要、怕。

步骤概括如下：

  1. 拿到源码
  2. 看文档，确定需求，确定项目对外接口
  3. 小步迭代 TDD，参考源码，考虑：测试，算法，安全
  4. 对照源码，优化自己代码，甚至超过源码
  5. 码代码以外：注释，README, License

今天的练习项目是 gorilla/context

准备

  1. 拿到源码 go get github.com/gorilla/context

  2. 看文档 go doc github.com/gorilla/context

  3. 项目需求：在一个 request 的处理期间，保存一些值。

  4. 基本用法和项目对外接口（界限）：

package foo

import (
  "github.com/gorilla/context"
)

// 1.定义要保存值的名字(key interface{})
type key int

const MyKey key = 0

// 2.设置和获取值
context.Set(r, MyKey, "bar")

func MyHandler(w http.ResponseWriter, r *http.Request) {
  // val is "bar".
  val := context.Get(r, foo.MyKey)

  // returns ("bar", true)
  val, ok := context.GetOk(r, foo.MyKey)
  // ...
}

// 3.清除缓存
context.Clear(r) // clear all caches of one request
context.ClearHanlder() // wrap a handler to clear varaibles at end of a request lifetime

// 4. 对外接口
func Clear(r *http.Request)
func ClearHandler(h http.Handler) http.Handler
func Delete(r *http.Request, key interface{})
func Get(r *http.Request, key interface{}) interface{}
func GetAll(r *http.Request) map[interface{}]interface{}
func GetAllOk(r *http.Request) (map[interface{}]interface{}, bool)
func GetOk(r *http.Request, key interface{}) (interface{}, bool)
func Purge(maxAge int) int
func Set(r *http.Request, key, val interface{})

小步迭代开发

V1: 实现 Set(), Get(), GetOk(), GetAll(), GetAllOk()
  1. 设计数据结构存储数据：map[*http.Request]map[interface{}]interface{}
  2. 写测试
  3. 实现 参考代码 ​
V2: 实现 Delete(), Clear(), ClearHandler()
  1. ClearHandler() 利用 http.HandlerFunc() + defer
  2. 写测试，实现 参考源码
V3: 实现 Purge()
  1. 看文档 go doc github.com/gorilla/context.Purge
    涉及到数据存储的时间，所以需要一个数据结构存储时间, map[*http.Request]int64
  2. 写测试，实现 Purge() 参考源码 ​
V4: 使用 RWMutex 保证数据可靠性 参考源码

​对照源码

  1. 不足：

  2. 缺少 benchmark

  3. 比源码好地方：

  4. 测试虽多写了几行，但是测试结果更直观

  5. 使用 defer 增加代码可读性

  6. 简化 Get() GetAll() 逻辑

  7. V5: 添加 benchmark 参考代码

完善项目

  1. doc.go
  2. README.md
  3. LICENSE
  4. .travis.yml

总结

虽然这个开源库的源码只有 100 左右，但是需求很明确，代码干净，考虑的比较全面，除了核心代码，有比较完备的测试，文档，持续集成，让我们动手实现的过程中不仅在实践中加深对基本语法的理解，体会到 Golang 的迭代开发思路，并且认识到编码只是软件工程的一部分，测试、文档、规范化也很重要。

联想到平时的开发，花时间最多的往往不是最终代码的编写，而是 小修小改 + 推倒重来。反观这次的开发过程，基本没有走弯路，原因很简单，我们是由结果倒推的解决思路，当然，在日常开发中，不可能每次都能将一个库的最终接口先完全准确地设计出来，但是，我们可看到前期设计的重要性。

    原文作者：王谙然
    原文地址: https://www.jianshu.com/p/2e7ad8640c56
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞