# go-httprequest

**Repository Path**: dxvgef/go-httprequest

## Basic Information

- **Project Name**: go-httprequest
- **Description**: Go语言的HTTP请求包，支持自动重试和多端点轮循以及响应数据转换等功能
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-26
- **Last Updated**: 2023-09-11

## Categories & Tags

**Categories**: web-dev-toolkits

**Tags**: None

## README

# go-httprequest

## 简介
Go语言的HTTP请求包，功能特性：
- 线程安全
- 链式语法
- 支持`GET`,`POST`,`PUT`,`PATCH`,`HEAD`,`DELETE`,`OPTIONS`,`TRACE`方法
- 可按间隔时间和最大次数自动重发请求
- 可定义多个URL轮循请求，当请求失败时自动使用下一个URL重发请求
- 对响应数据进行类型转换

## 导入路径
> github.com/dxvgef/go-httprequest

## 当前版本
> v0.0.9

## 基本示例
```go
package main

import (
	"log"
	
	"github.com/dxvgef/go-httprequest"
)

func main() {
    // 使用默认配置创建请求实例，可传入httprequest.Config{}来自定义配置
    request := httprequest.New()
    
    resp := request.AddHeader("test", "ok").    // 添加Header参数
    AddEndpoint("http://localhost/").    // 添加端点
    GET()   // 执行GET请求
    // 判断请求过程是否出错
    if resp.Error() != nil {
        log.Println(err)
        return
    }

    // 响应状态码
    log.Println(resp.StatusCode())

    // 将响应数据转为string
    str, err := resp.String()
}
```

## `httprequest.Config`参数配置
如果执行`httprequest.New()`时不传入参数，则自动使用默认配置。

默认配置及具体参数说明如下：

```go
var DefaultConfig = Config{
    // 每次请求的超时时间(秒)
    Timeout:       10,
    // 触发重试的响应状态码
    RetryStatus:   []int{500, 502, 503, 504, 506, 507},
    // 每个端点的重试次数
    RetryCount:    1,
    // 每个端点的重试间隔时间(毫秒)
    RetryInterval: 1000,
}
```

## `httprequest.Request`请求
- `AddEndpoint(string)` 添加一个目标端点URL
- `SetEndpoint([])` 设置目标端点URL
- `AddHeader(string, string)` 添加一个头部参数
- `SetHeader(map[string]string)` 设置头部参数
- `AddValue(string, string)` 添加一个请求参数
- `SetValue(url.Values)` 设置请求参数
- `SetBody([]body)` 设置请求正文数据
- `SetJSON(interface{})` 将入参变量进行`JSON`编码并做为请求正文数据
- `SetXML(interface{})` 将入参变量进行`XML`编码并做为请求正文数据
- `GET()` 发送`GET`方法的请求
- `POST()` 发送`POST`方法的请求
- `PUT()` 发送`PUT`方法的请求
- `PATCH()` 发送`PATCH`方法的请求
- `DELETE()` 发送`DELETE`方法的请求
- `OPTIONS()` 发送`OPTIONS`方法的请求
- `HEAD()` 发送`HEAD`方法的请求
- `TRACE()` 发送`TRACE`方法的请求
- `Error() error` 获取请求过程中的错误

## `httprequest.Response`响应

- `Error()` 获取请求过程中的错误
- `Raw()` 获取`*http.Response`
- `Bytes() ([]byte, error)` 将响应的正文数据转为`[]byte`类型
- `String() (string, error)` 将响应的正文数据转为`string`类型
- `ParseQuery() (url.Values, error)` 将响应的正文数据按查询参数格式解析到`net.Values`类型的变量
- `UnmarshalJSON(interface{}) error` 将响应的正文数据进行`JSON`解析到入参变量
- `UnmarshalXML(interface{}) error` 将响应的正文数据进行`XML`解析到入参变量