zhamao-robot/zhamao-logger
1
0
Fork 0
mirror of https://github.com/zhamao-robot/zhamao-logger.git synced 2026-07-02 14:25:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from zhamao-robot/refactor-logger

Browse Source 
重构 ConsoleLogger
This commit is contained in:
sunxyw
2022-05-14 01:00:27 +08:00
committed by GitHub
parent 7a386bc1ed 9bfa140de1
commit 2afe08d396
2 changed files with 161 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
composer.json
View File

@@ -61,6 +61,7 @@
"[ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/cghooks add"
],
"analyse": "phpstan analyse --memory-limit 300M",
"cs-fix": "php-cs-fixer fix"
"cs-fix": "php-cs-fixer fix",
"test": "phpunit --no-coverage"
}
}

218
src/ZM/Logger/ConsoleLogger.php
View File

@@ -12,24 +12,41 @@ class ConsoleLogger extends AbstractLogger
{
public const VERSION = '1.0.0-alpha';
public static $format = '[%date%] [%level%] %process%%body%';
/**
* 日志输出格式
*
* @var string
*/
public static $format = '[%date%] [%level%] %body%';
/**
* 日志输出日期格式
*
* @var string
*/
public static $date_format = 'Y-m-d H:i:s';
/**
* @var string[][] 颜色表
* 颜色表
*
* @var string[][]
*/
protected static $styles = [
LogLevel::EMERGENCY => ['blink', 'white', 'bg_bright_red'],
LogLevel::ALERT => ['white', 'bg_bright_red'],
LogLevel::CRITICAL => ['underline', 'red'],
LogLevel::ERROR => ['red'],
LogLevel::WARNING => ['bright_yellow'],
LogLevel::NOTICE => ['cyan'],
LogLevel::INFO => ['green'],
LogLevel::DEBUG => ['gray'],
['blink', 'white', 'bg_bright_red'], // emergency
['white', 'bg_bright_red'], // alert
['underline', 'red'], // critical
['red'], // error
['bright_yellow'], // warning
['cyan'], // notice
['green'], // info
['gray'], // debug
];
/**
* 等级表
*
* @var string[]
*/
protected static $levels = [
LogLevel::EMERGENCY, // 0
LogLevel::ALERT, // 1
@@ -41,17 +58,40 @@ class ConsoleLogger extends AbstractLogger
LogLevel::DEBUG, // 7
];
protected static $logLevel;
/**
* 当前日志等级
*
* @var int
*/
protected static $log_level;
protected $exceptionHandler;
/**
* 静态上下文
*
* @var array
*/
protected $static_context = [];
public function __construct($logLevel = LogLevel::INFO)
/**
* 日志记录回调
*
* @var callable[]
*/
protected $log_callbacks = [];
/**
* 创建一个 ConsoleLogger 实例
*
* @param string $level 日志等级
*/
public function __construct(string $level = LogLevel::INFO)
{
self::$logLevel = array_flip(self::$levels)[$logLevel];
//ExceptionHandler::getInstance();
self::$log_level = $this->castLogLevel($level);
}
/**
* 获取当前样式表
*
* @return string[][]
*/
public static function getStyles(): array
@@ -59,13 +99,33 @@ class ConsoleLogger extends AbstractLogger
return self::$styles;
}
public function colorize($string, $level): string
/**
* 获取版本号
*/
public static function getVersion(): string
{
$string = $this->stringify($string);
$styles = self::$styles[$level] ?? [];
return ConsoleColor::apply($styles, $string)->__toString();
return self::VERSION;
}
/**
* 添加静态上下文
*/
public function addStaticContext(array $context): void
{
$this->static_context = array_merge($this->static_context, $context);
}
/**
* 添加日志记录回调
*/
public function addLogCallback(callable $callback): void
{
$this->log_callbacks[] = $callback;
}
/**
* 打印执行栈
*/
public function trace(): void
{
$log = "Stack trace:\n";
@@ -84,82 +144,114 @@ class ConsoleLogger extends AbstractLogger
}
$log .= "{$t['function']}()\n";
}
$log = $this->colorize($log, LogLevel::DEBUG);
$log = $this->colorize($log, $this->castLogLevel(LogLevel::DEBUG));
echo $log;
}
public function getTrace(): string
/**
* 根据日志等级将样式应用至指定字符串
*
* @param mixed $string 日志内容
* @param int $level 日志等级
*/
public function colorize($string, int $level): string
{
// if (self::$info_level !== null && self::$info_level == 4) {
// $trace = debug_backtrace()[2] ?? ['file' => '', 'function' => ''];
// $trace = '[' . ($trace['class'] ?? '') . ':' . ($trace['function'] ?? '') . '] ';
// }
// return $trace ?? '';
return '';
$string = $this->stringify($string);
$styles = self::$styles[$level] ?? [];
return ConsoleColor::apply($styles, $string)->__toString();
}
// $trace = debug_backtrace()[1] ?? ['file' => '', 'function' => ''];
// $trace = '[' . ($trace['class'] ?? '') . ':' . ($trace['function'] ?? '') . '] ';
/**
* {@inheritDoc}
*/
public function log($level, $message, array $context = []): void
{
if (!in_array($level, self::$levels, true)) {
throw new InvalidArgumentException();
}
$level = $this->castLogLevel($level);
if (array_flip(self::$levels)[$level] > self::$logLevel) {
if (!$this->shouldLog($level)) {
return;
}
$output = str_replace(
['%date%', '%level%', '%body%'],
[date(self::$date_format), strtoupper(substr($level, 0, 4)), $message],
[date(self::$date_format), strtoupper(substr(self::$levels[$level], 0, 4)), $message],
self::$format
);
$output = $this->interpolate($output, $context);
$output = $this->interpolate($output, array_merge($this->static_context, $context));
foreach ($this->log_callbacks as $callback) {
if ($callback($level, $output, $message, $context) === false) {
return;
}
}
echo $this->colorize($output, $level) . "\n";
}
public static function getVersion(): string
/**
* 转换日志等级
*/
private function castLogLevel(string $level): int
{
return self::VERSION;
if (in_array($level, self::$levels, true)) {
return array_flip(self::$levels)[$level];
}
private function stringify($item)
throw new InvalidArgumentException('无效的日志等级');
}
/**
* 将日志内容转换为字符串
*
* @param mixed $item 日志内容
*/
private function stringify($item): string
{
if (is_object($item) && method_exists($item, '__toString')) {
return $item;
}
if (is_string($item) || is_numeric($item)) {
return $item;
}
if (is_callable($item)) {
return '{Closure}';
}
if (is_bool($item)) {
return $item ? '*True*' : '*False*';
}
switch (true) {
case is_callable($item):
if (is_array($item)) {
return json_encode(
$item,
JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_LINE_TERMINATORS
);
if (is_object($item[0])) {
return get_class($item[0]) . '@' . $item[1];
}
if (is_resource($item)) {
return '{Resource}';
return $item[0] . '::' . $item[1];
}
if (is_null($item)) {
return 'NULL';
return 'closure';
case is_string($item):
return $item;
case is_array($item):
return 'array' . json_encode($item, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_LINE_TERMINATORS);
case is_object($item):
return get_class($item);
case is_resource($item):
return 'resource(' . get_resource_type($item) . ')';
case is_null($item):
return 'null';
case is_bool($item):
return $item ? 'true' : 'false';
case is_float($item):
case is_int($item):
return (string) $item;
default:
return 'unknown';
}
return '{Not Stringable Object:' . get_class($item) . '}';
}
private function interpolate($message, array $context = [])
/**
* 判断是否应该记录该等级日志
*/
private function shouldLog(int $level): bool
{
if (is_array($message)) {
return $message;
return $level <= self::$log_level;
}
/**
* 插入变量到日志内容中
*
* @param string $message 日志内容
* @param array $context 变量列表
*/
private function interpolate(string $message, array $context = []): string
{
$replace = [];
foreach ($context as $key => $value) {
$replace['{' . $key . '}'] = $this->stringify($value);