TP5源码分析之ip获取函数

最近在做系统日志功能，需要获取登录用户ip，而系统是TP5已自带获取ip的函数$request->ip()。然后在兴趣下一步步分析了一下该函数并加上了注释

    /**
     * 获取客户端IP地址
     * @param integer   $type 返回类型 0 返回IP地址 1 返回IPV4地址数字
     * @param boolean   $adv 是否进行高级模式获取（有可能被伪装）
     * @return mixed
     */
    public function ip($type = 0, $adv = false)
    {
        $type      = $type ? 1 : 0;    //判断是否传入type=1参数，又则求ipv4地址数字
        static $ip = null;             //定义为静态变量，防止重复调用
        if (null !== $ip) {
            return $ip[$type];
        }
        /*
         * 获取客户端ip有几种方式，当用户使用了代理服务器的时候，通过$_SERVER['HTTP_X_FORWARDED_FOR']或
         * $_SERVER['HTTP_CLIENT_IP']获取，当然获取ip的方式不止包括这些，还有比如getenv('REMOTE_ADDR')等
         * */
        if ($adv) {
            //对用户是否传参数判断通过什么方式获取ip
            if (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) {
                $arr = explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);   //等到代理ip和用户本机ip
                $pos = array_search('unknown', $arr);                       //对获取的值进行过滤判断
                if (false !== $pos) {
                    unset($arr[$pos]);
                }
                $ip = trim(current($arr));
            } elseif (isset($_SERVER['HTTP_CLIENT_IP'])) {
                $ip = $_SERVER['HTTP_CLIENT_IP'];
            } elseif (isset($_SERVER['REMOTE_ADDR'])) {
                $ip = $_SERVER['REMOTE_ADDR'];
            }
        } elseif (isset($_SERVER['REMOTE_ADDR'])) {
            $ip = $_SERVER['REMOTE_ADDR'];
        }
        // IP地址合法验证
        $long = sprintf("%u", ip2long($ip));
        $ip   = $long ? [$ip, $long] : ['0.0.0.0', 0];
        return $ip[$type];
    }