http

Documentation

Index

• Constants
• Variables
• func BasicAuth(username, password string) string
• func CopyHttpHeader(dst, src http.Header)
• func FormatRange(start, end, total int64) string
• func GetToken(r *http.Request) string
• func HandlerWrap[REQ, RES any](service Service[*REQ, *RES]) http.Handler
• func HandlerWrapCompatibleGRPC[REQ, RES any](method types.GrpcServiceMethod[*REQ, *RES]) http.Handler
• func NewNoCloseRequest(req *http.Request, s []byte)
• func NewNoCloseStrRequest(req *http.Request, s string)
• func ParseDisposition(disposition string) (mediatype string, params map[string]string, err error)
• func ParseRange(rangeHeader string) (start int64, end int64, total int64, err error)
• func RespErrRep(w http.ResponseWriter, rep *errcode.ErrRep)
• func RespErrcode(w http.ResponseWriter, code errcode.ErrCode)
• func RespError(w http.ResponseWriter, code errcode.ErrCode, msg string)
• func RespSuccess[T any](w http.ResponseWriter, msg string, data T)
• func RespSuccessData(w http.ResponseWriter, data any)
• func RespSuccessMsg(w http.ResponseWriter, msg string)
• func Response[T any](w http.ResponseWriter, code errcode.ErrCode, msg string, data T)
• func SetBasicAuth(header http.Header, username, password string)
• func Stream(w http.ResponseWriter)
• func StreamWriter(w http.ResponseWriter, writer func(w io.Writer) bool)
• type Body
• type HandlerFuncs
  • func (hs *HandlerFuncs) Add(handler http.HandlerFunc)
  • func (hs HandlerFuncs) HandlerFunc() http.HandlerFunc
  • func (hs HandlerFuncs) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Handlers
  • func (hs Handlers) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Header
• type HttpResponse
• type IHttpResponse
• type MapHeader
  • func (m MapHeader) IntoHttpHeader(header http.Header)
• type NoCloseBody
  • func NewNoCloseBody(s []byte) *NoCloseBody
  • func (r *NoCloseBody) Close() error
  • func (r *NoCloseBody) Len() int
  • func (r *NoCloseBody) Read(b []byte) (n int, err error)
  • func (r *NoCloseBody) Size() int64
• type NoCloseStrBody
  • func NewNoCloseStrBody(s string) *NoCloseStrBody
  • func (r *NoCloseStrBody) Close() error
  • func (r *NoCloseStrBody) Len() int
  • func (r *NoCloseStrBody) Read(b []byte) (n int, err error)
  • func (r *NoCloseStrBody) Size() int64
• type ReceiveData
  • func NewReceiveData(code errcode.ErrCode, msg string, data any) *ReceiveData
• type ReqResp
• type RequestAt
  • func NewRequestAt() *RequestAt
  • func NewRequestAtFromTime(t time.Time) *RequestAt
  • func (r *RequestAt) String() string
• type ResAnyData
  • func NewErrorResData(code errcode.ErrCode, msg string) *ResAnyData
  • func NewResAnyData(code errcode.ErrCode, msg string, data any) *ResAnyData
  • func NewSuccessResData(data any) *ResAnyData
• type ResData
  • func NewResData[T any](code errcode.ErrCode, msg string, data T) *ResData[T]
  • func (res *ResData[T]) Response(w http.ResponseWriter, httpcode int)
• type ResponseRecorder
  • func NewRecorder(header http.Header) *ResponseRecorder
  • func (rw *ResponseRecorder) Flush()
  • func (rw *ResponseRecorder) Header() http.Header
  • func (rw *ResponseRecorder) Reset()
  • func (rw *ResponseRecorder) Result() *http.Response
  • func (rw *ResponseRecorder) Write(buf []byte) (int, error)
  • func (rw *ResponseRecorder) WriteHeader(code int)
  • func (rw *ResponseRecorder) WriteString(str string) (int, error)
• type Service
• type SliceHeader
  • func NewHeader() *SliceHeader
  • func (h *SliceHeader) Add(k, v string) *SliceHeader
  • func (h SliceHeader) Clone() SliceHeader
  • func (h SliceHeader) IntoHttpHeader(header http.Header)
  • func (h *SliceHeader) Set(k, v string) *SliceHeader

Constants

const (
	// ContentTypeJavascript header value for JSONP & Javascript data.
	ContentTypeJavascript = "text/javascript"
	// ContentTypeHtml is the  string of text/html response header's content type value.
	ContentTypeHtml = "text/html"
	ContentTypeCss  = "text/css"
	// ContentTypeText header value for Text data.
	ContentTypeText = "text/plain"
	// ContentTypeXml header value for XML data.
	ContentTypeXml = "text/xml"
	// ContentTypeMarkdown custom key/content type, the real is the text/html.
	ContentTypeMarkdown = "text/markdown"
	// ContentTypeYamlText header value for YAML plain text.
	ContentTypeYamlText = "text/yaml"

	// ContentTypeMultipart header value for post multipart form data.
	ContentTypeMultipart = "multipart/form-data"

	// ContentTypeOctetStream header value for binary data.
	ContentTypeOctetStream = "application/octet-stream"
	// ContentTypeWebassembly header value for web assembly files.
	ContentTypeWebassembly = "application/wasm"
	// ContentTypeJson header value for JSON data.
	ContentTypeJson = "application/json"
	// ContentTypeJsonProblem header value for JSON API problem error.
	// Read more at: https://tools.ietf.org/html/rfc7807
	ContentTypeJsonProblem = "application/problem+json"
	// ContentTypeXmlProblem header value for XML API problem error.
	// Read more at: https://tools.ietf.org/html/rfc7807
	ContentTypeXmlProblem           = "application/problem+xml"
	ContentTypeJavascriptUnreadable = "application/javascript"
	// ContentTypeXmlUnreadable obsolete header value for XML.
	ContentTypeXmlUnreadable = "application/xml"
	// ContentTypeYaml header value for YAML data.
	ContentTypeYaml = "application/x-yaml"
	// ContentTypeProtobuf header value for Protobuf messages data.
	ContentTypeProtobuf = "application/x-protobuf"
	// ContentTypeMsgPack header value for MsgPack data.
	ContentTypeMsgPack = "application/msgpack"
	// ContentTypeMsgPack2 alternative header value for MsgPack data.
	ContentTypeMsgPack2 = "application/x-msgpack"
	// ContentTypeForm header value for post form data.
	ContentTypeForm = "application/x-www-form-urlencoded"

	// ContentTypeGrpc Content-Type header value for gRPC.
	ContentTypeGrpc    = "application/grpc"
	ContentTypeGrpcWeb = "application/grpc-web"
	ContentPdf         = "application/pdf"
	ContentJsonUtf8    = "application/json;charset=utf-8"
	ContentFormParam   = "application/x-www-form-urlencoded;param=value"

	ContentImagePng                  = "image/png"
	ContentImageJpeg                 = "image/jpeg"
	ContentImageGif                  = "image/gif"
	ContentImageBmp                  = "image/bmp"
	ContentImageWebp                 = "image/webp"
	ContentImageAvif                 = "image/avif"
	ContentTypeImageHeif             = "image/heif"
	ContentTypeImageSvg              = "image/svg+xml"
	ContentTypeImageTiff             = "image/tiff"
	ContentTypeImageXIcon            = "image/x-icon"
	ContentTypeImageVndMicrosoftIcon = "image/vnd.microsoft.icon"

	ContentTypeCharsetUtf8 = "charset=UTF-8"
)

const (
	HeaderDeviceInfo = "Device-AuthInfo"
	HeaderLocation   = "Location"
	HeaderArea       = "Area"
)

const (
	HeaderUserAgent                   = "User-Agent"
	HeaderXForwardedFor               = "X-Forwarded-For"
	HeaderXAccelBuffering             = "X-Accel-Buffering"
	HeaderAuth                        = "HeaderAuth"
	HeaderContentType                 = "Content-Type"
	HeaderTrace                       = "Tracing"
	HeaderTraceID                     = "Tracing-ID"
	HeaderTraceBin                    = "Tracing-Bin"
	HeaderAuthorization               = "Authorization"
	HeaderCookie                      = "Cookie"
	HeaderCookieValueToken            = "token"
	HeaderCookieValueDel              = "del"
	HeaderContentDisposition          = "Content-Disposition"
	HeaderContentEncoding             = "Content-Encoding"
	HeaderReferer                     = "Referer"
	HeaderAccept                      = "Accept"
	HeaderAcceptLanguage              = "Accept-Language"
	HeaderAcceptEncoding              = "Accept-Encoding"
	HeaderCacheControl                = "Cache-Control"
	HeaderSetCookie                   = "Set-Cookie"
	HeaderTrailer                     = "Trailer"
	HeaderTransferEncoding            = "Transfer-Encoding"
	HeaderTransferEncodingChunked     = "chunked"
	HeaderInternal                    = "Internal"
	HeaderTE                          = "TE"
	HeaderLastModified                = "Last-Modified"
	HeaderContentLength               = "Content-Length"
	HeaderAccessControlRequestMethod  = "Access-Control-Request-Method"
	HeaderAccessControlRequestHeaders = "Access-Control-Request-Headers"
	HeaderOrigin                      = "Origin"
	HeaderConnection                  = "Connection"
	HeaderRange                       = "Range"
	HeaderContentRange                = "Content-Range"
	HeaderAcceptRanges                = "Accept-Ranges"
)

const (
	HeaderGrpcTraceBin = "grpc-trace-bin"
	HeaderGrpcInternal = "grpc-internal"
)

const (
	FormDataFieldTmpl = `form-data; name="%s"`
	FormDataFileTmpl  = `form-data; name="%s"; filename="%s"`
)

const DefaultRemoteAddr = "1.2.3.4"

DefaultRemoteAddr is the default remote address to return in RemoteAddr if an explicit DefaultRemoteAddr isn't set on ResponseRecorder.

Variables

var ResponseOk = []byte(`{"code":0}`)

var ResponseSysErr = []byte(`{"code":-1,"msg":"system error"}`)

Functions

func BasicAuth

func BasicAuth(username, password string) string

func CopyHttpHeader

func CopyHttpHeader(dst, src http.Header)

func FormatRange

func FormatRange(start, end, total int64) string

func GetToken

func GetToken(r *http.Request) string

func HandlerWrap

func HandlerWrap[REQ, RES any](service Service[*REQ, *RES]) http.Handler

func HandlerWrapCompatibleGRPC

func HandlerWrapCompatibleGRPC[REQ, RES any](method types.GrpcServiceMethod[*REQ, *RES]) http.Handler

func NewNoCloseRequest

func NewNoCloseRequest(req *http.Request, s []byte)

func NewNoCloseStrRequest

func NewNoCloseStrRequest(req *http.Request, s string)

func ParseDisposition

func ParseDisposition(disposition string) (mediatype string, params map[string]string, err error)

func ParseRange

func ParseRange(rangeHeader string) (start int64, end int64, total int64, err error)

func RespErrRep

func RespErrRep(w http.ResponseWriter, rep *errcode.ErrRep)

func RespErrcode

func RespErrcode(w http.ResponseWriter, code errcode.ErrCode)

func RespError

func RespError(w http.ResponseWriter, code errcode.ErrCode, msg string)

func RespSuccess

func RespSuccess[T any](w http.ResponseWriter, msg string, data T)

func RespSuccessData

func RespSuccessData(w http.ResponseWriter, data any)

func RespSuccessMsg

func RespSuccessMsg(w http.ResponseWriter, msg string)

func Response

func Response[T any](w http.ResponseWriter, code errcode.ErrCode, msg string, data T)

func SetBasicAuth

func SetBasicAuth(header http.Header, username, password string)

func Stream

func Stream(w http.ResponseWriter)

func StreamWriter

func StreamWriter(w http.ResponseWriter, writer func(w io.Writer) bool)

Types

type Body

type Body map[string]any

type HandlerFuncs

type HandlerFuncs []http.HandlerFunc

func (*HandlerFuncs) Add

func (hs *HandlerFuncs) Add(handler http.HandlerFunc)

func (HandlerFuncs) HandlerFunc

func (hs HandlerFuncs) HandlerFunc() http.HandlerFunc

func (HandlerFuncs) ServeHTTP

func (hs HandlerFuncs) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Handlers

type Handlers []http.Handler

func (Handlers) ServeHTTP

func (hs Handlers) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Header

type Header interface {
	IntoHttpHeader(header http.Header)
}

type HttpResponse

type HttpResponse struct {
	Header     map[string]string `json:"header"`
	Body       []byte            `json:"body"`
	StatusCode int               `json:"status"`
}

type IHttpResponse

type IHttpResponse interface {
	Header() http.Header
	Body() []byte
	StatusCode() int
}

type MapHeader

type MapHeader map[string]string

func (MapHeader) IntoHttpHeader

func (m MapHeader) IntoHttpHeader(header http.Header)

type NoCloseBody

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

func NewNoCloseBody

func NewNoCloseBody(s []byte) *NoCloseBody

适用于轮询

func (*NoCloseBody) Close

func (r *NoCloseBody) Close() error

func (*NoCloseBody) Len

func (r *NoCloseBody) Len() int

func (*NoCloseBody) Read

func (r *NoCloseBody) Read(b []byte) (n int, err error)

func (*NoCloseBody) Size

func (r *NoCloseBody) Size() int64

type NoCloseStrBody

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

func NewNoCloseStrBody

func NewNoCloseStrBody(s string) *NoCloseStrBody

适用于轮询

func (*NoCloseStrBody) Close

func (r *NoCloseStrBody) Close() error

func (*NoCloseStrBody) Len

func (r *NoCloseStrBody) Len() int

func (*NoCloseStrBody) Read

func (r *NoCloseStrBody) Read(b []byte) (n int, err error)

func (*NoCloseStrBody) Size

func (r *NoCloseStrBody) Size() int64

type ReceiveData

type ReceiveData = ResData[json.RawMessage]

func NewReceiveData

func NewReceiveData(code errcode.ErrCode, msg string, data any) *ReceiveData

type ReqResp

type ReqResp struct {
	*http.Request
	http.ResponseWriter
}

type RequestAt

type RequestAt struct {
	Time       time.Time
	TimeStamp  int64
	TimeString string
}

func NewRequestAt

func NewRequestAt() *RequestAt

func NewRequestAtFromTime

func NewRequestAtFromTime(t time.Time) *RequestAt

func (*RequestAt) String

func (r *RequestAt) String() string

type ResAnyData

type ResAnyData = ResData[any]

func NewErrorResData

func NewErrorResData(code errcode.ErrCode, msg string) *ResAnyData

func NewResAnyData

func NewResAnyData(code errcode.ErrCode, msg string, data any) *ResAnyData

func NewSuccessResData

func NewSuccessResData(data any) *ResAnyData

type ResData

type ResData[T any] struct {
	Code errcode.ErrCode `json:"code"`
	Msg  string          `json:"msg,omitempty"`
	//验证码
	Data T `json:"data,omitempty"`
}

ResData 主要用来接收返回，发送请使用ResAnyData

func NewResData

func NewResData[T any](code errcode.ErrCode, msg string, data T) *ResData[T]

func (*ResData[T]) Response

func (res *ResData[T]) Response(w http.ResponseWriter, httpcode int)

type ResponseRecorder

type ResponseRecorder struct {
	// Code is the HTTP response code set by WriteHeader.
	//
	// Note that if a Handler never calls WriteHeader or Write,
	// this might end up being 0, rather than the implicit
	// http.StatusOK. To get the implicit value, use the Result
	// method.
	Code int

	HeaderMap http.Header

	// Body is the buffer to which the Handler's Write calls are sent.
	// If nil, the Writes are silently discarded.
	Body *bytes.Buffer

	// Flushed is whether the Handler called Flush.
	Flushed bool
	// contains filtered or unexported fields
}

ResponseRecorder is an implementation of http.ResponseWriter that records its mutations for later inspection in tests.

func NewRecorder

func NewRecorder(header http.Header) *ResponseRecorder

NewRecorder returns an initialized ResponseRecorder.

func (*ResponseRecorder) Flush

func (rw *ResponseRecorder) Flush()

Flush implements http.Flusher. To test whether Flush was called, see rw.Flushed.

func (*ResponseRecorder) Header

func (rw *ResponseRecorder) Header() http.Header

Header implements http.ResponseWriter. It returns the response headers to mutate within a handler. To test the headers that were written after a handler completes, use the Result method and see the returned Response value's Header.

func (*ResponseRecorder) Reset

func (rw *ResponseRecorder) Reset()

func (*ResponseRecorder) Result

func (rw *ResponseRecorder) Result() *http.Response

Result returns the response generated by the handler.

The returned Response will have at least its StatusCode, Header, Body, and optionally Trailer populated. More fields may be populated in the future, so callers should not DeepEqual the result in tests.

The Response.Header is a snapshot of the headers at the time of the first write call, or at the time of this call, if the handler never did a write.

The Response.Body is guaranteed to be non-nil and Body.Read call is guaranteed to not return any error other than io.EOF.

Result must only be called after the handler has finished running.

func (*ResponseRecorder) Write

func (rw *ResponseRecorder) Write(buf []byte) (int, error)

Write implements http.ResponseWriter. The data in buf is written to rw.Body, if not nil.

func (*ResponseRecorder) WriteHeader

func (rw *ResponseRecorder) WriteHeader(code int)

WriteHeader implements http.ResponseWriter.

func (*ResponseRecorder) WriteString

func (rw *ResponseRecorder) WriteString(str string) (int, error)

WriteString implements io.StringWriter. The data in str is written to rw.Body, if not nil.

type Service

type Service[REQ, RES any] func(ctx ReqResp, req REQ) (RES, error)

type SliceHeader

type SliceHeader []string

func NewHeader

func NewHeader() *SliceHeader

func (*SliceHeader) Add

func (h *SliceHeader) Add(k, v string) *SliceHeader

func (SliceHeader) Clone

func (h SliceHeader) Clone() SliceHeader

func (SliceHeader) IntoHttpHeader

func (h SliceHeader) IntoHttpHeader(header http.Header)

func (*SliceHeader) Set

func (h *SliceHeader) Set(k, v string) *SliceHeader