README.zh-CN.md

Greq

中文说明 | English

greq 一个简单的 HTTP 客户端请求构建器和发送器，支持下载、重试等增强功能。

功能说明

• 链式配置请求，支持 GET,POST,PUT,PATCH,DELETE,HEAD 等通用请求方法
• 自定义提供请求 Body 数据，支持 JSON,XML,Form,MultiPart,File 等格式
• 自定义响应 Body 解析，支持 JSON,XML 等格式
• 支持定义添加任意的中间件
• 支持请求重试功能，可以自定义重试次数、间隔和重试检查器
  • 默认重试检查器 DefaultRetryChecker ，支持对网络错误、5xx服务器错误和429限流错误进行重试
• 支持直接解析并发送 .http 文件格式请求
• 支持上传下载文件
• 内置命令工具
  • cmd/greq 一个简单的 HTTP 请求工具，类似curl同时支持IDEA http 文件格式
  • cmd/gbench 一个简单的 HTTP 请求压力测试工具，类似 ab 测试工具

安装

go get github.com/gookit/greq

安装内置工具

# HTTP 请求工具
go install github.com/gookit/greq/cmd/greq@latest
# HTTP 测试工具
go install github.com/gookit/greq/cmd/gbench@latest

快速开始

package main

import (
	"github.com/gookit/goutil/dump"
	"github.com/gookit/greq"
)

func main() {
	resp, err := greq.New("https://httpbin.org").
		JSONType().
		UserAgent("custom-client/1.0").
		Get("/get")

	if err != nil {
		panic(err)
	}

	retMp := make(map[string]any)
	err = resp.Decode(&retMp)
	if err != nil {
		panic(err)
	}

	dump.P(retMp)
}

Result:

PRINT AT github.com/gookit/greq_test.TestHReq_Send(greq_test.go:73)
map[string]interface {} { #len=4
  "args": map[string]interface {} { #len=0
  },
  "headers": map[string]interface {} { #len=4
    "Host": string("httpbin.org"), #len=11
    "User-Agent": string("custom-client/1.0"), #len=17
    "X-Amzn-Trace-Id": string("Root=1-61e4d41e-06e27ae12ff872a224373ca7"), #len=40
    "Accept-Encoding": string("gzip"), #len=4
  },
  "origin": string("222.210.59.218"), #len=14
  "url": string("https://httpbin.org/get"), #len=23
},

使用中间件

	buf := &bytes.Buffer{}
	mid0 := greq.MiddleFunc(func(r *http.Request, next greq.HandleFunc) (*greq.Response, error) {
		buf.WriteString("MID0>>")
		w, err := next(r)
		buf.WriteString(">>MID0")
		return w, err
	})

	mid1 := greq.MiddleFunc(func(r *http.Request, next greq.HandleFunc) (*greq.Response, error) {
		buf.WriteString("MID1>>")
		w, err := next(r)
		buf.WriteString(">>MID1")
		return w, err
	})

	mid2 := greq.MiddleFunc(func(r *http.Request, next greq.HandleFunc) (*greq.Response, error) {
		buf.WriteString("MID2>>")
		w, err := next(r)
		buf.WriteString(">>MID2")
		return w, err
	})

	resp, err := greq.New("https://httpbin.org").
		Doer(httpreq.DoerFunc(func(req *http.Request) (*http.Response, error) {
			tw := httptest.NewRecorder()
			buf.WriteString("(CORE)")
			return tw.Result(), nil
		})).
		Middleware(mid0, mid1, mid2).
		Get("/get")

    fmt.Println(buf.String())

Output:

MID2>>MID1>>MID0>>(CORE)>>MID0>>MID1>>MID2

更多使用

Response to string

greq.Response.String() 可以将响应转换为字符串，方便观察结果。

package main

import (
	"fmt"

	"github.com/gookit/goutil/dump"
	"github.com/gookit/greq"
)

func main() {
	resp, err := greq.New("https://httpbin.org").
		UserAgent("custom-client/1.0").
		Send("/get")

	if err != nil {
		panic(err)
	}

	fmt.Print(resp.String())
}

Output:

HTTP/2.0 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Date: Tue, 18 Jan 2022 04:52:39 GMT
Content-Type: application/json
Content-Length: 272
Server: gunicorn/19.9.0

{
  "args": {},
  "headers": {
    "Accept-Encoding": "gzip",
    "Host": "httpbin.org",
    "User-Agent": "custom-client/1.0",
    "X-Amzn-Trace-Id": "Root=1-61e64797-3e428a925f7709906a8b7c01"
  },
  "origin": "222.210.59.218",
  "url": "https://httpbin.org/get"
}

命令工具使用

greq 工具

greq 是一个简单的 HTTP 请求工具，类似 curl，支持 IDEA http 文件格式。

安装工具：

go install github.com/gookit/greq/cmd/greq@latest

查看选项：

greq -h

使用示例：

greq https://httpbin.org/get
greq -X POST -d '{"name": "inhere"}' https://httpbin.org/post

gbench 工具

gbench 是一个 HTTP 负载压力测试工具，类似 ab 测试工具。

安装工具：

go install github.com/gookit/greq/cmd/gbench@latest

查看选项：

gbench -h

使用示例：

gbench -c 10 -n 100 https://httpbin.org/get
gbench -c 10 -n 100 -d '{"name": "inhere"}' https://httpbin.org/post

Refers

• https://github.com/dghubble/sling
• https://github.com/zhshch2002/goreq
• https://github.com/go-resty/resty
• https://github.com/monaco-io/request