阅读(3622) (12)

GoFrame HTTPClient-链式操作

2022-04-12 11:28:33 更新

链式操作

GoFrame​框架的客户端支持便捷的链式操作,常用方法如下:

func (c *Client) Timeout(t time.Duration) *Client
func (c *Client) Cookie(m map[string]string) *Client
func (c *Client) Header(m map[string]string) *Client
func (c *Client) HeaderRaw(headers string) *Client
func (c *Client) ContentType(contentType string) *Client
func (c *Client) ContentJson() *Client
func (c *Client) ContentXml() *Client
func (c *Client) BasicAuth(user, pass string) *Client
func (c *Client) Retry(retryCount int, retryInterval time.Duration) *Client
func (c *Client) Prefix(prefix string) *Client
func (c *Client) Proxy(proxyURL string) *Client
func (c *Client) RedirectLimit(redirectLimit int) *Client
func (c *Client) Dump(dump ...bool) *Client
func (c *Client) Use(handlers ...HandlerFunc) *Client

简要说明:

  • Timeout​方法用于设置当前请求超时时间。
  • Cookie​方法用于设置当前请求的自定义​Cookie​信息。
  • Header*​方法用于设置当前请求的自定义​Header​信息。
  • Content*​方法用于设置当前请求的​Content-Type​信息,并且支持根据该信息自动检查提交参数并自动编码。
  • BasicAuth​方法用于设置​HTTP Basic Auth​校验信息。
  • Retry​方法用于设置请求失败时重连次数和重连间隔。
  • Proxy​方法用于设置​http​访问代理。
  • RedirectLimit​方法用于限制重定向跳转次数。

使用示例

示例1,请求超时控制

g.Client().Timeout(3*time.Second).GetContent(ctx, "http://user.svc/v1/user/info/1")
g.Client().Timeout(10*time.Second).PostContent(ctx, "http://order.svc/v1/order/create", g.Map{
    "uid"         : 1,
    "sku_id"      : 10000,
    "amount"      : 19.99,
    "create_time" : "2020-03-26 12:00:00",
})

示例2,自定义Cookie

g.Client().SetCookie("sessionid", "MNV5432PIY76").GetContent(ctx, "http://user.svc/v1/user/info/1")

示例3,自定义Header

g.Client().SetHeader("RequestId", "XVF654RT98UJNMN641V06Y").GetContent(ctx, "http://user.svc/v1/user/info/1")
g.Client().HeaderRaw(`
Referer: https://goframe.org/
User-Agent: MyTesyClient
`).GetContent(ctx, "http://user.svc/v1/user/info")

示例4,提交Json请求

g.Client().ContentJson().PostContent(ctx, "http://order.svc/v1/order/create", g.Map{
    "uid"         : 1,
    "sku_id"      : 10000,
    "amount"      : 19.99,
    "create_time" : "2020-03-26 12:00:00",
})

该请求将会将​Content-Type​设置为​application/json​,并且将提交参数自动编码为​Json​:

{"uid":1,"sku_id":10000,"amount":19.99,"create_time":"2020-03-26 12:00:00"}

示例5,提交Xml请求

g.Client().ContentXml().PostContent(ctx, "http://order.svc/v1/order/create", g.Map{
    "uid"         : 1,
    "sku_id"      : 10000,
    "amount"      : 19.99,
    "create_time" : "2020-03-26 12:00:00",
})

该请求将会将​Content-Type​设置为​application/xml​,并且将提交参数自动编码为​Xml​:

<doc><amount>19.99</amount><create_time>2020-03-26 12:00:00</create_time><sku_id>10000</sku_id><uid>1</uid></doc>