Pure - 小而美的JSON Web API框架

一. 什么是Pure

Pure是Go语言实现的,小而美的Web API框架。在设计上它提供纯粹的JSON支持:所有的API调用都通过GET或者POST请求来实现,请求参数和响应的结果都按照JSON格式进行打包。

除此之外,Pure框架还支持插件式开发,开发者通过开发各种中间件插件来扩展更多可定制的功能。框架通过中间件提供原生支持的功能有:

  1. pure.CORSMiddleware:处理CORS请求;
  2. pure.JSONMiddleware:检查HTTP请求头是否为application/json;
  3. pure.MultipartFormMiddleware:检查HTTP请求头是否为multipart/form-data;
  4. pure.LoggerMiddleware:记录请求日志,包含请求的处理时间,单位毫秒(ms);
  5. pure.RecoverPanicMiddleware:业务逻辑发生崩溃时恢复。

RESTful API的设计方式是通过HTTP方法来规范对资源的操作:

  • 使用GET获取资源
  • 使用POST创建资源
  • 使用PUT更新现有资源
  • 使用DELETE删除现有资源

而Pure框架采用的Pure-JSON设计方式则是通过URL命名来规范对资源的操作。虽然不是硬性要求,但强烈建议按照CRUD来进行命名:

  • Create:创建资源
  • Retrieve:获取资源
  • Update:更新现有资源
  • Delete:删除现有资源

二. 定义API

使用Pure框架开发API,需要定义三种结构:请求参数,处理逻辑(Handler)和响应结果。然后我们将该处理逻辑注册到框架中即可。下面我们通过一个Hello API举例说明一下。假设该API需要一个请求参数name,业务逻辑是返回一句问候语“hello xxx”。那么我们可以通过以下三个步骤完成。

1. 定义请求参数和响应结果

分别定义一个helloReq和helloRsp的结构,添加JSON tag:

type helloReq struct {
  Name string `json: "name"`
}
type helloRsp struct {
  Greeting string `json:"greeting"`
}

2. 定义处理逻辑

所有的处理逻辑必须定义在Handle(Context) interface{}函数中,即具体的处理逻辑一定满足pure.Handler接口:

type helloHandler struct {
  req helloReq
}
func (h helloHandler) Handle(ctx context.Context) interface{} {
  return helloRsp{ Greeting: fmt.Sprintf("hello %s", h.req.Name) }
}

3. 注册处理逻辑

最后,将处理逻辑注册到Pure框架中即可:

pure.API().
  Version(1).
  Class("hello").
  URI("hello").
  Post().
  Handle(helloHandler{}).
  Use(pure.LoggerMiddleware, pure.JSONMiddleware).
  Final()

此时客户端通过POST请求http://host/api_1/hello/hello即可获得相应的调用结果。

4. 实现原理

Pure框架通过上述“链式调用”构造了一个API对象(建造者模式),然后将这个对象注册到系统中。当有新web请求到达时,根据HTTP方法(GET或者POST)会回调到不同的分配函数中(getDispatcher或postDispatcher)。这两个处理函数执行一套相似的逻辑:根据URL获取用户注册的handler类型,然后使用Go语言的反射机制运行时构造该handler,初始化请求参数,并调用该处理逻辑,然后将返回的结果发送给请求方。

三. 插件式中间件开发

除了上面提供的中间件外,开发者还可以自行开发更多的插件来满足业务逻辑的需要。一般来说,开发中间件的基本套路就是在业务逻辑开始处理之前截获请求,然后在真正业务逻辑执行之前或之后进行其他处理,或者在开始处理业务逻辑之前进行必要检查,如不满足要求则进一步选择处理或者不处理。比如要实现一个记录请求日志的中间件插件,则需要在业务逻辑执行之前记录时间,然后运行业务逻辑,最后再减去之间记录的时间得到业务逻辑执行时间,然后打印日志,如下:

func LoggerMiddleware(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
    start := time.Now()

    rw := NewResponseWriter(w)
    next(rw, r)

    logging := fmt.Sprintf("%s -- %v %s %s %s %s - %s %v",
        r.RemoteAddr,
        start,
        r.Method,
        r.URL.Path,
        r.Proto,
        http.StatusText(rw.StatusCode()),
        r.Header.Get("User-Agent"),
        time.Since(start))

    holmes.Infoln(logging)
}

更多的中间件例子请参考源代码。

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

推荐阅读更多精彩内容