From 34c28fece3c8d2624a80c58052ae1555bf98e232 Mon Sep 17 00:00:00 2001 From: dudaodong Date: Tue, 15 Feb 2022 17:46:07 +0800 Subject: [PATCH] docs&refactor: rename request.go to http.go --- docs/netutil.md | 58 ++++++++++++++++++++++- docs/netutil_zh-CN.md | 57 +++++++++++++++++++++- netutil/{request.go => http.go} | 0 netutil/{request_test.go => http_test.go} | 0 netutil/{request_util.go => http_util.go} | 0 5 files changed, 113 insertions(+), 2 deletions(-) rename netutil/{request.go => http.go} (100%) rename netutil/{request_test.go => http_test.go} (100%) rename netutil/{request_util.go => http_util.go} (100%) diff --git a/docs/netutil.md b/docs/netutil.md index ddab77f..ac8eb1f 100644 --- a/docs/netutil.md +++ b/docs/netutil.md @@ -7,7 +7,7 @@ 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/request.go](https://github.com/duke-git/lancet/blob/main/netutil/request.go) +[https://github.com/duke-git/lancet/blob/main/netutil/http.go](https://github.com/duke-git/lancet/blob/main/netutil/http.go)
@@ -23,6 +23,8 @@ import ( ## Index - [ConvertMapToQueryString](#ConvertMapToQueryString) - [GetInternalIp](#GetInternalIp) +- [GetIps](#GetIps) +- [GetMacAddrs](#GetMacAddrs) - [GetPublicIpInfo](#GetPublicIpInfo) - [IsPublicIP](#IsPublicIP) - [HttpGet](#HttpGet) @@ -99,6 +101,60 @@ func main() { +### GetIps +

Get all ipv4 list.

+ +Signature: + +```go +func GetIps() []string +``` +Example: + +```go +package main + +import ( + "fmt" + "net" + "github.com/duke-git/lancet/netutil" +) + +func main() { + ips := netutil.GetIps() + fmt.Println(ips) //[192.168.1.9] +} +``` + + + +### GetMacAddrs +

Get all mac addresses list.

+ +Signature: + +```go +func GetMacAddrs() []string { +``` +Example: + +```go +package main + +import ( + "fmt" + "net" + "github.com/duke-git/lancet/netutil" +) + +func main() { + addrs := netutil.GetMacAddrs() + fmt.Println(addrs) +} +``` + + + ### GetPublicIpInfo

Get public ip information.

diff --git a/docs/netutil_zh-CN.md b/docs/netutil_zh-CN.md index 93c4beb..8cbe3f3 100644 --- a/docs/netutil_zh-CN.md +++ b/docs/netutil_zh-CN.md @@ -7,7 +7,7 @@ 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/request.go](https://github.com/duke-git/lancet/blob/main/netutil/request.go) +[https://github.com/duke-git/lancet/blob/main/netutil/http.go](https://github.com/duke-git/lancet/blob/main/netutil/http.go)
@@ -23,6 +23,8 @@ import ( ## 目录 - [ConvertMapToQueryString](#ConvertMapToQueryString) - [GetInternalIp](#GetInternalIp) +- [GetIps](#GetIps) +- [GetMacAddrs](#GetMacAddrs) - [GetPublicIpInfo](#GetPublicIpInfo) - [IsPublicIP](#IsPublicIP) - [HttpGet](#HttpGet) @@ -98,6 +100,59 @@ func main() { ``` +### GetIps +

获取ipv4地址列表

+ +函数签名: + +```go +func GetIps() []string +``` +例子: + +```go +package main + +import ( + "fmt" + "net" + "github.com/duke-git/lancet/netutil" +) + +func main() { + ips := netutil.GetIps() + fmt.Println(ips) //[192.168.1.9] +} +``` + + + +### GetMacAddrs +

获取mac地址列

+ +函数签名: + +```go +func GetMacAddrs() []string { +``` +例子: + +```go +package main + +import ( + "fmt" + "net" + "github.com/duke-git/lancet/netutil" +) + +func main() { + addrs := netutil.GetMacAddrs() + fmt.Println(addrs) +} +``` + + ### GetPublicIpInfo

获取公网ip信息

diff --git a/netutil/request.go b/netutil/http.go similarity index 100% rename from netutil/request.go rename to netutil/http.go diff --git a/netutil/request_test.go b/netutil/http_test.go similarity index 100% rename from netutil/request_test.go rename to netutil/http_test.go diff --git a/netutil/request_util.go b/netutil/http_util.go similarity index 100% rename from netutil/request_util.go rename to netutil/http_util.go