goRouter

README

goRouter

goRouter is a very flexible and lightweight router with hight performance. It is very suitable for small project or some little web service.

Usage

talk is less, show you the code:

package main

import (
    "fmt"
    // import router
    "github.com/Barbery/goRouter"
    "net/http"
)

func main() {
    // get the instance of router
    mux := goRouter.GetMuxInstance()

    // add routes
    // Note: In goRouter, the routes is full match(by default, native router in golang is prefix match).
    mux.Get(`/user/:id(\d+)`, getUser)
    mux.Get(`/user/profile/:id(\d+)\.:format(\w+)`, getUserProfile)
    mux.Post(`/user`, postUser)
    mux.Delete(`/user/:id(\d+)`, deleteUser)
    mux.Put(`/user/:id(\d+)`, putUser)

    // run the serve
    http.ListenAndServe(":8888", mux)
}

// routes handler must be type of http.HandlerFunc
func getUser(w http.ResponseWriter, r *http.Request) {
    id := r.URL.Query().Get(":id")
    w.Write([]byte(fmt.Sprintf(`GET user by id: %s`, id)))
}

func getUserProfile(w http.ResponseWriter, r *http.Request) {
    params := r.URL.Query()
    w.Write([]byte(fmt.Sprintf(`GET user profile by id: %s, format: %s`, params[":id"][0], params.Get(":format"))))
}

func postUser(w http.ResponseWriter, r *http.Request) {
    r.ParseForm()
    w.Write([]byte(fmt.Sprintf(`POST a new user, form data: %s`, fmt.Sprintln(r.PostForm))))
}

func deleteUser(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte(fmt.Sprintf(`DELETE a user by id: %s`, r.URL.Query().Get(":id"))))
}

func putUser(w http.ResponseWriter, r *http.Request) {
    r.ParseForm()
    w.Write([]byte(fmt.Sprintf(`UPDATE a user by id: %s, form data: %s`, r.URL.Query().Get(":id"), fmt.Sprintln(r.PostForm))))
}

If you want to match query params, you should add ':' prefix, like

// It will match below request url:
// GET /user/123
// GET /user/123/
// slash at the end of the url is optional
mux.Get(`/user/:id(\d+)`, getUser)

It will match the :id param and it is restricted to numeric type.

not match

POST /user/123
PUT /user/123
GET /user/123a

Documentation

Index

• Constants
• type Mux
  • func GetMuxInstance() *Mux
  • func (m *Mux) AddRoute(pattern string, handler http.HandlerFunc, method string)
  • func (m *Mux) Delete(pattern string, handler http.HandlerFunc)
  • func (m *Mux) Get(pattern string, handler http.HandlerFunc)
  • func (m *Mux) Post(pattern string, handler http.HandlerFunc)
  • func (m *Mux) Put(pattern string, handler http.HandlerFunc)
  • func (m *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants

const (
	CONNECT = "CONNECT"
	DELETE  = "DELETE"
	GET     = "GET"
	HEAD    = "HEAD"
	OPTIONS = "OPTIONS"
	PATCH   = "PATCH"
	POST    = "POST"
	PUT     = "PUT"
	TRACE   = "TRACE"
)

http method

Types

type Mux

type Mux struct {
	// contains filtered or unexported fields
}

func GetMuxInstance

func GetMuxInstance() *Mux

func (*Mux) AddRoute

func (m *Mux) AddRoute(pattern string, handler http.HandlerFunc, method string)

func (*Mux) Delete

func (m *Mux) Delete(pattern string, handler http.HandlerFunc)

func (*Mux) Get

func (m *Mux) Get(pattern string, handler http.HandlerFunc)

func (*Mux) Post

func (m *Mux) Post(pattern string, handler http.HandlerFunc)

func (*Mux) Put

func (m *Mux) Put(pattern string, handler http.HandlerFunc)

func (*Mux) ServeHTTP

func (m *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request)