netutil

package
v0.3.3 Latest Latest
Warning

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

 Go to latest Published: Dec 16, 2023 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

Package netutil implements some basic functions to send http request and get ip info. Note: HttpGet, HttpPost, HttpDelete, HttpPut, HttpPatch, function param `url` is required. HttpGet, HttpPost, HttpDelete, HttpPut, HttpPatch, function param `params` is variable, the order is: params[0] is header which type should be http.Header or map[string]string, params[1] is query string param which type should be url.Values or map[string]string, when content-type header is multipart/form-data or application/x-www-form-urlencoded params[2] is post body which type should be []byte. params[3] is http client which type should be http.Client.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConvertMapToQueryString 

func ConvertMapToQueryString(param map[string]any) string

ConvertMapToQueryString convert map to sorted url query string. Play: https://go.dev/play/p/jnNt_qoSnRi

Example 
var m = map[string]any{
	"c": 3,
	"a": 1,
	"b": 2,
}

qs := ConvertMapToQueryString(m)

fmt.Println(qs)

Output:

a=1&b=2&c=3

func EncodeUrl 

func EncodeUrl(urlStr string) (string, error)

EncodeUrl encode url. Play: https://go.dev/play/p/bsZ6BRC4uKI

Example 
urlAddr := "http://www.lancet.com?a=1&b=[2]"

encodedUrl, err := EncodeUrl(urlAddr)
if err != nil {
	return
}

fmt.Println(encodedUrl)

Output:

http://www.lancet.com?a=1&b=%5B2%5D

func GetInternalIp 

func GetInternalIp() string

GetInternalIp return internal ipv4. Play: https://go.dev/play/p/5mbu-gFp7ei

Example 
internalIp := GetInternalIp()

result := IsInternalIP(net.ParseIP(internalIp))
fmt.Println(result)

Output:

true

func GetIps 

func GetIps() []string

GetIps return all ipv4 of system. Play: https://go.dev/play/p/NUFfcEmukx1

func GetMacAddrs 

func GetMacAddrs() []string

GetMacAddrs get mac address. Play: https://go.dev/play/p/Rq9UUBS_Xp1

func GetRequestPublicIp 

func GetRequestPublicIp(req *http.Request) string

GetRequestPublicIp return the requested public ip. Play: https://go.dev/play/p/kxU-YDc_eBo

Example 
ip := "36.112.24.10"

request := http.Request{
	Method: "GET",
	Header: http.Header{
		"X-Forwarded-For": {ip},
	},
}
publicIp := GetRequestPublicIp(&request)

fmt.Println(publicIp)

Output:

36.112.24.10

func HttpDelete 

func HttpDelete(url string, params ...any) (*http.Response, error)

HttpDelete send delete http request.

func HttpGet 

func HttpGet(url string, params ...any) (*http.Response, error)

HttpGet send get http request.

func HttpPatch 

func HttpPatch(url string, params ...any) (*http.Response, error)

HttpPatch send patch http request.

func HttpPost 

func HttpPost(url string, params ...any) (*http.Response, error)

HttpPost send post http request.

func HttpPut 

func HttpPut(url string, params ...any) (*http.Response, error)

HttpPut send put http request.

func IsInternalIP 

func IsInternalIP(IP net.IP) bool

IsInternalIP verify an ip is intranet or not. Play: https://go.dev/play/p/sYGhXbgO4Cb

Example 
ip1 := IsInternalIP(net.ParseIP("127.0.0.1"))
ip2 := IsInternalIP(net.ParseIP("192.168.0.1"))
ip3 := IsInternalIP(net.ParseIP("36.112.24.10"))

fmt.Println(ip1)
fmt.Println(ip2)
fmt.Println(ip3)

Output:

true
true
false

func IsPublicIP 

func IsPublicIP(IP net.IP) bool

IsPublicIP verify a ip is public or not. Play: https://go.dev/play/p/nmktSQpJZnn

Example 
ip1 := IsPublicIP(net.ParseIP("127.0.0.1"))
ip2 := IsPublicIP(net.ParseIP("192.168.0.1"))
ip3 := IsPublicIP(net.ParseIP("36.112.24.10"))

fmt.Println(ip1)
fmt.Println(ip2)
fmt.Println(ip3)

Output:

false
false
true

func ParseHttpResponse 

func ParseHttpResponse(resp *http.Response, obj any) error

ParseHttpResponse decode http response to specified interface.

func StructToUrlValues 

func StructToUrlValues(targetStruct any) url.Values

StructToUrlValues convert struct to url valuse, only convert the field which is exported and has `json` tag. Play: https://go.dev/play/p/pFqMkM40w9z

Example 
type TodoQuery struct {
	Id   int    `json:"id"`
	Name string `json:"name"`
}
todoQuery := TodoQuery{
	Id:   1,
	Name: "Test",
}
todoValues := StructToUrlValues(todoQuery)

fmt.Println(todoValues.Get("id"))
fmt.Println(todoValues.Get("name"))

Output:

1
Test

Types

type HttpClient 

type HttpClient struct {
	*http.Client
	TLS     *tls.Config
	Request *http.Request
	Config  HttpClientConfig
}

HttpClient is used for sending http request

func NewHttpClient 

func NewHttpClient() *HttpClient

NewHttpClient make a HttpClient instance

func NewHttpClientWithConfig 

func NewHttpClientWithConfig(config *HttpClientConfig) *HttpClient

NewHttpClientWithConfig make a HttpClient instance with pass config

func (*HttpClient) DecodeResponse 

func (client *HttpClient) DecodeResponse(resp *http.Response, target any) error

DecodeResponse decode response into target object. Play: https://go.dev/play/p/jUSgynekH7G

Example 
request := &HttpRequest{
	RawURL: "https://jsonplaceholder.typicode.com/todos/1",
	Method: "GET",
}

httpClient := NewHttpClient()
resp, err := httpClient.SendRequest(request)
if err != nil || resp.StatusCode != 200 {
	return
}

type Todo struct {
	UserId    int    `json:"userId"`
	Id        int    `json:"id"`
	Title     string `json:"title"`
	Completed bool   `json:"completed"`
}

var todo Todo
err = httpClient.DecodeResponse(resp, &todo)
if err != nil {
	return
}

fmt.Println(todo.Id)

Output:

1

func (*HttpClient) SendRequest 

func (client *HttpClient) SendRequest(request *HttpRequest) (*http.Response, error)

SendRequest send http request. Play: https://go.dev/play/p/jUSgynekH7G

Example 
request := &HttpRequest{
	RawURL: "https://jsonplaceholder.typicode.com/todos/1",
	Method: "GET",
}

httpClient := NewHttpClient()
resp, err := httpClient.SendRequest(request)
if err != nil || resp.StatusCode != 200 {
	return
}

type Todo struct {
	UserId    int    `json:"userId"`
	Id        int    `json:"id"`
	Title     string `json:"title"`
	Completed bool   `json:"completed"`
}

var todo Todo
err = httpClient.DecodeResponse(resp, &todo)
if err != nil {
	return
}

fmt.Println(todo.Id)

Output:

1

type HttpClientConfig 

type HttpClientConfig struct {
	SSLEnabled       bool
	TLSConfig        *tls.Config
	Compressed       bool
	HandshakeTimeout time.Duration
	ResponseTimeout  time.Duration
	Verbose          bool
}

HttpClientConfig contains some configurations for http client

type HttpRequest 

type HttpRequest struct {
	RawURL      string
	Method      string
	Headers     http.Header
	QueryParams url.Values
	FormData    url.Values
	Body        []byte
}

HttpRequest struct is a composed http request

type PublicIpInfo 

type PublicIpInfo struct {
	Status      string  `json:"status"`
	Country     string  `json:"country"`
	CountryCode string  `json:"countryCode"`
	Region      string  `json:"region"`
	RegionName  string  `json:"regionName"`
	City        string  `json:"city"`
	Lat         float64 `json:"lat"`
	Lon         float64 `json:"lon"`
	Isp         string  `json:"isp"`
	Org         string  `json:"org"`
	As          string  `json:"as"`
	Ip          string  `json:"query"`
}

PublicIpInfo public ip info: country, region, isp, city, lat, lon, ip

func GetPublicIpInfo 

func GetPublicIpInfo() (*PublicIpInfo, error)

GetPublicIpInfo return public ip information return the PublicIpInfo struct. Play: https://go.dev/play/p/YDxIfozsRHR

Example 
ipInfo, err := GetPublicIpInfo()
if err != nil {
	return
}

result := IsPublicIP(net.ParseIP(ipInfo.Ip))
fmt.Println(result)

Output:

true

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.