forked from mirror/gin
commit
545101811a
|
@ -1,7 +1,5 @@
|
||||||
language: go
|
language: go
|
||||||
|
|
||||||
go:
|
go:
|
||||||
- 1.1
|
|
||||||
- 1.2
|
|
||||||
- 1.3
|
- 1.3
|
||||||
- tip
|
- tip
|
||||||
|
|
128
README.md
128
README.md
|
@ -4,35 +4,36 @@
|
||||||
[![Build Status](https://travis-ci.org/gin-gonic/gin.svg)](https://travis-ci.org/gin-gonic/gin)
|
[![Build Status](https://travis-ci.org/gin-gonic/gin.svg)](https://travis-ci.org/gin-gonic/gin)
|
||||||
|
|
||||||
Gin is a web framework written in Golang. It features a martini-like API with much better performance, up to 40 times faster. If you need performance and good productivity, you will love Gin.
|
Gin is a web framework written in Golang. It features a martini-like API with much better performance, up to 40 times faster. If you need performance and good productivity, you will love Gin.
|
||||||
[Check out the official web site](http://gin-gonic.github.io/gin/)
|
![Gin console logger](http://gin-gonic.github.io/gin/other/console.png)
|
||||||
|
|
||||||
|
|
||||||
##Gin is new, will it be supported?
|
##Gin is new, will it be supported?
|
||||||
|
|
||||||
Yes, Gin is an internal project of [my](https://github.com/manucorporat) upcoming startup. We developed it and we are going to continue using and improve it.
|
Yes, Gin is an internal project of [my](https://github.com/manucorporat) upcoming startup. We developed it and we are going to continue using and improve it.
|
||||||
|
|
||||||
|
|
||||||
##Roadmap
|
##Roadmap for v0.2
|
||||||
- Performance improments, reduce allocation and garbage collection overhead
|
- [x] Performance improments, reduce allocation and garbage collection overhead
|
||||||
- Fix bugs
|
- [x] Fix bugs
|
||||||
- Ask our designer for a cool logo
|
- [ ] Ask our designer for a cool logo
|
||||||
- Add tons of unit tests and benchmarks
|
- [ ] Add tons of unit tests
|
||||||
- Improve logging system
|
- [ ] Add internal benchmarks suite
|
||||||
- Improve JSON/XML validation using bindings
|
- [x] Improve logging system
|
||||||
- Improve XML support
|
- [x] Improve JSON/XML validation using bindings
|
||||||
- Improve documentation
|
- [x] Improve XML support
|
||||||
- Add more cool middlewares, for example redis caching (this also helps developers to understand the framework)
|
- [ ] Improve documentation
|
||||||
- Continuous integration
|
- [ ] Add more cool middlewares, for example redis caching (this also helps developers to understand the framework).
|
||||||
|
- [x] Continuous integration
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Start using it
|
## Start using it
|
||||||
Run:
|
Obviously, you need to have Git and Go! already installed to run Gin.
|
||||||
|
Run this in your terminal
|
||||||
|
|
||||||
```
|
```
|
||||||
go get github.com/gin-gonic/gin
|
go get github.com/gin-gonic/gin
|
||||||
```
|
```
|
||||||
Then import it in your Golang code:
|
Then import it in your Go! code:
|
||||||
|
|
||||||
```
|
```
|
||||||
import "github.com/gin-gonic/gin"
|
import "github.com/gin-gonic/gin"
|
||||||
|
@ -43,11 +44,13 @@ import "github.com/gin-gonic/gin"
|
||||||
|
|
||||||
#### Create most basic PING/PONG HTTP endpoint
|
#### Create most basic PING/PONG HTTP endpoint
|
||||||
```go
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
import "github.com/gin-gonic/gin"
|
import "github.com/gin-gonic/gin"
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
r := gin.Default()
|
r := gin.Default()
|
||||||
r.GET("/ping", func(c *gin.Context){
|
r.GET("/ping", func(c *gin.Context) {
|
||||||
c.String(200, "pong")
|
c.String(200, "pong")
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -56,7 +59,7 @@ func main() {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Using GET, POST, PUT, PATCH and DELETE
|
#### Using GET, POST, PUT, PATCH, DELETE and OPTIONS
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func main() {
|
func main() {
|
||||||
|
@ -68,6 +71,8 @@ func main() {
|
||||||
r.PUT("/somePut", putting)
|
r.PUT("/somePut", putting)
|
||||||
r.DELETE("/someDelete", deleting)
|
r.DELETE("/someDelete", deleting)
|
||||||
r.PATCH("/somePatch", patching)
|
r.PATCH("/somePatch", patching)
|
||||||
|
r.HEAD("/someHead", head)
|
||||||
|
r.OPTIONS("/someOptions", options)
|
||||||
|
|
||||||
// Listen and server on 0.0.0.0:8080
|
// Listen and server on 0.0.0.0:8080
|
||||||
r.Run(":8080")
|
r.Run(":8080")
|
||||||
|
@ -86,6 +91,13 @@ func main() {
|
||||||
c.String(200, message)
|
c.String(200, message)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
r.GET("/user/:name/:action", func(c *gin.Context) {
|
||||||
|
name := c.Params.ByName("name")
|
||||||
|
action := c.Params.ByName("action")
|
||||||
|
message := name + " is " + action
|
||||||
|
c.String(200, message)
|
||||||
|
})
|
||||||
|
|
||||||
// Listen and server on 0.0.0.0:8080
|
// Listen and server on 0.0.0.0:8080
|
||||||
r.Run(":8080")
|
r.Run(":8080")
|
||||||
}
|
}
|
||||||
|
@ -187,9 +199,9 @@ func main() {
|
||||||
// in the HTTP stream and return a 400 error. If you want custom error
|
// in the HTTP stream and return a 400 error. If you want custom error
|
||||||
// handling you should use: c.ParseBody(interface{}) error
|
// handling you should use: c.ParseBody(interface{}) error
|
||||||
if c.EnsureBody(&json) {
|
if c.EnsureBody(&json) {
|
||||||
if json.User=="manu" && json.Password=="123" {
|
if json.User == "manu" && json.Password == "123" {
|
||||||
c.JSON(200, gin.H{"status": "you are logged in"})
|
c.JSON(200, gin.H{"status": "you are logged in"})
|
||||||
}else{
|
} else {
|
||||||
c.JSON(401, gin.H{"status": "unauthorized"})
|
c.JSON(401, gin.H{"status": "unauthorized"})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -258,6 +270,7 @@ You can also use your own html template render
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "html/template"
|
import "html/template"
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
r := gin.Default()
|
r := gin.Default()
|
||||||
html := template.Must(template.ParseFiles("file1", "file2"))
|
html := template.Must(template.ParseFiles("file1", "file2"))
|
||||||
|
@ -286,6 +299,10 @@ func Logger() gin.HandlerFunc {
|
||||||
// after request
|
// after request
|
||||||
latency := time.Since(t)
|
latency := time.Since(t)
|
||||||
log.Print(latency)
|
log.Print(latency)
|
||||||
|
|
||||||
|
// access the status we are sending
|
||||||
|
status := c.Writer.Status()
|
||||||
|
log.Println(status)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -293,8 +310,8 @@ func main() {
|
||||||
r := gin.New()
|
r := gin.New()
|
||||||
r.Use(Logger())
|
r.Use(Logger())
|
||||||
|
|
||||||
r.GET("/test", func(c *gin.Context){
|
r.GET("/test", func(c *gin.Context) {
|
||||||
example := c.Get("example").(string)
|
example := c.MustGet("example").(string)
|
||||||
|
|
||||||
// it would print: "12345"
|
// it would print: "12345"
|
||||||
log.Println(example)
|
log.Println(example)
|
||||||
|
@ -305,8 +322,77 @@ func main() {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Using BasicAuth() middleware
|
||||||
|
```go
|
||||||
|
// similate some private data
|
||||||
|
var secrets = gin.H{
|
||||||
|
"foo": gin.H{"email": "foo@bar.com", "phone": "123433"},
|
||||||
|
"austin": gin.H{"email": "austin@example.com", "phone": "666"},
|
||||||
|
"lena": gin.H{"email": "lena@guapa.com", "phone": "523443"},
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
r := gin.Default()
|
||||||
|
|
||||||
|
// Group using gin.BasicAuth() middleware
|
||||||
|
// gin.Accounts is a shortcut for map[string]string
|
||||||
|
authorized := r.Group("/admin", gin.BasicAuth(gin.Accounts{
|
||||||
|
"foo": "bar",
|
||||||
|
"austin": "1234",
|
||||||
|
"lena": "hello2",
|
||||||
|
"manu": "4321",
|
||||||
|
}))
|
||||||
|
|
||||||
|
// /admin/secrets endpoint
|
||||||
|
// hit "localhost:8080/admin/secrets
|
||||||
|
authorized.GET("/secrets", func(c *gin.Context) {
|
||||||
|
// get user, it was setted by the BasicAuth middleware
|
||||||
|
user := c.Get(gin.AuthUserKey).(string)
|
||||||
|
if secret, ok := secrets[user]; ok {
|
||||||
|
c.JSON(200, gin.H{"user": user, "secret": secret})
|
||||||
|
} else {
|
||||||
|
c.JSON(200, gin.H{"user": user, "secret": "NO SECRET :("})
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// Listen and server on 0.0.0.0:8080
|
||||||
|
r.Run(":8080")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Goroutines inside a middleware
|
||||||
|
When starting inside a middleware or handler, you **SHOULD NOT** use the original context inside it, you have to use a read-only copy.
|
||||||
|
|
||||||
|
```go
|
||||||
|
func main() {
|
||||||
|
r := gin.Default()
|
||||||
|
|
||||||
|
r.GET("/long_async", func(c *gin.Context) {
|
||||||
|
// create copy to be used inside the goroutine
|
||||||
|
c_cp := c.Copy()
|
||||||
|
go func() {
|
||||||
|
// simulate a long task with time.Sleep(). 5 seconds
|
||||||
|
time.Sleep(5 * time.Second)
|
||||||
|
|
||||||
|
// note than you are using the copied context "c_cp", IMPORTANT
|
||||||
|
log.Println("Done! in path " + c_cp.Req.URL.Path)
|
||||||
|
}()
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
r.GET("/long_sync", func(c *gin.Context) {
|
||||||
|
// simulate a long task with time.Sleep(). 5 seconds
|
||||||
|
time.Sleep(5 * time.Second)
|
||||||
|
|
||||||
|
// since we are NOT using a goroutine, we do not have to copy the context
|
||||||
|
log.Println("Done! in path " + c.Req.URL.Path)
|
||||||
|
})
|
||||||
|
|
||||||
|
// Listen and server on 0.0.0.0:8080
|
||||||
|
r.Run(":8080")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
#### Custom HTTP configuration
|
#### Custom HTTP configuration
|
||||||
|
|
||||||
|
|
15
auth.go
15
auth.go
|
@ -16,12 +16,7 @@ type (
|
||||||
Code string
|
Code string
|
||||||
User string
|
User string
|
||||||
}
|
}
|
||||||
Account struct {
|
Accounts map[string]string
|
||||||
User string
|
|
||||||
Password string
|
|
||||||
}
|
|
||||||
|
|
||||||
Accounts []Account
|
|
||||||
Pairs []BasicAuthPair
|
Pairs []BasicAuthPair
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -34,13 +29,13 @@ func processCredentials(accounts Accounts) (Pairs, error) {
|
||||||
return nil, errors.New("Empty list of authorized credentials.")
|
return nil, errors.New("Empty list of authorized credentials.")
|
||||||
}
|
}
|
||||||
pairs := make(Pairs, 0, len(accounts))
|
pairs := make(Pairs, 0, len(accounts))
|
||||||
for _, account := range accounts {
|
for user, password := range accounts {
|
||||||
if len(account.User) == 0 || len(account.Password) == 0 {
|
if len(user) == 0 || len(password) == 0 {
|
||||||
return nil, errors.New("User or password is empty")
|
return nil, errors.New("User or password is empty")
|
||||||
}
|
}
|
||||||
base := account.User + ":" + account.Password
|
base := user + ":" + password
|
||||||
code := "Basic " + base64.StdEncoding.EncodeToString([]byte(base))
|
code := "Basic " + base64.StdEncoding.EncodeToString([]byte(base))
|
||||||
pairs = append(pairs, BasicAuthPair{code, account.User})
|
pairs = append(pairs, BasicAuthPair{code, user})
|
||||||
}
|
}
|
||||||
// We have to sort the credentials in order to use bsearch later.
|
// We have to sort the credentials in order to use bsearch later.
|
||||||
sort.Sort(pairs)
|
sort.Sort(pairs)
|
||||||
|
|
|
@ -0,0 +1,190 @@
|
||||||
|
package binding
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"encoding/xml"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
type (
|
||||||
|
Binding interface {
|
||||||
|
Bind(*http.Request, interface{}) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// JSON binding
|
||||||
|
jsonBinding struct{}
|
||||||
|
|
||||||
|
// XML binding
|
||||||
|
xmlBinding struct{}
|
||||||
|
|
||||||
|
// // form binding
|
||||||
|
formBinding struct{}
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
JSON = jsonBinding{}
|
||||||
|
XML = xmlBinding{}
|
||||||
|
Form = formBinding{} // todo
|
||||||
|
)
|
||||||
|
|
||||||
|
func (_ jsonBinding) Bind(req *http.Request, obj interface{}) error {
|
||||||
|
decoder := json.NewDecoder(req.Body)
|
||||||
|
if err := decoder.Decode(obj); err == nil {
|
||||||
|
return Validate(obj)
|
||||||
|
} else {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_ xmlBinding) Bind(req *http.Request, obj interface{}) error {
|
||||||
|
decoder := xml.NewDecoder(req.Body)
|
||||||
|
if err := decoder.Decode(obj); err == nil {
|
||||||
|
return Validate(obj)
|
||||||
|
} else {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (_ formBinding) Bind(req *http.Request, obj interface{}) error {
|
||||||
|
if err := req.ParseForm(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := mapForm(obj, req.Form); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return Validate(obj)
|
||||||
|
}
|
||||||
|
|
||||||
|
func mapForm(ptr interface{}, form map[string][]string) error {
|
||||||
|
typ := reflect.TypeOf(ptr).Elem()
|
||||||
|
formStruct := reflect.ValueOf(ptr).Elem()
|
||||||
|
for i := 0; i < typ.NumField(); i++ {
|
||||||
|
typeField := typ.Field(i)
|
||||||
|
if inputFieldName := typeField.Tag.Get("form"); inputFieldName != "" {
|
||||||
|
structField := formStruct.Field(i)
|
||||||
|
if !structField.CanSet() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
inputValue, exists := form[inputFieldName]
|
||||||
|
if !exists {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
numElems := len(inputValue)
|
||||||
|
if structField.Kind() == reflect.Slice && numElems > 0 {
|
||||||
|
sliceOf := structField.Type().Elem().Kind()
|
||||||
|
slice := reflect.MakeSlice(structField.Type(), numElems, numElems)
|
||||||
|
for i := 0; i < numElems; i++ {
|
||||||
|
if err := setWithProperType(sliceOf, inputValue[i], slice.Index(i)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
formStruct.Elem().Field(i).Set(slice)
|
||||||
|
} else {
|
||||||
|
if err := setWithProperType(typeField.Type.Kind(), inputValue[0], structField); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func setWithProperType(valueKind reflect.Kind, val string, structField reflect.Value) error {
|
||||||
|
switch valueKind {
|
||||||
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
|
if val == "" {
|
||||||
|
val = "0"
|
||||||
|
}
|
||||||
|
intVal, err := strconv.Atoi(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
} else {
|
||||||
|
structField.SetInt(int64(intVal))
|
||||||
|
}
|
||||||
|
case reflect.Bool:
|
||||||
|
if val == "" {
|
||||||
|
val = "false"
|
||||||
|
}
|
||||||
|
boolVal, err := strconv.ParseBool(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
} else {
|
||||||
|
structField.SetBool(boolVal)
|
||||||
|
}
|
||||||
|
case reflect.Float32:
|
||||||
|
if val == "" {
|
||||||
|
val = "0.0"
|
||||||
|
}
|
||||||
|
floatVal, err := strconv.ParseFloat(val, 32)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
} else {
|
||||||
|
structField.SetFloat(floatVal)
|
||||||
|
}
|
||||||
|
case reflect.Float64:
|
||||||
|
if val == "" {
|
||||||
|
val = "0.0"
|
||||||
|
}
|
||||||
|
floatVal, err := strconv.ParseFloat(val, 64)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
} else {
|
||||||
|
structField.SetFloat(floatVal)
|
||||||
|
}
|
||||||
|
case reflect.String:
|
||||||
|
structField.SetString(val)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Don't pass in pointers to bind to. Can lead to bugs. See:
|
||||||
|
// https://github.com/codegangsta/martini-contrib/issues/40
|
||||||
|
// https://github.com/codegangsta/martini-contrib/pull/34#issuecomment-29683659
|
||||||
|
func ensureNotPointer(obj interface{}) {
|
||||||
|
if reflect.TypeOf(obj).Kind() == reflect.Ptr {
|
||||||
|
panic("Pointers are not accepted as binding models")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func Validate(obj interface{}) error {
|
||||||
|
|
||||||
|
typ := reflect.TypeOf(obj)
|
||||||
|
val := reflect.ValueOf(obj)
|
||||||
|
|
||||||
|
if typ.Kind() == reflect.Ptr {
|
||||||
|
typ = typ.Elem()
|
||||||
|
val = val.Elem()
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < typ.NumField(); i++ {
|
||||||
|
field := typ.Field(i)
|
||||||
|
fieldValue := val.Field(i).Interface()
|
||||||
|
zero := reflect.Zero(field.Type).Interface()
|
||||||
|
|
||||||
|
// Validate nested and embedded structs (if pointer, only do so if not nil)
|
||||||
|
if field.Type.Kind() == reflect.Struct ||
|
||||||
|
(field.Type.Kind() == reflect.Ptr && !reflect.DeepEqual(zero, fieldValue)) {
|
||||||
|
if err := Validate(fieldValue); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.Index(field.Tag.Get("binding"), "required") > -1 {
|
||||||
|
if reflect.DeepEqual(zero, fieldValue) {
|
||||||
|
name := field.Name
|
||||||
|
if j := field.Tag.Get("json"); j != "" {
|
||||||
|
name = j
|
||||||
|
} else if f := field.Tag.Get("form"); f != "" {
|
||||||
|
name = f
|
||||||
|
}
|
||||||
|
return errors.New("Required " + name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
|
@ -0,0 +1,33 @@
|
||||||
|
package gin
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/gin-gonic/gin/binding"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DEPRECATED, use Bind() instead.
|
||||||
|
// Like ParseBody() but this method also writes a 400 error if the json is not valid.
|
||||||
|
func (c *Context) EnsureBody(item interface{}) bool {
|
||||||
|
return c.Bind(item)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DEPRECATED use bindings directly
|
||||||
|
// Parses the body content as a JSON input. It decodes the json payload into the struct specified as a pointer.
|
||||||
|
func (c *Context) ParseBody(item interface{}) error {
|
||||||
|
return binding.JSON.Bind(c.Req, item)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DEPRECATED use gin.Static() instead
|
||||||
|
// ServeFiles serves files from the given file system root.
|
||||||
|
// The path must end with "/*filepath", files are then served from the local
|
||||||
|
// path /defined/root/dir/*filepath.
|
||||||
|
// For example if root is "/etc" and *filepath is "passwd", the local file
|
||||||
|
// "/etc/passwd" would be served.
|
||||||
|
// Internally a http.FileServer is used, therefore http.NotFound is used instead
|
||||||
|
// of the Router's NotFound handler.
|
||||||
|
// To use the operating system's file system implementation,
|
||||||
|
// use http.Dir:
|
||||||
|
// router.ServeFiles("/src/*filepath", http.Dir("/var/www"))
|
||||||
|
func (engine *Engine) ServeFiles(path string, root http.FileSystem) {
|
||||||
|
engine.router.ServeFiles(path, root)
|
||||||
|
}
|
|
@ -33,18 +33,19 @@ func main() {
|
||||||
// "manu": "123",
|
// "manu": "123",
|
||||||
//}))
|
//}))
|
||||||
authorized := r.Group("/", gin.BasicAuth(gin.Accounts{
|
authorized := r.Group("/", gin.BasicAuth(gin.Accounts{
|
||||||
{"foo", "bar"}, //1. user:foo password:bar
|
"foo": "bar", // user:foo password:bar
|
||||||
{"manu", "123"}, //2. user:manu password:123
|
"manu": "123", // user:manu password:123
|
||||||
}))
|
}))
|
||||||
|
|
||||||
authorized.POST("admin", func(c *gin.Context) {
|
authorized.POST("admin", func(c *gin.Context) {
|
||||||
user := c.Get("user").(string)
|
user := c.MustGet(gin.AuthUserKey).(string)
|
||||||
|
|
||||||
// Parse JSON
|
// Parse JSON
|
||||||
var json struct {
|
var json struct {
|
||||||
Value string `json:"value" binding:"required"`
|
Value string `json:"value" binding:"required"`
|
||||||
}
|
}
|
||||||
if c.EnsureBody(&json) {
|
|
||||||
|
if c.Bind(&json) {
|
||||||
DB[user] = json.Value
|
DB[user] = json.Value
|
||||||
c.JSON(200, gin.H{"status": "ok"})
|
c.JSON(200, gin.H{"status": "ok"})
|
||||||
}
|
}
|
||||||
|
|
269
gin.go
269
gin.go
|
@ -6,16 +6,29 @@ import (
|
||||||
"encoding/xml"
|
"encoding/xml"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/gin-gonic/gin/binding"
|
||||||
"github.com/julienschmidt/httprouter"
|
"github.com/julienschmidt/httprouter"
|
||||||
"html/template"
|
"html/template"
|
||||||
"log"
|
"log"
|
||||||
"math"
|
"math"
|
||||||
"net/http"
|
"net/http"
|
||||||
"path"
|
"path"
|
||||||
|
"sync"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
AbortIndex = math.MaxInt8 / 2
|
AbortIndex = math.MaxInt8 / 2
|
||||||
|
MIMEJSON = "application/json"
|
||||||
|
MIMEHTML = "text/html"
|
||||||
|
MIMEXML = "application/xml"
|
||||||
|
MIMEXML2 = "text/xml"
|
||||||
|
MIMEPlain = "text/plain"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
ErrorTypeInternal = 1 << iota
|
||||||
|
ErrorTypeExternal = 1 << iota
|
||||||
|
ErrorTypeAll = 0xffffffff
|
||||||
)
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
|
@ -24,23 +37,24 @@ type (
|
||||||
H map[string]interface{}
|
H map[string]interface{}
|
||||||
|
|
||||||
// Used internally to collect errors that occurred during an http request.
|
// Used internally to collect errors that occurred during an http request.
|
||||||
ErrorMsg struct {
|
errorMsg struct {
|
||||||
Err string `json:"error"`
|
Err string `json:"error"`
|
||||||
|
Type uint32 `json:"-"`
|
||||||
Meta interface{} `json:"meta"`
|
Meta interface{} `json:"meta"`
|
||||||
}
|
}
|
||||||
|
|
||||||
ErrorMsgs []ErrorMsg
|
errorMsgs []errorMsg
|
||||||
|
|
||||||
// Context is the most important part of gin. It allows us to pass variables between middleware,
|
// Context is the most important part of gin. It allows us to pass variables between middleware,
|
||||||
// manage the flow, validate the JSON of a request and render a JSON response for example.
|
// manage the flow, validate the JSON of a request and render a JSON response for example.
|
||||||
Context struct {
|
Context struct {
|
||||||
Req *http.Request
|
Req *http.Request
|
||||||
Writer http.ResponseWriter
|
Writer ResponseWriter
|
||||||
Keys map[string]interface{}
|
Keys map[string]interface{}
|
||||||
Errors ErrorMsgs
|
Errors errorMsgs
|
||||||
Params httprouter.Params
|
Params httprouter.Params
|
||||||
|
Engine *Engine
|
||||||
handlers []HandlerFunc
|
handlers []HandlerFunc
|
||||||
engine *Engine
|
|
||||||
index int8
|
index int8
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -56,16 +70,51 @@ type (
|
||||||
// Represents the web framework, it wraps the blazing fast httprouter multiplexer and a list of global middlewares.
|
// Represents the web framework, it wraps the blazing fast httprouter multiplexer and a list of global middlewares.
|
||||||
Engine struct {
|
Engine struct {
|
||||||
*RouterGroup
|
*RouterGroup
|
||||||
|
HTMLTemplates *template.Template
|
||||||
|
cache sync.Pool
|
||||||
handlers404 []HandlerFunc
|
handlers404 []HandlerFunc
|
||||||
router *httprouter.Router
|
router *httprouter.Router
|
||||||
HTMLTemplates *template.Template
|
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
func (a ErrorMsgs) String() string {
|
// Allows type H to be used with xml.Marshal
|
||||||
|
func (h H) MarshalXML(e *xml.Encoder, start xml.StartElement) error {
|
||||||
|
start.Name = xml.Name{"", "map"}
|
||||||
|
if err := e.EncodeToken(start); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for key, value := range h {
|
||||||
|
elem := xml.StartElement{
|
||||||
|
xml.Name{"", key},
|
||||||
|
[]xml.Attr{},
|
||||||
|
}
|
||||||
|
if err := e.EncodeElement(value, elem); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := e.EncodeToken(xml.EndElement{start.Name}); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a errorMsgs) ByType(typ uint32) errorMsgs {
|
||||||
|
if len(a) == 0 {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
result := make(errorMsgs, 0, len(a))
|
||||||
|
for _, msg := range a {
|
||||||
|
if msg.Type&typ > 0 {
|
||||||
|
result = append(result, msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a errorMsgs) String() string {
|
||||||
var buffer bytes.Buffer
|
var buffer bytes.Buffer
|
||||||
for i, msg := range a {
|
for i, msg := range a {
|
||||||
text := fmt.Sprintf("Error #%02d: %s \n Meta: %v\n\n", (i + 1), msg.Err, msg.Meta)
|
text := fmt.Sprintf("Error #%02d: %s \n Meta: %v\n", (i + 1), msg.Err, msg.Meta)
|
||||||
buffer.WriteString(text)
|
buffer.WriteString(text)
|
||||||
}
|
}
|
||||||
return buffer.String()
|
return buffer.String()
|
||||||
|
@ -78,6 +127,9 @@ func New() *Engine {
|
||||||
engine.RouterGroup = &RouterGroup{nil, "/", nil, engine}
|
engine.RouterGroup = &RouterGroup{nil, "/", nil, engine}
|
||||||
engine.router = httprouter.New()
|
engine.router = httprouter.New()
|
||||||
engine.router.NotFound = engine.handle404
|
engine.router.NotFound = engine.handle404
|
||||||
|
engine.cache.New = func() interface{} {
|
||||||
|
return &Context{Engine: engine, Writer: &responseWriter{}}
|
||||||
|
}
|
||||||
return engine
|
return engine
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -100,27 +152,12 @@ func (engine *Engine) NotFound404(handlers ...HandlerFunc) {
|
||||||
func (engine *Engine) handle404(w http.ResponseWriter, req *http.Request) {
|
func (engine *Engine) handle404(w http.ResponseWriter, req *http.Request) {
|
||||||
handlers := engine.combineHandlers(engine.handlers404)
|
handlers := engine.combineHandlers(engine.handlers404)
|
||||||
c := engine.createContext(w, req, nil, handlers)
|
c := engine.createContext(w, req, nil, handlers)
|
||||||
if engine.handlers404 == nil {
|
c.Writer.setStatus(404)
|
||||||
http.NotFound(c.Writer, c.Req)
|
|
||||||
} else {
|
|
||||||
c.Writer.WriteHeader(404)
|
|
||||||
}
|
|
||||||
|
|
||||||
c.Next()
|
c.Next()
|
||||||
}
|
if !c.Writer.Written() {
|
||||||
|
c.Data(404, MIMEPlain, []byte("404 page not found"))
|
||||||
// ServeFiles serves files from the given file system root.
|
}
|
||||||
// The path must end with "/*filepath", files are then served from the local
|
engine.cache.Put(c)
|
||||||
// path /defined/root/dir/*filepath.
|
|
||||||
// For example if root is "/etc" and *filepath is "passwd", the local file
|
|
||||||
// "/etc/passwd" would be served.
|
|
||||||
// Internally a http.FileServer is used, therefore http.NotFound is used instead
|
|
||||||
// of the Router's NotFound handler.
|
|
||||||
// To use the operating system's file system implementation,
|
|
||||||
// use http.Dir:
|
|
||||||
// router.ServeFiles("/src/*filepath", http.Dir("/var/www"))
|
|
||||||
func (engine *Engine) ServeFiles(path string, root http.FileSystem) {
|
|
||||||
engine.router.ServeFiles(path, root)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ServeHTTP makes the router implement the http.Handler interface.
|
// ServeHTTP makes the router implement the http.Handler interface.
|
||||||
|
@ -138,15 +175,15 @@ func (engine *Engine) Run(addr string) {
|
||||||
/********** ROUTES GROUPING *********/
|
/********** ROUTES GROUPING *********/
|
||||||
/************************************/
|
/************************************/
|
||||||
|
|
||||||
func (group *RouterGroup) createContext(w http.ResponseWriter, req *http.Request, params httprouter.Params, handlers []HandlerFunc) *Context {
|
func (engine *Engine) createContext(w http.ResponseWriter, req *http.Request, params httprouter.Params, handlers []HandlerFunc) *Context {
|
||||||
return &Context{
|
c := engine.cache.Get().(*Context)
|
||||||
Writer: w,
|
c.Writer.reset(w)
|
||||||
Req: req,
|
c.Req = req
|
||||||
index: -1,
|
c.Params = params
|
||||||
engine: group.engine,
|
c.handlers = handlers
|
||||||
Params: params,
|
c.Keys = nil
|
||||||
handlers: handlers,
|
c.index = -1
|
||||||
}
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
// Adds middlewares to the group, see example code in github.
|
// Adds middlewares to the group, see example code in github.
|
||||||
|
@ -180,7 +217,9 @@ func (group *RouterGroup) Handle(method, p string, handlers []HandlerFunc) {
|
||||||
p = path.Join(group.prefix, p)
|
p = path.Join(group.prefix, p)
|
||||||
handlers = group.combineHandlers(handlers)
|
handlers = group.combineHandlers(handlers)
|
||||||
group.engine.router.Handle(method, p, func(w http.ResponseWriter, req *http.Request, params httprouter.Params) {
|
group.engine.router.Handle(method, p, func(w http.ResponseWriter, req *http.Request, params httprouter.Params) {
|
||||||
group.createContext(w, req, params, handlers).Next()
|
c := group.engine.createContext(w, req, params, handlers)
|
||||||
|
c.Next()
|
||||||
|
group.engine.cache.Put(c)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -209,6 +248,34 @@ func (group *RouterGroup) PUT(path string, handlers ...HandlerFunc) {
|
||||||
group.Handle("PUT", path, handlers)
|
group.Handle("PUT", path, handlers)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// OPTIONS is a shortcut for router.Handle("OPTIONS", path, handle)
|
||||||
|
func (group *RouterGroup) OPTIONS(path string, handlers ...HandlerFunc) {
|
||||||
|
group.Handle("OPTIONS", path, handlers)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HEAD is a shortcut for router.Handle("HEAD", path, handle)
|
||||||
|
func (group *RouterGroup) HEAD(path string, handlers ...HandlerFunc) {
|
||||||
|
group.Handle("HEAD", path, handlers)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Static serves files from the given file system root.
|
||||||
|
// Internally a http.FileServer is used, therefore http.NotFound is used instead
|
||||||
|
// of the Router's NotFound handler.
|
||||||
|
// To use the operating system's file system implementation,
|
||||||
|
// use :
|
||||||
|
// router.Static("/static", "/var/www")
|
||||||
|
func (group *RouterGroup) Static(p, root string) {
|
||||||
|
p = path.Join(p, "/*filepath")
|
||||||
|
fileServer := http.FileServer(http.Dir(root))
|
||||||
|
|
||||||
|
group.GET(p, func(c *Context) {
|
||||||
|
original := c.Req.URL.Path
|
||||||
|
c.Req.URL.Path = c.Params.ByName("filepath")
|
||||||
|
fileServer.ServeHTTP(c.Writer, c.Req)
|
||||||
|
c.Req.URL.Path = original
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func (group *RouterGroup) combineHandlers(handlers []HandlerFunc) []HandlerFunc {
|
func (group *RouterGroup) combineHandlers(handlers []HandlerFunc) []HandlerFunc {
|
||||||
s := len(group.Handlers) + len(handlers)
|
s := len(group.Handlers) + len(handlers)
|
||||||
h := make([]HandlerFunc, 0, s)
|
h := make([]HandlerFunc, 0, s)
|
||||||
|
@ -221,6 +288,13 @@ func (group *RouterGroup) combineHandlers(handlers []HandlerFunc) []HandlerFunc
|
||||||
/****** FLOW AND ERROR MANAGEMENT****/
|
/****** FLOW AND ERROR MANAGEMENT****/
|
||||||
/************************************/
|
/************************************/
|
||||||
|
|
||||||
|
func (c *Context) Copy() *Context {
|
||||||
|
var cp Context = *c
|
||||||
|
cp.index = AbortIndex
|
||||||
|
cp.handlers = nil
|
||||||
|
return &cp
|
||||||
|
}
|
||||||
|
|
||||||
// Next should be used only in the middlewares.
|
// Next should be used only in the middlewares.
|
||||||
// It executes the pending handlers in the chain inside the calling handler.
|
// It executes the pending handlers in the chain inside the calling handler.
|
||||||
// See example in github.
|
// See example in github.
|
||||||
|
@ -236,7 +310,9 @@ func (c *Context) Next() {
|
||||||
// For example, the first handler checks if the request is authorized. If it's not, context.Abort(401) should be called.
|
// For example, the first handler checks if the request is authorized. If it's not, context.Abort(401) should be called.
|
||||||
// The rest of pending handlers would never be called for that request.
|
// The rest of pending handlers would never be called for that request.
|
||||||
func (c *Context) Abort(code int) {
|
func (c *Context) Abort(code int) {
|
||||||
|
if code >= 0 {
|
||||||
c.Writer.WriteHeader(code)
|
c.Writer.WriteHeader(code)
|
||||||
|
}
|
||||||
c.index = AbortIndex
|
c.index = AbortIndex
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -251,14 +327,19 @@ func (c *Context) Fail(code int, err error) {
|
||||||
c.Abort(code)
|
c.Abort(code)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (c *Context) ErrorTyped(err error, typ uint32, meta interface{}) {
|
||||||
|
c.Errors = append(c.Errors, errorMsg{
|
||||||
|
Err: err.Error(),
|
||||||
|
Type: typ,
|
||||||
|
Meta: meta,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
// Attaches an error to the current context. The error is pushed to a list of errors.
|
// Attaches an error to the current context. The error is pushed to a list of errors.
|
||||||
// It's a good idea to call Error for each error that occurred during the resolution of a request.
|
// It's a good idea to call Error for each error that occurred during the resolution of a request.
|
||||||
// A middleware can be used to collect all the errors and push them to a database together, print a log, or append it in the HTTP response.
|
// A middleware can be used to collect all the errors and push them to a database together, print a log, or append it in the HTTP response.
|
||||||
func (c *Context) Error(err error, meta interface{}) {
|
func (c *Context) Error(err error, meta interface{}) {
|
||||||
c.Errors = append(c.Errors, ErrorMsg{
|
c.ErrorTyped(err, ErrorTypeExternal, meta)
|
||||||
Err: err.Error(),
|
|
||||||
Meta: meta,
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Context) LastError() error {
|
func (c *Context) LastError() error {
|
||||||
|
@ -283,70 +364,95 @@ func (c *Context) Set(key string, item interface{}) {
|
||||||
c.Keys[key] = item
|
c.Keys[key] = item
|
||||||
}
|
}
|
||||||
|
|
||||||
// Returns the value for the given key.
|
// Get returns the value for the given key or an error if the key does not exist.
|
||||||
// It panics if the value doesn't exist.
|
func (c *Context) Get(key string) (interface{}, error) {
|
||||||
func (c *Context) Get(key string) interface{} {
|
|
||||||
var ok bool
|
|
||||||
var item interface{}
|
|
||||||
if c.Keys != nil {
|
if c.Keys != nil {
|
||||||
item, ok = c.Keys[key]
|
item, ok := c.Keys[key]
|
||||||
} else {
|
if ok {
|
||||||
item, ok = nil, false
|
return item, nil
|
||||||
}
|
}
|
||||||
if !ok || item == nil {
|
}
|
||||||
|
return nil, errors.New("Key does not exist.")
|
||||||
|
}
|
||||||
|
|
||||||
|
// MustGet returns the value for the given key or panics if the value doesn't exist.
|
||||||
|
func (c *Context) MustGet(key string) interface{} {
|
||||||
|
value, err := c.Get(key)
|
||||||
|
if err != nil || value == nil {
|
||||||
log.Panicf("Key %s doesn't exist", key)
|
log.Panicf("Key %s doesn't exist", key)
|
||||||
}
|
}
|
||||||
return item
|
return value
|
||||||
}
|
}
|
||||||
|
|
||||||
/************************************/
|
/************************************/
|
||||||
/******** ENCOGING MANAGEMENT********/
|
/******** ENCOGING MANAGEMENT********/
|
||||||
/************************************/
|
/************************************/
|
||||||
|
|
||||||
// Like ParseBody() but this method also writes a 400 error if the json is not valid.
|
func filterFlags(content string) string {
|
||||||
func (c *Context) EnsureBody(item interface{}) bool {
|
for i, a := range content {
|
||||||
if err := c.ParseBody(item); err != nil {
|
if a == ' ' || a == ';' {
|
||||||
|
return content[:i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return content
|
||||||
|
}
|
||||||
|
|
||||||
|
// This function checks the Content-Type to select a binding engine automatically,
|
||||||
|
// Depending the "Content-Type" header different bindings are used:
|
||||||
|
// "application/json" --> JSON binding
|
||||||
|
// "application/xml" --> XML binding
|
||||||
|
// else --> returns an error
|
||||||
|
// if Parses the request's body as JSON if Content-Type == "application/json" using JSON or XML as a JSON input. It decodes the json payload into the struct specified as a pointer.Like ParseBody() but this method also writes a 400 error if the json is not valid.
|
||||||
|
func (c *Context) Bind(obj interface{}) bool {
|
||||||
|
var b binding.Binding
|
||||||
|
ctype := filterFlags(c.Req.Header.Get("Content-Type"))
|
||||||
|
switch {
|
||||||
|
case c.Req.Method == "GET":
|
||||||
|
b = binding.Form
|
||||||
|
case ctype == MIMEJSON:
|
||||||
|
b = binding.JSON
|
||||||
|
case ctype == MIMEXML || ctype == MIMEXML2:
|
||||||
|
b = binding.XML
|
||||||
|
default:
|
||||||
|
c.Fail(400, errors.New("unknown content-type: "+ctype))
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return c.BindWith(obj, b)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Context) BindWith(obj interface{}, b binding.Binding) bool {
|
||||||
|
if err := b.Bind(c.Req, obj); err != nil {
|
||||||
c.Fail(400, err)
|
c.Fail(400, err)
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// Parses the body content as a JSON input. It decodes the json payload into the struct specified as a pointer.
|
|
||||||
func (c *Context) ParseBody(item interface{}) error {
|
|
||||||
decoder := json.NewDecoder(c.Req.Body)
|
|
||||||
if err := decoder.Decode(&item); err == nil {
|
|
||||||
return Validate(c, item)
|
|
||||||
} else {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Serializes the given struct as JSON into the response body in a fast and efficient way.
|
// Serializes the given struct as JSON into the response body in a fast and efficient way.
|
||||||
// It also sets the Content-Type as "application/json".
|
// It also sets the Content-Type as "application/json".
|
||||||
func (c *Context) JSON(code int, obj interface{}) {
|
func (c *Context) JSON(code int, obj interface{}) {
|
||||||
c.Writer.Header().Set("Content-Type", "application/json")
|
c.Writer.Header().Set("Content-Type", MIMEJSON)
|
||||||
if code >= 0 {
|
if code >= 0 {
|
||||||
c.Writer.WriteHeader(code)
|
c.Writer.WriteHeader(code)
|
||||||
}
|
}
|
||||||
encoder := json.NewEncoder(c.Writer)
|
encoder := json.NewEncoder(c.Writer)
|
||||||
if err := encoder.Encode(obj); err != nil {
|
if err := encoder.Encode(obj); err != nil {
|
||||||
c.Error(err, obj)
|
c.ErrorTyped(err, ErrorTypeInternal, obj)
|
||||||
http.Error(c.Writer, err.Error(), 500)
|
c.Abort(500)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Serializes the given struct as XML into the response body in a fast and efficient way.
|
// Serializes the given struct as XML into the response body in a fast and efficient way.
|
||||||
// It also sets the Content-Type as "application/xml".
|
// It also sets the Content-Type as "application/xml".
|
||||||
func (c *Context) XML(code int, obj interface{}) {
|
func (c *Context) XML(code int, obj interface{}) {
|
||||||
c.Writer.Header().Set("Content-Type", "application/xml")
|
c.Writer.Header().Set("Content-Type", MIMEXML)
|
||||||
if code >= 0 {
|
if code >= 0 {
|
||||||
c.Writer.WriteHeader(code)
|
c.Writer.WriteHeader(code)
|
||||||
}
|
}
|
||||||
encoder := xml.NewEncoder(c.Writer)
|
encoder := xml.NewEncoder(c.Writer)
|
||||||
if err := encoder.Encode(obj); err != nil {
|
if err := encoder.Encode(obj); err != nil {
|
||||||
c.Error(err, obj)
|
c.ErrorTyped(err, ErrorTypeInternal, obj)
|
||||||
http.Error(c.Writer, err.Error(), 500)
|
c.Abort(500)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -354,30 +460,35 @@ func (c *Context) XML(code int, obj interface{}) {
|
||||||
// It also updates the HTTP code and sets the Content-Type as "text/html".
|
// It also updates the HTTP code and sets the Content-Type as "text/html".
|
||||||
// See http://golang.org/doc/articles/wiki/
|
// See http://golang.org/doc/articles/wiki/
|
||||||
func (c *Context) HTML(code int, name string, data interface{}) {
|
func (c *Context) HTML(code int, name string, data interface{}) {
|
||||||
c.Writer.Header().Set("Content-Type", "text/html")
|
c.Writer.Header().Set("Content-Type", MIMEHTML)
|
||||||
if code >= 0 {
|
if code >= 0 {
|
||||||
c.Writer.WriteHeader(code)
|
c.Writer.WriteHeader(code)
|
||||||
}
|
}
|
||||||
if err := c.engine.HTMLTemplates.ExecuteTemplate(c.Writer, name, data); err != nil {
|
if err := c.Engine.HTMLTemplates.ExecuteTemplate(c.Writer, name, data); err != nil {
|
||||||
c.Error(err, map[string]interface{}{
|
c.ErrorTyped(err, ErrorTypeInternal, H{
|
||||||
"name": name,
|
"name": name,
|
||||||
"data": data,
|
"data": data,
|
||||||
})
|
})
|
||||||
http.Error(c.Writer, err.Error(), 500)
|
c.Abort(500)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Writes the given string into the response body and sets the Content-Type to "text/plain".
|
// Writes the given string into the response body and sets the Content-Type to "text/plain".
|
||||||
func (c *Context) String(code int, msg string) {
|
func (c *Context) String(code int, format string, values ...interface{}) {
|
||||||
|
c.Writer.Header().Set("Content-Type", MIMEPlain)
|
||||||
if code >= 0 {
|
if code >= 0 {
|
||||||
c.Writer.WriteHeader(code)
|
c.Writer.WriteHeader(code)
|
||||||
}
|
}
|
||||||
c.Writer.Header().Set("Content-Type", "text/plain")
|
c.Writer.Write([]byte(fmt.Sprintf(format, values...)))
|
||||||
c.Writer.Write([]byte(msg))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Writes some data into the body stream and updates the HTTP code.
|
// Writes some data into the body stream and updates the HTTP code.
|
||||||
func (c *Context) Data(code int, data []byte) {
|
func (c *Context) Data(code int, contentType string, data []byte) {
|
||||||
|
if len(contentType) > 0 {
|
||||||
|
c.Writer.Header().Set("Content-Type", contentType)
|
||||||
|
}
|
||||||
|
if code >= 0 {
|
||||||
c.Writer.WriteHeader(code)
|
c.Writer.WriteHeader(code)
|
||||||
|
}
|
||||||
c.Writer.Write(data)
|
c.Writer.Write(data)
|
||||||
}
|
}
|
||||||
|
|
62
logger.go
62
logger.go
|
@ -1,35 +1,83 @@
|
||||||
package gin
|
package gin
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
|
||||||
"log"
|
"log"
|
||||||
|
"os"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func ErrorLogger() HandlerFunc {
|
func ErrorLogger() HandlerFunc {
|
||||||
|
return ErrorLoggerT(ErrorTypeAll)
|
||||||
|
}
|
||||||
|
|
||||||
|
func ErrorLoggerT(typ uint32) HandlerFunc {
|
||||||
return func(c *Context) {
|
return func(c *Context) {
|
||||||
c.Next()
|
c.Next()
|
||||||
|
|
||||||
if len(c.Errors) > 0 {
|
errs := c.Errors.ByType(typ)
|
||||||
|
if len(errs) > 0 {
|
||||||
// -1 status code = do not change current one
|
// -1 status code = do not change current one
|
||||||
c.JSON(-1, c.Errors)
|
c.JSON(-1, c.Errors)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func Logger() HandlerFunc {
|
var (
|
||||||
return func(c *Context) {
|
green = string([]byte{27, 91, 57, 55, 59, 52, 50, 109})
|
||||||
|
white = string([]byte{27, 91, 57, 48, 59, 52, 55, 109})
|
||||||
|
yellow = string([]byte{27, 91, 57, 55, 59, 52, 51, 109})
|
||||||
|
red = string([]byte{27, 91, 57, 55, 59, 52, 49, 109})
|
||||||
|
reset = string([]byte{27, 91, 48, 109})
|
||||||
|
)
|
||||||
|
|
||||||
|
func Logger() HandlerFunc {
|
||||||
|
stdlogger := log.New(os.Stdout, "", 0)
|
||||||
|
//errlogger := log.New(os.Stderr, "", 0)
|
||||||
|
|
||||||
|
return func(c *Context) {
|
||||||
// Start timer
|
// Start timer
|
||||||
t := time.Now()
|
start := time.Now()
|
||||||
|
|
||||||
// Process request
|
// Process request
|
||||||
c.Next()
|
c.Next()
|
||||||
|
|
||||||
|
// save the IP of the requester
|
||||||
|
requester := c.Req.Header.Get("X-Real-IP")
|
||||||
|
// if the requester-header is empty, check the forwarded-header
|
||||||
|
if requester == "" {
|
||||||
|
requester = c.Req.Header.Get("X-Forwarded-For")
|
||||||
|
}
|
||||||
|
|
||||||
|
// if the requester is still empty, use the hard-coded address from the socket
|
||||||
|
if requester == "" {
|
||||||
|
requester = c.Req.RemoteAddr
|
||||||
|
}
|
||||||
|
|
||||||
|
var color string
|
||||||
|
code := c.Writer.Status()
|
||||||
|
switch {
|
||||||
|
case code >= 200 && code <= 299:
|
||||||
|
color = green
|
||||||
|
case code >= 300 && code <= 399:
|
||||||
|
color = white
|
||||||
|
case code >= 400 && code <= 499:
|
||||||
|
color = yellow
|
||||||
|
default:
|
||||||
|
color = red
|
||||||
|
}
|
||||||
|
end := time.Now()
|
||||||
|
latency := end.Sub(start)
|
||||||
|
stdlogger.Printf("[GIN] %v |%s %3d %s| %12v | %s %4s %s\n",
|
||||||
|
end.Format("2006/01/02 - 15:04:05"),
|
||||||
|
color, c.Writer.Status(), reset,
|
||||||
|
latency,
|
||||||
|
requester,
|
||||||
|
c.Req.Method, c.Req.URL.Path,
|
||||||
|
)
|
||||||
|
|
||||||
// Calculate resolution time
|
// Calculate resolution time
|
||||||
log.Printf("%s in %v", c.Req.RequestURI, time.Since(t))
|
|
||||||
if len(c.Errors) > 0 {
|
if len(c.Errors) > 0 {
|
||||||
fmt.Println(c.Errors.String())
|
stdlogger.Println(c.Errors.String())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -82,9 +82,6 @@ func function(pc uintptr) []byte {
|
||||||
func Recovery() HandlerFunc {
|
func Recovery() HandlerFunc {
|
||||||
return func(c *Context) {
|
return func(c *Context) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if len(c.Errors) > 0 {
|
|
||||||
log.Println(c.Errors.String())
|
|
||||||
}
|
|
||||||
if err := recover(); err != nil {
|
if err := recover(); err != nil {
|
||||||
stack := stack(3)
|
stack := stack(3)
|
||||||
log.Printf("PANIC: %s\n%s", err, stack)
|
log.Printf("PANIC: %s\n%s", err, stack)
|
||||||
|
|
|
@ -0,0 +1,47 @@
|
||||||
|
package gin
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type (
|
||||||
|
ResponseWriter interface {
|
||||||
|
http.ResponseWriter
|
||||||
|
Status() int
|
||||||
|
Written() bool
|
||||||
|
|
||||||
|
// private
|
||||||
|
reset(http.ResponseWriter)
|
||||||
|
setStatus(int)
|
||||||
|
}
|
||||||
|
|
||||||
|
responseWriter struct {
|
||||||
|
http.ResponseWriter
|
||||||
|
status int
|
||||||
|
written bool
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
func (w *responseWriter) reset(writer http.ResponseWriter) {
|
||||||
|
w.ResponseWriter = writer
|
||||||
|
w.status = 0
|
||||||
|
w.written = false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *responseWriter) setStatus(code int) {
|
||||||
|
w.status = code
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *responseWriter) WriteHeader(code int) {
|
||||||
|
w.status = code
|
||||||
|
w.written = true
|
||||||
|
w.ResponseWriter.WriteHeader(code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *responseWriter) Status() int {
|
||||||
|
return w.status
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *responseWriter) Written() bool {
|
||||||
|
return w.written
|
||||||
|
}
|
|
@ -1,45 +0,0 @@
|
||||||
package gin
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"reflect"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Validate(c *Context, obj interface{}) error {
|
|
||||||
|
|
||||||
var err error
|
|
||||||
typ := reflect.TypeOf(obj)
|
|
||||||
val := reflect.ValueOf(obj)
|
|
||||||
|
|
||||||
if typ.Kind() == reflect.Ptr {
|
|
||||||
typ = typ.Elem()
|
|
||||||
val = val.Elem()
|
|
||||||
}
|
|
||||||
|
|
||||||
for i := 0; i < typ.NumField(); i++ {
|
|
||||||
field := typ.Field(i)
|
|
||||||
fieldValue := val.Field(i).Interface()
|
|
||||||
zero := reflect.Zero(field.Type).Interface()
|
|
||||||
|
|
||||||
// Validate nested and embedded structs (if pointer, only do so if not nil)
|
|
||||||
if field.Type.Kind() == reflect.Struct ||
|
|
||||||
(field.Type.Kind() == reflect.Ptr && !reflect.DeepEqual(zero, fieldValue)) {
|
|
||||||
err = Validate(c, fieldValue)
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.Index(field.Tag.Get("binding"), "required") > -1 {
|
|
||||||
if reflect.DeepEqual(zero, fieldValue) {
|
|
||||||
name := field.Name
|
|
||||||
if j := field.Tag.Get("json"); j != "" {
|
|
||||||
name = j
|
|
||||||
} else if f := field.Tag.Get("form"); f != "" {
|
|
||||||
name = f
|
|
||||||
}
|
|
||||||
err = errors.New("Required " + name)
|
|
||||||
c.Error(err, "json validation")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
Loading…
Reference in New Issue