yang-f / beauty Goto Github PK

A microframework based on mymysql,net/http,jwt-go and mux.

License: MIT License

Go 100.00%

golang framwork rest-api restful-api simple error-handler logging session cors-request

beauty's Introduction

A simple framwork written in golang.

You can build a simple restful project or a web application with it. If you dosen't want to use mysql db, you can implement your own Auth decorates and session.You can use your own DAO or whatever you like.

quick start:

run cmd

mkdir demo && cd demo
go get gopkg.in/alecthomas/kingpin.v2
go get github.com/yang-f/beauty

add $GOPATH/bin to your $PATH

run cmd beauty

usage: beauty [<flags>] <command> [<args> ...]

A command-line tools of beauty.

Flags:
  --help  Show context-sensitive help (also try --help-long and --help-man).

Commands:
  help [<command>...]
    Show help.

  demo
    Demo of web server.

  generate <name>
    Generate a new app.

test beauty
```
beauty demo
```

then

2017/05/04 16:21:05 start server on port :8080

visit 127.0.0.1:8080
```
{"description":"this is json"}
```
visit 127.0.0.1:8080/demo1
```
{"description":"this is json"}
```

How to use:

Generate new app
```
beauty generate yourAppName
```

dir list

GOPATH/src/yourAppName
├── controllers
│   ├── adminController.go
│   └── controller_test.go
├── decorates
|   └── http.go
├── main.go
├── models
├── tpl
└── utils

about Route

demo

    r := router.New()

    r.GET("/", controllers.Config().ContentJSON())

    r.GET("/demo1", controllers.Config().ContentJSON().Verify())

token generate

tokenString, err := token.Generate(fmt.Sprintf("%v|%v", user_id, user_pass))

demo

package main

import (
    "net/http"
    "log"
    "github.com/yang-f/beauty/consts/contenttype"
    "github.com/yang-f/beauty/router"
    "github.com/yang-f/beauty/settings"
    "github.com/yang-f/beauty/controllers"
    "github.com/yang-f/beauty/decorates"

)

func main() {

    log.Printf("start server on port %s", settings.Listen)

    settings.Listen = ":8080"

    settings.Domain = "yourdomain.com"

    settings.DefaultOrigin = "http://defaultorigin.com"

    settings.HmacSampleSecret = "whatever"

    r := router.New()

    r.GET("/", controllers.Config().ContentJSON())

    r.GET("/demo1", controllers.Config().ContentJSON().Verify())

    log.Fatal(http.ListenAndServe(settings.Listen, r))
}

Support:

token

settings.HmacSampleSecret = "whatever"

token, err := token.Generate(origin)

origin, err := token.Valid(token)

cors

static file server

router.PathPrefix("/static/").Handler(http.StripPrefix("/static/", decorates.CorsHeader2(http.FileServer(http.Dir("/your/static/path")))))

api etc:
- default is cors

error handler

func XxxxController() decorates.Handler{
    return func (w http.ResponseWriter, r *http.Request) *models.APPError {
        xxx,err := someOperation()
        if err != nil{
            return &models.APPError {err, Message, Code, Status}
        }
        ...
        return nil
    }
}

utils
- Response
- Rand
- MD5
- Post
test
- go test -v -bench=".*"
- go test -v -short $(go list ./... | grep -v /vendor/)
- ...

Contributing:

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -m 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

TODO:

Cmd tools
Improve document
Role review
Error handler

beauty's People

Contributors

Stargazers

Watchers

Forkers

huluar wsl-victor pythonpeixun songyuzhang imanner jazzmr charlesproject glorysongglory williamsyb shane-xb-qian jinligen xiaoyong68 0lddriv3r

beauty's Issues

真的优秀啊

早就觉得 golang 不需要什么框架了.
你总结的很好👍

error http: panic serving [::1]:53314: runtime error: invalid memory address or nil pointer dereference

error

open url ：http://localhost:8080/demo3
open url ：http://localhost:8080/demo1

2018/01/25 20:04:14 http: panic serving [::1]:53314: runtime error: invalid memory address or nil pointer dereference
goroutine 7 [running]:
net/http.(*conn).serve.func1(0xc420085ea0)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:1697 +0xd0
panic(0x13b8960, 0x1654240)
        /usr/local/Cellar/go/1.9.2/libexec/src/runtime/panic.go:491 +0x283
github.com/yang-f/beauty/utils/token.Valid(0x0, 0x0, 0x14297f6, 0xd, 0x167fde0, 0xc4200428f0)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/utils/token/token.go:50 +0x54
github.com/yang-f/beauty/decorates.Handler.Auth.func1(0x1627b80, 0xc42011a000, 0xc420118200, 0x0)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/auth.go:48 +0x9f
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc420042d10, 0x1627b80, 0xc42011a000, 0xc420118200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.Handler.Verify.func1(0x1627b80, 0xc42011a000, 0xc420118200, 0x142f354)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/verify.go:61 +0x79d
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc420042d20, 0x1627b80, 0xc42011a000, 0xc420118200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.CorsHeader.func1(0x1627b80, 0xc42011a000, 0xc420118200, 0x142935e)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/cors.go:41 +0x1d3
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200432e0, 0x1627b80, 0xc42011a000, 0xc420118200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.ContentType.func1(0x1627b80, 0xc42011a000, 0xc420118200, 0x1086296)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/contentType.go:33 +0xb3
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200dcc40, 0x1627b80, 0xc42011a000, 0xc420118200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.Logger.func1(0x1627b80, 0xc42011a000, 0xc420118200, 0x12b31fa)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/logger.go:36 +0xa1
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200dcc60, 0x1627b80, 0xc42011a000, 0xc420118200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/gorilla/mux.(*Router).ServeHTTP(0xc420108770, 0x1627b80, 0xc42011a000, 0xc420118200)
        /Users/liberxue/golang/src/github.com/gorilla/mux/mux.go:159 +0xed
net/http.serverHandler.ServeHTTP(0xc42007bc70, 0x1627b80, 0xc42011a000, 0xc420118000)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:2619 +0xb4
net/http.(*conn).serve(0xc420085ea0, 0x1628240, 0xc42005c5c0)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:1801 +0x71d
created by net/http.(*Server).Serve
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:2720 +0x288
2018/01/25 20:04:14 http: panic serving [::1]:53315: runtime error: invalid memory address or nil pointer dereference
goroutine 18 [running]:
net/http.(*conn).serve.func1(0xc420168000)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:1697 +0xd0
panic(0x13b8960, 0x1654240)
        /usr/local/Cellar/go/1.9.2/libexec/src/runtime/panic.go:491 +0x283
github.com/yang-f/beauty/utils/token.Valid(0x0, 0x0, 0x14297f6, 0xd, 0x167fde0, 0xc4200428f0)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/utils/token/token.go:50 +0x54
github.com/yang-f/beauty/decorates.Handler.Auth.func1(0x1627b80, 0xc420182000, 0xc420172200, 0x0)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/auth.go:48 +0x9f
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc420042d10, 0x1627b80, 0xc420182000, 0xc420172200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.Handler.Verify.func1(0x1627b80, 0xc420182000, 0xc420172200, 0x142f354)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/verify.go:61 +0x79d
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc420042d20, 0x1627b80, 0xc420182000, 0xc420172200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.CorsHeader.func1(0x1627b80, 0xc420182000, 0xc420172200, 0x142935e)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/cors.go:41 +0x1d3
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200432e0, 0x1627b80, 0xc420182000, 0xc420172200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.ContentType.func1(0x1627b80, 0xc420182000, 0xc420172200, 0x1086296)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/contentType.go:33 +0xb3
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200dcc40, 0x1627b80, 0xc420182000, 0xc420172200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.Logger.func1(0x1627b80, 0xc420182000, 0xc420172200, 0x12b31fa)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/logger.go:36 +0xa1
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200dcc60, 0x1627b80, 0xc420182000, 0xc420172200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/gorilla/mux.(*Router).ServeHTTP(0xc420108770, 0x1627b80, 0xc420182000, 0xc420172200)
        /Users/liberxue/golang/src/github.com/gorilla/mux/mux.go:159 +0xed
net/http.serverHandler.ServeHTTP(0xc42007bc70, 0x1627b80, 0xc420182000, 0xc420172000)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:2619 +0xb4
net/http.(*conn).serve(0xc420168000, 0x1628240, 0xc42011c080)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:1801 +0x71d
created by net/http.(*Server).Serve
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:2720 +0x288
2018/01/25 20:04:15 http: panic serving [::1]:53321: runtime error: invalid memory address or nil pointer dereference
goroutine 34 [running]:
net/http.(*conn).serve.func1(0xc4201e6000)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:1697 +0xd0
panic(0x13b8960, 0x1654240)
        /usr/local/Cellar/go/1.9.2/libexec/src/runtime/panic.go:491 +0x283
github.com/yang-f/beauty/utils/token.Valid(0x0, 0x0, 0x14297f6, 0xd, 0x167fde0, 0xc4200428f0)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/utils/token/token.go:50 +0x54
github.com/yang-f/beauty/decorates.Handler.Auth.func1(0x1627b80, 0xc420212000, 0xc420202200, 0x0)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/auth.go:48 +0x9f
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc420042d10, 0x1627b80, 0xc420212000, 0xc420202200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.Handler.Verify.func1(0x1627b80, 0xc420212000, 0xc420202200, 0x142f354)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/verify.go:61 +0x79d
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc420042d20, 0x1627b80, 0xc420212000, 0xc420202200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.CorsHeader.func1(0x1627b80, 0xc420212000, 0xc420202200, 0x142935e)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/cors.go:41 +0x1d3
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200432e0, 0x1627b80, 0xc420212000, 0xc420202200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.ContentType.func1(0x1627b80, 0xc420212000, 0xc420202200, 0x1086296)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/contentType.go:33 +0xb3
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200dcc40, 0x1627b80, 0xc420212000, 0xc420202200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.Logger.func1(0x1627b80, 0xc420212000, 0xc420202200, 0x12b31fa)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/logger.go:36 +0xa1
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200dcc60, 0x1627b80, 0xc420212000, 0xc420202200)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/gorilla/mux.(*Router).ServeHTTP(0xc420108770, 0x1627b80, 0xc420212000, 0xc420202200)
        /Users/liberxue/golang/src/github.com/gorilla/mux/mux.go:159 +0xed
net/http.serverHandler.ServeHTTP(0xc42007bc70, 0x1627b80, 0xc420212000, 0xc420202000)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:2619 +0xb4
net/http.(*conn).serve(0xc4201e6000, 0x1628240, 0xc4201fa040)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:1801 +0x71d
created by net/http.(*Server).Serve
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:2720 +0x288
2018/01/25 20:04:15 http: panic serving [::1]:53322: runtime error: invalid memory address or nil pointer dereference
goroutine 20 [running]:
net/http.(*conn).serve.func1(0xc420168280)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:1697 +0xd0
panic(0x13b8960, 0x1654240)
        /usr/local/Cellar/go/1.9.2/libexec/src/runtime/panic.go:491 +0x283
github.com/yang-f/beauty/utils/token.Valid(0x0, 0x0, 0x14297f6, 0xd, 0x167fde0, 0xc4200428f0)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/utils/token/token.go:50 +0x54
github.com/yang-f/beauty/decorates.Handler.Auth.func1(0x1627b80, 0xc4201820e0, 0xc420172700, 0x0)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/auth.go:48 +0x9f
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc420042d10, 0x1627b80, 0xc4201820e0, 0xc420172700)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.Handler.Verify.func1(0x1627b80, 0xc4201820e0, 0xc420172700, 0x142f354)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/verify.go:61 +0x79d
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc420042d20, 0x1627b80, 0xc4201820e0, 0xc420172700)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.CorsHeader.func1(0x1627b80, 0xc4201820e0, 0xc420172700, 0x142935e)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/cors.go:41 +0x1d3
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200432e0, 0x1627b80, 0xc4201820e0, 0xc420172700)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.ContentType.func1(0x1627b80, 0xc4201820e0, 0xc420172700, 0x1086296)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/contentType.go:33 +0xb3
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200dcc40, 0x1627b80, 0xc4201820e0, 0xc420172700)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/yang-f/beauty/decorates.Logger.func1(0x1627b80, 0xc4201820e0, 0xc420172700, 0x12b31fa)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/logger.go:36 +0xa1
github.com/yang-f/beauty/decorates.Handler.ServeHTTP(0xc4200dcc60, 0x1627b80, 0xc4201820e0, 0xc420172700)
        /Users/liberxue/golang/src/github.com/yang-f/beauty/decorates/http.go:34 +0x48
github.com/gorilla/mux.(*Router).ServeHTTP(0xc420108770, 0x1627b80, 0xc4201820e0, 0xc420172700)
        /Users/liberxue/golang/src/github.com/gorilla/mux/mux.go:159 +0xed
net/http.serverHandler.ServeHTTP(0xc42007bc70, 0x1627b80, 0xc4201820e0, 0xc420172500)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:2619 +0xb4
net/http.(*conn).serve(0xc420168280, 0x1628240, 0xc42011c340)
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:1801 +0x71d
created by net/http.(*Server).Serve
        /usr/local/Cellar/go/1.9.2/libexec/src/net/http/server.go:2720 +0x288

go env

Liberxue:beauty liberxue$ go env
GOARCH="amd64"
GOBIN="/Users/liberxue/golang/bin"
GOEXE=""
GOHOSTARCH="amd64"
GOHOSTOS="darwin"
GOOS="darwin"
GOPATH="/Users/liberxue/golang"
GORACE=""
GOROOT="/usr/local/Cellar/go/1.9.2/libexec"
GOTOOLDIR="/usr/local/Cellar/go/1.9.2/libexec/pkg/tool/darwin_amd64"
GCCGO="gccgo"
CC="clang"
GOGCCFLAGS="-fPIC -m64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/1b/57_cycb550z9qdp5y7p_6drc0000gn/T/go-build226069681=/tmp/go-build -gno-record-gcc-switches -fno-common"
CXX="clang++"
CGO_ENABLED="1"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.