httpclient

Documentation

Overview

Package httpclient http客户端

Package httpclient is a generated protocol buffer package.

It is generated from these files:

httpclient/test.proto

It has these top-level messages:

Message

Index

• type DNSResolverFunc
• type DialContext
• type Message
  • func (*Message) Descriptor() ([]byte, []int)
  • func (m *Message) GetName() string
  • func (*Message) ProtoMessage()
  • func (m *Message) Reset()
  • func (m *Message) String() string
• type Option
  • func WithClient(client *http.Client) Option
  • func WithClientTrace(t *httptrace.ClientTrace) Option
  • func WithConnectTimeout(timeout time.Duration) Option
  • func WithCookieJar(cookieJar http.CookieJar) Option
  • func WithDNSResolver(dnsResolver DNSResolverFunc) Option
  • func WithDebug() Option
  • func WithDisableKeepAlive() Option
  • func WithEnableDefaultHeader() Option
  • func WithMaxIdleConnsPerHost(n int) Option
  • func WithProxyURL(proxyURL string) Option
  • func WithRequestInterceptor(i RequestInterceptor) Option
  • func WithResponseInterceptor(i ResponseInterceptor) Option
  • func WithRetryTime(retryTimes int) Option
  • func WithShouldRetryFunc(f func(*http.Request, *http.Response, error) bool) Option
  • func WithTimeout(timeout time.Duration) Option
• type Request
  • func NewRequest(opt ...Option) *Request
  • func (req *Request) Delete(url string, data interface{}, header http.Header) (*Response, error)
  • func (req *Request) Get(url string, params url.Values, header http.Header) (*Response, error)
  • func (req *Request) Post(url string, data interface{}, header http.Header) (*Response, error)
  • func (req *Request) PostJSON(url string, data interface{}, header http.Header) (*Response, error)
  • func (req *Request) PostProtoBuf(url string, v proto.Message, header http.Header) (*Response, error)
  • func (req *Request) Put(url string, data interface{}, header http.Header) (*Response, error)
  • func (req *Request) UploadFile(url string, reader io.Reader, filename string, header http.Header, ...) (*Response, error)
• type RequestInterceptor
• type Response
  • func Get(url string, data url.Values, header http.Header) (*Response, error)
  • func Post(url string, data interface{}, header http.Header) (*Response, error)
  • func PostJSON(url string, data interface{}, header http.Header) (*Response, error)
  • func (resp *Response) Bytes() ([]byte, error)
  • func (resp *Response) DecodeJSON(v interface{}) error
  • func (resp *Response) DecodeProtoBuf(v interface{}) error
  • func (resp *Response) Discard() (int64, error)
  • func (resp *Response) Header() http.Header
  • func (resp *Response) IsStatusOK() bool
  • func (resp *Response) Raw() *http.Response
  • func (resp *Response) String() (string, error)
  • func (resp *Response) WriteFile(filename string) (int64, error)
  • func (resp *Response) WriteTo(w io.Writer) (int64, error)
• type ResponseInterceptor

Types

type DNSResolverFunc

type DNSResolverFunc func(host string) (ip string, err error)

DNSResolver DNS解析

type DialContext

type DialContext func(ctx context.Context, network, addr string) (net.Conn, error)

type Message

type Message struct {
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

func (*Message) Descriptor

func (*Message) Descriptor() ([]byte, []int)

func (*Message) GetName

func (m *Message) GetName() string

func (*Message) ProtoMessage

func (*Message) ProtoMessage()

func (*Message) Reset

func (m *Message) Reset()

func (*Message) String

func (m *Message) String() string

type Option

type Option func(*options)

func WithClient

func WithClient(client *http.Client) Option

WithClient 自定义http client

func WithClientTrace

func WithClientTrace(t *httptrace.ClientTrace) Option

func WithConnectTimeout

func WithConnectTimeout(timeout time.Duration) Option

WithConnectTimeout 设置连接超时

func WithCookieJar

func WithCookieJar(cookieJar http.CookieJar) Option

func WithDNSResolver

func WithDNSResolver(dnsResolver DNSResolverFunc) Option

func WithDebug

func WithDebug() Option

WithDebug 开启调试模式

func WithDisableKeepAlive

func WithDisableKeepAlive() Option

WithDisableKeepAlive 连接重用

func WithEnableDefaultHeader

func WithEnableDefaultHeader() Option

WithEnableDefaultHeader 设置默认header

func WithMaxIdleConnsPerHost

func WithMaxIdleConnsPerHost(n int) Option

WithMaxIdleConnsPerHost 设置每个host最大空闲连接数

func WithProxyURL

func WithProxyURL(proxyURL string) Option

WithProxyURL 设置代理

func WithRequestInterceptor

func WithRequestInterceptor(i RequestInterceptor) Option

func WithResponseInterceptor

func WithResponseInterceptor(i ResponseInterceptor) Option

func WithRetryTime

func WithRetryTime(retryTimes int) Option

WithRetryTime 设置重试次数

func WithShouldRetryFunc

func WithShouldRetryFunc(f func(*http.Request, *http.Response, error) bool) Option

WithShouldRetryFunc 自定义是否需要重试

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout 设置超时

type Request

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

Request http请求

func NewRequest

func NewRequest(opt ...Option) *Request

NewRequest 创建request

func (*Request) Delete

func (req *Request) Delete(url string, data interface{}, header http.Header) (*Response, error)

Delete Delete请求

func (*Request) Get

func (req *Request) Get(url string, params url.Values, header http.Header) (*Response, error)

Get get请求

func (*Request) Post

func (req *Request) Post(url string, data interface{}, header http.Header) (*Response, error)

Post 普通post请求

func (*Request) PostJSON

func (req *Request) PostJSON(url string, data interface{}, header http.Header) (*Response, error)

PostJSON 发送json body

func (*Request) PostProtoBuf

func (req *Request) PostProtoBuf(url string, v proto.Message, header http.Header) (*Response, error)

PostProtoBuf 发送protoBuf body

func (*Request) Put

func (req *Request) Put(url string, data interface{}, header http.Header) (*Response, error)

Put Put请求

func (*Request) UploadFile

func (req *Request) UploadFile(url string, reader io.Reader, filename string, header http.Header, params map[string]string) (*Response, error)

UploadFile 上传文件

type RequestInterceptor

type RequestInterceptor func(req *http.Request)

type Response

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

Response http响应

func Get

func Get(url string, data url.Values, header http.Header) (*Response, error)

Get get请求

func Post

func Post(url string, data interface{}, header http.Header) (*Response, error)

Post 普通post请求

func PostJSON

func PostJSON(url string, data interface{}, header http.Header) (*Response, error)

PostJSON 发送json body

func (*Response) Bytes

func (resp *Response) Bytes() ([]byte, error)

Bytes 读取http.Body, 返回bytes

func (*Response) DecodeJSON

func (resp *Response) DecodeJSON(v interface{}) error

DecodeJSON json decode

func (*Response) DecodeProtoBuf

func (resp *Response) DecodeProtoBuf(v interface{}) error

DecodeProtoBuf protoBuf decode

func (*Response) Discard

func (resp *Response) Discard() (int64, error)

Discard 丢弃http.body

func (*Response) Header

func (resp *Response) Header() http.Header

Header 获取header

func (*Response) IsStatusOK

func (resp *Response) IsStatusOK() bool

IsStatusOK 响应码是否为200

func (*Response) Raw

func (resp *Response) Raw() *http.Response

Raw 获取原始的http response

func (*Response) String

func (resp *Response) String() (string, error)

String 读取http.Body, 返回string

func (*Response) WriteFile

func (resp *Response) WriteFile(filename string) (int64, error)

WriteFile 读取http.Body内容并写入文件中

func (*Response) WriteTo

func (resp *Response) WriteTo(w io.Writer) (int64, error)

WriteTo 读取http.Body并写入w中

type ResponseInterceptor

type ResponseInterceptor func(req *http.Request, resp *http.Response, err error)