errorpage

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 17, 2019 License: MIT, MIT Imports: 2 Imported by: 1

README

ErrorPage 自定义错误页组件

根据http响应的状态码,显示自定义的页面

功能

  • 根据不同的状态码显示不同的页面
  • 提供默认的错误页,在非正常状态码(>=400)的情况下默认显示
  • 提供禁用组件的功能,使得能在使用了本组件的路由子组件下能显示原始的反馈

使用方法

//创建新的组件
em:=errorpage.New()


em.
    //默认错误页,当状态码>399并<600时使用
    OnError(func(w http.ResponseWriter, r *http.Request, status int){
        http.Error(w,http.StatusText(status),status)
    }).
    //指定状态码的错误页
    OnStatus(404,func(w http.ResponseWriter, r *http.Request, status int){
        http.Error(w,"页面未找到",404)
    }).
    //跳过执行状态
    IgnoreStatus(422)

    app.Use(em)
    
    //强制关闭自定义错误页
    em2.Use(em.MiddlewareDisable())

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ErrorPage

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

ErrorPage error page middleware main struct

func New

func New() *ErrorPage

New create new error page middleware.

func (*ErrorPage) IgnoreStatus

func (e *ErrorPage) IgnoreStatus(status int) *ErrorPage

IgnoreStatus configure ignore given status.

func (*ErrorPage) MiddlewareDisable

func (e *ErrorPage) MiddlewareDisable(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

MiddlewareDisable middleware which disable previous installed error page middleware

func (*ErrorPage) OnError

func (e *ErrorPage) OnError(f func(w http.ResponseWriter, r *http.Request, status int)) *ErrorPage

OnError configure default error page when statuscode >399 and statuscode <600

func (*ErrorPage) OnStatus

func (e *ErrorPage) OnStatus(status int, f func(w http.ResponseWriter, r *http.Request, status int)) *ErrorPage

OnStatus configure error page by status code.

func (*ErrorPage) ServeMiddleware

func (e *ErrorPage) ServeMiddleware(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

ServeMiddleware serve as middleware

type Writer

type Writer interface {
	http.ResponseWriter
	http.Hijacker
}

Writer http response writer interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL