http_service

Documentation

Index

• Variables
• type FileHeader
• type IBodyDataReader
• type IBodyDataWriter
• type IBodyGet
• type IBodySet
• type IChain
• type IFilter
• type IHeaderReader
• type IHeaderWriter
• type IHttpContext
• type IQueryReader
• type IQueryWriter
• type IRequest
• type IRequestReader
• type IResponse
• type IResponseHeader
• type IStatusGet
• type IStatusSet
• type IURIReader
• type IURIWriter

Variables

var (
	FilterSkillName = config.TypeNameOf((*IFilter)(nil))
)

Types

type FileHeader

type FileHeader struct {
	FileName string
	Header   textproto.MIMEHeader
	Data     []byte
}

type IBodyDataReader

type IBodyDataReader interface {
	//protocol() RequestType
	ContentType() string
	//content-Type = application/x-www-form-urlencoded 或 multipart/form-data，与原生request.Form不同，这里不包括 query 参数
	BodyForm() (url.Values, error)
	//content-Type = multipart/form-data 时有效
	Files() (map[string]*FileHeader, error)
	GetForm(key string) string
	GetFile(key string) (file *FileHeader, has bool)
	RawBody() ([]byte, error)
}

type IBodyDataWriter

type IBodyDataWriter interface {
	IBodyDataReader
	//设置form数据并将content-type设置 为 application/x-www-form-urlencoded 或 multipart/form-data
	SetForm(values url.Values) error
	SetToForm(key, value string) error
	AddForm(key, value string) error
	// 会替换掉对应掉file信息，并且将content-type 设置为 multipart/form-data
	AddFile(key string, file *FileHeader) error
	//设置 multipartForm 数据并将content-type设置 为 multipart/form-data
	// 重置body，会清除掉未处理掉 form和file
	SetRaw(contentType string, body []byte)
}

type IBodyGet

type IBodyGet interface {
	GetBody() []byte
	BodyLen() int
}

type IBodySet

type IBodySet interface {
	SetBody([]byte)
}

type IChain

type IChain interface {
	DoChain(ctx IHttpContext) error
	Destroy()
}

type IFilter

type IFilter interface {
	DoFilter(ctx IHttpContext, next IChain) (err error)
	Destroy()
}

type IHeaderReader

type IHeaderReader interface {
	RawHeader() string
	GetHeader(name string) string
	Headers() http.Header
	Host() string
	GetCookie(key string) string
}

type IHeaderWriter

type IHeaderWriter interface {
	IHeaderReader
	SetHeader(key, value string)
	AddHeader(key, value string)
	DelHeader(key string)
	SetHost(host string)
}

type IHttpContext

type IHttpContext interface {
	RequestId() string
	Context() context.Context
	Value(key interface{}) interface{}
	WithValue(key, val interface{})
	Request() IRequestReader // 读取原始请求
	Proxy() IRequest         // 读写转发请求
	Response() IResponse     // 处理返回结果，可读可写
	SendTo(address string, timeout time.Duration) error
	Proxies() []IRequest
	SetLabel(name, value string)
	GetLabel(name string) string
	Labels() map[string]string
}

type IQueryReader

type IQueryReader interface {
	GetQuery(key string) string
	RawQuery() string
}

type IQueryWriter

type IQueryWriter interface {
	IQueryReader
	SetQuery(key, value string)
	AddQuery(key, value string)
	DelQuery(key string)
	SetRawQuery(raw string)
}

type IRequest

type IRequest interface {
	Method() string
	Header() IHeaderWriter
	Body() IBodyDataWriter
	URI() IURIWriter
	SetMethod(method string)
}

用于组装转发的request

type IRequestReader

type IRequestReader interface {
	Header() IHeaderReader
	Body() IBodyDataReader
	RemoteAddr() string
	RemotePort() string
	ReadIP() string
	ForwardIP() string
	URI() IURIReader
	Method() string
	String() string
}

原始请求数据的读

type IResponse

type IResponse interface {
	ResponseError() error
	ClearError()
	String() string
	IStatusGet
	IResponseHeader
	IStatusSet // 设置返回状态
	IBodySet   // 设置返回内容
	IBodyGet
}

返回给client端的

type IResponseHeader

type IResponseHeader interface {
	GetHeader(name string) string
	Headers() http.Header
	HeadersString() string
	SetHeader(key, value string)
	AddHeader(key, value string)
	DelHeader(key string)
}

type IStatusGet

type IStatusGet interface {
	StatusCode() int
	ProxyStatusCode() int
	ProxyStatus() string
	Status() string
}

type IStatusSet

type IStatusSet interface {
	SetStatus(code int, status string)
	SetProxyStatus(code int, status string)
}

type IURIReader

type IURIReader interface {
	RequestURI() string
	Scheme() string
	RawURL() string
	Host() string
	Path() string
	IQueryReader
}

type IURIWriter

type IURIWriter interface {
	IURIReader
	IQueryWriter
	//SetRequestURI(uri string)
	SetPath(string)
	SetScheme(scheme string)
	SetHost(host string)
}