中文说明

GoDoc

Install

go get github.com/gookit/rux

Quick start

package mainimport ("github.com/gookit/rux")funcmain() {r:=rux.New()// Add Routes:r.GET("/",func(c*rux.Context) {c.Text(200,"hello")})r.GET("/hello/{name}",func(c*rux.Context) {c.Text(200,"hello "+c.Param("name"))})r.POST("/post",func(c*rux.Context) {c.Text(200,"hello")})// add multi method support for an route pathr.Add("/post[/{id}]",func(c*rux.Context) {ifc.Param("id")=="" {// do create postc.Text(200,"created")return}id:=c.Params.Int("id")// do update postc.Text(200,"updated "+fmt.Sprint(id))},rux.POST,rux.PUT)// Start serverr.Listen(":8080")// can also// http.ListenAndServe(":8080", r)}

Route Group

r.Group("/articles",func() {r.GET("",func(c*rux.Context) {c.Text(200,"view list")    })r.POST("",func(c*rux.Context) {c.Text(200,"create ok")    })r.GET(`/{id:\d+}`,func(c*rux.Context) {c.Text(200,"view detail, id: "+c.Param("id"))    })})

Path Params

// can access by: "/blog/123"r.GET(`/blog/{id:\d+}`,func(c*rux.Context) {c.Text(200,"view detail, id: "+c.Param("id"))})

// can access by: "/blog/my-article" "/blog/my-article.html"r.GET(`/blog/{title:\w+}[.html]`,func(c*rux.Context) {c.Text(200,"view detail, id: "+c.Param("id"))})r.Add("/posts[/{id}]",func(c*rux.Context) {ifc.Param("id")=="" {// do create postc.Text(200,"created")return    }id:=c.Params.Int("id")// do update postc.Text(200,"updated "+fmt.Sprint(id))},rux.POST,rux.PUT)

Use Middleware

package mainimport ("fmt""github.com/gookit/rux")funcmain() {r:=rux.New()// add global middlewarer.Use(func(c*rux.Context) {// do something ...})// add middleware for the routeroute:=r.GET("/middle",func(c*rux.Context) {// main handlerc.WriteString("-O-")},func(c*rux.Context) {// middle 1c.WriteString("a")c.Next()// Notice: call Next()c.WriteString("A")// if call Abort(), will abort at the end of this middleware run// c.Abort()    })// add more by Use()route.Use(func(c*rux.Context) {// middle 2c.WriteString("b")c.Next()c.WriteString("B")})// now, access the URI /middle// will output: ab-O-BA}

        +-----------------------------+        | middle 1                    |        |  +----------------------+   |        |  | middle 2             |   | start  |  |  +----------------+  |   | end------->|  |  |  main handler  |  |   |--->----        |  |  |________________|  |   |            |  |______________________|   |          |_____________________________|

Use http.Handler

package mainimport ("net/http""github.com/gookit/rux"// here we use gorilla/handlers, it provides some generic handlers."github.com/gorilla/handlers")funcmain() {r:=rux.New()// create a simple generic http.Handlerh0:=http.HandlerFunc(func (w http.ResponseWriter,r*http.Request) {w.Header().Set("new-key","val")})r.Use(rux.WrapHTTPHandler(h0),rux.WrapHTTPHandler(handlers.ProxyHeaders()))r.GET("/",func(c*rux.Context) {c.Text(200,"hello")})// add routes ...// Wrap our server with our gzip handler to gzip compress all responses.http.ListenAndServe(":8000",handlers.CompressHandler(r))}

More Usage

Static Assets

package mainimport ("embed""net/http""github.com/gookit/rux")//go:embed staticvarembAssets embed.FSfuncmain() {r:=rux.New()// one filer.StaticFile("/site.js","testdata/site.js")// allow any files in the directory.r.StaticDir("/static","testdata")// file type limit in the directoryr.StaticFiles("/assets","testdata","css|js")// go 1.16+: use embed assets. access: /embed/static/some.htmlr.StaticFS("/embed",http.FS(embAssets))}

Name Route

r:=rux.New()// Method 1myRoute:=rux.NewNamedRoute("name1","/path4/some/{id}",emptyHandler,"GET")r.AddRoute(myRoute)// Method 2rux.AddNamed("name2","/",func(c*rux.Context) {c.Text(200,"hello")})// Method 3r.GET("/hi",func(c*rux.Context) {c.Text(200,"hello")}).NamedTo("name3",r)// get route by namemyRoute=r.GetRoute("name1")

Redirect

r.GET("/",func(c*rux.Context) {c.AbortThen().Redirect("/login",302)})// Orr.GET("/",func(c*rux.Context) {c.Redirect("/login",302)c.Abort()})r.GET("/",func(c*rux.Context) {c.Back()c.Abort()})

Cookies

r.GET("/setcookie",func(c*rux.Context) {c.FastSetCookie("rux_cookie2","test-value2",3600)c.SetCookie("rux_cookie","test-value1",3600,"/",c.Req.URL.Host,false,true)c.WriteString("hello, in "+c.URL().Path)})r.GET("/delcookie",func(c*rux.Context) {val:=ctx.Cookie("rux_cookie")// "test-value1"c.DelCookie("rux_cookie","rux_cookie2")})

Multi Domains

package mainimport ("log""net/http""github.com/gookit/rux")typeHostSwitchmap[string]http.Handler// Implement the ServeHTTP method on our new typefunc (hsHostSwitch)ServeHTTP(w http.ResponseWriter,r*http.Request) {// Check if a http.Handler is registered for the given host.// If yes, use it to handle the request.ifrouter:=hs[r.Host];router!=nil {router.ServeHTTP(w,r)}else {// Handle host names for which no handler is registeredhttp.Error(w,"Forbidden",403)// Or Redirect?}}funcmain() {// Initialize a router as usualrouter:=rux.New()router.GET("/",Index)router.GET("/hello/{name}",func(c*rux.Context) {})// Make a new HostSwitch and insert the router (our http handler)// for example.com and port 12345hs:=make(HostSwitch)hs["example.com:12345"]=router// Use the HostSwitch to listen and serve on port 12345log.Fatal(http.ListenAndServe(":12345",hs))}

RESETFul Style

package mainimport ("log""net/http""github.com/gookit/rux")typeProductstruct {}// Uses middlewares [optional]func (Product)Uses()map[string][]rux.HandlerFunc {returnmap[string][]rux.HandlerFunc{// function name: handlers"Delete": []rux.HandlerFunc{handlers.HTTPBasicAuth(map[string]string{"test":"123"}),handlers.GenRequestID(),},}}// all products [optional]func (p*Product)Index(c*rux.Context) {// do something}// create product [optional]func (p*Product)Create(c*rux.Context) {// do something}// save new product [optional]func (p*Product)Store(c*rux.Context) {// do something}// show product with {id} [optional]func (p*Product)Show(c*rux.Context) {// do something}// edit product [optional]func (p*Product)Edit(c*rux.Context) {// do something}// save edited product [optional]func (p*Product)Update(c*rux.Context) {// do something}// delete product [optional]func (p*Product)Delete(c*rux.Context) {// do something}funcmain() {router:=rux.New()// methodsPathActionRoute Name// GET/productindexproduct_index// GET/product/createcreateproduct_create// POST/productstoreproduct_store// GET/product/{id}showproduct_show// GET/product/{id}/editeditproduct_edit// PUT/PATCH/product/{id}updateproduct_update// DELETE/product/{id}deleteproduct_delete// resetful stylerouter.Resource("/",new(Product))log.Fatal(http.ListenAndServe(":12345",router))}

Controller Style

package mainimport ("log""net/http""github.com/gookit/rux")// News controllertypeNewsstruct {}func (n*News)AddRoutes(g*rux.Router) {g.GET("/",n.Index)g.POST("/",n.Create)g.PUT("/",n.Edit)}func (n*News)Index(c*rux.Context) {// Do something}func (n*News)Create(c*rux.Context) {// Do something}func (n*News)Edit(c*rux.Context) {// Do something}funcmain() {router:=rux.New()// controller stylerouter.Controller("/news",new(News))log.Fatal(http.ListenAndServe(":12345",router))}

Build URL

package mainimport ("log""net/http""github.com/gookit/rux")funcmain() {// Initialize a router as usualrouter:=rux.New()router.GET(`/news/{category_id}/{new_id:\d+}/detail`,func(c*rux.Context) {varu=make(url.Values)u.Add("username","admin")u.Add("password","12345")b:=rux.NewBuildRequestURL()// b.Scheme("https")// b.Host("www.mytest.com")b.Queries(u)b.Params(rux.M{"{category_id}":"100","{new_id}":"20"})// b.Path("/dev")// println(b.Build().String())println(c.Router().BuildRequestURL("new_detail",b).String())// result:  /news/100/20/detail?username=admin&password=12345// get current route nameifc.MustGet(rux.CTXCurrentRouteName)=="new_detail" {// post data etc....        }}).NamedTo("new_detail",router)// Use the HostSwitch to listen and serve on port 12345log.Fatal(http.ListenAndServe(":12345",router))}

Help

golint ./...

# list error filesgofmt -s -l ./# fix format and write to filegofmt -s -w some.go

gotest -cover ./...

Gookit Packages

See also

License