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

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

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

由于 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 的迭代开发思路,并且认识到编码只是软件工程的一部分,测试、文档、规范化也很重要。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容