forked from Fuyu/router
Compare commits
14 commits
Author | SHA1 | Date | |
---|---|---|---|
152bf49c4b | |||
283c75b32e | |||
66ae2a435c | |||
5b5a102c71 | |||
d504c9d2b5 | |||
2a612eb82f | |||
317961ab6e | |||
60f82143da | |||
15df08f21b | |||
717c6f65fc | |||
890ff550eb | |||
0990f5bafe | |||
4cc4ce2a2e | |||
d30d304cea |
5 changed files with 121 additions and 19 deletions
53
context.go
53
context.go
|
@ -1,8 +1,12 @@
|
||||||
package router
|
package router
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/julienschmidt/httprouter"
|
"github.com/julienschmidt/httprouter"
|
||||||
)
|
)
|
||||||
|
@ -16,11 +20,29 @@ type Context struct {
|
||||||
store map[string]interface{}
|
store map[string]interface{}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newContext(router *Router, res http.ResponseWriter, req *http.Request, param httprouter.Params) *Context {
|
// NewContext creates a new context, this function is only exported for use in tests
|
||||||
|
func NewContext(router *Router, res http.ResponseWriter, req *http.Request, param httprouter.Params) *Context {
|
||||||
return &Context{router, req, res, param.ByName, make(map[string]interface{})}
|
return &Context{router, req, res, param.ByName, make(map[string]interface{})}
|
||||||
}
|
}
|
||||||
|
|
||||||
// String returns the given status code and writes the bytes to the body
|
// QueryParam returns the specified parameter from the query string.
|
||||||
|
// Returns an empty string if it doesn't exist. Returns the first parameter if multiple instances exist
|
||||||
|
func (c *Context) QueryParam(param string) string {
|
||||||
|
params := c.Request.URL.Query()[param]
|
||||||
|
if params == nil {
|
||||||
|
return ``
|
||||||
|
}
|
||||||
|
|
||||||
|
return params[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
// Redirect sends a redirect to the client
|
||||||
|
func (c *Context) Redirect(code int, url string) error {
|
||||||
|
http.Redirect(c.Response, c.Request, url, code)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Bytes returns the given status code and writes the bytes to the body
|
||||||
func (c *Context) Bytes(code int, b []byte) error {
|
func (c *Context) Bytes(code int, b []byte) error {
|
||||||
c.Response.WriteHeader(code)
|
c.Response.WriteHeader(code)
|
||||||
_, err := c.Response.Write(b)
|
_, err := c.Response.Write(b)
|
||||||
|
@ -53,14 +75,22 @@ func (c *Context) JSON(code int, data interface{}) error {
|
||||||
return json.NewEncoder(c.Response).Encode(data) // TODO: Encode to buffer first to prevent partial responses on error
|
return json.NewEncoder(c.Response).Encode(data) // TODO: Encode to buffer first to prevent partial responses on error
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Render renders a templating using the Renderer set in router
|
||||||
func (c *Context) Render(code int, template string, data interface{}) error {
|
func (c *Context) Render(code int, template string, data interface{}) error {
|
||||||
if c.router.Renderer == nil {
|
if c.router.Renderer == nil {
|
||||||
panic(`Cannot call render without a renderer set`)
|
panic(`Cannot call render without a renderer set`)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var b bytes.Buffer
|
||||||
|
err := c.router.Renderer.Render(&b, template, data, c)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
c.Response.Header().Set(`Content-Type`, `text/html`)
|
c.Response.Header().Set(`Content-Type`, `text/html`)
|
||||||
c.Response.WriteHeader(code)
|
c.Response.WriteHeader(code)
|
||||||
return c.router.Renderer.Render(c.Response, template, data, c)
|
_, _ = io.Copy(c.Response, &b)
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set sets a value in the context. Set is not safe to be used concurrently
|
// Set sets a value in the context. Set is not safe to be used concurrently
|
||||||
|
@ -72,3 +102,20 @@ func (c *Context) Set(key string, value interface{}) {
|
||||||
func (c *Context) Get(key string) interface{} {
|
func (c *Context) Get(key string) interface{} {
|
||||||
return c.store[key]
|
return c.store[key]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// RealIP uses proxy headers for the real ip, if none exist the IP of the current connection is returned
|
||||||
|
func (c *Context) RealIP() string {
|
||||||
|
reqIP := c.Request.RemoteAddr
|
||||||
|
|
||||||
|
if ip := c.Request.Header.Get(`X-Forwarded-For`); ip != `` {
|
||||||
|
reqIP = strings.Split(ip, `, `)[0]
|
||||||
|
} else if ip := c.Request.Header.Get(`X-Real-IP`); ip != `` {
|
||||||
|
reqIP = ip
|
||||||
|
}
|
||||||
|
|
||||||
|
ra, _, _ := net.SplitHostPort(reqIP)
|
||||||
|
if ra != `` {
|
||||||
|
reqIP = ra
|
||||||
|
}
|
||||||
|
return reqIP
|
||||||
|
}
|
||||||
|
|
5
go.mod
Normal file
5
go.mod
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
module git.fuyu.moe/Fuyu/router
|
||||||
|
|
||||||
|
go 1.13
|
||||||
|
|
||||||
|
require github.com/julienschmidt/httprouter v1.3.0
|
2
go.sum
Normal file
2
go.sum
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
github.com/julienschmidt/httprouter v1.3.0 h1:U0609e9tgbseu3rBINet9P48AI/D3oJs4dN7jwJOQ1U=
|
||||||
|
github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM=
|
79
router.go
79
router.go
|
@ -1,8 +1,12 @@
|
||||||
package router
|
package router
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/tls"
|
||||||
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"reflect"
|
"reflect"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/julienschmidt/httprouter"
|
"github.com/julienschmidt/httprouter"
|
||||||
)
|
)
|
||||||
|
@ -23,7 +27,7 @@ type ErrorHandle func(*Context, interface{})
|
||||||
// Middleware is a function that runs before your route, it gets the next handler as a parameter
|
// Middleware is a function that runs before your route, it gets the next handler as a parameter
|
||||||
type Middleware func(Handle) Handle
|
type Middleware func(Handle) Handle
|
||||||
|
|
||||||
// Binder reads input to dst, returns true is successful
|
// Reader reads input to dst, returns true if successful
|
||||||
type Reader func(c *Context, dst interface{}) (bool, error)
|
type Reader func(c *Context, dst interface{}) (bool, error)
|
||||||
|
|
||||||
// Router is the router itself
|
// Router is the router itself
|
||||||
|
@ -35,6 +39,8 @@ type Router struct {
|
||||||
NotFoundHandler Handle
|
NotFoundHandler Handle
|
||||||
MethodNotAllowedHandler Handle
|
MethodNotAllowedHandler Handle
|
||||||
ErrorHandler ErrorHandle
|
ErrorHandler ErrorHandle
|
||||||
|
TrimTrailingSlashes bool
|
||||||
|
server *http.Server
|
||||||
}
|
}
|
||||||
|
|
||||||
// New returns a new Router
|
// New returns a new Router
|
||||||
|
@ -90,14 +96,48 @@ func (r *Router) OPTIONS(path string, handle Handle, middleware ...Middleware) {
|
||||||
r.routes = append(r.routes, route{`OPTIONS`, path, handle, middleware})
|
r.routes = append(r.routes, route{`OPTIONS`, path, handle, middleware})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Serve accepts incoming HTTP connections on the listener
|
||||||
|
func (r *Router) Serve(l net.Listener) error {
|
||||||
|
httpr := r.getHttpr()
|
||||||
|
|
||||||
|
r.server = &http.Server{Handler: httpr}
|
||||||
|
return r.server.Serve(l)
|
||||||
|
}
|
||||||
|
|
||||||
// Start starts the web server and binds to the given address
|
// Start starts the web server and binds to the given address
|
||||||
func (r *Router) Start(addr string) error {
|
func (r *Router) Start(addr string) error {
|
||||||
httpr := r.getHttpr()
|
httpr := r.getHttpr()
|
||||||
|
|
||||||
return http.ListenAndServe(addr, httpr)
|
r.server = &http.Server{Addr: addr, Handler: httpr}
|
||||||
|
return r.server.ListenAndServe()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *Router) getHttpr() *httprouter.Router {
|
// StartTLS starts a TLS web server using the given key, cert and config and binds to the given address
|
||||||
|
func (r *Router) StartTLS(addr, certFile, keyFile string, conf *tls.Config) error {
|
||||||
|
httpr := r.getHttpr()
|
||||||
|
|
||||||
|
r.server = &http.Server{Addr: addr, Handler: httpr, TLSConfig: conf}
|
||||||
|
return r.server.ListenAndServeTLS(certFile, keyFile)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stop stops the web server
|
||||||
|
func (r *Router) Stop() error {
|
||||||
|
if r.server == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
|
||||||
|
defer cancel()
|
||||||
|
err := r.server.Shutdown(ctx)
|
||||||
|
if err == context.DeadlineExceeded {
|
||||||
|
err = r.server.Close()
|
||||||
|
}
|
||||||
|
r.server = nil
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Router) getHttpr() http.Handler {
|
||||||
httpr := httprouter.New()
|
httpr := httprouter.New()
|
||||||
|
|
||||||
for _, v := range r.routes {
|
for _, v := range r.routes {
|
||||||
|
@ -106,7 +146,11 @@ func (r *Router) getHttpr() *httprouter.Router {
|
||||||
handle = handlePOST(r, v.Handle)
|
handle = handlePOST(r, v.Handle)
|
||||||
}
|
}
|
||||||
|
|
||||||
httpr.Handle(v.Method, v.Path, handleReq(r, handle, append(r.middleware, v.Middleware...)))
|
middleware := make([]Middleware, len(r.middleware)+len(v.Middleware))
|
||||||
|
copy(middleware, r.middleware)
|
||||||
|
copy(middleware[len(r.middleware):], v.Middleware)
|
||||||
|
|
||||||
|
httpr.Handle(v.Method, v.Path, handleReq(r, handle, middleware))
|
||||||
}
|
}
|
||||||
|
|
||||||
httpr.NotFound = http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
|
httpr.NotFound = http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
|
||||||
|
@ -118,18 +162,23 @@ func (r *Router) getHttpr() *httprouter.Router {
|
||||||
})
|
})
|
||||||
|
|
||||||
httpr.PanicHandler = func(res http.ResponseWriter, req *http.Request, err interface{}) {
|
httpr.PanicHandler = func(res http.ResponseWriter, req *http.Request, err interface{}) {
|
||||||
c := newContext(r, res, req, nil)
|
c := NewContext(r, res, req, nil)
|
||||||
r.ErrorHandler(c, err)
|
r.ErrorHandler(c, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return httpr
|
if r.TrimTrailingSlashes {
|
||||||
}
|
httpr.RedirectTrailingSlash = false
|
||||||
|
|
||||||
func handleErr(errHandler ErrorHandle, err interface{}) Handle {
|
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
|
||||||
return func(c *Context) error {
|
l := len(req.URL.Path)
|
||||||
errHandler(c, err)
|
if l > 1 && req.URL.Path[l-1] == '/' {
|
||||||
return nil
|
req.URL.Path = req.URL.Path[:l-1]
|
||||||
|
}
|
||||||
|
httpr.ServeHTTP(w, req)
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return httpr
|
||||||
}
|
}
|
||||||
|
|
||||||
func checkInterfaceHandle(f interface{}) {
|
func checkInterfaceHandle(f interface{}) {
|
||||||
|
@ -154,8 +203,6 @@ func checkInterfaceHandle(f interface{}) {
|
||||||
if rt.In(0) != reflect.TypeOf(&Context{}) {
|
if rt.In(0) != reflect.TypeOf(&Context{}) {
|
||||||
panic(`handle should accept Context as first argument`)
|
panic(`handle should accept Context as first argument`)
|
||||||
}
|
}
|
||||||
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func handlePOST(r *Router, f interface{}) Handle {
|
func handlePOST(r *Router, f interface{}) Handle {
|
||||||
|
@ -166,7 +213,7 @@ func handlePOST(r *Router, f interface{}) Handle {
|
||||||
|
|
||||||
if r.Reader != nil {
|
if r.Reader != nil {
|
||||||
ok, err := r.Reader(c, data.Interface())
|
ok, err := r.Reader(c, data.Interface())
|
||||||
c.Request.Body.Close()
|
_ = c.Request.Body.Close()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
@ -186,10 +233,10 @@ func handlePOST(r *Router, f interface{}) Handle {
|
||||||
|
|
||||||
func handleReq(r *Router, handle Handle, m []Middleware) httprouter.Handle {
|
func handleReq(r *Router, handle Handle, m []Middleware) httprouter.Handle {
|
||||||
return func(res http.ResponseWriter, req *http.Request, param httprouter.Params) {
|
return func(res http.ResponseWriter, req *http.Request, param httprouter.Params) {
|
||||||
c := newContext(r, res, req, param)
|
c := NewContext(r, res, req, param)
|
||||||
|
|
||||||
f := handle
|
f := handle
|
||||||
for i := len(m) - 1; i >= 0; i-- { // TODO: 1,2,3 of 3,2,1
|
for i := len(m) - 1; i >= 0; i-- {
|
||||||
f = m[i](f)
|
f = m[i](f)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
1
type.go
1
type.go
|
@ -4,6 +4,7 @@ import (
|
||||||
"io"
|
"io"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Renderer renders a template
|
||||||
type Renderer interface {
|
type Renderer interface {
|
||||||
Render(w io.Writer, template string, data interface{}, c *Context) error
|
Render(w io.Writer, template string, data interface{}, c *Context) error
|
||||||
}
|
}
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue