原文鏈接：https://blog.thinkeridea.com/201903/go/get_client_ip.html

用戶請(qǐng)求到達(dá)提供服務(wù)的服務(wù)器中間有很多的環(huán)節(jié)，導(dǎo)致服務(wù)獲取用戶真實(shí)的 ip 非常困難弛车，大多數(shù)的框架及工具庫(kù)都會(huì)封裝各種獲取用戶真實(shí) ip 的方法蕉汪，在 exnet 包中也封裝了各種 ip 相關(guān)的操作涂滴，其中就包含獲取客戶端 ip 的方法炊汤，比較實(shí)用的方法如下：

• func ClientIP(r *http.Request) string ClientIP 盡最大努力實(shí)現(xiàn)獲取客戶端 IP 的算法寞射。 解析 X-Real-IP 和 X-Forwarded-For 以便于反向代理（nginx 或 haproxy）可以正常工作。
• func ClientPublicIP(r *http.Request) string ClientPublicIP 盡最大努力實(shí)現(xiàn)獲取客戶端公網(wǎng) IP 的算法畦贸。 解析 X-Real-IP 和 X-Forwarded-For 以便于反向代理（nginx 或 haproxy）可以正常工作。
• func HasLocalIP(ip net.IP) bool HasLocalIP 檢測(cè) IP 地址是否是內(nèi)網(wǎng)地址
• func HasLocalIPddr(ip string) bool HasLocalIPddr 檢測(cè) IP 地址字符串是否是內(nèi)網(wǎng)地址
• func RemoteIP(r *http.Request) string RemoteIP 通過(guò) RemoteAddr 獲取 IP 地址楞捂， 只是一個(gè)快速解析方法薄坏。

獲取用戶真實(shí)ip地址

ClientIP 方法 與 ClientPublicIP 方法的實(shí)現(xiàn)類似，只是一個(gè)按照 http 協(xié)議約定獲取客戶端 ip寨闹， 一個(gè)按照約定格式查找到公網(wǎng) ip胶坠。

在網(wǎng)絡(luò)與服務(wù)架構(gòu)、業(yè)務(wù)邏輯復(fù)雜的環(huán)境中繁堡，按照 http 協(xié)議約定的方式沈善，并非總能獲取到真實(shí)的 ip，在我們的業(yè)務(wù)中用戶流量經(jīng)由三方多層級(jí)轉(zhuǎn)發(fā)(都是三方自己實(shí)現(xiàn)的http client) 椭蹄，難免會(huì)出現(xiàn)一些紕漏矮瘟，這時(shí)越往后的服務(wù)獲取用戶真實(shí) ip 越加困難，你甚至不知道自己獲取的 ip 是否是真實(shí)的塑娇。

但是我們的客戶經(jīng)由三方轉(zhuǎn)發(fā)而來(lái)的流量澈侠，那么客戶極大多數(shù)甚至排除測(cè)試之外都是公網(wǎng)用戶，結(jié)合使用 ClientPublicIP 和 ClientIP 方法總能更好的獲取用戶的真實(shí) ip埋酬。

// var r *http.Request
ip := exnet.ClientPublicIP(r)
if ip == ""{
  ip = exnet.ClientIP(r)
}

用上面的方法總能有效的獲取用戶真實(shí)的 ip 地址哨啃，下面分析下兩個(gè)方法的具體實(shí)現(xiàn)烧栋。

// ClientIP 盡最大努力實(shí)現(xiàn)獲取客戶端 IP 的算法。
// 解析 X-Real-IP 和 X-Forwarded-For 以便于反向代理（nginx 或 haproxy）可以正常工作拳球。
func ClientIP(r *http.Request) string {
    xForwardedFor := r.Header.Get("X-Forwarded-For")
    ip := strings.TrimSpace(strings.Split(xForwardedFor, ",")[0])
    if ip != "" {
        return ip
    }

    ip = strings.TrimSpace(r.Header.Get("X-Real-Ip"))
    if ip != "" {
        return ip
    }

    if ip, _, err := net.SplitHostPort(strings.TrimSpace(r.RemoteAddr)); err == nil {
        return ip
    }

    return ""
}

ClientIP 首先讀取 X-Forwarded-For header 中用 , 分隔的第一個(gè)ip地址审姓，如果這個(gè)地址不存在，就會(huì)從 X-Real-Ip header 中獲取祝峻，如果還是不存在魔吐，說(shuō)明流量并非是由反向代理轉(zhuǎn)發(fā)而來(lái)，而是客戶端直接請(qǐng)求服務(wù)莱找，這時(shí)通過(guò) http.Request.RemoteAddr 字段截取除去端口號(hào)的 ip 地址酬姆。

這個(gè)方法很簡(jiǎn)單，就是按照 http 約定的格式獲取奥溺，其中 X-Forwarded-For 和 X-Real-Ip header 由反向代理填充辞色，例如 nginx 或 haproxy。

// ClientPublicIP 盡最大努力實(shí)現(xiàn)獲取客戶端公網(wǎng) IP 的算法浮定。
// 解析 X-Real-IP 和 X-Forwarded-For 以便于反向代理（nginx 或 haproxy）可以正常工作相满。
func ClientPublicIP(r *http.Request) string {
    var ip string
    for _, ip = range strings.Split(r.Header.Get("X-Forwarded-For"), ",") {
        ip = strings.TrimSpace(ip)
        if ip != "" && !HasLocalIPddr(ip) {
            return ip
        }
    }

    ip = strings.TrimSpace(r.Header.Get("X-Real-Ip"))
    if ip != "" && !HasLocalIPddr(ip) {
        return ip
    }

    if ip, _, err := net.SplitHostPort(strings.TrimSpace(r.RemoteAddr)); err == nil {
        if !HasLocalIPddr(ip) {
            return ip
        }
    }

    return ""
}

ClientPublicIP 很簡(jiǎn)單，和 ClientIP 方法的讀取順序一樣桦卒，只是試圖中 X-Forwarded-For 列表中找到一個(gè)公網(wǎng)ip立美，如果沒(méi)有檢查 X-Real-Ip 是否是一個(gè)公網(wǎng) ip，其次檢查 http.Request.RemoteAddr 是否是公網(wǎng)ip方灾，如果沒(méi)有找到公網(wǎng) ip 這返回一個(gè)空字符串悯辙。

這個(gè)方法可以讓我們有機(jī)會(huì)優(yōu)先獲取到用戶的公網(wǎng) ip，往往公網(wǎng) ip 對(duì)我們來(lái)說(shuō)更有價(jià)值迎吵。

檢查ip對(duì)否是內(nèi)網(wǎng)地址

exnet 中還提供了檢查 ip 地址是否是內(nèi)網(wǎng)地址躲撰，這在有些情況下非常有用，比如：服務(wù)中有些接口只能內(nèi)網(wǎng)訪問(wèn)击费，也就是只允許管理員訪問(wèn)（例如動(dòng)態(tài)設(shè)定日志級(jí)別拢蛋、查看服務(wù) pprof 信息）；我們想隱藏后端服務(wù)蔫巩，只暴露給用戶負(fù)載均衡(反向代理)谆棱，用戶無(wú)法直接訪問(wèn)我們的服務(wù)，這些方法及其有用圆仔，下面看看具體實(shí)現(xiàn)垃瞧。

我的服務(wù)提供了動(dòng)態(tài)設(shè)置日志級(jí)別，以便服務(wù)出現(xiàn)問(wèn)題坪郭，可以第一時(shí)間查看調(diào)試日志分析具體原因个从，但是這個(gè)接口很危險(xiǎn)，不應(yīng)該暴露給公網(wǎng)，所以會(huì)用路由中間件檢查請(qǐng)求是否來(lái)自公網(wǎng)嗦锐，來(lái)自公網(wǎng)則返回 404嫌松。

該方法認(rèn)為如下地址段都是內(nèi)網(wǎng)地址：

10.0.0.0/8
169.254.0.0/16
172.16.0.0/12
172.17.0.0/12
172.18.0.0/12
172.19.0.0/12
172.20.0.0/12
172.21.0.0/12
172.22.0.0/12
172.23.0.0/12
172.24.0.0/12
172.25.0.0/12
172.26.0.0/12
172.27.0.0/12
172.28.0.0/12
172.29.0.0/12
172.30.0.0/12
172.31.0.0/12
192.168.0.0/16

// HasLocalIPddr 檢測(cè) IP 地址字符串是否是內(nèi)網(wǎng)地址
func HasLocalIPddr(ip string) bool {
    return HasLocalIP(net.ParseIP(ip))
}

// HasLocalIP 檢測(cè) IP 地址是否是內(nèi)網(wǎng)地址
func HasLocalIP(ip net.IP) bool {
    for _, network := range localNetworks {
        if network.Contains(ip) {
            return true
        }
    }

    return ip.IsLoopback()
}

兩個(gè)檢查方法實(shí)現(xiàn)差異僅接受參數(shù)類型不一致，檢查過(guò)程都是逐個(gè)對(duì)比內(nèi)網(wǎng) ip 段是否包含該ip地址奕污，如果不包含則判斷該地址是否是回環(huán)地址萎羔。

獲取反向代理ip

如何判斷改地址來(lái)自反向代理服務(wù)器呢，不同的反向代理實(shí)現(xiàn)都有些差異碳默，4 層反向代理甚至可以提供用戶的真實(shí) ip（http.Request.RemoteAddr 是用戶的ip贾陷，而不是反向代理的）， 而隱藏自己的ip嘱根，這里說(shuō)一下常見的方法髓废。

往往 http.Request.RemoteAddr 保存最后一個(gè)連接服務(wù)的客戶端 ip，我們獲取反向代理的ip地址儿子，最簡(jiǎn)單有效的方法就是通過(guò) http.Request.RemoteAddr 獲取瓦哎， exnet 中提供了 RemoteIP 的快捷方法砸喻，實(shí)現(xiàn)如下：

// RemoteIP 通過(guò) RemoteAddr 獲取 IP 地址柔逼， 只是一個(gè)快速解析方法。
func RemoteIP(r *http.Request) string {
    if ip, _, err := net.SplitHostPort(strings.TrimSpace(r.RemoteAddr)); err == nil {
        return ip
    }

    return ""
}

這是一個(gè)非常方便的腳手架割岛，它僅僅切分 http.Request.RemoteAddr 的 ip 和端口愉适，并返回有效的ip地址，但卻可以簡(jiǎn)化我們的編寫業(yè)務(wù)代碼癣漆。

轉(zhuǎn)載：

本文作者： 戚銀（thinkeridea）

本文鏈接： https://blog.thinkeridea.com/201903/go/get_client_ip.html

版權(quán)聲明： 本博客所有文章除特別聲明外维咸，均采用 CC BY 4.0 CN協(xié)議 許可協(xié)議。轉(zhuǎn)載請(qǐng)注明出處惠爽！