README
¶
Gofast - A light, fast and simple Go micro-framework
This is a light and fast micro-framework I wrote in order to train to Go language.
This project uses "pongo2" library for rendering templates (compatible with Django Jinja templates)
Installation
Prior to Go 1.11:
$ git clone git@github.com:eko/gofast.git
$ go get -u github.com/flosch/pongo2
$ go get -u golang.org/x/net/http2
$ go get -u golang.org/sirupsen/logrus
Prefer using dep?
$ dep ensure
When using Go 1.11 (go modules) or later:
$ go build ./...
Running an application
$ go run app.go
2015/01/26 21:57:35 gofast v1.0-beta
2015/01/26 21:57:48 [POST] 200 | route: 'add' | url: "/add/toto" (time: 143.238us)
This will run the application on port 8080. Optionnaly, you can provide a port number this way:
$ PORT=8005 go run app.go
A simple application example
Because an example will explain it better, here is an application example with things you can do with Gofast:
package main
import (
"github.com/eko/gofast"
)
func main() {
app := gofast.Bootstrap()
app.SetAssetsDirectory("assets")
app.SetViewsDirectory("views")
// This adds a fallback route for 404 (not found) resources
app.SetFallback(func(context gofast.Context) {
context.GetResponse().SetStatusCode(404)
app.Render(context, "404.html")
})
// You can add a simple GET route
app.Get("homepage", "/$", func(context gofast.Context) {
app.Render(context, "index.html")
})
// ... or add a more complex POST route with a URL parameter
app.Post("add", "/add/([a-zA-Z]+)$", func(context gofast.Context) {
request := context.GetRequest()
pattern := context.GetRoute().GetPattern()
url := request.GetHttpRequest().URL.Path
request.AddParameter("name", pattern.FindStringSubmatch(url)[1])
// ... your custom code
app.Render(context, "add.html")
})
app.Listen()
}
HTTP/2 Support
You can use HTTP/2 support by using the following line instead of app.Listen():
app.ListenHttp2("./fullchain.pem", "./privkey.pem")
Of course, you will have to precize SSL certificate and private key.
You can also set Link headers in order to preload assets:
response := c.GetResponse()
response.Header().Add("Link", "</assets/img/rocket.png>; rel=preload")
response.Header().Add("Link", "</assets/css/style.css>; rel=preload")
Templating
You can use all Pongo2 template features and retrieve data like this:
{% extends "../layout.html" %}
{% block navigation %}
{% include "../include/navigation.html" with current="blog" %}
{% endblock %}
<h2>Retrieve a "name" parameter</h2>
<p>{{ request.GetParameter("name") }}</p>
<h2>Retrieve a "data" POST form value</h2>
<p>{{ request.GetFormValue("data") }}</p>
You have access to both request and response objects from context.
Requesting this example
Using the example given below, here is the request results:
> $ curl -X GET http://127.0.0.1:8080/
<h1>Welcome to the index template!</h1>
> $ curl -X POST -d'data=my post data' http://127.0.0.1:8080/add/toto
<h2>Retrieve a "name" parameter</h2>
<p>toto</p>
<h2>Retrieve a "data" POST form value</h2>
<p>my post data</p>
Middlewares
You can add some middlewares in your application by the following way:
app.Use(func(context gofast.Context, next gofast.MiddlewareFunc) gofast.Handler {
// Some code before calling the next middleware
handler := next(context, next)
// Some code after calling the next middleware
return handler
})
It allows you to access context (request, response, current route) and also
allows to define a new handler function to update the application behavior.
Default CORS headers
Following CORS headers are enabled by default when the request has an "Origin" header:
Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization
Access-Control-Allow-Methods: POST, GET, OPTIONS, PUT, DELETE
Access-Control-Allow-Origin: domainname.tld
You can override any header (including CORS ones) by the following way into each action:
app.Get("retrieve-data", "/retrieve$", func(context gofast.Context) {
response := context.GetResponse()
response.Header().Set("Access-Control-Allow-Methods", "GET")
response.Header().Set("Content-Type", "application/json")
fmt.Fprint(response, "{result: 200}")
})
Use the logger
The Logrus logger instance can be used to write information in your application stdout if you need it. You can retrieve the logger instance from the context as follows:
app.Get("test-logger", "/test-logger$", func(context gofast.Context) {
logger := context.GetLogger()
logger.Info("Roger, this is my log information!")
})
Documentation
¶
Index ¶
- Constants
- type Context
- func (c *Context) AddDefaultHeaders()
- func (c *Context) GetLogger() *logrus.Logger
- func (c *Context) GetRequest() *Request
- func (c *Context) GetResponse() *Response
- func (c *Context) GetRoute() *Route
- func (c *Context) SetLogger(logger *logrus.Logger)
- func (c *Context) SetRequest(req *http.Request)
- func (c *Context) SetResponse(res http.ResponseWriter)
- func (c *Context) SetRoute(route *Route)
- type Gofast
- type Handler
- type Middleware
- type MiddlewareFunc
- type Parameter
- type Request
- type Response
- type Route
- type RouteLen
- type Router
- func (r *Router) Add(method string, name string, pattern string, handler Handler)
- func (r *Router) All(name string, pattern string, handler Handler)
- func (r *Router) Delete(name string, pattern string, handler Handler)
- func (r *Router) Get(name string, pattern string, handler Handler)
- func (r *Router) GetFallback() Route
- func (r *Router) GetRoute(name string) Route
- func (r *Router) GetRoutes() []Route
- func (r *Router) Head(name string, pattern string, handler Handler)
- func (r *Router) Options(name string, pattern string, handler Handler)
- func (r *Router) Patch(name string, pattern string, handler Handler)
- func (r *Router) Post(name string, pattern string, handler Handler)
- func (r *Router) Put(name string, pattern string, handler Handler)
- func (r *Router) SetFallback(handler Handler)
- type Templating
Constants ¶
const ( PORT string = ":8080" VERSION string = "1.0-beta" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Context ¶
type Context struct {
// contains filtered or unexported fields
}
func (*Context) AddDefaultHeaders ¶
func (c *Context) AddDefaultHeaders()
AddDefaultHeaders adds some defaults headers to send with the response
func (*Context) GetRequest ¶
GetRequest returns a HTTP request component instance
func (*Context) GetResponse ¶
GetResponse returns a HTTP response component instance
func (*Context) SetRequest ¶
SetRequest sets a HTTP request instance
func (*Context) SetResponse ¶
func (c *Context) SetResponse(res http.ResponseWriter)
SetResponse sets a HTTP response instance
type Gofast ¶
type Gofast struct {
*logrus.Logger
*Router
*Templating
*Middleware
}
func (*Gofast) HandleRoute ¶
HandleRoute handles a route with the initialized context
func (*Gofast) ListenHttp2 ¶
ListenHttp2 listens and handles HTTP/2 requests
func (*Gofast) PrepareHttpServer ¶
PrepareHttpServer prepares a HTTP server
type Middleware ¶
type Middleware struct {
// contains filtered or unexported fields
}
func NewMiddleware ¶
func NewMiddleware() Middleware
NewMiddleware creates a new middleware component instance
func (*Middleware) HandleMiddlewares ¶
func (m *Middleware) HandleMiddlewares(context Context) Handler
HandleMiddlewares handles middlewares and returns handler
func (*Middleware) Use ¶
func (m *Middleware) Use(middleware MiddlewareFunc)
Use adds a new middleware
type MiddlewareFunc ¶
type MiddlewareFunc func(context Context, middleware MiddlewareFunc) Handler
type Request ¶
type Request struct {
// contains filtered or unexported fields
}
func NewRequest ¶
NewRequest creates a new Request component instance
func (*Request) AddParameter ¶
AddParameter adds a request parameter
func (*Request) GetFormValue ¶
GetFormValue returns a POST form value from given name
func (*Request) GetHttpRequest ¶
GetHttpRequest returs HTTP request
func (*Request) GetParameter ¶
GetParameter returns a request parameter from given name
type Response ¶
type Response struct {
http.ResponseWriter
// contains filtered or unexported fields
}
func NewResponse ¶
func NewResponse(res http.ResponseWriter) Response
NewResponse creates a new Response component instance
func (*Response) GetStatusCode ¶
GetStatusCode returns Response status code
func (*Response) SetStatusCode ¶
SetStatusCode sets Response status code
type Route ¶
type Route struct {
// contains filtered or unexported fields
}
func (*Route) GetPattern ¶
GetPattern returns a route pattern
func (*Route) SetHandler ¶
SetHandler sets a route handler
type Router ¶
type Router struct {
// contains filtered or unexported fields
}
func (*Router) GetFallback ¶
GetFallback returns fallback route (for 404 error pages)
func (*Router) SetFallback ¶
SetFallback sets route fallback (for 404 error pages)
type Templating ¶
type Templating struct {
// contains filtered or unexported fields
}
func NewTemplating ¶
func NewTemplating() Templating
NewTemplating creates a new templating component instance
func (*Templating) GetAssetsDirectory ¶
func (t *Templating) GetAssetsDirectory() string
GetAssetsDirectory returns templating assets directory
func (*Templating) GetViewsDirectory ¶
func (t *Templating) GetViewsDirectory() string
GetViewsDirectory returns templating views directory
func (*Templating) Render ¶
func (t *Templating) Render(context Context, name string)
Render renders a template
func (*Templating) SetAssetsDirectory ¶
func (t *Templating) SetAssetsDirectory(name string)
SetAssetsDirectory sets templating assets directory
func (*Templating) SetViewsDirectory ¶
func (t *Templating) SetViewsDirectory(name string)
SetViewsDirectory sets templating views directory
Source Files