后端的代码基于thinkphp框架开发，随着业务的增加，代码复杂度不断增多，而且有好几份代码，可能部署在不同的服务器上。即使在测试服务器上经过严格测试，正式环境有时也很难避免出现bug，所以需要较为详细的日志来记录，而且日志要有统一的位置存放。
1.thinkphp本身的异常处理
稍微熟悉thinkphp的都应该知道，它的异常可以自己定义，只要自定定一个handle类，继承think\exception\handle,然后重写里面的render方法，然后在配置文件配置自己定义的异常处理类，就可以根据业务场景的不同，以不同的形式输出异常信息，比如json、html。所以一个工程中是存在多个think\exception\handle的子类的。对应异常信息的记录，其实tp本身是有记录的。
think\Error类异常处理的代码如下。
/**
* Exception Handler
* @access public
* @param \Exception|\Throwable $e
*/
public static function appException($e)
{
if (!$e instanceof \Exception) {
$e = new ThrowableError($e);
}
self::getExceptionHandler()->report($e);
if (PHP_SAPI == 'cli') {
self::getExceptionHandler()->renderForConsole(new ConsoleOutput, $e);
} else {
self::getExceptionHandler()->render($e)->send();
}
}
public static function appError($errno, $errstr, $errfile = '', $errline = 0)
{
$exception = new ErrorException($errno, $errstr, $errfile, $errline);
if (error_reporting() & $errno) {
// 将错误信息托管至 think\exception\ErrorException
throw $exception;
}
self::getExceptionHandler()->report($exception);
}
其中self::getException()就是根据配置获取处理异常的handle实例，然后调用了该实例的report方法。所以report方法是所有异常必经之路。经过report处理以后，才会根据php当前运行模式进行渲染输出。
2.thinkphp异常记录的不足
点击report跳转到think\exception\handle
public function report(Exception $exception)
{
if (!$this->isIgnoreReport($exception)) {
// 收集异常数据
if (Container::get('app')->isDebug()) {
$data = [
'file' => $exception->getFile(),
'line' => $exception->getLine(),
'message' => $this->getMessage($exception),
'code' => $this->getCode($exception),
];
$log = "[{$data['code']}]{$data['message']}[{$data['file']}:{$data['line']}]";
} else {
$data = [
'code' => $this->getCode($exception),
'message' => $this->getMessage($exception),
];
$log = "[{$data['code']}]{$data['message']}";
}
if (Container::get('app')->config('log.record_trace')) {
$log .= "\r\n" . $exception->getTraceAsString();
}
Container::get('log')->record($log, 'error');
}
}
可以看到这是thinkphp默认的异常记录，缺点如下：
- 记录的信息不够详情，仅仅记录了异常信息，没有记录访问的url、参数、用户id和其他相关的信息，对想要更快速的定位异常信息，提供的依据较少。
- 日志记录是记录在文件的，放在了runtime下的log目录，按照日期划分，但是这些文件是有大小和个数限制的。超过了就会合并、改名字、删除。对于需要快速查找日志信息，有的时候不方便，还有可能找不到。
- 对于多服务器部署来说、每个工程下面的日志文件是独立的、没有一个统一的地方去查看这些日志，需要一个工程一个工程去查找日志，非常麻烦。
- 不利于对每天的日志进行分析，统计。
3.我们如何改进
所以我们要强化日志记录功能，因为report方法是tp记录日志的方法，所以显然我们定义一个baseHandle继承 think\exception\handle，然后在baseHandle重写report方法就可以了，然后工程中所有的handle都继承baseHandle，异常自然就会被自定义的report方法里面逻辑处理。到底记录这些异常信息，有很多方案。这里我们用的是mongo存储，尽可能详情的记录。无论如何，把数据都记录在一块了，然后后台增加个查看异常信息的功能，幸福还会远吗？
class BaseHandle extends parentHandle
{
public function report(Exception $exception)
{
parent::report($exception); // TODO: Change the autogenerated stub
try{
// //记录日志
$exceptionLogParam = new ExceptionLogParam();
$exceptionLogParam->exception = $exception->getMessage();
$exceptionLogParam->trace = $exception->getTraceAsString();
$exceptionLogParam->is_cli = PHP_SAPI == 'cli' ? 1 : 0;
$exceptionLogParam->header = \GuzzleHttp\json_encode(Request::header(), JSON_UNESCAPED_UNICODE);
$exceptionLogParam->param = \GuzzleHttp\json_encode(Request::param(), JSON_UNESCAPED_UNICODE);
$exceptionLogParam->method = \GuzzleHttp\json_encode(Request::method(), JSON_UNESCAPED_UNICODE);
$exceptionLogParam->controller = Loader::parseName(Request::controller(), 0);
$exceptionLogParam->param = Request::param();
$exceptionLogParam->param = \GuzzleHttp\json_encode($exceptionLogParam->param, JSON_UNESCAPED_UNICODE);
$exceptionLogParam->action = Request::action();
$exceptionLogParam->module = Request::module();
$exceptionLogParam->user_id = RememberMeHelper::$_userId;
$exceptionLogParam->created_at = time();
$exceptionLogParam->cookie = \GuzzleHttp\json_encode(Request::cookie(),true);
$exceptionLogParam->session = \GuzzleHttp\json_encode(Request::session(),true);
$exceptionLogParam->url = Request::url();
$exceptionLogParam->server_ip = get_server_ip();
$exceptionLogParam->file_line_info = $exception->getFile().$exception->getLine();
ExceptionLogService::getInstance()->create($exceptionLogParam);
}catch (\Exception $exception){
\think\facade\Log::write('存储日志发生了异常');
}
}
}
考虑过的其他存储方法：
- 数据库建立一个exception表专门存储，因为异常信息量可能非常大，用mysql存储代价比较昂贵，而且对mysql的读写性能感觉会有干扰，所以放弃。
- 用一个专门的mongo数据库存储，因为thinkphp的model是可以配置的，只要配置连接数据库是mongo，使用起来没有什么区别。mongo便宜一些，日志存的多，查询方式比较单一，所以选了这个。
- 考虑过ELK，往ES里面写入文档，了解过网上有很多说可以用ELK做日志分析，但是对这个目前使用不熟悉，以后考虑研究下。
网友评论