go/kratos
1
0
Fork 0
mirror of https://github.com/go-kratos/kratos.git synced 2025-01-07 23:02:12 +02:00
Code Issues Releases Activity

transport/http: rename route to router (#1082)

Browse Source 
* rename route to router
This commit is contained in:
Tony Chen 2021-06-19 16:02:07 +08:00 committed by GitHub
parent 1dab58616b
commit 30334dc47c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 45 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
transport/http/context.go
View File

@ -16,9 +16,6 @@ import (
var _ Context = (*wrapper)(nil)
// HandlerFunc defines a function to serve HTTP requests.
type HandlerFunc func(Context) error
// Context is an HTTP Context.
type Context interface {
context.Context
@ -60,10 +57,10 @@ func (w *responseWriter) Write(data []byte) (int, error) {
}
type wrapper struct {
route *Route
req *http.Request
res http.ResponseWriter
w responseWriter
router *Router
req *http.Request
res http.ResponseWriter
w responseWriter
}
func (c *wrapper) Header() http.Header {
@ -90,9 +87,9 @@ func (c *wrapper) Query() url.Values {
func (c *wrapper) Request() *http.Request { return c.req }
func (c *wrapper) Response() http.ResponseWriter { return c.res }
func (c *wrapper) Middleware(h middleware.Handler) middleware.Handler {
return middleware.Chain(c.route.srv.ms...)(h)
return middleware.Chain(c.router.srv.ms...)(h)
}
func (c *wrapper) Bind(v interface{}) error { return c.route.srv.dec(c.req, v) }
func (c *wrapper) Bind(v interface{}) error { return c.router.srv.dec(c.req, v) }
func (c *wrapper) BindVars(v interface{}) error { return binding.BindQuery(c.Vars(), v) }
func (c *wrapper) BindQuery(v interface{}) error { return binding.BindQuery(c.Query(), v) }
func (c *wrapper) BindForm(v interface{}) error { return binding.BindForm(c.req, v) }
@ -100,7 +97,7 @@ func (c *wrapper) Returns(v interface{}, err error) error {
if err != nil {
return err
}
if err := c.route.srv.enc(&c.w, c.req, v); err != nil {
if err := c.router.srv.enc(&c.w, c.req, v); err != nil {
return err
}
return nil
@ -108,7 +105,7 @@ func (c *wrapper) Returns(v interface{}, err error) error {
func (c *wrapper) Result(code int, v interface{}) error {
c.w.WriteHeader(code)
if err := c.route.srv.enc(&c.w, c.req, v); err != nil {
if err := c.router.srv.enc(&c.w, c.req, v); err != nil {
return err
}
return nil

16
transport/http/filter.go Normal file
View File

@ -0,0 +1,16 @@
package http
import "net/http"
// FilterFunc is a function which receives an http.Handler and returns another http.Handler.
type FilterFunc func(http.Handler) http.Handler
// FilterChain returns a FilterFunc that specifies the chained handler for HTTP Router.
func FilterChain(filters ...FilterFunc) FilterFunc {
return func(next http.Handler) http.Handler {
for i := len(filters) - 1; i >= 0; i-- {
next = filters[i](next)
}
return next
}
}

44
transport/http/route.go → transport/http/router.go
View File

@ -6,41 +6,31 @@ import (
"sync"
)
// FilterFunc is a function which receives an http.Handler and returns another http.Handler.
type FilterFunc func(http.Handler) http.Handler
// HandlerFunc defines a function to serve HTTP requests.
type HandlerFunc func(Context) error
// FilterChain returns a FilterFunc that specifies the chained handler for HTTP Router.
func FilterChain(filters ...FilterFunc) FilterFunc {
return func(next http.Handler) http.Handler {
for i := len(filters) - 1; i >= 0; i-- {
next = filters[i](next)
}
return next
}
}
// Route is an HTTP route.
type Route struct {
// Router is an HTTP router.
type Router struct {
prefix string
pool sync.Pool
srv *Server
filters []FilterFunc
}
func newRoute(prefix string, srv *Server, filters ...FilterFunc) *Route {
r := &Route{
func newRouter(prefix string, srv *Server, filters ...FilterFunc) *Router {
r := &Router{
prefix: prefix,
srv: srv,
filters: filters,
}
r.pool.New = func() interface{} {
return &wrapper{route: r}
return &wrapper{router: r}
}
return r
}
// Handle registers a new route with a matcher for the URL path and method.
func (r *Route) Handle(method, relativePath string, h HandlerFunc, filters ...FilterFunc) {
func (r *Router) Handle(method, relativePath string, h HandlerFunc, filters ...FilterFunc) {
next := http.Handler(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
ctx := r.pool.Get().(Context)
ctx.Reset(res, req)
@ -56,46 +46,46 @@ func (r *Route) Handle(method, relativePath string, h HandlerFunc, filters ...Fi
}
// GET registers a new GET route for a path with matching handler in the router.
func (r *Route) GET(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) GET(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodGet, path, h, m...)
}
// HEAD registers a new HEAD route for a path with matching handler in the router.
func (r *Route) HEAD(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) HEAD(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodHead, path, h, m...)
}
// POST registers a new POST route for a path with matching handler in the router.
func (r *Route) POST(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) POST(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodPost, path, h, m...)
}
// PUT registers a new PUT route for a path with matching handler in the router.
func (r *Route) PUT(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) PUT(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodPut, path, h, m...)
}
// PATCH registers a new PATCH route for a path with matching handler in the router.
func (r *Route) PATCH(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) PATCH(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodPatch, path, h, m...)
}
// DELETE registers a new DELETE route for a path with matching handler in the router.
func (r *Route) DELETE(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) DELETE(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodDelete, path, h, m...)
}
// CONNECT registers a new CONNECT route for a path with matching handler in the router.
func (r *Route) CONNECT(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) CONNECT(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodConnect, path, h, m...)
}
// OPTIONS registers a new OPTIONS route for a path with matching handler in the router.
func (r *Route) OPTIONS(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) OPTIONS(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodOptions, path, h, m...)
}
// TRACE registers a new TRACE route for a path with matching handler in the router.
func (r *Route) TRACE(path string, h HandlerFunc, m ...FilterFunc) {
func (r *Router) TRACE(path string, h HandlerFunc, m ...FilterFunc) {
r.Handle(http.MethodTrace, path, h, m...)
}

0
transport/http/route_test.go → transport/http/router_test.go
View File

6
transport/http/server.go
View File

@ -127,9 +127,9 @@ func NewServer(opts ...ServerOption) *Server {
return srv
}
// Route registers an HTTP route.
func (s *Server) Route(prefix string, filters ...FilterFunc) *Route {
return newRoute(prefix, s, filters...)
// Route registers an HTTP router.
func (s *Server) Route(prefix string, filters ...FilterFunc) *Router {
return newRouter(prefix, s, filters...)
}
// Handle registers a new route with a matcher for the URL path.

8
transport/http/server_test.go
View File

@ -22,15 +22,9 @@ type testData struct {
func TestServer(t *testing.T) {
fn := func(w http.ResponseWriter, r *http.Request) {
data := &testData{Path: r.RequestURI}
json.NewEncoder(w).Encode(data)
if r.Context().Value(testKey{}) != "test" {
w.WriteHeader(500)
}
json.NewEncoder(w).Encode(testData{Path: r.RequestURI})
}
ctx := context.Background()
ctx = context.WithValue(ctx, testKey{}, "test")
srv := NewServer()
srv.HandleFunc("/index", fn)