request

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 30, 2021 License: Apache-2.0 Imports: 22 Imported by: 0

README

sky_blue/request框架

A simple HTTP Request package for golang. GET POST DELETE PUT Upload

Installation

go get github.com/zdao-pro/sky_blue/pkg/net/http/request

How do we use request?
Create request object use http.DefaultTransport
req := request.NewRequest()
req := request.NewRequest().Debug(true).SetTimeout(5)
Set headers
req.SetHeaders(map[string]string{
    "Content-Type": "application/x-www-form-urlencoded",
    "Connection": "keep-alive",
})

req.SetHeaders(map[string]string{
    "Source":"api",
})
Set cookies
req.SetCookies(map[string]string{
    "name":"json",
    "token":"",
})

req.SetCookies(map[string]string{
    "age":"19",
})
Set basic auth
req.SetBasicAuth("username","password")
Set timeout
req.SetTimeout(5)  //default 30s
Transport

If you want to customize the Client object and reuse TCP connections, you need to define a global http.RoundTripper or & http.Transport, because the reuse of the http connection pool is based on Transport.

var transport *http.Transport
func init() {   
    transport = &http.Transport{
        DialContext: (&net.Dialer{
            Timeout:   30 * time.Second,
            KeepAlive: 30 * time.Second,
            DualStack: true,
        }).DialContext,
        MaxIdleConns:          100, 
        IdleConnTimeout:       90 * time.Second,
        TLSHandshakeTimeout:   5 * time.Second,
        ExpectContinueTimeout: 1 * time.Second,
    }
}

func demo(){
    // Use http.DefaultTransport
    res, err := request.Get("http://127.0.0.1:8080")
    // Use custom Transport
    res, err := request.Transport(transport).Get("http://127.0.0.1:8080")
}
Keep Alives，Only effective for custom Transport
req.DisableKeepAlives(false)

request.Transport(transport).DisableKeepAlives(false).Get("http://127.0.0.1:8080")
Ignore Https certificate validation，Only effective for custom Transport
req.SetTLSClient(&tls.Config{InsecureSkipVerify: true})

request.Transport(transport).SetTLSClient(&tls.Config{InsecureSkipVerify: true}).Get("http://127.0.0.1:8080")
Object-oriented operation mode
req := request.NewRequest().
	Debug(true).
	SetHeaders(map[string]string{
	    "Content-Type": "application/x-www-form-urlencoded",
	}).SetTimeout(5)
resp,err := req.Get("http://127.0.0.1")

resp,err := request.NewRequest().Get("http://127.0.0.1")
GET
Query parameter
resp, err := req.Get("http://127.0.0.1:8000")
resp, err := req.Get("http://127.0.0.1:8000",nil)
resp, err := req.Get("http://127.0.0.1:8000?id=10&title=request")
resp, err := req.Get("http://127.0.0.1:8000?id=10&title=request","address=beijing")

resp, err := request.Get("http://127.0.0.1:8000")
resp, err := request.Debug(true).SetHeaders(map[string]string{}).Get("http://127.0.0.1:8000")
使用配置文件

为了实现环境代码一致性,方便管理URL: 对URL的地址进行可配置管理

    1.对于http://pre.zhaodao88.com来说
      配置文件可以这样写:
      user_server:
        server:
            - pre.zhaodao88.com
        keepalive: 100`
    2.代码就得这样:
      //类似于环境变量的写法
      rs, err := r.Get("https://$user_server/user/token_check")
      //也可以直接指明地址,框架会检查
      rs, err := r.Get("https://pre.zhaodao88.com/user/token_check")

示例:

package main

import (
	"fmt"
	"github.com/zdao-pro/sky_blue/pkg/net/http/request"
)

type M map[string]Upstream

func main() {
	s := `user_server:
            server:
                - pre.zhaodao88.com
            keepalive: 100`
	request.InitUpstream(s)
	r := request.NewRequest()
	p := map[string]interface{}{
		"token": "eee",
	}
	rs, err := r.Get("https://$user_server/user/token_check", p)
	if err != nil {
		panic(err)
	}
	fmt.Println(rs.Content())
}
Multi parameter
resp, err := req.Get("http://127.0.0.1:8000?id=10&title=request",map[string]interface{}{
    "name":  "jason",
    "score": 100,
})
defer resp.Close()

body, err := resp.Body()
if err != nil {
    return
}

return string(body)
POST
// Send nil
resp, err := request.Post("http://127.0.0.1:8000")

// Send integer
resp, err := request.Post("http://127.0.0.1:8000", 100)

// Send []byte
resp, err := request.Post("http://127.0.0.1:8000", nil, []byte("bytes data"))

// Send io.Reader
resp, err := request.Post("http://127.0.0.1:8000",  nil, bytes.NewReader(buf []byte))
resp, err := request.Post("http://127.0.0.1:8000",  nil, strings.NewReader("string data"))
resp, err := request.Post("http://127.0.0.1:8000",  nil, bytes.NewBuffer(buf []byte))

// Send string
resp, err := request.Post("http://127.0.0.1:8000", "title=github&type=1")

// Send JSON
resp, err := request.JSON().Post("http://127.0.0.1:8000",  nil, "{\"id\":10,\"title\":\"request\"}")

// Send map[string]interface{}{}
resp, err := req.Post("http://127.0.0.1:8000", map[string]interface{}{
    "id":    10,
    "title": "request",
})
defer resp.Close()

body, err := resp.Body()
if err != nil {
    return
}
return string(body)

resp, err := request.Post("http://127.0.0.1:8000")
resp, err := request.JSON().Post("http://127.0.0.1:8000",map[string]interface{}{"title":"github"})
resp, err := request.Debug(true).SetHeaders(map[string]string{}).JSON().Post("http://127.0.0.1:8000", nil, "{\"title\":\"github\"}")
Jar
j, _ := cookiejar.New(nil)
j.SetCookies(&url.URL{
	Scheme: "http",
	Host:   "127.0.0.1:8000",
}, []*http.Cookie{
	&http.Cookie{Name: "identity-user", Value: "83df5154d0ed31d166f5c54ddc"},
	&http.Cookie{Name: "token_id", Value: "JSb99d0e7d809610186813583b4f802a37b99d"},
})
resp, err := request.Jar(j).Get("http://127.0.0.1:8000/city/list")
defer resp.Close()

if err != nil {
	log.Fatalf("Request error：%v", err.Error())
}
Proxy
proxy, err := url.Parse("http://proxyip:proxyport")
if err != nil {
	log.Println(err)
}

resp, err := request.Proxy(http.ProxyURL(proxy)).Get("http://127.0.0.1:8000/ip")
defer resp.Close()

if err != nil {
	log.Println("Request error：%v", err.Error())
}

body, err := resp.Body()
if err != nil {
	log.Println("Get body error：%v", err.Error())
}
log.Println(string(body))
Upload

Params: url, filename, fileinput

resp, err := req.Upload("http://127.0.0.1:8000/upload", "/root/demo.txt","uploadFile")
body, err := resp.Body()
defer resp.Close()
if err != nil {
    return
}
return string(body)
Debug
Default false
req.Debug(true)
Print in standard output：
[request]
-------------------------------------------------------------------
Request: GET http://127.0.0.1:8000?name=iceview&age=19&score=100
Headers: map[Content-Type:application/x-www-form-urlencoded]
Cookies: map[]
Timeout: 30s
ReqBody: map[age:19 score:100]
-------------------------------------------------------------------

Json

Post JSON request

Set header
 req.SetHeaders(map[string]string{"Content-Type": "application/json"})

Or

req.JSON().Post("http://127.0.0.1:8000", map[string]interface{}{
    "id":    10,
    "title": "github",
})

req.JSON().Post("http://127.0.0.1:8000",  nil, "{\"title\":\"github\",\"id\":10}")
Post request
resp, err := req.Post("http://127.0.0.1:8000", map[string]interface{}{
    "id":    10,
    "title": "request",
})
Print formatted JSON
str, err := resp.Export()
if err != nil {
   return
}
Unmarshal JSON
var u User
err := resp.Json(&u)
if err != nil {
   return err
}

var m map[string]interface{}
err := resp.Json(&m)
if err != nil {
   return err
}
Response
Response() *http.Response
resp, err := req.Post("http://127.0.0.1:8000/") //res is a http.Response object
StatusCode() int
resp.StatusCode()
Body() ([]byte, error)
body, err := resp.Body()
log.Println(string(body))
Close() error
resp.Close()
Time() string
resp.Time()  //ms
Print formatted JSON
str, err := resp.Export()
if err != nil {
   return
}
Unmarshal JSON
var u User
err := resp.Json(&u)
if err != nil {
   return err
}

var m map[string]interface{}
err := resp.Json(&m)
if err != nil {
   return err
}
Url() string
resp.Url()  //return the requested url
Headers() http.Header
resp.Headers()  //return the response headers
resp.Headers().Get("Content-Type")

resp.Cookies()  //return the response cookies
Advanced
GET
import "github.com/kirinlabs/request"
   
resp,err := request.Get("http://127.0.0.1:8000/")
resp,err := request.Get("http://127.0.0.1:8000/","title=github")
resp,err := request.Get("http://127.0.0.1:8000/?title=github")
resp,err := request.Debug(true).JSON().Get("http://127.0.0.1:8000/")
POST
import "github.com/kirinlabs/request"
   
resp,err := request.Post("http://127.0.0.1:8000/")
resp,err := request.SetHeaders(map[string]string{
	"title":"github",
}).Post("http://127.0.0.1:8000/")
resp,err := request.Debug(true).JSON().Post("http://127.0.0.1:8000/")
Example
import "github.com/kirinlabs/request"
   
resp,err := request.Get("http://127.0.0.1:8000/")
resp,err := request.Get("http://127.0.0.1:8000/","title=github")
resp,err := request.Get("http://127.0.0.1:8000/?title=github")
resp,err := request.Get("http://127.0.0.1:8000/",map[string]interface{}{
	"title":"github",
})
resp,err := request.Debug(true).JSON().SetHeaders(map[string]string{
	"source":"api",
}).SetCookies(map[string]string{
	"name":"request",
}).Post("http://127.0.0.1:8000/")


//Or
req := request.NewRequest()
req := req.Debug(true).SetHeaders()
resp,err := req.Debug(true).JSON().SetHeaders(map[string]string{
    "source":"api",
}).SetCookies(map[string]string{
    "name":"request",
}).Post("http://127.0.0.1:8000/")

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	//UpstreamMap ..
	UpstreamMap Map
	//ErrNoKey ..
	ErrNoKey = fmt.Errorf("the server is not exist")
	//ErrNoMap ..
	ErrNoMap = fmt.Errorf("the UpstreamMap is null")
)

Functions

func Export 

func Export(v interface{}) string

func InitUpstream 

func InitUpstream(str ...string)

InitUpstream ..

func IntByte 

func IntByte(v interface{}) []byte

func Json 

func Json(v interface{}) string

func KeyNamed 

func KeyNamed(key string) string

KeyNamed key naming to lower case.

Types

type Map 

type Map struct {
	// contains filtered or unexported fields
}

Map ..

func (*Map) Add 

func (m *Map) Add(s string)

Add ..

func (*Map) Get 

func (m *Map) Get(key string) (*Upstream, error)

Get ..

func (*Map) Store 

func (m *Map) Store(values map[string]Upstream)

Store ..

type Request 

type Request struct {
	context.Context
	// contains filtered or unexported fields
}

Request ..

func NewRequest 

func NewRequest(c context.Context, arg ...interface{}) *Request

NewRequest .. 

@param1: timeout itime.Duration
@param2: headers map[string]string
@param2: cookies map[string]string

func (*Request) CheckRedirect 

func (r *Request) CheckRedirect(v func(req *http.Request, via []*http.Request) error) *Request

func (*Request) Debug 

func (r *Request) Debug(v bool) *Request

Debug model

func (*Request) Delete 

func (r *Request) Delete(url string, data ...interface{}) (*Response, error)

Delete is a delete http request

func (*Request) DisableKeepAlives 

func (r *Request) DisableKeepAlives(v bool) *Request

func (*Request) Get 

func (r *Request) Get(url string, data ...interface{}) (*Response, error)

Get is a get http request

func (*Request) JSON 

func (r *Request) JSON() *Request

func (*Request) Jar 

func (r *Request) Jar(v http.CookieJar) *Request

func (*Request) Post 

func (r *Request) Post(url string, data ...interface{}) (*Response, error)

Post is a post http request

func (*Request) Proxy 

func (r *Request) Proxy(v func(*http.Request) (*url.URL, error)) *Request

func (*Request) Put 

func (r *Request) Put(url string, data ...interface{}) (*Response, error)

Put is a put http request

func (*Request) SetBasicAuth 

func (r *Request) SetBasicAuth(username, password string) *Request

Set basic auth

func (*Request) SetCookies 

func (r *Request) SetCookies(cookies map[string]string) *Request

Set cookies

func (*Request) SetHeaders 

func (r *Request) SetHeaders(headers map[string]string) *Request

Set headers

func (*Request) SetTLSClient 

func (r *Request) SetTLSClient(v *tls.Config) *Request

func (*Request) SetTimeout 

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

func (*Request) TLSClient 

func (r *Request) TLSClient(v *tls.Config) *Request

func (*Request) Transport 

func (r *Request) Transport(v *http.Transport) *Request

func (*Request) Upload 

func (r *Request) Upload(url, filename, fileinput string) (*Response, error)

Upload file

type Response 

type Response struct {
	// contains filtered or unexported fields
}

func (*Response) Body 

func (r *Response) Body() ([]byte, error)

func (*Response) Close 

func (r *Response) Close() error

func (*Response) Content 

func (r *Response) Content() (string, error)

func (*Response) Cookies 

func (r *Response) Cookies() []*http.Cookie

func (*Response) Export 

func (r *Response) Export() (string, error)

func (*Response) Headers 

func (r *Response) Headers() http.Header

func (*Response) Json 

func (r *Response) Json(v interface{}) error

func (*Response) Response 

func (r *Response) Response() *http.Response

func (*Response) StatusCode 

func (r *Response) StatusCode() int

func (*Response) Time 

func (r *Response) Time() string

func (*Response) Unmarshal 

func (r *Response) Unmarshal(v interface{}) error

func (*Response) Url 

func (r *Response) Url() string

type Upstream 

type Upstream struct {
	Server    []string `yaml:"server"`    // server addr
	Keepalive int      `yaml:"keepalive"` // keepalive
}

Upstream ..

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.