doc: update netutil document

2026-02-04 12:52:28 +08:00 · 2022-07-29 13:23:30 +08:00
parent 2c7bcc9fbb
commit 3e2c25f827
2 changed files with 211 additions and 2 deletions
--- a/docs/netutil.md
+++ b/docs/netutil.md
@@ -22,16 +22,19 @@ import (

 ## Index
 - [ConvertMapToQueryString](#ConvertMapToQueryString)
+- [EncodeUrl](#EncodeUrl)
 - [GetInternalIp](#GetInternalIp)
 - [GetIps](#GetIps)
 - [GetMacAddrs](#GetMacAddrs)
 - [GetPublicIpInfo](#GetPublicIpInfo)
+- [GetRequestPublicIp](#GetRequestPublicIp)
 - [IsPublicIP](#IsPublicIP)
+
+- [IsInternalIP](#IsInternalIP)
 - [HttpGet](#HttpGet)
 - [HttpDelete](#HttpDelete)
 - [HttpPost](#HttpPost)
 - [HttpPut](#HttpPut)
-
 - [HttpPatch](#HttpPatch)
 - [ParseHttpResponse](#ParseHttpResponse)

@@ -72,6 +75,35 @@ func main() {



+### <span id="EncodeUrl">EncodeUrl</span>
+<p>Encode url query string values.</p>
+
+<b>Signature:</b>
+
+```go
+func EncodeUrl(urlStr string) (string, error)
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/netutil"
+)
+
+func main() {
+	urlAddr := "http://www.lancet.com?a=1&b=[2]"
+	encodedUrl, err := netutil.EncodeUrl(urlAddr)
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Println(encodedUrl) //http://www.lancet.com?a=1&b=%5B2%5D
+}
+```
+
+
 ### <span id="GetInternalIp">GetInternalIp</span>
 <p>Get internal ip information.</p>

@@ -198,6 +230,48 @@ func main() {
 ```


+### <span id="GetRequestPublicIp">GetRequestPublicIp</span>
+<p>Get http request public ip.</p>
+
+<b>Signature:</b>
+
+```go
+func GetRequestPublicIp(req *http.Request) string
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/netutil"
+)
+
+func main() {
+	ip := "36.112.24.10"
+
+	request1 := http.Request{
+		Method: "GET",
+		Header: http.Header{
+			"X-Forwarded-For": {ip},
+		},
+	}
+	publicIp1 := netutil.GetRequestPublicIp(&request1)
+	fmt.Println(publicIp1) //36.112.24.10
+
+	request2 := http.Request{
+		Method: "GET",
+		Header: http.Header{
+			"X-Real-Ip": {ip},
+		},
+	}
+	publicIp2 := netutil.GetRequestPublicIp(&request2)
+	fmt.Println(publicIp2) //36.112.24.10
+}
+```
+
+

 ### <span id="IsPublicIP">IsPublicIP</span>
 <p>Checks if a ip is public or not.</p>
@@ -229,6 +303,36 @@ func main() {



+### <span id="IsInternalIP">IsInternalIP</span>
+<p>Checks if an ip is intranet or not.</p>
+
+<b>Signature:</b>
+
+```go
+func IsInternalIP(IP net.IP) bool
+```
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+    "github.com/duke-git/lancet/v2/netutil"
+)
+
+func main() {
+	ip1 := net.ParseIP("127.0.0.1")
+	ip2 := net.ParseIP("36.112.24.10")
+
+	fmt.Println(netutil.IsInternalIP(ip1)) //true
+	fmt.Println(netutil.IsInternalIP(ip2)) //false
+}
+```
+
+
+

 ### <span id="HttpGet">HttpGet</span>
 <p>Send http get request.</p>
--- a/docs/netutil_zh-CN.md
+++ b/docs/netutil_zh-CN.md
@@ -22,16 +22,19 @@ import (

 ## 目录
 - [ConvertMapToQueryString](#ConvertMapToQueryString)
+- [EncodeUrl](#EncodeUrl)
 - [GetInternalIp](#GetInternalIp)
 - [GetIps](#GetIps)
 - [GetMacAddrs](#GetMacAddrs)
 - [GetPublicIpInfo](#GetPublicIpInfo)
+- [GetRequestPublicIp](#GetRequestPublicIp)
+
 - [IsPublicIP](#IsPublicIP)
+- [IsInternalIP](#IsInternalIP)
 - [HttpGet](#HttpGet)
 - [HttpDelete](#HttpDelete)
 - [HttpPost](#HttpPost)
 - [HttpPut](#HttpPut)
-
 - [HttpPatch](#HttpPatch)
 - [ParseHttpResponse](#ParseHttpResponse)

@@ -72,6 +75,36 @@ func main() {



+### <span id="EncodeUrl">EncodeUrl</span>
+<p>编码url query string的值</p>
+
+<b>函数签名:</b>
+
+```go
+func EncodeUrl(urlStr string) (string, error)
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/netutil"
+)
+
+func main() {
+	urlAddr := "http://www.lancet.com?a=1&b=[2]"
+	encodedUrl, err := netutil.EncodeUrl(urlAddr)
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Println(encodedUrl) //http://www.lancet.com?a=1&b=%5B2%5D
+}
+```
+
+
+
 ### <span id="GetInternalIp">GetInternalIp</span>
 <p>获取内部ip</p>

@@ -198,6 +231,49 @@ func main() {



+### <span id="GetRequestPublicIp">GetRequestPublicIp</span>
+<p>获取http请求ip</p>
+
+<b>函数签名:</b>
+
+```go
+func GetRequestPublicIp(req *http.Request) string
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/netutil"
+)
+
+func main() {
+	ip := "36.112.24.10"
+
+	request1 := http.Request{
+		Method: "GET",
+		Header: http.Header{
+			"X-Forwarded-For": {ip},
+		},
+	}
+	publicIp1 := netutil.GetRequestPublicIp(&request1)
+	fmt.Println(publicIp1) //36.112.24.10
+
+	request2 := http.Request{
+		Method: "GET",
+		Header: http.Header{
+			"X-Real-Ip": {ip},
+		},
+	}
+	publicIp2 := netutil.GetRequestPublicIp(&request2)
+	fmt.Println(publicIp2) //36.112.24.10
+}
+```
+
+
+
 ### <span id="IsPublicIP">IsPublicIP</span>
 <p>判断ip是否是公共ip</p>

@@ -228,6 +304,35 @@ func main() {



+### <span id="IsInternalIP">IsInternalIP</span>
+<p>判断ip是否是局域网ip.</p>
+
+<b>函数签名:</b>
+
+```go
+func IsInternalIP(IP net.IP) bool
+```
+<b>例子:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+	"net"
+    "github.com/duke-git/lancet/netutil"
+)
+
+func main() {
+	ip1 := net.ParseIP("127.0.0.1")
+	ip2 := net.ParseIP("36.112.24.10")
+
+	fmt.Println(netutil.IsInternalIP(ip1)) //true
+	fmt.Println(netutil.IsInternalIP(ip2)) //false
+}
+```
+
+

 ### <span id="HttpGet">HttpGet</span>
 <p>发送http get请求</p>