httpagent

README

httpagent

一个简洁易用的 HTTP-User-Agent 客户端

Documentation

Index

• func NewMainModule() *application.ModuleBuilder
• func NewTestModule() *application.ModuleBuilder
• type Client
  • func NewClientWithFilters(filters ...*FilterRegistration) Client
• type ClientContext
• type Clients
  • func Default() Clients
• type Context
• type Entity
  • func NewEntityWithBinary(bin []byte, contentType string) *Entity
  • func NewEntityWithJSON(v any) *Entity
  • func NewEntityWithText(text string, contentType string) *Entity
  • func (inst *Entity) OpenReader() (io.ReadCloser, error)
  • func (inst *Entity) ReadBinary() ([]byte, error)
  • func (inst *Entity) ReadJSON(obj any) error
  • func (inst *Entity) ReadText() (string, error)
• type Filter
• type FilterChain
• type FilterChainBuilder
  • func (inst *FilterChainBuilder) AddRegistration(list ...*FilterRegistration) *FilterChainBuilder
  • func (inst *FilterChainBuilder) AddRegistry(list ...FilterRegistry) *FilterChainBuilder
  • func (inst *FilterChainBuilder) Create() FilterChain
• type FilterRegistration
• type FilterRegistry
• type Headers
  • func (inst *Headers) Get(name string) string
  • func (inst *Headers) Remove(name string)
  • func (inst *Headers) Set(name, value string)
  • func (inst *Headers) Table() map[string]string
• type Request
  • func (inst *Request) SetEntity(entity *Entity)
• type Response
  • func (inst *Response) GetEntity() (*Entity, error)

Functions

func NewMainModule

func NewMainModule() *application.ModuleBuilder

NewMainModule ...

func NewTestModule

func NewTestModule() *application.ModuleBuilder

NewTestModule ...

Types

type Client

type Client interface {
	Execute(req *Request) (*Response, error)
}

Client 是一个简易的 HTTP 客户端

func NewClientWithFilters

func NewClientWithFilters(filters ...*FilterRegistration) Client

NewClientWithFilters ...

type ClientContext

type ClientContext struct {
	Attributes attributes.Table
	Client     Client
	Chain      FilterChain
	Filters    []*FilterRegistration
}

ClientContext ...

type Clients

type Clients interface {
	GetClient() Client
	NewClient() Client
}

Clients 是一个简易的 HTTP 客户端服务

func Default

func Default() Clients

Default 获取默认的 Clients 对象

type Context

type Context struct {
	Attributes    attributes.Table
	ClientContext *ClientContext
	Request       *Request
	Response      *Response
}

Context ...

type Entity

type Entity struct {
	ContentLength int64
	ContentType   string
	Data          []byte
}

Entity ...

func NewEntityWithBinary

func NewEntityWithBinary(bin []byte, contentType string) *Entity

NewEntityWithBinary ...

func NewEntityWithJSON

func NewEntityWithJSON(v any) *Entity

NewEntityWithJSON ...

func NewEntityWithText

func NewEntityWithText(text string, contentType string) *Entity

NewEntityWithText ...

func (*Entity) OpenReader

func (inst *Entity) OpenReader() (io.ReadCloser, error)

OpenReader ...

func (*Entity) ReadBinary

func (inst *Entity) ReadBinary() ([]byte, error)

ReadBinary ...

func (*Entity) ReadJSON

func (inst *Entity) ReadJSON(obj any) error

ReadJSON ...

func (*Entity) ReadText

func (inst *Entity) ReadText() (string, error)

ReadText ...

type Filter

type Filter interface {
	Handle(c *Context, chain FilterChain) error
}

Filter 用于过滤 web 请求

type FilterChain

type FilterChain interface {
	Handle(c *Context) error
}

FilterChain 表示一个由若干 Filter 构成的链条

type FilterChainBuilder

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

FilterChainBuilder 用于创建 FilterChain

func (*FilterChainBuilder) AddRegistration

func (inst *FilterChainBuilder) AddRegistration(list ...*FilterRegistration) *FilterChainBuilder

AddRegistration ...

func (*FilterChainBuilder) AddRegistry

func (inst *FilterChainBuilder) AddRegistry(list ...FilterRegistry) *FilterChainBuilder

AddRegistry ...

func (*FilterChainBuilder) Create

func (inst *FilterChainBuilder) Create() FilterChain

Create ...

type FilterRegistration

type FilterRegistration struct {
	Name    string
	Enabled bool
	Order   int
	Filter  Filter
}

FilterRegistration 是 Filter 的注册信息

type FilterRegistry

type FilterRegistry interface {
	FilterRegistrations() []*FilterRegistration
}

FilterRegistry 用于注册 Filter

type Headers

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

Headers ...

func (*Headers) Get

func (inst *Headers) Get(name string) string

Get ...

func (*Headers) Remove

func (inst *Headers) Remove(name string)

Remove ...

func (*Headers) Set

func (inst *Headers) Set(name, value string)

Set ...

func (*Headers) Table

func (inst *Headers) Table() map[string]string

Table ...

type Request

type Request struct {
	Context context.Context
	Method  string
	URL     string
	Headers Headers
	Body    io.ReadCloser
}

Request ...

func (*Request) SetEntity

func (inst *Request) SetEntity(entity *Entity)

SetEntity 设置请求的 body

type Response

type Response struct {
	Request *Request
	Status  int
	Message string
	Headers Headers
	Body    io.ReadCloser
}

Response ...

func (*Response) GetEntity

func (inst *Response) GetEntity() (*Entity, error)

GetEntity 以 Entity 的形式获取响应的 body