介绍一个日志记录函数

框架的好处之一是有完整的日志记录系统，但都只是针对框架本身的，比如记录数据库调用信息，记录表单值和框架方法之间的参数和返回值等。但是如果项目之间涉及到跨平台，这个日志系统就显得微乎其微了。比如我之前参加的一个项目，主要是使用PHP来编写前段，包含几乎全部的业务逻辑，但是不需要操作数据库，因为操作数据库的所有事情都交给Java语言去实现了。而我们PHP组编写代码的其实只有6个人，但是给我们提供数据库操作的Java组就有30 多个人，按道理应该很容易将这个项目做出来。也只有经历过才觉得这之间的痛苦，这其中我们过的并不快乐。要知道，测试有任何问题都是找到我们，丝毫和接口没任何关系。而我们debug的结果是，自己去找Java中提供该接口的那个人。特别浪费时间，效率低并且接口的质量严重不过关。导致项目拖了两年 还久，直到现在都还在死死挣扎之中，我也是现在离开这家公司了。

还是后来有了新组长，他编码比较强，有很多年的工作经验。他来后就给我们写了这个函数，作用很简单，就是用来给Java接口debug的，我们只需要监控该函数产生的日志，就完全知道怎么回事了。

1.第一个函数是调用Java接口，使用PHP的扩展cURL中间件来实现，只需要简单的设置就可以使用了，我们的函数原型是这样的：

 

/**
 *
 * @name rop调用数据
 * @param unknown $method            
 * @param unknown $params            
 * @param string $version            
 * @param string $format            
 * @return Ambigous <multitype:, string, mixed>
 */
function calljava($module, $method, $params , $version = '1.0')
{
    $start = microtime(true);
    $ret = array(
        'code' => '999999'
    );
    
    $callurl = geturl($module, $method, $version);
    if ($callurl) {
        $postQs = http_build_query($params);
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $callurl);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $postQs);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_TIMEOUT, 60);
        $output = curl_exec($ch);
        
        if ($errno = curl_errno($ch)) {
            $output = "Error [$errno]: " . curl_error($ch);
        } else {
            $ret = json_decode($output, true);
        }
        curl_close($ch);
        $duration = $start - microtime(true);
        writeLog($callurl, $method, $params, $output, $duration);
    }
    return $ret;
}

 

2.第二个函数只是将各种接口的地址进行归类

//获取接口调用地址

 

function geturl($module, $method, $version)
{
    $callurl = '';
    $appKey = '00001';
    $sign = '***A9957CCDB2';
    switch ($module) {
        case 'bidding':
            $url = C('INTERFACE_BIDDING_URL') ."/bidKing-rs/router?";
            break;
        case 'auction':
            $url = C('INTERFACE_AUCTION_URL') ."/bidKing-rs/router?";
            break;
        //一堆地址列表
    }
    
    if (! $url) {
        writeLog('', '', '', '', 0);
    } elseif (! $method) {
        writeLog($callurl, '', '', '', 0);
    } else {
        $qs = "m=" . $method . "&v=" . $version . "&f=json&ak=" . $appKey . "&s=" . $sign;
        $callurl = $url . $qs;
    }
    return $callurl;
}

 

3.第三个函数就比较重要了，虽然简单，但是就是它给接口调用反馈了一个清晰的提示，并且将日志记录到文件中，每个组都可以在浏览器中通过

接口路径查看自己的接口究竟产生了一些什么信息，还能看到是不是自己的错误或者疏漏。

 

/**
 *
 * @name 记录日志
 * @param unknown $url:调用的url地址            
 * @param unknown $method:调用的方法            
 * @param unknown $request:传参            
 * @param unknown $response:返回信息            
 * @param unknown $duration:消耗时间            
 * @param string $type:日志类型，Info,
 *            Warning, Error
 */
function writeLog($url, $method, $request, $response, $duration)
{
    $uri = isset($_SERVER["REQUEST_URI"]) ? $_SERVER["REQUEST_URI"] : '';
    $serverip = isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : 'unknown';
    
    $log = "[" . date('Y-m-d H:i:s') . "]";
    if (! $url || ! $method || ! $request) {
        $log .= "\r\n-------------------------------\r\n";
        $log .= "Log Type: User Request Error!!!";
        $log .= "\r\n-------------------------------\r\n";
        $log .= "Error Message: Some necessary parameters are empty";
        $log .= "\r\n-------------------------------\r\n";
        $log .= "Solution: \r\ncallurl:" . $url . "\r\nmethod:" . $method . "\r\nrequest:" . var_export($request, true);
    } else {
        if (! $response) {
            $log .= "\r\n-------------------------------\r\n";
            $log .= "Log Type: System Response Error!!!";
            $log .= "\r\n-------------------------------\r\n";
            $log .= "Error Message: Server Response is empty";
        } else {
            $rjson = json_decode($response, true);
            if ($rjson['code'] == 1) {
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Log Type: System Error!!";
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Error Message: " . $rjson['message'];
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Solution: " . $rjson['solution'];
            } elseif (in_array($rjson['code'], array(
                8,
                23,
                25,
                27,
                30,
                32,
                33
            ))) {
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Log Type: User Request Error!!!";
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Error Message: " . $rjson['message'];
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Solution: " . $rjson['solution'];
            } elseif ($rjson['code'] != '000000') {
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Log Type: Error";
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Error Message: " . $rjson['message'];
                $log .= "\r\n-------------------------------\r\n";
                $log .= "Solution: " . $rjson['solution'];
            }
        }
    }
    $log .= "\r\n-------------------------------\r\n";
    $log .= "REQUEST URI: " . $uri;
    $log .= "\r\n-------------------------------\r\n";
    $log .= "Call Method: " . MODULE_NAME . '/' . CONTROLLER_NAME . '/' . ACTION_NAME;
    $log .= "\r\n-------------------------------\r\n";
    $log .= "Interface Url: " . $url. '&'. http_build_query($request);;
    $log .= "\r\n-------------------------------\r\n";
    $log .= "Interface Method: " . $method;
    $log .= "\r\n-------------------------------\r\n";
    $log .= "Request Data: \r\n" . var_export($request, true);
    $log .= "\r\n-------------------------------\r\n";
    $log .= "Response Data: \r\n" . var_export(json_decode($response, true), true);
    $log .= "\r\n-------------------------------\r\n";
    $log .= "Duration time: " . abs($duration);
    $log .= "\r\n-------------------------------\r\n";
    $log .= "User Client IP: " . get_client_ip();
    $log .= "\r\n-------------------------------\r\n";
    $log .= "Server IP: " . $serverip;
    $log .= "\r\n-------------------------------\r\n\r\n";
    
    $logpath = LOG_PATH;
    
    if (! is_dir($logpath)) {
        mkdir($logpath);
    }
    if(! is_dir($logpath .'/byMember')){
        mkdir($logpath.'/byMember');
    }
    if(! is_dir($logpath .'/byHour')){
        mkdir($logpath.'/byHour');
    }
    if(! is_dir($logpath .'/byInterface')){
        mkdir($logpath.'/byInterface');
    }
    if(! is_dir($logpath .'/byModule')){
        mkdir($logpath.'/byModule');
    }
    $logfile = $logpath . '/byHour/' . date('YmdH') . '.log.txt';
    $f = fopen($logfile, 'a+');
    fwrite($f, $log);
    fclose($f);
    $logfile = $logpath . '/byInterface/' . $method . '.log.txt';
    $f = fopen($logfile, 'a+');
    fwrite($f, $log);
    fclose($f);
    $logfile = $logpath . '/byModule/' . MODULE_NAME . '-' . CONTROLLER_NAME . '-' . ACTION_NAME . '.log.txt';
    $f = fopen($logfile, 'a+');
    fwrite($f, $log);
    fclose($f);
    if(isset($_SESSION['user']['MEMBERID']))
    {
        $logfile = $logpath . '/byMember/' . $_SESSION['user']['MEMBERID'].'.log.txt';
        $f = fopen($logfile, 'a+');
        fwrite($f, $log);
        fclose($f);
    }
}