使用Go語言自制簡單易用的Web框架
為什么寫這玩意
有時我要寫一些很小的應用,比如爬蟲后端、服務器腳本又或者是BFF服務,需要簡單的Web服務。用gin感覺有點重,go.mod里會有很多用不到的依賴,直接用httprouter又很麻煩。所以想整個簡單易用的Web框架。在實現(xiàn)基礎能力的同時,順便集成一些方便開發(fā)的功能(便捷的Websocket連接、SSE推送、自動綁定請求數(shù)據(jù)、自動序列化返回響應數(shù)據(jù)),并且盡量不引入第三方依賴,保持極簡架構。
大概的架構圖

技術選型
- 底層HTTP路由:選擇httprouter。
- 將請求頭/表單/URI參數(shù)綁定到結構體上:選擇mapstructure。
框架目前的go.mod依賴情況:
module github.com/dpwgc/easierweb go 1.21.4 require ( github.com/julienschmidt/httprouter v1.3.0 github.com/mitchellh/mapstructure v1.5.0 golang.org/x/net v0.17.0 gopkg.in/yaml.v3 v3.0.1 )
基本用法
首先,運行go get,安裝一下框架:
go get github.com/dpwgc/easierweb
然后,編寫路由代碼,寫起來和gin差不多,沒有學習成本:
package main
import (
"github.com/dpwgc/easierweb"
"github.com/dpwgc/easierweb/middlewares"
"log"
"net/http"
)
func main() {
// 新建一個路由
router := easierweb.New()
// 使用日志中間件
router.Use(middlewares.Logger())
// GET接口
router.GET("/hello/:name", hello)
// 啟動服務
log.Fatal(router.Run(":80"))
}
// 請求處理函數(shù)
func hello(ctx *easierweb.Context) {
// 獲取URI Path里的name參數(shù)
name := ctx.Path.Get("name")
// 綁定URI Query參數(shù)到指定結構體上
req := Request{}
err := ctx.BindQuery(&req)
if err != nil {
panic(err)
}
fmt.Println("request data:", req)
// 響應:hello {name}
ctx.WriteString(http.StatusOK, "hello "+name)
}
// 請求結構體
type Request struct {
Name string `mapstructure:"name"`
Mobile string `mapstructure:"mobile"`
}
進階改造(將繁瑣的流程自動化)
實際在使用的時候,每次獲取請求數(shù)據(jù)都得調用一下Bind函數(shù),然后響應數(shù)據(jù)時又得調用下Write函數(shù)再return,感覺還是不夠簡單,因此加了個通過反射自動綁定請求數(shù)據(jù)到結構體、自動序列化寫入響應數(shù)據(jù)的功能。

實現(xiàn)方式參考: github.com/MikeLINGxZ/simple-server-runner 這是一個基于Gin的自動綁定請求數(shù)據(jù)+自動寫入響應數(shù)據(jù)的庫。
最終成品有點像Spring Boot那種接口方法樣式:
package main
import (
"fmt"
"github.com/dpwgc/easierweb"
"github.com/dpwgc/easierweb/middlewares"
"log"
)
func main() {
// 還是老樣子,先創(chuàng)建一個路由
router := easierweb.New().Use(middlewares.Logger())
// 使用EasyPOST函數(shù)(EasyXXX函數(shù)內置了自動綁定+自動寫入),整一個POST提交接口
router.EasyPOST("/submit", submit)
// 啟動服務
log.Fatal(router.Run(":80"))
}
// 請求處理函數(shù)(自動綁定請求數(shù)據(jù)+自動寫入響應數(shù)據(jù))
// 這個請求處理函數(shù)和上文的基礎版不大一樣,除了上下文入參以外,還有個請求數(shù)據(jù)入參和響應數(shù)據(jù)返回體
// 當這個函數(shù)被調用時,會通過反射將POST請求的Body數(shù)據(jù)自動解析并綁定到req參數(shù)上(如果是GET請求就綁定Query參數(shù))
// 當這個函數(shù)返回時,同樣通過反射獲取到返回的結構體,將其序列化成Json字符串后,寫入響應
func submit(ctx *easierweb.Context, req Request) *Response {
// 打印req的參數(shù)
fmt.Printf("json body -> name: %s, mobile: %s \n", req.Name, req.Mobile)
// 直接return結構體
return &Response{Code: 1000, Msg: "hello"}
}
type Request struct {
Name string `json:"name"`
Mobile string `json:"mobile"`
}
type Response struct {
Code int `json:"code"`
Msg string `json:"msg"`
}
請求入參和響應返回值在反射賦值/取值時都做了動態(tài)化識別,可傳可不傳,不傳req入參時就不會自動綁定請求數(shù)據(jù),不返回Response且沒有報錯時就響應204,返回了error或者函數(shù)拋出異常了就返回400/500,Response可以是對象也可以是切片。
func TestAPI(ctx *easierweb.Context, req Request) (*Response, error) func TestAPI(ctx *easierweb.Context, req Request) *Response func TestAPI(ctx *easierweb.Context, req Request) error func TestAPI(ctx *easierweb.Context, req Request) func TestAPI(ctx *easierweb.Context) (*Response, error) func TestAPI(ctx *easierweb.Context) *Response func TestAPI(ctx *easierweb.Context) error func TestAPI(ctx *easierweb.Context)
實際開發(fā)中,不一定以Json格式來接收/呈現(xiàn)數(shù)據(jù),所以留了個插件口子,可以讓用戶自定義自動綁定/寫入數(shù)據(jù)的序列化與反序列化方式。
// 使用XML格式來處理自動綁定和自動寫入的數(shù)據(jù)
router := easierweb.New(easierweb.RouterOptions{
RequestHandle: plugins.XMLRequestHandle(),
ResponseHandle: plugins.XMLResponseHandle(),
})
追加功能(常用方法封裝)
我寫瀏覽器Js爬蟲經常要用Websocket來連接后端并持續(xù)傳輸數(shù)據(jù),還有些表單動態(tài)賦值的需求經常要用到SSE,那就順便給框架整個websocket和SSE的快捷使用方式,同時把連接升級、跨域、SSE請求頭設置、連接關閉之類的操作全部都封裝到底層,不需要使用者操心這么多事情。
func main() {
// 新建路由
router := easierweb.New()
// 快速使用websocket
router.WS("/demoWS/:id", DemoWS)
// 快速使用SSE
router.SSE("/demoSSE/:id", DemoSSE)
// 啟動
log.Fatal(router.Run(":80"))
}
// 快速使用websocket
func DemoWS(ctx *easierweb.Context) {
// 處理websocket連接
for {
// 接收客戶端消息
msg, err := ctx.ReceiveString()
if err != nil {
panic(err)
}
fmt.Println("read websocket msg:", msg)
// 發(fā)送消息給客戶端
err = ctx.SendString("hello")
if err != nil {
panic(err)
}
time.Sleep(1 * time.Second)
// 函數(shù)返回時,websocket連接會自動關閉,不勞煩用戶手動調close了
return
}
}
// 快速使用SSE
func DemoSSE(ctx *easierweb.Context) {
// 循環(huán)推送數(shù)據(jù)
for i := 0; i < 5; i++ {
// SSE推送數(shù)據(jù), data: hello, id: {i}
err := ctx.Push(fmt.Sprintf("data: hello\nid: %v\n\n", i))
if err != nil {
panic(err)
}
time.Sleep(1 * time.Second)
}
}


以上就是使用Go語言自制簡單易用的Web框架的詳細內容,更多關于Go Web框架的資料請關注腳本之家其它相關文章!
相關文章
go使用SQLX操作MySQL數(shù)據(jù)庫的教程詳解
sqlx 是 Go 語言中一個流行的操作數(shù)據(jù)庫的第三方包,它提供了對 Go 標準庫 database/sql 的擴展,簡化了操作數(shù)據(jù)庫的步驟,下面我們就來學習一下go如何使用SQLX實現(xiàn)MySQL數(shù)據(jù)庫的一些基本操作吧2023-11-11
Go基礎教程系列之import導入包(遠程包)和變量初始化詳解
這篇文章主要介紹了Go基礎教程系列之import導包和初始化詳解,需要的朋友可以參考下2022-04-04

