merge dev into master

Author: lixizan

.github/workflows/go.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v3
       with:
-        go-version: 1.16
+        go-version: 1.18
 
     - name: Test
-      run: go test 
+      run: go test ./...

.gitignore

@@ -15,4 +15,5 @@
 test/
 debug
 vendor/
-examples/
+examples/
+bin/

Makefile

@@ -0,0 +1,8 @@
+test:
+	go test -count 1 -timeout 30s -run ^Test ./...
+
+bench:
+	go test -benchmem -run=^$$ -bench . github.com/lxzan/gws
+
+cover:
+	go test -coverprofile=./bin/cover.out --cover ./...

README.md

@@ -1,165 +1,132 @@
 # Hasaki
+
 http request library for golang
 
-[![Build Status](https://github.com/lxzan/hasaki/workflows/Go%20Test/badge.svg?branch=master)](https://github.com/lxzan/hasaki/actions?query=branch%3Amaster)
-[![OSCS Status](https://www.oscs1024.com/platform/badge/lxzan/hasaki.svg?size=small)](https://www.oscs1024.com/project/lxzan/hasaki?ref=badge_small)
+[![Build Status][1]][2] [![codecov][3]][4]
 
-- Package
-```bash
-github.com/lxzan/hasaki
-```
+[1]: https://github.com/lxzan/hasaki/workflows/Go%20Test/badge.svg?branch=master
 
-### 基本使用
-#### 发送GET请求
-```go
-package main
+[2]: https://github.com/lxzan/hasaki/actions?query=branch%3Amaster
 
-import (
-	"github.com/lxzan/hasaki"
-)
+[3]: https://codecov.io/gh/lxzan/hasaki/graph/badge.svg?token=0VY55RLS3G
 
-func main() {
-	result := make([]map[string]interface{}, 0)
-	err := hasaki.
-		Get("https://api.github.com/users/%s/repos", "lxzan").
-		SetQuery(hasaki.Any{
-			"type":     "go",
-			"per_page": 1,
-		}).
-		Send(nil).
-		BindJSON(&result)
-}
-```
+[4]: https://codecov.io/gh/lxzan/hasaki
 
-#### 发送POST JSON请求
-```go
-func main() {
-	var body = struct {
-		Name string `json:"name"`
-	}{Name: "caster"}
-
-	err := hasaki.
-		Post("http://localhost:8080" + "/sendJson").
-		SetEncoder(hasaki.JsonEncoder).
-		Send(body).
-		Err()
-}
-```
+- [Hasaki](#hasaki)
+    - [Features](#features)
+    - [Install](#install)
+    - [Usage](#usage)
+      - [GET](#get)
+      - [POST](#post)
+    - [Middleware](#middleware)
 
-#### 发送POST Form请求
-```go
-func main() {
-	var body = struct {
-		Name string `form:"name"`
-	}{Name: "caster"}
+### Features
 
-    // Content-Type: application/x-www-form-urlencoded
-	err := hasaki.
-		Post("http://localhost:8080" + "/sendForm").
-		SetEncoder(hasaki.FormEncoder).
-		Send(body).
-		Err()
-}
+- [x] Buffer Pool
+- [x] Trace the Error Stack
+- [x] JSON / WWWForm Encoder
+- [x] Request Before and After Middleware
+
+### Install
+
+```bash
+go get -v github.com/lxzan/hasaki
 ```
 
-#### 发送字节流
+### Usage
+
+##### GET
+
 ```go
 package main
 
 import (
+	"log"
+
 	"github.com/lxzan/hasaki"
-	"os"
 )
 
 func main() {
-	file, _ := os.Open("")
-	err := hasaki.
-		Put("http://localhost:8080" + "/upload").
-		SetHeader(hasaki.H{"Content-Type": hasaki.ContentTypeSTREAM}).
-		Send(file).
-		Err()
+	type Query struct {
+		Q     string `form:"q"`
+		Page  int    `form:"page"`
+		Order string `form:"-"`
+	}
+	var out = make(map[string]any)
+	var err = hasaki.
+		Get("https://api.github.com/search/repositories").
+		SetQuery(Query{
+			Q:    "go-ws",
+			Page: 1,
+		}).
+		Send(nil).
+		BindJSON(out)
+	if err != nil {
+		log.Printf("%+v", err)
+	}
 }
-```
-
-### 高级
 
-#### 设置代理
-```go
-cli, err := hasaki.NewClient(hasaki.WithProxy("socks5://127.0.0.1:1080"))
 ```
 
-#### 统一的错误处理
+##### POST
+
 ```go
 package main
 
 import (
-	"context"
-	"fmt"
-	jsoniter "github.com/json-iterator/go"
+	"log"
+
 	"github.com/lxzan/hasaki"
-	"github.com/pkg/errors"
-	"mime"
-	"net/http"
 )
 
-type BaseResult struct {
-	Code    *int   `json:"code"`
-	Message string `json:"message"`
-}
-
-var afterFunc = func(ctx context.Context, resp *http.Response) (context.Context, error) {
-	if resp.StatusCode != http.StatusOK {
-		return ctx, hasaki.ErrUnexpectedStatusCode
-	}
-	typ, _, _ := mime.ParseMediaType(resp.Header.Get("Content-Type"))
-	if typ != "application/json" {
-		return ctx, nil
+func main() {
+	type Query struct {
+		Q     string `form:"q"`
+		Page  int    `form:"page"`
+		Order string `form:"-"`
 	}
-
-	rc, err := hasaki.NewReadCloser(resp.Body)
+	var out = make(map[string]any)
+	var err = hasaki.
+		Post("https://api.github.com/search/repositories").
+		SetEncoder(hasaki.FormEncoder).
+		Send(Query{
+			Q:    "go-ws",
+			Page: 1,
+		}).
+		BindJSON(&out)
 	if err != nil {
-		return ctx, err
-	}
-	var result = BaseResult{}
-	if err := jsoniter.Unmarshal(rc.Bytes(), &result); err != nil {
-		return ctx, err
-	}
-	if result.Code == nil || *result.Code != 0 {
-		return ctx, errors.New(result.Message)
+		log.Printf("%+v", err)
 	}
-	resp.Body = rc
-	return ctx, nil
-}
-
-func main() {
-	cli, _ := hasaki.NewClient(hasaki.WithAfter(afterFunc))
 }
 ```
 
-#### 统计请求耗时
+### Middleware
+
 ```go
 package main
 
 import (
 	"context"
-	"fmt"
-	"github.com/lxzan/hasaki"
+	"log"
 	"net/http"
 	"time"
+
+	"github.com/lxzan/hasaki"
 )
 
 func main() {
-	cli, _ := hasaki.NewClient(
-		hasaki.WithBefore(func(ctx context.Context, request *http.Request) (context.Context, error) {
-			ctx = context.WithValue(ctx, "t0", time.Now())
-			return ctx, nil
-		}),
-		hasaki.WithAfter(func(ctx context.Context, response *http.Response) (context.Context, error) {
-			t0 := ctx.Value("t0").(time.Time)
-			fmt.Printf("cost = %dms\n", time.Since(t0).Milliseconds())
-			return ctx, nil
-		}),
-	)
-	cli.Get("https://api.github.com/users/%s", "lxzan").Send(nil)
+	before := hasaki.WithBefore(func(ctx context.Context, request *http.Request) (context.Context, error) {
+		return context.WithValue(ctx, "t0", time.Now()), nil
+	})
+
+	after := hasaki.WithAfter(func(ctx context.Context, response *http.Response) (context.Context, error) {
+		t0 := ctx.Value("t0").(time.Time)
+		log.Printf("latency=%s", time.Since(t0).String())
+		return ctx, nil
+	})
+
+	var url = "https://api.github.com/search/repositories"
+	cli, _ := hasaki.NewClient(before, after)
+	cli.Get(url).Send(nil)
 }
 ```

client.go

@@ -4,15 +4,17 @@ import (
 	"context"
 	"fmt"
 	"net/http"
+	"strings"
 )
 
 type Client struct {
-	config *Config
+	config *config
 }
 
-// NewClient 新建一个客户端, 支持自定义HttpClient, 错误检查和中间件
+// NewClient 新建一个客户端
+// Create a new client
 func NewClient(options ...Option) (*Client, error) {
-	var c = new(Config)
+	var c = new(config)
 	options = append(options, withInitialize())
 	for _, f := range options {
 		f(c)
@@ -21,34 +23,33 @@ func NewClient(options ...Option) (*Client, error) {
 	return client, nil
 }
 
-func (c *Client) Get(url string, args ...interface{}) *Request {
+func (c *Client) Get(url string, args ...any) *Request {
 	return c.Request(http.MethodGet, url, args...)
 }
 
-func (c *Client) Post(url string, args ...interface{}) *Request {
+func (c *Client) Post(url string, args ...any) *Request {
 	return c.Request(http.MethodPost, url, args...)
 }
 
-func (c *Client) Put(url string, args ...interface{}) *Request {
+func (c *Client) Put(url string, args ...any) *Request {
 	return c.Request(http.MethodPut, url, args...)
 }
 
-func (c *Client) Delete(url string, args ...interface{}) *Request {
+func (c *Client) Delete(url string, args ...any) *Request {
 	return c.Request(http.MethodDelete, url, args...)
 }
 
-func (c *Client) Request(method string, url string, args ...interface{}) *Request {
+func (c *Client) Request(method string, url string, args ...any) *Request {
 	if len(args) > 0 {
 		url = fmt.Sprintf(url, args...)
 	}
-	return &Request{
+	return (&Request{
 		ctx:     context.Background(),
 		client:  c.config.HTTPClient,
-		method:  method,
+		method:  strings.ToUpper(method),
 		url:     url,
-		encoder: JsonEncoder,
 		before:  c.config.BeforeFunc,
 		after:   c.config.AfterFunc,
 		headers: http.Header{},
-	}
+	}).SetEncoder(JsonEncoder)
 }