README
¶
SGo
SGo is a simple, light and fast Web framework written in Go.
The source is easy to learn, then you can make your own Go Web Framework!
Features
- Pretty and fast router - based on radix tree
- Middleware Support
- Friendly to REST API
- No regexp or reflect
- QUIC Support
- Inspired by many excellent Go Web framework
Installation
go get github.com/AmyangXYZ/sgo
Example
Simple
package main
import (
"github.com/AmyangXYZ/sgo"
)
func main() {
app := sgo.New()
app.GET("/", func(ctx *sgo.Context) error {
return ctx.Text(200, "Hello Sweetie")
})
app.Run(":16311")
}
Further
package main
import (
"html/template"
"net/http"
"os"
"time"
"github.com/AmyangXYZ/sgo"
"github.com/AmyangXYZ/sgo/middlewares"
"github.com/dgrijalva/jwt-go"
)
var (
tplDir = "templates"
listenPort = ":16311"
secretKey = "CuteSweetie"
jwtSkipper = func(ctx *sgo.Context) bool {
if ctx.Path() == "/" ||
(ctx.Path() == "/api" && ctx.Method() == "GET") ||
(ctx.Path() == "/login" && ctx.Method() == "POST") ||
(len(ctx.Path()) > 8 && ctx.Path()[0:8] == "/static/") {
return true
}
return false
}
)
func main() {
app := sgo.New()
app.SetTemplates(tplDir, template.FuncMap{})
app.USE(middlewares.Logger(os.Stdout, middlewares.DefaultSkipper))
app.USE(middlewares.JWT("Header", secretKey, jwtSkipper))
app.GET("/", home)
app.GET("/static/*files", static)
app.GET("/api", biu)
app.POST("/api", hello)
app.POST("/login", login)
app.GET("/usr/:user", usr)
app.Run(listenPort)
// Or use QUIC
// app.RunOverQUIC(listenPort, "fullchain.pem", "privkey.pem")
}
func home(ctx *sgo.Context) {
ctx.Set("baby", "Sweetie")
ctx.Render(200, "index")
}
func static(ctx *sgo.Context) {
staticHandle := http.StripPrefix("/static",
http.FileServer(http.Dir("./static")))
staticHandle.ServeHTTP(ctx.Resp, ctx.Req)
}
func biu(ctx *sgo.Context) {
ctx.Text(200, "biu")
}
func login(ctx *sgo.Context) {
usr := ctx.Param("usr")
pwd := ctx.Param("pwd")
if usr == "Amyang" && pwd == "biu" {
token := jwt.New(jwt.SigningMethodHS256)
claims := token.Claims.(jwt.MapClaims)
claims["name"] = "Amyang"
claims["admin"] = true
claims["exp"] = time.Now().Add(time.Hour * 72).Unix()
t, _ := token.SignedString([]byte(secretKey))
ctx.JSON(200, 1, "success", map[string]string{"SG_Token": t})
return
}
ctx.JSON(200, 0, "username or password error", nil)
}
func api(ctx *sgo.Context) {
ctx.JSON(200, 1, "success", map[string]string{"version": "1.1"})
}
func hello(ctx *sgo.Context) {
usr := ctx.Get("userInfo").(*jwt.Token)
claims := usr.Claims.(jwt.MapClaims)
name := claims["name"].(string)
ctx.Text(200, "Hello "+name)
}
func usr(ctx *sgo.Context) {
ctx.Text(200, "Welcome home, "+ctx.Param("user"))
}
My Blog is also powered by SGo.
License
MIT
Documentation
¶
Index ¶
- Constants
- func MethodNotAllowedHandler(ctx *Context) error
- func NotFoundHandler(ctx *Context) error
- type Context
- func (ctx *Context) Error(code int, error string)
- func (ctx *Context) FormFile(key string) (multipart.File, *multipart.FileHeader, error)
- func (ctx *Context) Get(key string) interface{}
- func (ctx *Context) GetCookie(name string) string
- func (ctx *Context) Gets() map[string]interface{}
- func (ctx *Context) Init(w http.ResponseWriter, r *http.Request)
- func (ctx *Context) JSON(code, flag int, msg string, data interface{}) error
- func (ctx *Context) JSONP(code int, callback string, data interface{}) error
- func (ctx *Context) Method() string
- func (ctx *Context) Next()
- func (ctx *Context) Param(key string) string
- func (ctx *Context) Params() url.Values
- func (ctx *Context) Path() string
- func (ctx *Context) Redirect(code int, url string)
- func (ctx *Context) Referer() string
- func (ctx *Context) Render(code int, tplname string) error
- func (ctx *Context) SaveFile(name, saveDir string) (string, error)
- func (ctx *Context) Set(key string, val interface{})
- func (ctx *Context) SetCookie(name, value string)
- func (ctx *Context) Status() int
- func (ctx *Context) Text(code int, body string) error
- func (ctx *Context) UserAgent() string
- func (ctx *Context) Write(data []byte) (n int, err error)
- type HandlerFunc
- type SGo
- func (sg *SGo) Any(path string, handler HandlerFunc)
- func (sg *SGo) CONNECT(path string, handler HandlerFunc)
- func (sg *SGo) DELETE(path string, handler HandlerFunc)
- func (sg *SGo) GET(path string, handler HandlerFunc)
- func (sg *SGo) HEAD(path string, handler HandlerFunc)
- func (sg *SGo) Handle(method, path string, handler HandlerFunc)
- func (sg *SGo) OPTIONS(path string, handler HandlerFunc)
- func (sg *SGo) PATCH(path string, handler HandlerFunc)
- func (sg *SGo) POST(path string, handler HandlerFunc)
- func (sg *SGo) PUT(path string, handler HandlerFunc)
- func (sg *SGo) Run(addr string) error
- func (sg *SGo) RunOverTLS(addr, certFile, keyFile string) error
- func (sg *SGo) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (sg *SGo) SetTemplates(tplDir string, funcMap template.FuncMap)
- func (sg *SGo) TRACE(path string, handler HandlerFunc)
- func (sg *SGo) USE(middlewares ...HandlerFunc)
- type Templates
- type Trie
Constants ¶
View Source
const ( CONNECT = http.MethodConnect DELETE = http.MethodDelete GET = http.MethodGet HEAD = http.MethodHead OPTIONS = http.MethodOptions PATCH = http.MethodPatch POST = http.MethodPost PUT = http.MethodPut TRACE = http.MethodTrace )
HTTP methods
Variables ¶
This section is empty.
Functions ¶
func MethodNotAllowedHandler ¶
MethodNotAllowedHandler .
Types ¶
type Context ¶
type Context struct {
Req *http.Request
Resp *responseWriter
// contains filtered or unexported fields
}
Context provide a HTTP context for SGo.
func NewContext ¶
NewContext .
func (*Context) Init ¶
func (ctx *Context) Init(w http.ResponseWriter, r *http.Request)
Init the context gotten from sync pool.
type SGo ¶
type SGo struct {
// Router is based on a radix/trie tree.
Tree *Trie
// Pool is for context.
Pool *sync.Pool
NotFoundHandler HandlerFunc
MethodNotAllowedHandler HandlerFunc
// Built-in templates render.
Templates *Templates
Middlewares []HandlerFunc
}
SGo is Suuuuuuuuper Sweetie!
func (*SGo) Any ¶
func (sg *SGo) Any(path string, handler HandlerFunc)
Any register any method handler
func (*SGo) CONNECT ¶
func (sg *SGo) CONNECT(path string, handler HandlerFunc)
CONNECT register CONNECT request handler
func (*SGo) DELETE ¶
func (sg *SGo) DELETE(path string, handler HandlerFunc)
DELETE register DELETE request handler
func (*SGo) GET ¶
func (sg *SGo) GET(path string, handler HandlerFunc)
GET register GET request handler
func (*SGo) HEAD ¶
func (sg *SGo) HEAD(path string, handler HandlerFunc)
HEAD register HEAD request handler
func (*SGo) Handle ¶
func (sg *SGo) Handle(method, path string, handler HandlerFunc)
Handle register custom METHOD request HandlerFunc
func (*SGo) OPTIONS ¶
func (sg *SGo) OPTIONS(path string, handler HandlerFunc)
OPTIONS register OPTIONS request handler
func (*SGo) PATCH ¶
func (sg *SGo) PATCH(path string, handler HandlerFunc)
PATCH register PATCH request HandlerFunc
func (*SGo) POST ¶
func (sg *SGo) POST(path string, handler HandlerFunc)
POST register POST request handler
func (*SGo) PUT ¶
func (sg *SGo) PUT(path string, handler HandlerFunc)
PUT register PUT request handler
func (*SGo) RunOverTLS ¶
RunOverTLS .
func (*SGo) SetTemplates ¶
SetTemplates set the templates dir and funcMap.
func (*SGo) TRACE ¶
func (sg *SGo) TRACE(path string, handler HandlerFunc)
TRACE register TRACE request handler
type Templates ¶
type Templates struct {
Dir string
Suffix string
FuncMap template.FuncMap
// contains filtered or unexported fields
}
Templates is a templates manager.
func NewTemplates ¶
NewTemplates .
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.