simpleRequest/README.MD

189 lines
4.3 KiB
Plaintext
Raw Normal View History

2022-03-17 08:06:20 +00:00
# simpleRequest
2022-03-14 03:29:59 +00:00
## 说明
[simpleRequest](www.github.com/dorlolo/simpleRequest) 是基于golang原生http库的封装适合用来对第三方接口进行快速地对接和开发。
它具备以下特点:
- 相对于其它请求库,更易于理解和使用。极大减少了开发过程中的代码量和资料查询时间。
- 适合对接一些未遵循restful规范的接口。
2022-03-13 13:24:29 +00:00
## 如何使用?
### 模块导入
```go
2022-03-13 13:43:07 +00:00
import "github.com/dorlolo/simpleRequest"
2022-03-13 13:24:29 +00:00
```
### 实例化
```go
2022-03-13 13:43:07 +00:00
var r = simpleRequest.NewRequest()
2022-03-13 13:24:29 +00:00
```
### 添加请求头
#### 单个赋值
```go
r.Headers().Set("token", "d+jfdji*D%1=")
r.Headers().Set("Content-Type", "application/json")
```
#### map赋值
```go
mapHeaders:= map[string]string{
"token": "d+jfdji*D%1=",
"Content-Type": "application/json",
}
r.Headers().Sets(mapHeaders)
```
#### 链式赋值
```go
r.Headers().Set("token", "d+jfdji*D%1=").Set("Content-Type", "application/json")
```
2022-03-16 01:43:46 +00:00
#### 添加多值
对单个key添加多只不要使用`.set`,因为原先的值会被覆盖
```go
r.Headers().Set("Accept", "text/html")
r.Headers().Add("Accept","application/xhtml+xml")
r.Headers().Add("Accept","application/xml;q=0.8")
r.Headers().Add("Accept","image/webp")
r.Headers().Add("Accept","*/*;q=0.8")
```
2022-03-13 13:24:29 +00:00
#### 使用预设的key
```go
2022-03-14 03:29:59 +00:00
r.Headers().SetConentType("application/json")
//r.Headers().Set("Content-Type", "application/json")
2022-03-13 13:24:29 +00:00
r.Headers().SetUserAgent("Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/14.0.835.163 Safari/535.1"")
//r.Headers().Set("User-Agent",Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/14.0.835.163 Safari/535.1")
2022-03-14 03:29:59 +00:00
r.Headers().SetConentEncoding("gzip, deflate, br")
//r.Headers().Set("Content-Encoding", "gzip, deflate, br")
2022-03-13 13:24:29 +00:00
```
2022-03-14 03:29:59 +00:00
2022-03-13 13:24:29 +00:00
#### 使用预设的key-value
```go
//随机user-agent
r.Headers().SetRandomUerAgent()
//r.Headers().Set("User-Agent", "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/14.0.835.163 Safari/535.1")
r.Headers().ConentType_json()
//r.Headers().Set("Content-Type", "application/json")
r.Headers()ConentType_formData()
//r.Headers().Set("Content-Type","multipart/form-data")
r.Headers()ConentType_formUrlencoded()
//r.Headers().Set("Content-Type","application/x-www-form-urlencoded")
r.Headers()ConentType_textPlain()
//r.Headers().Set("Content-Type","text/plain; charset=utf-8")
```
### 添加queryParams
#### 单个赋值
```go
r.QueryParams().Set("user", "dorlolo")
```
#### map赋值
不会覆盖上面之前填充过的参数
```go
pamarsBulid := make(map[string]interface{})
pamarsBulid["passwd"] = "123456"
pamarsBulid["action"] = "login"
r.QueryParams().Sets(pamarsBulid)
```
#### 链式赋值
```go
r.QueryParams().Set("user", "dorlolo").Set("passwd","123456")
```
#### 获取url.Values对象进行赋值
对象类型为`*url.Values`,取到地址后,可以使用`url.Values`中的方法继续进行赋值
```go
qpData:=r.QueryParams().Gets()
qpData.Add("age","18")
```
### 添加请求体body
#### 单个赋值
```go
r.Body().Set("beginDate", "2022-03-01").Set("endDate", "2022-03-03")
```
#### map赋值
```go
2022-03-17 08:06:20 +00:00
bodyBulid := map[string]interface{}{
2022-03-13 13:24:29 +00:00
"beginDate":"2022-03-01",
"endDate":"2022-03-03",
}
r.Body().Sets(bodyBulid)
```
#### 链式赋值
```go
r.Body().Set("beginDate", "2022-03-01").Set("endDate", "2022-03-03")
```
#### 字符串赋值
2022-03-16 08:47:46 +00:00
json格式不要使用此方法
2022-03-13 13:24:29 +00:00
```go
bodydata:=`{"devSn":"230000000008","type":"day"}`
r.Body().SetString(bodydata)
```
### 其它请求参数
#### 设置超时时间
```go
r.TimeOut(time.Second * 30)
```
#### 跳过证书验证
```go
r.SkipCertVerify()
```
### 发送请求
#### post请求
```go
res, err :=r.Post("https://127.0.0.1:80/excample")
if err != nil {
ftm.Println( "error occured", err)
} else {
fmt.Println(res)
}
```
#### get请求
```go
res, err :=r.Get("https://127.0.0.1:80/excample")
if err != nil {
ftm.Println( "error occured", err)
} else {
fmt.Println(res)
}
```
2022-03-17 08:18:15 +00:00
#### 其它类型的请求
2022-03-13 13:24:29 +00:00
后续支持...敬请期待
### 获取上下文
请注意,需要完成请求后才能获得上下文数据!
2022-03-14 03:29:59 +00:00
#### 获取请求的上下文对象
2022-03-13 13:24:29 +00:00
```go
requestContext:=r.Request
```
2022-03-14 03:29:59 +00:00
#### 获取返回的上下文对象
2022-03-13 13:24:29 +00:00
```go
responseContext:=r.Response
```
## 使用示例
[simpleRequest_test.go](./test/simpleRequest_test.go)