goweb,基于go的API框架

goweb

一個(gè)基于go語言開發(fā)API的工具枫吧,這個(gè)工具受到了SpringMVC的啟發(fā),結(jié)合了go語言本身的特性张症,整體比較簡(jiǎn)單,接下來鸵贬,看看如何使用它俗他。

下載安裝:

go get github.com/alberliu/goweb

1.核心功能

請(qǐng)求體參數(shù)注入

package main

import "github.com/alberliu/goweb"

type User struct {
    Id   int    `json:"id"`
    Name string `json:"name"`
}

func handler(user User) User {
    return user
}

func main() {
    goweb.HandlePost("/test", handler)
    goweb.ListenAndServe(":8000")
}

請(qǐng)求體:

{
    "id": 1,
    "name": "alber"
}

響應(yīng)體:

{
    "id": 1,
    "name": "alber"
}

上面的代碼是一個(gè)最簡(jiǎn)的例子,HandlePost(string, interface{})會(huì)將一個(gè)handler注冊(cè)到一個(gè)全局的內(nèi)置的goweb實(shí)例defultGoWeb阔逼,ListenAndServe(":8000")會(huì)將defultGoWeb賦給Server的handler變量兆衅,然后啟動(dòng)這個(gè)Server。(是不是和內(nèi)置的ServerMux有點(diǎn)像)

goweb會(huì)自動(dòng)解析注冊(cè)到它本身的handler,當(dāng)請(qǐng)求到來時(shí)嗜浮,會(huì)將請(qǐng)求體的json數(shù)據(jù)反序列化并注入到handler的參數(shù)羡亩,handler處理完邏輯返回時(shí),會(huì)將handler的返回值序列化為json數(shù)據(jù)返回危融。goweb默認(rèn)使用json的序列化和反序列化方式畏铆,當(dāng)然你可以定義自己的序列化方式,這個(gè)在后面你可以看到吉殃。

例子給出的handler的參數(shù)和返回都是結(jié)構(gòu)體類型及志,當(dāng)然你也可以使用指針類型片排。

結(jié)構(gòu)體goweb其實(shí)本質(zhì)上就是一個(gè)路由,它實(shí)現(xiàn)了Handler接口速侈。上面的例子都是默認(rèn)的defultGoWeb率寡,你也可以自己實(shí)例化一個(gè)goweb。

func main() {
    goweb:=goweb.NewGoWeb();
    goweb.HandlePost("/test", handler)
    server := &http.Server{Addr: ":8000", Handler: goweb}
    server.ListenAndServe()
}

url參數(shù)注入

package main

import "github.com/alberliu/goweb"

type User struct {
    Id   int64  `json:"id"`
    Name string `json:"name"`
}

func handler(id int64, name string) User {
    return User{id, name}
}

func main() {
    goweb := goweb.NewGoWeb();
    goweb.HandleGet("/test/{id}/{name}", handler)
    goweb.ListenAndServe(":8000")
}

執(zhí)行上面的代碼倚搬,然后訪問url:http://localhost:8000/test/123456/alber

就可以返回下面的json數(shù)據(jù)

{
    "id": 123456,
    "name": "alber"
}

handler可以獲取到url中的參數(shù)冶共,并且注入到handler參數(shù)中。handler的第一個(gè)參數(shù)對(duì)應(yīng)url中的第一個(gè)參數(shù)每界,第二個(gè)參數(shù)對(duì)應(yīng)url中的的第二個(gè)參數(shù)捅僵,依次類推。不過暫時(shí)還有個(gè)限制眨层,在url中使用參數(shù)時(shí)庙楚,handler中的參數(shù)必須與url中的參數(shù)個(gè)數(shù)一致,且類型必須為string或者int64趴樱。

2.handler

goweb可以注冊(cè)多種形式的handler馒闷,goweb會(huì)利用反射自動(dòng)解析函數(shù),支持多種類型叁征,但是不能超出它可以解析的范圍纳账。以下是它所有能解析的類型。


func handler(ctx goweb.Context) {
}

func handler(ctx goweb.Context) User {
    return User{}
}

func handler(user User) User {
    return User{}
}

func handler(ctx goweb.Context, user User) User {
    return User{}
}

func handler(name string, id int64) User {
    return User{}
}

func handler(ctx goweb.Context, name string, id int64) User {
    return User{}
}

Context是一個(gè)請(qǐng)求上下文捺疼,他只有ResponseWriter和Request兩個(gè)字段疏虫,它的內(nèi)部結(jié)構(gòu)如下所示。你可以根據(jù)自己的需求修改源碼進(jìn)行擴(kuò)展啤呼,例如卧秘,把它作為一個(gè)請(qǐng)求的會(huì)話使用。

type Context struct {
    w http.ResponseWriter
    r *http.Request
}

3.用Group組織你的handler

func main() {
    group1:=goweb.NewGroup("/group1")
    group1.HandleGet("/handler1",handler)
    group1.HandleGet("/handler2",handler)
    group1.HandleGet("/handler3",handler)

    group2:=goweb.NewGroup("/group2")
    group2.HandleGet("/handler1",handler)
    group2.HandleGet("/handler2",handler)
    group2.HandleGet("/handler3",handler)

    group3:=goweb.NewGroup("/group3")
    group3.HandleGet("/handler1",handler)
    group3.HandleGet("/handler2",handler)
    group3.HandleGet("/handler3",handler)

    goweb.HandleGroup(group1)
    goweb.HandleGroup(group2)
    goweb.HandleGroup(group3)
    goweb.ListenAndServe(":8000")
}

group可以幫助你分層次的組織你的handler,使你的路由結(jié)構(gòu)更清晰官扣。

4.定義自己序列化和反序列化方式

var json = jsoniter.ConfigCompatibleWithStandardLibrary

func jsonUnmarshal(data []byte, v interface{}) error {
    return json.Unmarshal(data, v)
}

func jsonMarshal(v interface{}) ([]byte, error){
    return json.Marshal(v)
}

func main() {
    goweb:=goweb.NewGoWeb();
    goweb.Unmarshal=jsonUnmarshal
    goweb.Marshal=jsonMarshal
    
    goweb.ListenAndServe(":8000")
    
}

goweb默認(rèn)采用json(使用的是開源的jsoniter)序列化和反序列化數(shù)據(jù)翅敌,goweb的Marshal、Unmarshal變量本身是一個(gè)函數(shù).如果你想定義自己的序列化方式醇锚,只需要覆蓋掉它就行,就像上面那樣坯临。

5.攔截器


func interceptor1(http.ResponseWriter, *http.Request) bool {
    return true
}
func interceptor2(http.ResponseWriter, *http.Request) bool {
    return true
}
func interceptor3(http.ResponseWriter, *http.Request) bool {
    return true
}

func main() {
    goweb := goweb.NewGoWeb();
    goweb.AddInterceptor(interceptor1)
    goweb.AddInterceptor(interceptor2)
    goweb.AddInterceptor(interceptor3)
    goweb.ListenAndServe(":8000")
}

goweb在執(zhí)行handler之前焊唬,會(huì)執(zhí)行一個(gè)或者多個(gè)interceptor,并且會(huì)根據(jù)AddInterceptor的先后順序執(zhí)行看靠,當(dāng)interceptor返回true時(shí)赶促,會(huì)接著往下執(zhí)行,返回false時(shí)挟炬,會(huì)終止執(zhí)行鸥滨。

6.過濾器

func filter(w http.ResponseWriter, r *http.Request, f func(http.ResponseWriter, *http.Request)) {
    f(w, r)
}

func main() {
    goweb := goweb.NewGoWeb();
    goweb.Filter = filter
    goweb.ListenAndServe(":8000")
}

你可以給goweb添加一個(gè)過略器嗦哆,在過濾器中,如果你想執(zhí)行完自己的邏輯之后婿滓,執(zhí)行handler老速,只需要調(diào)用f(w, r)。

7.自定義錯(cuò)誤處理


func handler400(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(400)
    w.Write([]byte("bad request"))
}
func handler404(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(404)
    w.Write([]byte("url not found"))
}
func handler405(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(405)
    w.Write([]byte("method not found"))
}

func main() {
    goWeb := goweb.NewGoWeb()
    goWeb.Handler400 = handler400
    goWeb.Handler404 = handler404
    goWeb.Handler405 = handler405

    goweb.ListenAndServe(":8000")
}

當(dāng)請(qǐng)求執(zhí)行失敗時(shí)凸主,goweb中給出了一些默認(rèn)的錯(cuò)誤處理方式橘券,就像上面那樣。當(dāng)然卿吐,你也可以定義一些自己錯(cuò)誤處理方式旁舰。

寫在后面

如果你有什么好的建議,可以發(fā)我郵箱嗡官,一起交流箭窜。

alber_liu@qq.com

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市衍腥,隨后出現(xiàn)的幾起案子磺樱,更是在濱河造成了極大的恐慌,老刑警劉巖紧阔,帶你破解...
    沈念sama閱讀 221,198評(píng)論 6 514
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件坊罢,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡擅耽,警方通過查閱死者的電腦和手機(jī)活孩,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,334評(píng)論 3 398
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來乖仇,“玉大人憾儒,你說我怎么就攤上這事∧松常” “怎么了起趾?”我有些...
    開封第一講書人閱讀 167,643評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)警儒。 經(jīng)常有香客問我训裆,道長(zhǎng),這世上最難降的妖魔是什么蜀铲? 我笑而不...
    開封第一講書人閱讀 59,495評(píng)論 1 296
  • 正文 為了忘掉前任边琉,我火速辦了婚禮,結(jié)果婚禮上记劝,老公的妹妹穿的比我還像新娘变姨。我一直安慰自己,他們只是感情好厌丑,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,502評(píng)論 6 397
  • 文/花漫 我一把揭開白布定欧。 她就那樣靜靜地躺著渔呵,像睡著了一般。 火紅的嫁衣襯著肌膚如雪砍鸠。 梳的紋絲不亂的頭發(fā)上扩氢,一...
    開封第一講書人閱讀 52,156評(píng)論 1 308
  • 那天,我揣著相機(jī)與錄音睦番,去河邊找鬼类茂。 笑死,一個(gè)胖子當(dāng)著我的面吹牛托嚣,可吹牛的內(nèi)容都是我干的巩检。 我是一名探鬼主播,決...
    沈念sama閱讀 40,743評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼示启,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼兢哭!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起夫嗓,我...
    開封第一講書人閱讀 39,659評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤迟螺,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后舍咖,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體矩父,經(jīng)...
    沈念sama閱讀 46,200評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,282評(píng)論 3 340
  • 正文 我和宋清朗相戀三年排霉,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了窍株。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,424評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡攻柠,死狀恐怖球订,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情瑰钮,我是刑警寧澤冒滩,帶...
    沈念sama閱讀 36,107評(píng)論 5 349
  • 正文 年R本政府宣布,位于F島的核電站浪谴,受9級(jí)特大地震影響开睡,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜苟耻,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,789評(píng)論 3 333
  • 文/蒙蒙 一篇恒、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧梁呈,春花似錦婚度、人聲如沸蘸秘。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,264評(píng)論 0 23
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至寻咒,卻和暖如春哮翘,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背毛秘。 一陣腳步聲響...
    開封第一講書人閱讀 33,390評(píng)論 1 271
  • 我被黑心中介騙來泰國(guó)打工饭寺, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人叫挟。 一個(gè)月前我還...
    沈念sama閱讀 48,798評(píng)論 3 376
  • 正文 我出身青樓艰匙,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親抹恳。 傳聞我的和親對(duì)象是個(gè)殘疾皇子员凝,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,435評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容