日志处理

日志处理

Logger

EasySwoole\Trace\Logger是easyswoole默认的日志处理类,我们只需要直接调用即可使用:

function index()
{
    \EasySwoole\EasySwoole\Logger::getInstance()->log('日志内容');//将记录日志
    \EasySwoole\EasySwoole\Logger::getInstance()->console('控制器输出内容');//将记录日志+输出到控制台
    \EasySwoole\EasySwoole\Logger::getInstance()->logWithLocation('日志内容+文件来源');//将记录日志+调用该方法的文件地址和文件行数
    \EasySwoole\EasySwoole\Logger::getInstance()->consoleWithLocation('控制器输出内容+文件来源');//将记录日志+输出到控制台+调用该方法的文件地址和文件行数
    $this->writeJson(200, [], 'success');
}

将输出/记录以下内容:

[2019-04-12 10:04:18][default]控制器输出内容
[2019-04-12 10:04:18][default][file:/www/easyswoole/easyswoole-test/App/HttpController/Index.php][line:26]控制器输出内容

Trigger

\EasySwoole\EasySwoole\Trigger触发器,用于主动触发错误或者异常而不中断程序继续执行。
例如在控制器的onException中,我们可以记录错误异常,然后输出其他内容,不让系统终端运行,不让用户发觉真实错误.

function onException(\Throwable $throwable): void
{
    //记录错误异常日志,等级为Exception
    Trigger::getInstance()->throwable($throwable);
    //记录错误信息,等级为FatalError
    Trigger::getInstance()->error($throwable->getMessage().'666');
    //直接给前端响应500并输出系统繁忙
    $this->response()->withStatus(Status::CODE_INTERNAL_SERVER_ERROR);
    $this->response()->write('系统繁忙,请稍后再试 ');
}

自定义logger

如果你不想使用框架默认的记录日志逻辑,可以自定义logger的实现.
例如,框架的记录日志是记录到文件,我们可以改成记录到数据库,或者直接把错误发送短信到手机上(只是举例).

新增文件App/Utility/Logger.php:

<?php
/**
 * Created by PhpStorm.
 * User: Tioncico
 * Date: 2019/3/18 0018
 * Time: 14:56
 */
namespace App\Utility;
use EasySwoole\Trace\AbstractInterface\LoggerInterface;
class Logger implements LoggerInterface
{
    /**
     * 打印到控制台并记录日志
     * console
     * @param string $str
     * @param null   $category
     * @param bool   $saveLog
     * @return string|null
     * @author Tioncico
     * Time: 14:57
     */
    public function console(string $str, $category = null, $saveLog = true): ?string
    {
        //自定义逻辑,这里只echo了字符串,我们可以参考框架本身的,再调用一下log记录一下
        echo $str;
        return $str;//必须返回字符串回去
  }
    /**
     * 自定义进行日志存储,比如存到数据库,存到文件,或者请求其他地方存储
     * log
     * @param string   $str
     * @param null     $logCategory
     * @param int|null $timestamp
     * @return string|null
     * @author Tioncico
     * Time: 14:56
     */
    public function log(string $str, $logCategory = null, int $timestamp = null): ?string
    {
        //自定义逻辑,例如存储到数据库,短信发送错误数据到手机等等        
        file_put_contents(getcwd()."/test.log",$str.PHP_EOL,FILE_APPEND);
        return $str;//必须返回字符串回去
  }
}

在EasySwooleEvent.php中的initialize方法进行注册:

<?php
public static function initialize()
{
    // TODO: Implement initialize() method.
    date_default_timezone_set('Asia/Shanghai');
    Di::getInstance()->set(SysConst::LOGGER_HANDLER,\App\Utility\Logger::class);
}

调用:

function index()
{
    \EasySwoole\EasySwoole\Logger::getInstance()->log('日志内容');//将记录日志
    \EasySwoole\EasySwoole\Logger::getInstance()->console('控制器输出内容');//将记录日志+输出到控制台
    $this->writeJson(200, [], 'success');
}

自定义Trigger

同样,如果不想使用框架自带的Trigger处理,也可以自行实现
我们需要通过实现EasySwoole\Trace\AbstractInterface\TriggerInterface接口进行实现处理类:
新增文件App/Utility/Trigger.php

<?php
/**
 * Created by PhpStorm.
 * User: Tioncico
 * Date: 2019/3/18 0018
 * Time: 14:34
 */
namespace App\Utility;
use EasySwoole\EasySwoole\Logger;
use EasySwoole\Trace\AbstractInterface\TriggerInterface;
use EasySwoole\Trace\Bean\Location;
class Trigger implements TriggerInterface
{
    public function error($msg, int $errorCode = E_USER_ERROR, Location $location = null)
    {
        Logger::getInstance()->console('这是自定义输出的错误:'.$msg);
        // TODO: Implement error() method.
    }
    public function throwable(\Throwable $throwable)
    {
        Logger::getInstance()->console('这是自定义输出的异常:'.$throwable->getMessage());
        // TODO: Implement throwable() method.
    }
}

在EasySwooleEvent.php的initialize方法中进行注入:

    public static function initialize()
    {
        // TODO: Implement initialize() method.
        date_default_timezone_set('Asia/Shanghai');
        Di::getInstance()->set(SysConst::TRIGGER_HANDLER,\App\Utility\Trigger::class);
    }

调用:

<?php
/**
 * Created by PhpStorm.
 * User: Tioncico
 * Date: 2019/4/11 0011
 * Time: 14:40
 */
namespace App\HttpController;
use EasySwoole\EasySwoole\Trigger;
use EasySwoole\Http\AbstractInterface\Controller;
use EasySwoole\Http\Message\Status;
class Index extends Controller
{
    function index()
    {
        $a = new  a();//new一个不存在的类去触发
        $this->writeJson(200, [], 'success');
    }
    function onException(\Throwable $throwable): void
    {
        //记录错误异常日志,等级为Exception
        Trigger::getInstance()->throwable($throwable);
        //记录错误信息,等级为FatalError
        Trigger::getInstance()->error($throwable->getMessage() . '666');
        //直接给前端响应500并输出系统繁忙
        $this->response()->withStatus(Status::CODE_INTERNAL_SERVER_ERROR);
        $this->response()->write('系统繁忙,请稍后再试 ');
    }
}