release v2.1.6

doc: add source code link for http_client
doc: update readme file
2026-03-01 00:35:28 +08:00 · 2022-08-31 17:07:32 +08:00 · 2022-08-31 15:56:41 +08:00 · 2022-08-31 11:40:24 +08:00 · 2022-08-31 11:20:22 +08:00 · 2022-08-30 17:33:58 +08:00
6 changed files with 838 additions and 37 deletions
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 <br/>

 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.1.5-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.6-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
@@ -35,9 +35,9 @@ English | [简体中文](./README_zh-CN.md)
 go get github.com/duke-git/lancet/v2 // will install latest version of v2.x.x
 ```

-2. <b>For users who use version below go1.18, you should install v1.x.x. now latest v1 is v1.3.1. </b>
+2. <b>For users who use version below go1.18, you should install v1.x.x. now latest v1 is v1.3.2. </b>
 ```go
-go get github.com/duke-git/lancet@v1.3.1 // below go1.18, install latest version of v1.x.x
+go get github.com/duke-git/lancet@v1.3.2 // below go1.18, install latest version of v1.x.x
 ```

 ## Usage
@@ -351,11 +351,17 @@ import "github.com/duke-git/lancet/v2/netutil"
 - [GetRequestPublicIp](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetRequestPublicIp)
 - [IsPublicIP](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsPublicIP)
 - [IsInternalIP](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsInternalIP)
- [HttpGet](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpGet)
- [HttpDelete](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpDelete)
- [HttpPost](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPost)
- [HttpPut](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPut)
- [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPatch)
+- [HttpRequest](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpRequest)
+- [HttpClient](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpClient)
+- [SendRequest](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#SendRequest)
+- [DecodeResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#DecodeResponse)
+- [StructToUrlValues](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#StructToUrlValues)
+
+- [HttpGet<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpGet)
+- [HttpDelete<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpDelete)
+- [HttpPost<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPost)
+- [HttpPut<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPut)
+- [HttpPatch<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPatch)
 - [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#ParseHttpResponse)

 ### 14. Random package implements some basic functions to generate random int and string.
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -4,7 +4,7 @@
 <br/>

 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.1.5-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.6-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
@@ -35,9 +35,9 @@
 go get github.com/duke-git/lancet/v2 //安装v2最新版本v2.x.x
 ```

-2. <b>使用go1.18以下版本的用户，必须安装v1.x.x。目前最新的v1版本是v1.3.1。</b>
+2. <b>使用go1.18以下版本的用户，必须安装v1.x.x。目前最新的v1版本是v1.3.2。</b>
 ```go
-go get github.com/duke-git/lancet@v1.3.1 // 使用go1.18以下版本, 必须安装v1.x.x版本
+go get github.com/duke-git/lancet@v1.3.2 // 使用go1.18以下版本, 必须安装v1.x.x版本
 ```

 ## 用法
@@ -348,11 +348,17 @@ import "github.com/duke-git/lancet/v2/netutil"
 - [GetRequestPublicIp](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#GetRequestPublicIp)
 - [IsPublicIP](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#IsPublicIP)
 - [IsInternalIP](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#IsInternalIP)
- [HttpGet](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpGet)
- [HttpDelete](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpDelete)
- [HttpPost](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPost)
- [HttpPut](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPut)
- [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPatch)
+- [HttpRequest](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpRequest)
+- [HttpClient](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpClient)
+- [SendRequest](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#SendRequest)
+- [DecodeResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#DecodeResponse)
+- [StructToUrlValues](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#StructToUrlValues)
+
+- [HttpGet<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpGet)
+- [HttpDelete<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpDelete)
+- [HttpPost<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPost)
+- [HttpPut<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPut)
+- [HttpPatch<sup>Deprecated</sup>](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPatch)
 - [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#ParseHttpResponse)

 ### 14. random随机数生成器包，可以生成随机[]bytes, int, string。
--- a/docs/netutil.md
+++ b/docs/netutil.md
@@ -7,6 +7,8 @@ Package netutil contains functions to get net information and send http request.

 - [https://github.com/duke-git/lancet/blob/main/netutil/net.go](https://github.com/duke-git/lancet/blob/main/netutil/net.go)

+- [https://github.com/duke-git/lancet/blob/main/netutil/http_client.go](https://github.com/duke-git/lancet/blob/main/netutil/http_client.go)
+
 - [https://github.com/duke-git/lancet/blob/main/netutil/http.go](https://github.com/duke-git/lancet/blob/main/netutil/http.go)

 <div STYLE="page-break-after: always;"></div>
@@ -31,11 +33,17 @@ import (
 - [GetRequestPublicIp](#GetRequestPublicIp)
 - [IsPublicIP](#IsPublicIP)
 - [IsInternalIP](#IsInternalIP)
- [HttpGet](#HttpGet)
- [HttpDelete](#HttpDelete)
- [HttpPost](#HttpPost)
- [HttpPut](#HttpPut)
- [HttpPatch](#HttpPatch)
+- [HttpRequest](#HttpRequest)
+- [HttpClient](#HttpClient)
+- [SendRequest](#SendRequest)
+- [DecodeResponse](#DecodeResponse)
+- [StructToUrlValues](#StructToUrlValues)
+
+- [HttpGet<sup>Deprecated</sup>](#HttpGet)
+- [HttpDelete<sup>Deprecated</sup>](#HttpDelete)
+- [HttpPost<sup>Deprecated</sup>](#HttpPost)
+- [HttpPut<sup>Deprecated</sup>](#HttpPut)
+- [HttpPatch<sup>Deprecated</sup>](#HttpPatch)
 - [ParseHttpResponse](#ParseHttpResponse)

 <div STYLE="page-break-after: always;"></div>
@@ -335,8 +343,232 @@ func main() {
 ```


+### <span id="HttpRequest">HttpRequest</span>
+<p>HttpRequest is a struct used to abstract HTTP request entity.</p>

-### <span id="HttpGet">HttpGet</span>
+<b>Signature:</b>
+
+```go
+type HttpRequest struct {
+	RawURL      string
+	Method      string
+	Headers     http.Header
+	QueryParams url.Values
+	FormData    url.Values
+	Body        []byte
+}
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	header := http.Header{}
+	header.Add("Content-Type", "multipart/form-data")
+
+	postData := url.Values{}
+	postData.Add("userId", "1")
+	postData.Add("title", "testItem")
+
+	request := &netutil.HttpRequest{
+		RawURL:   "https://jsonplaceholder.typicode.com/todos",
+		Method:   "POST",
+		Headers:  header,
+		FormData: postData,
+	}
+}
+```
+
+
+### <span id="HttpClient">HttpClient</span>
+<p>HttpClient is a struct used to send HTTP request. It can be instanced with some configurations or none config.</p>
+
+<b>Signature:</b>
+
+```go
+type HttpClient struct {
+	*http.Client
+	TLS     *tls.Config
+	Request *http.Request
+	Config  HttpClientConfig
+}
+
+type HttpClientConfig struct {
+	SSLEnabled       bool
+	TLSConfig        *tls.Config
+	Compressed       bool
+	HandshakeTimeout time.Duration
+	ResponseTimeout  time.Duration
+	Verbose          bool
+}
+
+func NewHttpClient() *HttpClient
+
+func NewHttpClientWithConfig(config *HttpClientConfig) *HttpClient
+
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+	"time"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	httpClientCfg := netutil.HttpClientConfig{
+		SSLEnabled: true,
+		HandshakeTimeout:10 * time.Second
+	}
+	httpClient := netutil.NewHttpClientWithConfig(&httpClientCfg)
+}
+```
+
+
+
+### <span id="SendRequest">SendRequest</span>
+<p>Use HttpClient to send HTTP request.</p>
+
+<b>Signature:</b>
+
+```go
+func (client *HttpClient) SendRequest(request *HttpRequest) (*http.Response, error)
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+	"time"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	request := &netutil.HttpRequest{
+		RawURL: "https://jsonplaceholder.typicode.com/todos/1",
+		Method: "GET",
+	}
+
+	httpClient := netutil.NewHttpClient()
+	resp, err := httpClient.SendRequest(request)
+	if err != nil || resp.StatusCode != 200 {
+		log.Fatal(err)
+	}
+
+	type Todo struct {
+		UserId    int    `json:"userId"`
+		Id        int    `json:"id"`
+		Title     string `json:"title"`
+		Completed bool   `json:"completed"`
+	}
+
+	var todo Todo
+	httpClient.DecodeResponse(resp, &todo)
+
+	fmt.Println(todo.Id) //1
+}
+```
+
+
+
+### <span id="DecodeResponse">DecodeResponse</span>
+<p>Decode http response into target object.</p>
+
+<b>Signature:</b>
+
+```go
+func (client *HttpClient) DecodeResponse(resp *http.Response, target any) error
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+	"time"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	request := &netutil.HttpRequest{
+		RawURL: "https://jsonplaceholder.typicode.com/todos/1",
+		Method: "GET",
+	}
+
+	httpClient := netutil.NewHttpClient()
+	resp, err := httpClient.SendRequest(request)
+	if err != nil || resp.StatusCode != 200 {
+		log.Fatal(err)
+	}
+
+	type Todo struct {
+		UserId    int    `json:"userId"`
+		Id        int    `json:"id"`
+		Title     string `json:"title"`
+		Completed bool   `json:"completed"`
+	}
+
+	var todo Todo
+	httpClient.DecodeResponse(resp, &todo)
+
+	fmt.Println(todo.Id) //1
+}
+```
+
+
+### <span id="StructToUrlValues">StructToUrlValues</span>
+<p>Convert struct to url values, only convert the field which is exported and has `json` tag.</p>
+
+<b>Signature:</b>
+
+```go
+func StructToUrlValues(targetStruct any) url.Values
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	type TodoQuery struct {
+		Id     int `json:"id"`
+		UserId int `json:"userId"`
+	}
+	todoQuery := TodoQuery{
+		Id:     1,
+		UserId: 2,
+	}
+	todoValues := netutil.StructToUrlValues(todoQuery)
+
+	fmt.Println(todoValues.Get("id")) //1
+	fmt.Println(todoValues.Get("userId")) //2
+}
+```
+
+
+
+### <span id="HttpGet">HttpGet (Deprecated: use SendRequest for replacement)</span>
 <p>Send http get request.</p>

 <b>Signature:</b>
@@ -378,7 +610,7 @@ func main() {



-### <span id="HttpPost">HttpPost</span>
+### <span id="HttpPost">HttpPost (Deprecated: use SendRequest for replacement)</span>
 <p>Send http post request.</p>

 <b>Signature:</b>
@@ -427,7 +659,7 @@ func main() {



-### <span id="HttpPut">HttpPut</span>
+### <span id="HttpPut">HttpPut (Deprecated: use SendRequest for replacement)</span>
 <p>Send http put request.</p>

 <b>Signature:</b>
@@ -477,7 +709,7 @@ func main() {



-### <span id="HttpDelete">HttpDelete</span>
+### <span id="HttpDelete">HttpDelete (Deprecated: use SendRequest for replacement)</span>
 <p>Send http delete request.</p>

 <b>Signature:</b>
@@ -516,7 +748,7 @@ func main() {



-### <span id="HttpPatch">HttpPatch</span>
+### <span id="HttpPatch">HttpPatch (Deprecated: use SendRequest for replacement)</span>
 <p>Send http patch request.</p>

 <b>Signature:</b>
--- a/docs/netutil_zh-CN.md
+++ b/docs/netutil_zh-CN.md
@@ -6,6 +6,9 @@ netutil网络包支持获取ip地址，发送http请求。
 ## 源码:

 - [https://github.com/duke-git/lancet/blob/main/netutil/net.go](https://github.com/duke-git/lancet/blob/main/netutil/net.go)
+  
+- [https://github.com/duke-git/lancet/blob/main/netutil/http_client.go](https://github.com/duke-git/lancet/blob/main/netutil/http_client.go)
+
 - [https://github.com/duke-git/lancet/blob/main/netutil/http.go](https://github.com/duke-git/lancet/blob/main/netutil/http.go)

 <div STYLE="page-break-after: always;"></div>
@@ -30,11 +33,18 @@ import (

 - [IsPublicIP](#IsPublicIP)
 - [IsInternalIP](#IsInternalIP)
- [HttpGet](#HttpGet)
- [HttpDelete](#HttpDelete)
- [HttpPost](#HttpPost)
- [HttpPut](#HttpPut)
- [HttpPatch](#HttpPatch)
+- [HttpRequest](#HttpRequest)
+- [HttpClient](#HttpClient)
+- [SendRequest](#SendRequest)
+- [DecodeResponse](#DecodeResponse)
+- [StructToUrlValues](#StructToUrlValues)
+
+- [HttpGet<sup>Deprecated</sup>](#HttpGet)
+- [HttpDelete<sup>Deprecated</sup>](#HttpDelete)
+- [HttpPost<sup>Deprecated</sup>](#HttpPost)
+- [HttpPut<sup>Deprecated</sup>](#HttpPut)
+- [HttpPatch<sup>Deprecated</sup>](#HttpPatch)
+
 - [ParseHttpResponse](#ParseHttpResponse)

 <div STYLE="page-break-after: always;"></div>
@@ -334,8 +344,232 @@ func main() {
 ```


+### <span id="HttpRequest">HttpRequest</span>
+<p>HttpRequest用于抽象HTTP请求实体的结构</p>

-### <span id="HttpGet">HttpGet</span>
+<b>函数签名:</b>
+
+```go
+type HttpRequest struct {
+	RawURL      string
+	Method      string
+	Headers     http.Header
+	QueryParams url.Values
+	FormData    url.Values
+	Body        []byte
+}
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	header := http.Header{}
+	header.Add("Content-Type", "multipart/form-data")
+
+	postData := url.Values{}
+	postData.Add("userId", "1")
+	postData.Add("title", "testItem")
+
+	request := &netutil.HttpRequest{
+		RawURL:   "https://jsonplaceholder.typicode.com/todos",
+		Method:   "POST",
+		Headers:  header,
+		FormData: postData,
+	}
+}
+```
+
+
+### <span id="HttpClient">HttpClient</span>
+<p>HttpClient是用于发送HTTP请求的结构体。它可以用一些配置参数或无配置实例化.</p>
+
+<b>函数签名:</b>
+
+```go
+type HttpClient struct {
+	*http.Client
+	TLS     *tls.Config
+	Request *http.Request
+	Config  HttpClientConfig
+}
+
+type HttpClientConfig struct {
+	SSLEnabled       bool
+	TLSConfig        *tls.Config
+	Compressed       bool
+	HandshakeTimeout time.Duration
+	ResponseTimeout  time.Duration
+	Verbose          bool
+}
+
+func NewHttpClient() *HttpClient
+
+func NewHttpClientWithConfig(config *HttpClientConfig) *HttpClient
+
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+	"time"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	httpClientCfg := netutil.HttpClientConfig{
+		SSLEnabled: true,
+		HandshakeTimeout:10 * time.Second
+	}
+	httpClient := netutil.NewHttpClientWithConfig(&httpClientCfg)
+}
+```
+
+
+
+### <span id="SendRequest">SendRequest</span>
+<p>HttpClient发送http请求</p>
+
+<b>函数签名:</b>
+
+```go
+func (client *HttpClient) SendRequest(request *HttpRequest) (*http.Response, error)
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+	"time"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	request := &netutil.HttpRequest{
+		RawURL: "https://jsonplaceholder.typicode.com/todos/1",
+		Method: "GET",
+	}
+
+	httpClient := netutil.NewHttpClient()
+	resp, err := httpClient.SendRequest(request)
+	if err != nil || resp.StatusCode != 200 {
+		log.Fatal(err)
+	}
+
+	type Todo struct {
+		UserId    int    `json:"userId"`
+		Id        int    `json:"id"`
+		Title     string `json:"title"`
+		Completed bool   `json:"completed"`
+	}
+
+	var todo Todo
+	httpClient.DecodeResponse(resp, &todo)
+
+	fmt.Println(todo.Id) //1
+}
+```
+
+
+
+### <span id="DecodeResponse">DecodeResponse</span>
+<p>解析http响应体到目标结构体</p>
+
+<b>函数签名:</b>
+
+```go
+func (client *HttpClient) DecodeResponse(resp *http.Response, target any) error
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+	"time"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	request := &netutil.HttpRequest{
+		RawURL: "https://jsonplaceholder.typicode.com/todos/1",
+		Method: "GET",
+	}
+
+	httpClient := netutil.NewHttpClient()
+	resp, err := httpClient.SendRequest(request)
+	if err != nil || resp.StatusCode != 200 {
+		log.Fatal(err)
+	}
+
+	type Todo struct {
+		UserId    int    `json:"userId"`
+		Id        int    `json:"id"`
+		Title     string `json:"title"`
+		Completed bool   `json:"completed"`
+	}
+
+	var todo Todo
+	httpClient.DecodeResponse(resp, &todo)
+
+	fmt.Println(todo.Id) //1
+}
+```
+
+
+### <span id="StructToUrlValues">StructToUrlValues</span>
+<p>将结构体转为url values, 仅转化结构体导出字段并且包含`json` tag.</p>
+
+<b>函数签名:</b>
+
+```go
+func StructToUrlValues(targetStruct any) url.Values
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	type TodoQuery struct {
+		Id     int `json:"id"`
+		UserId int `json:"userId"`
+	}
+	todoQuery := TodoQuery{
+		Id:     1,
+		UserId: 2,
+	}
+	todoValues := netutil.StructToUrlValues(todoQuery)
+
+	fmt.Println(todoValues.Get("id")) //1
+	fmt.Println(todoValues.Get("userId")) //2
+}
+```
+
+
+
+### <span id="HttpGet">HttpGet (Deprecated: use SendRequest for replacement)</span>
 <p>发送http get请求</p>

 <b>函数签名:</b>
@@ -377,7 +611,7 @@ func main() {



-### <span id="HttpPost">HttpPost</span>
+### <span id="HttpPost">HttpPost (Deprecated: use SendRequest for replacement)</span>
 <p>发送http post请求</p>

 <b>函数签名:</b>
@@ -426,7 +660,7 @@ func main() {



-### <span id="HttpPut">HttpPut</span>
+### <span id="HttpPut">HttpPut (Deprecated: use SendRequest for replacement)</span>
 <p>发送http put请求</p>

 <b>函数签名:</b>
@@ -438,7 +672,7 @@ func main() {
 // params[3] http client，类型必须是http.Client
 func HttpPut(url string, params ...any) (*http.Response, error)
 ```
-<b>Example:</b>
+<b>例子:</b>

 ```go
 package main
@@ -476,7 +710,7 @@ func main() {



-### <span id="HttpDelete">HttpDelete</span>
+### <span id="HttpDelete">HttpDelete (Deprecated: use SendRequest for replacement)</span>
 <p>发送http delete请求</p>

 <b>函数签名:</b>
@@ -515,7 +749,7 @@ func main() {



-### <span id="HttpPatch">HttpPatch</span>
+### <span id="HttpPatch">HttpPatch (Deprecated: use SendRequest for replacement)</span>
 <p>发送http patch请求</p>

 <b>函数签名:</b>
--- a/netutil/http_client.go
+++ b/netutil/http_client.go
@@ -0,0 +1,228 @@
+package netutil
+
+import (
+	"bytes"
+	"crypto/tls"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"net/url"
+	"reflect"
+	"regexp"
+	"strings"
+	"time"
+
+	"github.com/duke-git/lancet/v2/slice"
+)
+
+// HttpRequest struct is a composed http request
+type HttpRequest struct {
+	RawURL      string
+	Method      string
+	Headers     http.Header
+	QueryParams url.Values
+	FormData    url.Values
+	Body        []byte
+}
+
+// HttpClientConfig contains some configurations for http client
+type HttpClientConfig struct {
+	SSLEnabled       bool
+	TLSConfig        *tls.Config
+	Compressed       bool
+	HandshakeTimeout time.Duration
+	ResponseTimeout  time.Duration
+	Verbose          bool
+}
+
+// defaultHttpClientConfig defalut client config
+var defaultHttpClientConfig = &HttpClientConfig{
+	Compressed:       false,
+	HandshakeTimeout: 20 * time.Second,
+	ResponseTimeout:  40 * time.Second,
+}
+
+// HttpClient is used for sending http request
+type HttpClient struct {
+	*http.Client
+	TLS     *tls.Config
+	Request *http.Request
+	Config  HttpClientConfig
+}
+
+// NewHttpClient make a HttpClient instance
+func NewHttpClient() *HttpClient {
+	client := &HttpClient{
+		Client: &http.Client{
+			Transport: &http.Transport{
+				TLSHandshakeTimeout:   defaultHttpClientConfig.HandshakeTimeout,
+				ResponseHeaderTimeout: defaultHttpClientConfig.ResponseTimeout,
+				DisableCompression:    !defaultHttpClientConfig.Compressed,
+			},
+		},
+		Config: *defaultHttpClientConfig,
+	}
+
+	return client
+}
+
+// NewHttpClientWithConfig make a HttpClient instance with pass config
+func NewHttpClientWithConfig(config *HttpClientConfig) *HttpClient {
+	if config == nil {
+		config = defaultHttpClientConfig
+	}
+
+	client := &HttpClient{
+		Client: &http.Client{
+			Transport: &http.Transport{
+				TLSHandshakeTimeout:   config.HandshakeTimeout,
+				ResponseHeaderTimeout: config.ResponseTimeout,
+				DisableCompression:    !config.Compressed,
+			},
+		},
+		Config: *config,
+	}
+
+	if config.SSLEnabled {
+		client.TLS = config.TLSConfig
+	}
+
+	return client
+}
+
+// SendRequest send http request
+func (client *HttpClient) SendRequest(request *HttpRequest) (*http.Response, error) {
+	err := validateRequest(request)
+	if err != nil {
+		return nil, err
+	}
+
+	rawUrl := request.RawURL
+
+	req, err := http.NewRequest(request.Method, rawUrl, bytes.NewBuffer(request.Body))
+	if err != nil {
+		return nil, err
+	}
+
+	client.setTLS(rawUrl)
+	client.setHeader(req, request.Headers)
+	client.setQueryParam(req, rawUrl, request.QueryParams)
+
+	if request.FormData != nil {
+		client.setFormData(req, request.FormData)
+	}
+
+	client.Request = req
+
+	resp, err := client.Client.Do(req)
+	if err != nil {
+		return nil, err
+	}
+
+	return resp, nil
+}
+
+// DecodeResponse decode response into target object
+func (client *HttpClient) DecodeResponse(resp *http.Response, target any) error {
+	if resp == nil {
+		return errors.New("invalid target param")
+	}
+	defer resp.Body.Close()
+	return json.NewDecoder(resp.Body).Decode(target)
+}
+
+// setTLS set http client transport TLSClientConfig
+func (client *HttpClient) setTLS(rawUrl string) {
+	if strings.HasPrefix(rawUrl, "https") {
+		if transport, ok := client.Client.Transport.(*http.Transport); ok {
+			transport.TLSClientConfig = client.TLS
+		}
+	}
+}
+
+// setHeader set http rquest header
+func (client *HttpClient) setHeader(req *http.Request, headers http.Header) {
+	if headers == nil {
+		headers = make(http.Header)
+	}
+
+	if _, ok := headers["Accept"]; !ok {
+		headers["Accept"] = []string{"*/*"}
+	}
+	if _, ok := headers["Accept-Encoding"]; !ok && client.Config.Compressed {
+		headers["Accept-Encoding"] = []string{"deflate, gzip"}
+	}
+
+	req.Header = headers
+}
+
+// setQueryParam set http request query string param
+func (client *HttpClient) setQueryParam(req *http.Request, reqUrl string, queryParam url.Values) error {
+	if queryParam != nil {
+		if !strings.Contains(reqUrl, "?") {
+			reqUrl = reqUrl + "?" + queryParam.Encode()
+		} else {
+			reqUrl = reqUrl + "&" + queryParam.Encode()
+		}
+		u, err := url.Parse(reqUrl)
+		if err != nil {
+			return err
+		}
+		req.URL = u
+	}
+	return nil
+}
+
+func (client *HttpClient) setFormData(req *http.Request, values url.Values) {
+	formData := []byte(values.Encode())
+	req.Body = ioutil.NopCloser(bytes.NewReader(formData))
+	req.ContentLength = int64(len(formData))
+}
+
+// validateRequest check if a request has url, and valid method.
+func validateRequest(req *HttpRequest) error {
+	if req.RawURL == "" {
+		return errors.New("invalid request url")
+	}
+
+	// common HTTP methods
+	methods := []string{"GET", "POST", "PUT", "DELETE", "PATCH",
+		"HEAD", "CONNECT", "OPTIONS", "TRACE"}
+
+	if !slice.Contain(methods, strings.ToUpper(req.Method)) {
+		return errors.New("invalid request method")
+	}
+
+	return nil
+}
+
+// StructToUrlValues convert struct to url valuse,
+// only convert the field which is exported and has `json` tag
+func StructToUrlValues(targetStruct any) url.Values {
+	rv := reflect.ValueOf(targetStruct)
+	rt := reflect.TypeOf(targetStruct)
+
+	if rt.Kind() == reflect.Ptr {
+		rt = rt.Elem()
+	}
+	if rt.Kind() != reflect.Struct {
+		panic(fmt.Errorf("data type %T not support, shuld be struct or pointer to struct", targetStruct))
+	}
+
+	result := url.Values{}
+
+	fieldNum := rt.NumField()
+	pattern := `^[A-Z]`
+	regex := regexp.MustCompile(pattern)
+	for i := 0; i < fieldNum; i++ {
+		name := rt.Field(i).Name
+		tag := rt.Field(i).Tag.Get("json")
+		if regex.MatchString(name) && tag != "" {
+			result.Add(tag, fmt.Sprintf("%v", rv.Field(i).Interface()))
+		}
+	}
+
+	return result
+}
--- a/netutil/http_client_test.go
+++ b/netutil/http_client_test.go
@@ -0,0 +1,95 @@
+package netutil
+
+import (
+	"io/ioutil"
+	"log"
+	"net/http"
+	"net/url"
+	"testing"
+
+	"github.com/duke-git/lancet/v2/internal"
+)
+
+func TestHttpClient_Get(t *testing.T) {
+	assert := internal.NewAssert(t, "TestHttpClient_Get")
+
+	request := &HttpRequest{
+		RawURL: "https://jsonplaceholder.typicode.com/todos/1",
+		Method: "GET",
+	}
+
+	httpClient := NewHttpClient()
+	resp, err := httpClient.SendRequest(request)
+	if err != nil || resp.StatusCode != 200 {
+		log.Fatal(err)
+	}
+
+	type Todo struct {
+		UserId    int    `json:"userId"`
+		Id        int    `json:"id"`
+		Title     string `json:"title"`
+		Completed bool   `json:"completed"`
+	}
+
+	var todo Todo
+	httpClient.DecodeResponse(resp, &todo)
+
+	assert.Equal(1, todo.Id)
+}
+
+func TestHttpClent_Post(t *testing.T) {
+	header := http.Header{}
+	header.Add("Content-Type", "multipart/form-data")
+
+	postData := url.Values{}
+	postData.Add("userId", "1")
+	postData.Add("title", "testItem")
+
+	request := &HttpRequest{
+		RawURL:   "https://jsonplaceholder.typicode.com/todos",
+		Method:   "POST",
+		Headers:  header,
+		FormData: postData,
+	}
+
+	httpClient := NewHttpClient()
+	resp, err := httpClient.SendRequest(request)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	body, _ := ioutil.ReadAll(resp.Body)
+	t.Log("response: ", resp.StatusCode, string(body))
+}
+
+func TestStructToUrlValues(t *testing.T) {
+	assert := internal.NewAssert(t, "TestStructToUrlValues")
+
+	type TodoQuery struct {
+		Id     int `json:"id"`
+		UserId int `json:"userId"`
+	}
+	todoQuery := TodoQuery{
+		Id:     1,
+		UserId: 1,
+	}
+	todoValues := StructToUrlValues(todoQuery)
+
+	assert.Equal("1", todoValues.Get("id"))
+	assert.Equal("1", todoValues.Get("userId"))
+
+	request := &HttpRequest{
+		RawURL:      "https://jsonplaceholder.typicode.com/todos",
+		Method:      "GET",
+		QueryParams: todoValues,
+	}
+
+	httpClient := NewHttpClient()
+	resp, err := httpClient.SendRequest(request)
+	if err != nil || resp.StatusCode != 200 {
+		log.Fatal(err)
+	}
+
+	body, _ := ioutil.ReadAll(resp.Body)
+	t.Log("response: ", string(body))
+}
Author	SHA1	Message	Date
dudaodong	531cb19fd1	release v2.1.6	2022-08-31 17:07:32 +08:00
dudaodong	4f0161ca53	doc: add source code link for http_client	2022-08-31 15:56:41 +08:00
dudaodong	73362b7f69	doc: update readme file	2022-08-31 11:40:24 +08:00
dudaodong	b289f2975b	doc: add document for functions in netutil/http_client.go	2022-08-31 11:20:22 +08:00
dudaodong	90ce2705ca	test: add unit test for http client	2022-08-30 17:33:58 +08:00
dudaodong	35e1d09ce3	feat: add http client for sending http request	2022-08-30 17:22:17 +08:00