// ⚑️ Fiber is an Express inspired web framework written in Go with β˜•οΈ // πŸ€– Github Repository: https://github.com/gofiber/fiber // πŸ“Œ API Documentation: https://docs.gofiber.io // Package fiber // Fiber is an Express inspired web framework built on top of Fasthttp, // the fastest HTTP engine for Go. Designed to ease things up for fast // development with zero memory allocation and performance in mind. package fiber import ( "bufio" "fmt" "net" "net/http" "net/http/httputil" "os" "reflect" "runtime" "strconv" "strings" "sync" "time" "github.com/gofiber/fiber/v2/internal/colorable" "github.com/gofiber/fiber/v2/internal/isatty" "github.com/gofiber/fiber/v2/utils" "github.com/valyala/fasthttp" ) // Version of current fiber package const Version = "2.0.1" // Map is a shortcut for map[string]interface{}, useful for JSON returns type Map map[string]interface{} // Handler defines a function to serve HTTP requests. type Handler = func(*Ctx) error // ErrorHandler defines a function that will process all errors // returned from any handlers in the stack // cfg := fiber.Config{} // cfg.ErrorHandler = func(c *Ctx, err error) error { // code := StatusInternalServerError // if e, ok := err.(*Error); ok { // code = e.Code // } // c.Set(HeaderContentType, MIMETextPlainCharsetUTF8) // return c.Status(code).SendString(err.Error()) // } // app := fiber.New(cfg) type ErrorHandler = func(*Ctx, error) error // Error represents an error that occurred while handling a request. type Error struct { Code int `json:"code"` Message string `json:"message"` } // App denotes the Fiber application. type App struct { mutex sync.Mutex // Route stack divided by HTTP methods stack [][]*Route // Route stack divided by HTTP methods and route prefixes treeStack []map[string][]*Route // Amount of registered routes routesCount int // Amount of registered handlers handlerCount int // Ctx pool pool sync.Pool // Fasthttp server server *fasthttp.Server // App config config Config } // Config is a struct holding the server settings. type Config struct { // When set to true, this will spawn multiple Go processes listening on the same port. // Default: false Prefork bool `json:"prefork"` // Enables the "Server: value" HTTP header. // Default: "" ServerHeader string `json:"server_header"` // When set to true, the router treats "/foo" and "/foo/" as different. // By default this is disabled and both "/foo" and "/foo/" will execute the same handler. StrictRouting bool `json:"strict_routing"` // When set to true, enables case sensitive routing. // E.g. "/FoO" and "/foo" are treated as different routes. // By default this is disabled and both "/FoO" and "/foo" will execute the same handler. CaseSensitive bool `json:"case_sensitive"` // When set to true, this relinquishes the 0-allocation promise in certain // cases in order to access the handler values (e.g. request bodies) in an // immutable fashion so that these values are available even if you return // from handler. // Default: false Immutable bool `json:"immutable"` // When set to true, converts all encoded characters in the route back // before setting the path for the context, so that the routing can also // work with urlencoded special characters. // Default: false UnescapePath bool `json:"unescape_path"` // Enable or disable ETag header generation, since both weak and strong etags are generated // using the same hashing method (CRC-32). Weak ETags are the default when enabled. // Default: false ETag bool `json:"etag"` // Max body size that the server accepts. // Default: 4 * 1024 * 1024 BodyLimit int `json:"body_limit"` // Maximum number of concurrent connections. // Default: 256 * 1024 Concurrency int `json:"concurrency"` // Views is the interface that wraps the Render function. // Default: nil Views Views `json:"-"` // The amount of time allowed to read the full request including body. // It is reset after the request handler has returned. // The connection's read deadline is reset when the connection opens. // Default: unlimited ReadTimeout time.Duration `json:"read_timeout"` // The maximum duration before timing out writes of the response. // It is reset after the request handler has returned. // Default: unlimited WriteTimeout time.Duration `json:"write_timeout"` // The maximum amount of time to wait for the next request when keep-alive is enabled. // If IdleTimeout is zero, the value of ReadTimeout is used. // Default: unlimited IdleTimeout time.Duration `json:"idle_timeout"` // Per-connection buffer size for requests' reading. // This also limits the maximum header size. // Increase this buffer if your clients send multi-KB RequestURIs // and/or multi-KB headers (for example, BIG cookies). // Default: 4096 ReadBufferSize int `json:"read_buffer_size"` // Per-connection buffer size for responses' writing. // Default: 4096 WriteBufferSize int `json:"write_buffer_size"` // CompressedFileSuffix adds suffix to the original file name and // tries saving the resulting compressed file under the new file name. // Default: ".fiber.gz" CompressedFileSuffix string `json:"compressed_file_suffix"` // ProxyHeader will enable c.IP() to return the value of the given header key // By default c.IP() will return the Remote IP from the TCP connection // This property can be useful if you are behind a load balancer: X-Forwarded-* // NOTE: headers are easily spoofed and the detected IP addresses are unreliable. // Default: "" ProxyHeader string `json:"proxy_header"` // GETOnly rejects all non-GET requests if set to true. // This option is useful as anti-DoS protection for servers // accepting only GET requests. The request size is limited // by ReadBufferSize if GETOnly is set. // Server accepts all the requests by default. GETOnly bool `json:"get_only"` // ErrorHandler is executed when an error is returned from fiber.Handler. ErrorHandler ErrorHandler `json:"-"` // When set to true, disables keep-alive connections. // The server will close incoming connections after sending the first response to client. // Default: false DisableKeepalive bool `json:"disable_keepalive"` // When set to true, causes the default date header to be excluded from the response. // Default: false DisableDefaultDate bool `json:"disable_default_date"` // When set to true, causes the default Content-Type header to be excluded from the response. // Default: false DisableDefaultContentType bool `json:"disable_default_content_type"` // When set to true, disables header normalization. // By default all header names are normalized: conteNT-tYPE -> Content-Type. // Default: false DisableHeaderNormalizing bool `json:"disable_header_normalizing"` // When set to true, it will not print out the Β«FiberΒ» ASCII art and listening address. // Default: false DisableStartupMessage bool `json:"disable_startup_message"` // FEATURE: v2.2.x // The router executes the same handler by default if StrictRouting or CaseSensitive is disabled. // Enabling RedirectFixedPath will change this behaviour into a client redirect to the original route path. // Using the status code 301 for GET requests and 308 for all other request methods. // RedirectFixedPath bool } // Static defines configuration options when defining static assets. type Static struct { // When set to true, the server tries minimizing CPU usage by caching compressed files. // This works differently than the github.com/gofiber/compression middleware. // Optional. Default value false Compress bool `json:"compress"` // When set to true, enables byte range requests. // Optional. Default value false ByteRange bool `json:"byte_range"` // When set to true, enables directory browsing. // Optional. Default value false. Browse bool `json:"browse"` // The name of the index file for serving a directory. // Optional. Default value "index.html". Index string `json:"index"` } // Default Config values const ( DefaultBodyLimit = 4 * 1024 * 1024 DefaultConcurrency = 256 * 1024 DefaultReadBufferSize = 4096 DefaultWriteBufferSize = 4096 DefaultCompressedFileSuffix = ".fiber.gz" ) // Default ErrorHandler that process return errors from handlers var DefaultErrorHandler = func(c *Ctx, err error) error { code := StatusInternalServerError if e, ok := err.(*Error); ok { code = e.Code } c.Set(HeaderContentType, MIMETextPlainCharsetUTF8) return c.Status(code).SendString(err.Error()) } // New creates a new Fiber named instance. // app := fiber.New() // You can pass optional configuration options by passing a Config struct: // app := fiber.New(fiber.Config{ // Prefork: true, // ServerHeader: "Fiber", // }) func New(config ...Config) *App { // Create a new app app := &App{ // Create router stack stack: make([][]*Route, len(intMethod)), treeStack: make([]map[string][]*Route, len(intMethod)), // Create Ctx pool pool: sync.Pool{ New: func() interface{} { return new(Ctx) }, }, // Create config config: Config{}, } // Override config if provided if len(config) > 0 { app.config = config[0] } // Override default values if app.config.BodyLimit <= 0 { app.config.BodyLimit = DefaultBodyLimit } if app.config.Concurrency <= 0 { app.config.Concurrency = DefaultConcurrency } if app.config.ReadBufferSize <= 0 { app.config.ReadBufferSize = DefaultReadBufferSize } if app.config.WriteBufferSize <= 0 { app.config.WriteBufferSize = DefaultWriteBufferSize } if app.config.CompressedFileSuffix == "" { app.config.CompressedFileSuffix = DefaultCompressedFileSuffix } if app.config.Immutable { getBytes, getString = getBytesImmutable, getStringImmutable } if app.config.ErrorHandler == nil { app.config.ErrorHandler = DefaultErrorHandler } // Init app app.init() // Return app return app } // Use registers a middleware route that will match requests // with the provided prefix (which is optional and defaults to "/"). // // app.Use(func(c *fiber.Ctx) error { // return c.Next() // }) // app.Use("/api", func(c *fiber.Ctx) error { // return c.Next() // }) // app.Use("/api", handler, func(c *fiber.Ctx) error { // return c.Next() // }) // // This method will match all HTTP verbs: GET, POST, PUT, HEAD etc... func (app *App) Use(args ...interface{}) Router { var prefix string var handlers []Handler for i := 0; i < len(args); i++ { switch arg := args[i].(type) { case string: prefix = arg case Handler: handlers = append(handlers, arg) // TODO: v2.1.0 // case *App: // stack := arg.Stack() // for m := range stack { // for r := range stack[m] { // route := app.copyRoute(stack[m][r]) // app.addRoute(route.Method, app.addPrefixToRoute(prefix, route)) // } // } // return app default: panic(fmt.Sprintf("use: invalid handler %v\n", reflect.TypeOf(arg))) } } app.register(methodUse, prefix, handlers...) return app } // Get registers a route for GET methods that requests a representation // of the specified resource. Requests using GET should only retrieve data. func (app *App) Get(path string, handlers ...Handler) Router { return app.Add(MethodHead, path, handlers...).Add(MethodGet, path, handlers...) } // Head registers a route for HEAD methods that asks for a response identical // to that of a GET request, but without the response body. func (app *App) Head(path string, handlers ...Handler) Router { return app.Add(MethodHead, path, handlers...) } // Post registers a route for POST methods that is used to submit an entity to the // specified resource, often causing a change in state or side effects on the server. func (app *App) Post(path string, handlers ...Handler) Router { return app.Add(MethodPost, path, handlers...) } // Put registers a route for PUT methods that replaces all current representations // of the target resource with the request payload. func (app *App) Put(path string, handlers ...Handler) Router { return app.Add(MethodPut, path, handlers...) } // Delete registers a route for DELETE methods that deletes the specified resource. func (app *App) Delete(path string, handlers ...Handler) Router { return app.Add(MethodDelete, path, handlers...) } // Connect registers a route for CONNECT methods that establishes a tunnel to the // server identified by the target resource. func (app *App) Connect(path string, handlers ...Handler) Router { return app.Add(MethodConnect, path, handlers...) } // Options registers a route for OPTIONS methods that is used to describe the // communication options for the target resource. func (app *App) Options(path string, handlers ...Handler) Router { return app.Add(MethodOptions, path, handlers...) } // Trace registers a route for TRACE methods that performs a message loop-back // test along the path to the target resource. func (app *App) Trace(path string, handlers ...Handler) Router { return app.Add(MethodTrace, path, handlers...) } // Patch registers a route for PATCH methods that is used to apply partial // modifications to a resource. func (app *App) Patch(path string, handlers ...Handler) Router { return app.Add(MethodPatch, path, handlers...) } // Add allows you to specify a HTTP method to register a route func (app *App) Add(method, path string, handlers ...Handler) Router { return app.register(method, path, handlers...) } // Static will create a file server serving static files func (app *App) Static(prefix, root string, config ...Static) Router { return app.registerStatic(prefix, root, config...) } // All will register the handler on all HTTP methods func (app *App) All(path string, handlers ...Handler) Router { for _, method := range intMethod { _ = app.Add(method, path, handlers...) } return app } // Group is used for Routes with common prefix to define a new sub-router with optional middleware. // api := app.Group("/api") // api.Get("/users", handler) func (app *App) Group(prefix string, handlers ...Handler) Router { if len(handlers) > 0 { app.register(methodUse, prefix, handlers...) } return &Group{prefix: prefix, app: app} } // Error makes it compatible with the `error` interface. func (e *Error) Error() string { return e.Message } // NewError creates a new Error instance with an optional message func NewError(code int, message ...string) *Error { e := &Error{ Code: code, } if len(message) > 0 { e.Message = message[0] } else { e.Message = utils.StatusMessage(code) } return e } // Listener can be used to pass a custom listener. func (app *App) Listener(ln net.Listener) error { // Prefork is supported for custom listeners if app.config.Prefork { addr, tls := lnMetadata(ln) return app.prefork(addr, tls) } // Print startup message if !app.config.DisableStartupMessage { app.startupMessage(ln.Addr().String(), false, "") } // TODO: Detect TLS return app.server.Serve(ln) } // Listen serves HTTP requests from the given addr. // // app.Listen(":8080") // app.Listen("127.0.0.1:8080") func (app *App) Listen(addr string) error { // Start prefork if app.config.Prefork { return app.prefork(addr, nil) } // Setup listener ln, err := net.Listen("tcp4", addr) if err != nil { return err } // Print startup message if !app.config.DisableStartupMessage { app.startupMessage(ln.Addr().String(), false, "") } // Start listening return app.server.Serve(ln) } // Config returns the app config as value ( read-only ). func (app *App) Config() Config { return app.config } // Handler returns the server handler. func (app *App) Handler() fasthttp.RequestHandler { return app.handler } // Stack returns the raw router stack. func (app *App) Stack() [][]*Route { return app.stack } // Shutdown gracefully shuts down the server without interrupting any active connections. // Shutdown works by first closing all open listeners and then waiting indefinitely for all connections to return to idle and then shut down. // // Make sure the program doesn't exit and waits instead for Shutdown to return. // // Shutdown does not close keepalive connections so its recommended to set ReadTimeout to something else than 0. func (app *App) Shutdown() error { app.mutex.Lock() defer app.mutex.Unlock() if app.server == nil { return fmt.Errorf("shutdown: server is not running") } return app.server.Shutdown() } // Test is used for internal debugging by passing a *http.Request. // Timeout is optional and defaults to 1s, -1 will disable it completely. func (app *App) Test(req *http.Request, msTimeout ...int) (resp *http.Response, err error) { // Set timeout timeout := 1000 if len(msTimeout) > 0 { timeout = msTimeout[0] } // Add Content-Length if not provided with body if req.Body != http.NoBody && req.Header.Get(HeaderContentLength) == "" { req.Header.Add(HeaderContentLength, strconv.FormatInt(req.ContentLength, 10)) } // Dump raw http request dump, err := httputil.DumpRequest(req, true) if err != nil { return nil, err } // Create test connection conn := new(testConn) // Write raw http request if _, err = conn.r.Write(dump); err != nil { return nil, err } // Serve conn to server channel := make(chan error) go func() { channel <- app.server.ServeConn(conn) }() // Wait for callback if timeout >= 0 { // With timeout select { case err = <-channel: case <-time.After(time.Duration(timeout) * time.Millisecond): return nil, fmt.Errorf("test: timeout error %vms", timeout) } } else { // Without timeout err = <-channel } // Check for errors if err != nil && err != fasthttp.ErrGetOnly { return nil, err } // Read response buffer := bufio.NewReader(&conn.w) // Convert raw http response to *http.Response return http.ReadResponse(buffer, req) } type disableLogger struct{} func (dl *disableLogger) Printf(format string, args ...interface{}) { // fmt.Println(fmt.Sprintf(format, args...)) } func (app *App) init() *App { // lock application app.mutex.Lock() // Only load templates if an view engine is specified if app.config.Views != nil { if err := app.config.Views.Load(); err != nil { fmt.Printf("views: %v\n", err) } } // create fasthttp server app.server = &fasthttp.Server{ Logger: &disableLogger{}, LogAllErrors: false, ErrorHandler: func(fctx *fasthttp.RequestCtx, err error) { c := app.AcquireCtx(fctx) if _, ok := err.(*fasthttp.ErrSmallBuffer); ok { err = ErrRequestHeaderFieldsTooLarge } else if netErr, ok := err.(*net.OpError); ok && netErr.Timeout() { err = ErrRequestTimeout } else if err == fasthttp.ErrBodyTooLarge { err = ErrRequestEntityTooLarge } else if err == fasthttp.ErrGetOnly { err = ErrMethodNotAllowed } else if strings.Contains(err.Error(), "timeout") { err = ErrRequestTimeout } else { err = ErrBadRequest } if catch := app.config.ErrorHandler(c, err); catch != nil { _ = c.SendStatus(StatusInternalServerError) } app.ReleaseCtx(c) }, } // fasthttp server settings app.server.Handler = app.handler app.server.Name = app.config.ServerHeader app.server.Concurrency = app.config.Concurrency app.server.NoDefaultDate = app.config.DisableDefaultDate app.server.NoDefaultContentType = app.config.DisableDefaultContentType app.server.DisableHeaderNamesNormalizing = app.config.DisableHeaderNormalizing app.server.DisableKeepalive = app.config.DisableKeepalive app.server.MaxRequestBodySize = app.config.BodyLimit app.server.NoDefaultServerHeader = app.config.ServerHeader == "" app.server.ReadTimeout = app.config.ReadTimeout app.server.WriteTimeout = app.config.WriteTimeout app.server.IdleTimeout = app.config.IdleTimeout app.server.ReadBufferSize = app.config.ReadBufferSize app.server.WriteBufferSize = app.config.WriteBufferSize app.server.GetOnly = app.config.GETOnly // unlock application app.mutex.Unlock() return app } func (app *App) startupMessage(addr string, tls bool, pids string) { // ignore child processes if IsChild() { return } var logo string logo += "\n%s" logo += " β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”\n" logo += " β”‚ %s β”‚\n" logo += " β”‚ %s β”‚\n" logo += " β”‚ β”‚\n" logo += " β”‚ Handlers %s Threads %s β”‚\n" logo += " β”‚ Prefork .%s PID ....%s β”‚\n" logo += " β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜" logo += "%s\n\n" const ( cBlack = "\u001b[90m" // cRed = "\u001b[91m" cCyan = "\u001b[96m" // cGreen = "\u001b[92m" // cYellow = "\u001b[93m" // cBlue = "\u001b[94m" // cMagenta = "\u001b[95m" // cWhite = "\u001b[97m" cReset = "\u001b[0m" ) value := func(s string, width int) string { pad := width - len(s) str := "" for i := 0; i < pad; i++ { str += "." } if s == "Disabled" { str += " " + s } else { str += fmt.Sprintf(" %s%s%s", cCyan, s, cBlack) } return str } center := func(s string, width int) string { pad := strconv.Itoa((width - len(s)) / 2) str := fmt.Sprintf("%"+pad+"s", " ") str += s str += fmt.Sprintf("%"+pad+"s", " ") if len(str) < width { str += " " } return str } centerValue := func(s string, width int) string { pad := strconv.Itoa((width - len(s)) / 2) str := fmt.Sprintf("%"+pad+"s", " ") str += fmt.Sprintf("%s%s%s", cCyan, s, cBlack) str += fmt.Sprintf("%"+pad+"s", " ") if len(str)-10 < width { str += " " } return str } host, port := parseAddr(addr) if host == "" || host == "0.0.0.0" { host = "127.0.0.1" } addr = "http://" + host + ":" + port if tls { addr = "https://" + host + ":" + port } isPrefork := "Disabled" if app.config.Prefork { isPrefork = "Enabled" } out := colorable.NewColorableStdout() if os.Getenv("TERM") == "dumb" || (!isatty.IsTerminal(os.Stdout.Fd()) && !isatty.IsCygwinTerminal(os.Stdout.Fd())) { out = colorable.NewNonColorable(os.Stdout) } fmt.Fprintf(out, logo, cBlack, centerValue(" Fiber v"+Version, 49), center(addr, 49), value(strconv.Itoa(app.handlerCount), 14), value(strconv.Itoa(runtime.NumCPU()), 14), value(isPrefork, 14), value(strconv.Itoa(os.Getpid()), 14), cReset, ) }