go工具库：hertz api框架 hertz client的使用

介绍

Hertz 是 字节跳动（ByteDance）开源的高性能 Golang 微服务框架，用于构建 Web 服务，特别适合对性能要求极高的场景。

基于字节内部自研的网络库 netpoll，具备极低的延迟和高并发能力。

对比标准库 net/http，在 QPS、RT、内存占用等指标上表现更优秀。

灵活易用
支持中间件机制，兼容 Gin 风格。

可插拔的组件设计，便于自定义协议栈、序列化方式、拦截器等。

支持自动路由注册（借助 IDL 工具）。

全面功能
路由、请求解析、响应封装

自动生成 HTTP 服务代码（结合 Kitex 使用）

内建 metrics、pprof、tracing、限流、熔断、超时等能力

多种序列化支持：JSON、Protobuf、Thrift、MsgPack 等

微服务友好
适配 CloudWeGo 微服务生态，和 Kitex 天然集成。

支持服务注册、发现、链路追踪等。

一个示例：

package main

import (
    "github.com/cloudwego/hertz/pkg/app"
    "github.com/cloudwego/hertz/pkg/app/server"
)

func main() {
    h := server.Default()

    h.GET("/ping", func(c context.Context, ctx *app.RequestContext) {
        ctx.JSON(200, map[string]string{
            "message": "pong",
        })
    })

    h.Spin()
}

创建client

创建一个标准的client
纯净的golang http client，sdk 一般用这个

package main


func main() {
   c, err := client.NewClient()
   // your code after this
}

使用配置创建标准的client

package main

import (
   "time"

)

func main() {
   c, err := client.NewClient(client.WithDialTimeout(1 * time.Second))
   //your code after this
}

支持的配置项

Hertz Client 配置表

使用配置创建byted client

package main

import (
   "time"

)

func main() {
   c, err := byted.NewClient(byted.WithAppClientOptions(client.WithDialTimeout(1 * time.Second)))
}

支持的配置项

发起请求

1. Do
   func (c *Client) Do(ctx context.Context,req *Request, resp Response) error
   Do会发送请求并将响应内容写入resp中，该函数不支持重定向跳转，如要使用，请使用DoRedirects或者Get方法
   package main

import (
   "context"
   "fmt"

  
)

func main() {
   c, err := byted.NewClient()
   if err != nil {
      return
   }
   req := &protocol.Request{}
   res := &protocol.Response{}
   req.SetMethod(consts.MethodGet)                            //设置请求方法
   req.Header.SetContentTypeBytes([]byte("application/json")) //设置请求header
   req.SetRequestURI("http://example.com")                    //设置请求url
   err = c.Do(context.Background(), req, res)
   if err != nil {
      return
   }
   fmt.Printf("%v", string(res.Body())) //读取响应body
}

2. DoDeadline
   func (c *Client) DoDeadline(ctx context.Context,req *Request, resp Response, deadline time.Time) error
   DoDeadline会发送请求并将响应内容写入resp中，如果在给定截止日期（deadline）后没有响应则会返回github.com/cloudwego/hertz/pkg/common/errors 下的 error.ErrTimeout 错误。该方法不支持重定向跳转，如要使用，请使用DoRedirects或者Get方法
   该方法会和 Mesh 的超时联动

package main

import (
   "context"
   "fmt"
   "time"


)

func main() {
   c, err := byted.NewClient()
   if err != nil {
      return
   }
   req := &protocol.Request{}
   res := &protocol.Response{}
   req.SetMethod(consts.MethodGet)         //设置请求方法
   req.SetRequestURI("http://example.com") //设置请求url
   c.DoDeadline(context.Background(), req, res, time.Now().Add(1*time.Second))
   fmt.Printf("%v\n", string(res.Body()))
}

3. DoRedirects
   func (c *Client) DoRedirects(ctx context.Context,req *Request, resp *Response, maxRedirectsCount int) error
   Hertz Client DoRedirects 接口预期外 404
   DoRedirects与Do的区别是它支持重定向跳转，当重定向次数超过maxRedirectsCount时会返回error

package main

import (
   "context"
   "fmt"


)

func main() {
   c, err := byted.NewClient()
   if err != nil {
      return
   }
   req := &protocol.Request{}
   res := &protocol.Response{}
   req.SetMethod(consts.MethodGet)                            //设置请求方法
   req.Header.SetContentTypeBytes([]byte("application/json")) //设置请求header
   req.SetRequestURI("http://example.com")                    //设置请求url
   err = c.DoRedirects(context.Background(), req, res, 1)
   if err != nil {
      return
   }
   fmt.Printf("%v\n", string(res.Body())) //读取响应body
}

4. DoTimeout
   func (c *Client) DoTimeout(ctx context.Context,req *Request, resp Response, timeout time.Duration) error
   DoTimeout发送给定的请求并将响应内容写入resp中，如果在给定超时时间（timeout）后没有响应则会返回timeout错误。该方法不支持重定向跳转，如要使用，请使用DoRedirects或者Get方法
   该方法会和 Mesh 的超时联动，这个超时会传递给 mesh，以代码超时为准

package main

import (
   "context"
   "fmt"
   "time"


)

func main() {
   c, err := byted.NewClient()
   if err != nil {
      return
   }
   req := &protocol.Request{}
   res := &protocol.Response{}
   req.SetMethod(consts.MethodGet)                            //设置请求方法
   req.Header.SetContentTypeBytes([]byte("application/json")) //设置请求header
   req.SetRequestURI("http://example.com")                    //设置请求url
   err = c.DoTimeout(context.Background(), req, res, 1*time.Second)
   if err != nil {
      return
   }
   fmt.Printf("%v\n", string(res.Body())) //读取响应body
}

5. Get
   func (c *Client) Get(ctx context.Context,dst []byte, url string) (statusCode int, body []byte, err error)
   Get会根据url返回相应的状态码和响应body；dst会被替换成响应body(响应的body会赋值给dst)，如果dst太小会分配一个新的slice；该方法支持重定向跳转

package main

import (
   "context"
   "fmt"

)

func main() {
   c, err := byted.NewClient()
   if err != nil {
      return
   }
   status, body, _ := c.Get(context.Background(), nil, "http://google.com")
   fmt.Printf("status=%v body=%v\n", status, string(body))
}

6. GetDeadline
   func (c *Client) GetDeadline(ctx context.Context,dst []byte, url string, deadline time.Time) (statusCode int, body []byte, err error)
   GetDeadline会根据url返回相应的状态码和响应body；如果在给定截止日期（deadline）后没有响应则会返回timeout错误，dst会被替换成响应请求body，如果dst太小会分配一个新的slice；该方法支持重定向跳转

package main

import (
   "context"
   "fmt"
   "time"

)

func main() {
   c, err := byted.NewClient()
   if err != nil {
      return
   }
   status, body, _ := c.GetDeadline(context.Background(), nil, "http://google.com", time.Now().Add(1*time.Second))
   fmt.Printf("status=%v body=%v\n", status, string(body))
}

7. GetTimeout
   func (c *Client) GetTimeout(ctx context.Context,dst []byte, url string, timeout time.Duration) (statusCode int, body []byte, err error)
   GetTimeout会根据url返回相应的状态码和响应body；如果在给定超时时间（timeout）后没有响应则会返回hertz.ErrTimeout错误，dst会被替换成响应请求body，如果dst太小会分配一个新的slice；该方法支持重定向跳转

package main

import (
   "context"
   "fmt"
   "time"

)

func main() {
   c, err := byted.NewClient()
   if err != nil {
      return
   }
   status, body, _ := c.GetTimeout(context.Background(), nil, "http://google.com", 1*time.Second)
   fmt.Printf("status=%v body=%v\n", status, string(body))
}

8. Post
   func (c *Client) Post(ctx context.Context,dst []byte, url string, postArgs *Args) (statusCode int, body []byte, err error)
   Post会根据url和post参数发送post请求，dst会被替换成响应请求body(响应的body会赋值给dst)，如果dst太小会分配一个新的slice；该方法支持重定向跳转；使用的content-type是application/x-www-url-form

package main

import (
   "context"
   "fmt"


)

func main() {
   c, err := byted.NewClient()
   if err != nil {
      return
   }

   var postArgs protocol.Args
   postArgs.Set("arg", "a") //设置post请求参数
   status, body, _ := c.Post(context.Background(), nil, "http://google.com", &postArgs)
   fmt.Printf("status=%v body=%v\n", status, string(body))
}

发起multipart/form-data请求

package main

import (
   "context"

  
)

func main() {
   client, err := byted.NewClient()
   if err != nil {
      return
   }
   req := &protocol.Request{}
   res := &protocol.Response{}
   req.Header.SetMethod(consts.MethodPost) //设置请求方法
   req.SetRequestURI("http://example.com") //设置请求url
   req.SetMultipartFormData(map[string]string{
      "msg": "test message",
   })
   err = client.Do(context.Background(), req, res)
   return
}