orgianze bootstrapper

This commit is contained in:
sunxyw 2022-11-08 17:28:07 +08:00
parent 74ba4d0145
commit aa29dc99f3
No known key found for this signature in database
GPG Key ID: F391C42B19AFFC98
9 changed files with 210 additions and 93 deletions

View File

@ -143,7 +143,7 @@ function container(): ContainerInterface
* 解析类实例(使用容器)
*
* @template T
* @param class-string<T> $abstract
* @param class-string<T> $abstract
* @return Closure|mixed|T
* @noinspection PhpDocMissingThrowsInspection
*/
@ -157,7 +157,7 @@ function resolve(string $abstract, array $parameters = [])
* 获取容器实例
*
* @template T
* @param null|class-string<T> $abstract
* @param null|class-string<T> $abstract
* @return Closure|ContainerInterface|mixed|T
*/
function app(string $abstract = null, array $parameters = [])
@ -196,11 +196,11 @@ function sql_builder(string $name = '')
* 传入数组,设置配置项
* 不传参数,返回配置容器
*
* @param null|array|string $key 键名
* @param mixed $default 默认值
* @param array|string|null $key 键名
* @param mixed|null $default 默认值
* @return mixed|void|ZMConfig
*/
function config($key = null, $default = null)
function config(array|string $key = null, mixed $default = null)
{
$config = ZMConfig::getInstance();
if (is_null($key)) {

View File

@ -0,0 +1,35 @@
<?php
namespace ZM\Bootstrap;
use OneBot\Driver\ExceptionHandler;
use ZM\Exception\Handler;
class HandleExceptions
{
public function bootstrap(array $config): void
{
// 注册全局错误处理器
set_error_handler(function ($error_no, $error_msg, $error_file, $error_line) {
$tips = [
E_WARNING => ['PHP Warning: ', 'warning'],
E_NOTICE => ['PHP Notice: ', 'notice'],
E_USER_ERROR => ['PHP Error: ', 'error'],
E_USER_WARNING => ['PHP Warning: ', 'warning'],
E_USER_NOTICE => ['PHP Notice: ', 'notice'],
E_STRICT => ['PHP Strict: ', 'notice'],
E_RECOVERABLE_ERROR => ['PHP Recoverable Error: ', 'error'],
E_DEPRECATED => ['PHP Deprecated: ', 'notice'],
E_USER_DEPRECATED => ['PHP User Deprecated: ', 'notice'],
];
$level_tip = $tips[$error_no] ?? ['PHP Unknown: ', 'error'];
$error = $level_tip[0] . $error_msg . ' in ' . $error_file . ' on ' . $error_line;
logger()->{$level_tip[1]}($error);
// 如果 return false 则错误会继续递交给 PHP 标准错误处理
return true;
}, E_ALL | E_STRICT);
// 重载异常处理器
ExceptionHandler::getInstance()->overrideWith(new Handler());
}
}

View File

@ -0,0 +1,69 @@
<?php
namespace ZM\Bootstrap;
use OneBot\Driver\Workerman\Worker;
use ZM\Config\ZMConfig;
class LoadConfiguration
{
public function bootstrap(array $config): void
{
$config_i = config();
$config_i->addConfigPath($this->getConfigDir($config));
$config_i->setEnvironment($this->getConfigEnvironment($config));
$this->parseArgvToConfig($config, $config_i);
}
private function getConfigDir(array $config): string
{
$config_dir = $config['config-dir'];
// 默认配置文件目录
$find_dir = [
WORKING_DIR . '/config',
SOURCE_ROOT_DIR . '/config',
];
// 如果启动参数指定了配置文件目录,则优先使用
if ($config_dir !== null) {
array_unshift($find_dir, $config_dir);
}
// 遍历目录,找到第一个存在的目录
foreach ($find_dir as $dir) {
if (is_dir($dir)) {
return $dir;
}
}
// 如果没有找到目录,则抛出异常
throw new \RuntimeException('No config directory found');
}
private function getConfigEnvironment(array $config): string
{
return $config['env'] ?? 'development';
}
private function parseArgvToConfig(array $argv, ZMConfig $config): void
{
foreach ($argv as $x => $y) {
// 当值为 true/false 时,表示该参数为可选参数。当值为 null 时,表示该参数必定会有一个值,如果是 null说明没指定
if ($y === false || is_null($y)) {
continue;
}
switch ($x) {
case 'driver': // 动态设置驱动类型
$config->set('global.driver', $y);
break;
case 'worker-num': // 动态设置 Worker 数量
$config->set('global.swoole_options.swoole_set.worker_num', (int)$y);
$config->set('global.workerman_options.workerman_worker_num', (int)$y);
break;
case 'daemon': // 启动为守护进程
$config->set('global.swoole_options.swoole_set.daemonize', 1);
Worker::$daemonize = true;
break;
}
}
}
}

View File

@ -0,0 +1,11 @@
<?php
namespace ZM\Bootstrap;
class LoadGlobalDefines
{
public function bootstrap(array $config): void
{
require zm_dir(SOURCE_ROOT_DIR . '/src/Globals/global_defines_framework.php');
}
}

View File

@ -0,0 +1,14 @@
<?php
namespace ZM\Bootstrap;
use ZM\Event\EventProvider;
class RegisterEventProvider
{
public function bootstrap(array $config): void
{
global $ob_event_provider;
$ob_event_provider = EventProvider::getInstance();
}
}

View File

@ -0,0 +1,18 @@
<?php
namespace ZM\Bootstrap;
use ZM\Logger\ConsoleLogger;
class RegisterLogger
{
public function bootstrap(array $config): void
{
// 初始化 Logger
if (!ob_logger_registered()) {
// 如果没有注册过 Logger那么就初始化一个在启动框架前注册的话就不会初始化了可替换为其他 Logger
$logger = new ConsoleLogger($config['log-level'] ?? 'info');
ob_logger_register($logger);
}
}
}

View File

@ -0,0 +1,11 @@
<?php
namespace ZM\Bootstrap;
class SetInternalTimezone
{
public function bootstrap(array $config): void
{
date_default_timezone_set(config('global.runtime.timezone', 'UTC'));
}
}

View File

@ -0,0 +1,31 @@
<?php
namespace ZM\Exception;
use OneBot\Driver\ExceptionHandler;
use Throwable;
class Handler extends ExceptionHandler
{
public function __construct()
{
// 我们知道此处没有调用父类的构造函数,这是设计上的缺陷
// 将会在稍后修复
}
public function handle(Throwable $e): void
{
if ($e instanceof ZMKnownException) {
// 如果是已知异常,则可以输出问题说明和解决方案
// TODO
}
if (is_null($this->whoops)) {
ob_logger()->error('Uncaught ' . get_class($e) . ': ' . $e->getMessage() . ' at ' . $e->getFile() . '(' . $e->getLine() . ')');
ob_logger()->error($e->getTraceAsString());
return;
}
// $this->whoops->handleException($e);
}
}

View File

@ -33,6 +33,7 @@ use ZM\Exception\ZMKnownException;
use ZM\Logger\ConsoleLogger;
use ZM\Logger\TablePrinter;
use ZM\Process\ProcessStateManager;
use ZM\Bootstrap;
/**
* 框架入口类
@ -57,10 +58,20 @@ class Framework
/** @var array<array<string, string>> 启动注解列表 */
protected array $setup_annotations = [];
protected array $bootstrappers = [
// 驱动前置
Bootstrap\LoadConfiguration::class,
Bootstrap\LoadGlobalDefines::class,
Bootstrap\RegisterLogger::class,
Bootstrap\HandleExceptions::class,
Bootstrap\RegisterEventProvider::class,
Bootstrap\SetInternalTimezone::class,
];
/**
* 框架初始化文件
*
* @param array<string, null|bool|string> $argv 传入的参数(见 ServerStartCommand
* @param array<string, null|bool|string> $argv 传入的参数(见 ServerStartCommand
* @throws InitException
* @throws \Exception
*/
@ -81,6 +92,10 @@ class Framework
*/
public function init(): Framework
{
foreach ($this->bootstrappers as $bootstrapper) {
app($bootstrapper)->bootstrap($this->argv);
}
// 执行一些 Driver 前置条件的内容
$this->initDriverPrerequisites();
@ -177,70 +192,9 @@ class Framework
* 6. 覆盖 PHP 报错样式解析
* 7. 解析命令行参数
* 8. 读取、解析并执行 OnSetup 注解
*
* @throws ConfigException
*/
public function initDriverPrerequisites()
{
// 寻找配置文件目录
if ($this->argv['config-dir'] !== null) { // 如果启动参数指定了config寻找目录那么就在指定的寻找不在别的地方寻找了
$find_dir = [$this->argv['config-dir']];
logger()->debug('使用命令参数指定的config-dir' . $this->argv['config-dir']);
} else { // 否则就从默认的工作目录或源码根目录寻找
$find_dir = [WORKING_DIR . '/config', SOURCE_ROOT_DIR . '/config'];
}
foreach ($find_dir as $v) {
if (is_dir($v)) {
config()->addConfigPath($v);
config()->setEnvironment($this->argv['env'] = ($this->argv['env'] ?? 'development'));
$config_done = true;
break;
}
}
// 找不到的话直接崩溃,因为框架依赖全局配置文件(但其实这个错误在 3.0 开始应该永远无法执行到)
if (!isset($config_done)) {
echo zm_internal_errcode('E00007') . 'Global config load failed' . "\nPlease init first!\nSee: https://github.com/zhamao-robot/zhamao-framework/issues/37\n";
exit(1);
}
// 初始化框架本体运行需要的常量,比如运行时间等
require zm_dir(__DIR__ . '/../Globals/global_defines_framework.php');
// 初始化 Logger此处为 Master 进程第一次初始化,在后续的多进程环境下,还需要在 Worker 进程中初始化
if (!ob_logger_registered()) { // 如果没有注册过 Logger那么就初始化一个在启动框架前注册的话就不会初始化了可替换为其他 Logger
ob_logger_register(new ConsoleLogger($this->argv['log-level'] ?? 'info'));
}
// 注册自己的EventProvider
global $ob_event_provider;
$ob_event_provider = EventProvider::getInstance();
// 初始化时区,默认为上海时区
date_default_timezone_set(config('global.runtime.timezone'));
// 注册全局错误处理器
set_error_handler(static function ($error_no, $error_msg, $error_file, $error_line) {
$tips = [
E_WARNING => ['PHP Warning: ', 'warning'],
E_NOTICE => ['PHP Notice: ', 'notice'],
E_USER_ERROR => ['PHP Error: ', 'error'],
E_USER_WARNING => ['PHP Warning: ', 'warning'],
E_USER_NOTICE => ['PHP Notice: ', 'notice'],
E_STRICT => ['PHP Strict: ', 'notice'],
E_RECOVERABLE_ERROR => ['PHP Recoverable Error: ', 'error'],
E_DEPRECATED => ['PHP Deprecated: ', 'notice'],
E_USER_DEPRECATED => ['PHP User Deprecated: ', 'notice'],
];
$level_tip = $tips[$error_no] ?? ['PHP Unknown: ', 'error'];
$error = $level_tip[0] . $error_msg . ' in ' . $error_file . ' on ' . $error_line;
logger()->{$level_tip[1]}($error);
// 如果 return false 则错误会继续递交给 PHP 标准错误处理
return true;
}, E_ALL | E_STRICT);
// 解析命令行参数
$this->parseArgs();
// 初始化 @OnSetup 事件
$this->initSetupAnnotations();
}
@ -459,32 +413,6 @@ class Framework
echo $motd;
}
/**
* 解析 argv 参数
*/
private function parseArgs()
{
foreach ($this->argv as $x => $y) {
// 当值为 true/false 时,表示该参数为可选参数。当值为 null 时,表示该参数必定会有一个值,如果是 null说明没指定
if ($y === false || is_null($y)) {
continue;
}
switch ($x) {
case 'driver': // 动态设置驱动类型
config()->set('global.driver', $y);
break;
case 'worker-num': // 动态设置 Worker 数量
config()->set('global.swoole_options.swoole_set.worker_num', intval($y));
config()->set('global.workerman_options.workerman_worker_num', intval($y));
break;
case 'daemon': // 启动为守护进程
config()->set('global.swoole_options.swoole_set.daemonize', 1);
Worker::$daemonize = true;
break;
}
}
}
/**
* 初始化 OnSetup 注解
*/