gohttp

README

Http 请求封装

package main

import (
	"context"
	"fmt"
	gocontext "github.com/gif-gif/go.io/go-context"
	"github.com/gif-gif/go.io/go-http"
	golog "github.com/gif-gif/go.io/go-log"
	"github.com/gif-gif/go.io/goio"
	"time"
)

func main() {
	goio.Init(goio.DEVELOPMENT)
	type httpRequest struct {
		Email string `json:"email"`
	}

	req := &gohttp.Request{
		Url: "/main",
		Urls: []string{
			"/main1",
			"/main2",
			"/main3",
		},
		QueryParams: map[string]string{"name": "jk"},
		Timeout:     time.Second * 2,
		Body: &httpRequest{
			Email: "test@gmail.com",
		},
	}

	gh := &gohttp.GoHttp[gohttp.Response]{
		Request: req,
		BaseUrl: "http://localhost",
		Headers: map[string]string{
			"User-Agent": "github.com/gif-gif/go.io",
		},
	}

	rst, err := gh.HttpPostJson(context.Background())
	if err != nil {
		golog.WithTag("http").Error(err.Error())
	} else {
		fmt.Println(rst)
	}
}

• Custom Root Certificates and Client Certificates
• Custom Root Certificates and Client Certificates from string
• Save HTTP Response into File

Documentation

Index

• Constants
• type GoHttp
  • func (g *GoHttp[T]) AddGlobalHeader(k, v string)
  • func (g *GoHttp[T]) GetBaseUrl() string
  • func (g *GoHttp[T]) GetGlobalHeaders() map[string]string
  • func (g *GoHttp[T]) HttpConcurrencyRequest() (*T, error)
  • func (g *GoHttp[T]) HttpGet(context context.Context) (*T, error)
  • func (g *GoHttp[T]) HttpPost(context context.Context) (*T, error)
  • func (g *GoHttp[T]) HttpPostJson(context context.Context) (*T, error)
  • func (g *GoHttp[T]) HttpRequest(context context.Context) (*T, error)
  • func (g *GoHttp[T]) RemoveGlobalHeader(k string)
  • func (g *GoHttp[T]) SetBaseUrl(base string)
• type Request
  • func (r *Request) AddUrl(url string)
  • func (r *Request) SetBody(body interface{})
  • func (r *Request) SetHeader(name string, value string)
  • func (r *Request) SetMethod(method string)
  • func (r *Request) SetQueryParams(name string, value string)
  • func (r *Request) SetRetryCount(tryCount int)
  • func (r *Request) SetRetryWaitTime(waitTime time.Duration)
  • func (r *Request) SetTimeout(timeout time.Duration)
• type Response
  • func HttpBadRequest(msg string) *Response
  • func HttpFail(msg string) *Response
  • func HttpFailForCode(code int64, msg string) *Response
  • func HttpForbidden(msg string) *Response
  • func HttpNotFound(msg string) *Response
  • func HttpServerError(msg string) *Response
  • func HttpSuccess(data interface{}) *Response
  • func HttpSuccessByCode(code int64, data interface{}) *Response
  • func HttpUnauthorized(msg string) *Response

Constants

const (
	TAG = "gohttp"

	CONTENT_TYPE_XML  = "application/xml"
	CONTENT_TYPE_JSON = "application/json"
	CONTENT_TYPE_FORM = "application/x-www-form-urlencoded"
)

const (
	POST   = "post"
	GET    = "get"
	PUT    = "put"
	DELETE = "delete"
)

const (
	HttpUnknownError = 1000
	HttpRetryError   = 2000
	HttpParamsError  = 3000
)

Types

type GoHttp

type GoHttp[T any] struct {
	BaseUrl string
	Headers map[string]string
	Request *Request
}

func (*GoHttp[T]) AddGlobalHeader

func (g *GoHttp[T]) AddGlobalHeader(k, v string)

func (*GoHttp[T]) GetBaseUrl

func (g *GoHttp[T]) GetBaseUrl() string

func (*GoHttp[T]) GetGlobalHeaders

func (g *GoHttp[T]) GetGlobalHeaders() map[string]string

func (*GoHttp[T]) HttpConcurrencyRequest

func (g *GoHttp[T]) HttpConcurrencyRequest() (*T, error)

带多个Urls重试逻辑,并发请求,速度快先到达后 直接返回，其他请求取消

func (*GoHttp[T]) HttpGet

func (g *GoHttp[T]) HttpGet(context context.Context) (*T, error)

func (*GoHttp[T]) HttpPost

func (g *GoHttp[T]) HttpPost(context context.Context) (*T, error)

func (*GoHttp[T]) HttpPostJson

func (g *GoHttp[T]) HttpPostJson(context context.Context) (*T, error)

func (*GoHttp[T]) HttpRequest

func (g *GoHttp[T]) HttpRequest(context context.Context) (*T, error)

带多个Urls重试逻辑

func (*GoHttp[T]) RemoveGlobalHeader

func (g *GoHttp[T]) RemoveGlobalHeader(k string)

func (*GoHttp[T]) SetBaseUrl

func (g *GoHttp[T]) SetBaseUrl(base string)

type Request

type Request struct {
	Url          string
	Urls         []string // 如果有值，当url 请求失败时继续用这里的接口尝试，直到成功返回或者全部失败
	Method       string
	Body         interface{}       //post body 参数
	QueryParams  map[string]string //get 参数
	ParamsValues url.Values        //get 参数
	FormData     map[string]string //formdata 参数
	Headers      map[string]string

	Files             map[string]string //上传文件列表
	FileName          string            //文件名称
	MultipartFormData map[string]string
	FileBytes         []byte

	Timeout       time.Duration
	RetryCount    int
	RetryWaitTime time.Duration

	//gotrace infos
	TraceInfo     resty.TraceInfo
	ResponseTime  time.Duration
	ResponseProto string
	Response      *resty.Response
	// contains filtered or unexported fields
}

func (*Request) AddUrl

func (r *Request) AddUrl(url string)

重复会去重

func (*Request) SetBody

func (r *Request) SetBody(body interface{})

func (*Request) SetHeader

func (r *Request) SetHeader(name string, value string)

func (*Request) SetMethod

func (r *Request) SetMethod(method string)

func (*Request) SetQueryParams

func (r *Request) SetQueryParams(name string, value string)

func (*Request) SetRetryCount

func (r *Request) SetRetryCount(tryCount int)

func (*Request) SetRetryWaitTime

func (r *Request) SetRetryWaitTime(waitTime time.Duration)

func (*Request) SetTimeout

func (r *Request) SetTimeout(timeout time.Duration)

type Response

type Response struct {
	Code int64       `json:"code"`
	Msg  string      `json:"msg"`
	Data interface{} `json:"data"`
}

func HttpBadRequest

func HttpBadRequest(msg string) *Response

请求格式错误，比如参数格式、参数字段名等 不正确

func HttpFail

func HttpFail(msg string) *Response

请求失败

func HttpFailForCode

func HttpFailForCode(code int64, msg string) *Response

如需返回特殊错误码，调用此接口

func HttpForbidden

func HttpForbidden(msg string) *Response

用户已进行身份认证，但权限不够

func HttpNotFound

func HttpNotFound(msg string) *Response

接口不存在

func HttpServerError

func HttpServerError(msg string) *Response

服务器内部错误

func HttpSuccess

func HttpSuccess(data interface{}) *Response

请求成功

func HttpSuccessByCode

func HttpSuccessByCode(code int64, data interface{}) *Response

func HttpUnauthorized

func HttpUnauthorized(msg string) *Response

用户没有访问权限，需要进行身份认证