基本使用

最基本的HTTP客户端使用是通过HTTP Method同名的几个操作方法来发送请求,但需要注意的是返回的结果对象需要执行Close防止内存溢出。我们来看几个HTTP客户端请求的简单示例。

发送GET请求,打印出返回值

  1. if r, err := g.Client().Get(ctx, "https://goframe.org"); err != nil {
  2. panic(err)
  3. }
  4. defer r.Close()
  5. fmt.Println(r.ReadAllString())

发送GET请求,下载远程文件

  1. if r, err := g.Client().Get(ctx, "https://goframe.org/cover.png"); err != nil {
  2. panic(err)
  3. }
  4. defer r.Close()
  5. gfile.PutBytes("/Users/john/Temp/cover.png", r.ReadAll())

下载文件操作,小文件下载非常简单。需要注意的是,如果远程文件比较大时,服务端会分批返回数据,因此会需要客户端发多个GET请求,每一次通过Header来请求分批的文件范围长度,感兴趣的同学可自行研究相关细节。

发送POST请求,打印出返回值

  1. if r, err := g.Client().Post(ctx, "http://127.0.0.1:8199/form", "name=john&age=18"); err != nil {
  2. panic(err)
  3. }
  4. defer r.Close()
  5. fmt.Println(r.ReadAllString())

传递多参数的时候用户可以使用&符号进行连接,注意参数值往往需要通过gurl.Encode编码一下。

发送POST请求,参数为map类型,打印出返回值

  1. if r, err := g.Client().Post(
  2. ctx,
  3. "http://127.0.0.1:8199/form",
  4. g.Map{
  5. "submit" : "1",
  6. "callback" : "http://127.0.0.1/callback?url=http://baidu.com",
  7. }
  8. )); err != nil {
  9. panic(err)
  10. }
  11. defer r.Close()
  12. fmt.Println(r.ReadAllString())

传递多参数的时候用户可以使用&符号进行连接,也可以直接使用map其实之前也提到,任意数据类型都支持,包括struct)。

发送POST请求,参数为JSON数据,打印出返回值

  1. if r, err := g.Client().Post(
  2. ctx,
  3. "http://user.svc/v1/user/create",
  4. `{"passport":"john","password":"123456","password-confirm":"123456"}`,
  5. ); err != nil {
  6. panic(err)
  7. }
  8. defer r.Close()
  9. fmt.Println(r.ReadAllString())

可以看到,通过ghttp客户端发送JSON数据请求非常方便,直接通过Post方法提交即可。当没有显式设置ContentType时,客户端会自动识别参数类型并将请求的Content-Type设置为application/json

发送DELETE请求,打印出返回值

  1. if r, err := g.Client().Delete(ctx, "http://user.svc/v1/user/delete/1", "10000"); err != nil {
  2. panic(err)
  3. }
  4. defer r.Close()
  5. fmt.Println(r.ReadAllString())

*Bytes*Content方法

BytesContent后缀结尾的请求方法为直接获取返回内容的快捷方法,这些方法将会自动读取服务端返回内容并自动关闭请求连接*Bytes方法用于获取[]byte类型结果,*Content方法用于获取string类型结果。需要注意的是,如果请求执行失败,返回内容将会为空。

发送GET请求,打印出返回值

  1. // 返回content为[]bytes类型
  2. content := g.Client().GetBytes(ctx, "https://goframe.org")
  1. // 返回content为string类型
  2. content := g.Client().GetContent(ctx, "https://goframe.org")

发送POST请求,打印出返回值

  1. // 返回content为[]bytes类型
  2. content := g.Client().PostBytes(
  3. ctx,
  4. "http://user.svc/v1/user/create",
  5. `{"passport":"john","password":"123456","password-confirm":"123456"}`,
  6. )
  1. // 返回content为string类型
  2. content := g.Client().PostContent(
  3. ctx,
  4. "http://user.svc/v1/user/create",
  5. `{"passport":"john","password":"123456","password-confirm":"123456"}`,
  6. )

*Var方法

Var后缀结尾的请求方法直接请求并获取HTTP接口结果为g.Var泛型类型便于下一步执行类型转换,特别是将请求结果转换到结构体对象上。往往用于服务端返回格式为JSON/XML的情况,通过返回的g.Var泛型对象可根据需要自动解析。此外,如果请求失败或者请求结果为空,会返回一个空的g.Var泛型对象,不影响转换方法调用。

使用示例:

  1. type User struct {
  2. Id int
  3. Name string
  4. }
  1. // Struct
  2. var user *User
  3. g.Client().GetVar(ctx, url).Scan(&user)
  1. // Struct数组
  2. var users []*User
  3. g.Client().GetVar(ctx, url).Scan(&users)