initialize 事件(即框架初始化事件)
框架初始化事件,在執行 initialize
初始化事件時,EasySwoole
框架此刻已經完成了如下工作:
- 加載配置文件
- 初始化
Log/Temp
目錄,完成系統默認Log/Temp
目錄的定義
函數原型
public static function initialize(): void
{
}
開發者自定義處理
開發者可以在 initialize
事件可以進行如下修改:
- 修改框架默認使用的
error_report
級別,使用自定義的error_report
級別 - 修改框架默認使用的
Logger
處理器,使用自定義的Logger
處理器 - 修改框架默認使用的
Trigger
處理器,使用自定義的Trigger
處理器 - 修改框架默認使用的
Error
處理器,使用自定義的Error
處理器 - 修改框架默認使用的
Shutdown
處理器,使用自定義的Shutdown
處理器 - 修改框架默認使用的
HttpException
全局處理器,使用自定義的HttpException
全局處理器 - 設置
Http
全局OnRequest
及AfterRequest
事件 - 注冊數據庫、Redis 連接池
具體可查看 SysConst.php
使用示例代碼:
<?php
namespace EasySwoole\EasySwoole;
use EasySwoole\EasySwoole\AbstractInterface\Event;
use EasySwoole\EasySwoole\Swoole\EventRegister;
class EasySwooleEvent implements Event
{
public static function initialize()
{
// TODO: Implement initialize() method.
date_default_timezone_set('Asia/Shanghai');
// 開發者自定義設置 錯誤級別
\EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::ERROR_REPORT_LEVEL, E_ALL);
// 開發者自定義設置 日志處理類(該類需要實現 \EasySwoole\Log\LoggerInterface,開發者可自行查看并實現,方便開發者自定義處理日志)
$logDir = EASYSWOOLE_LOG_DIR; // 定義日志存放目錄
$loggerHandler = new \EasySwoole\Log\Logger($logDir); // 定義日志處理對象
\EasySwoole\Component\Di::getInstance()->set(SysConst::LOGGER_HANDLER, $loggerHandler);
// 開發者自定義設置 Trace 追蹤器(該類需要實現 \EasySwoole\Trigger\TriggerInterface,開發者可自行查看并實現,方便開發者自定義處理 Trace 鏈路)
// Trace 追蹤器需要依據上面的 logger_handler
\EasySwoole\Component\Di::getInstance()->set(SysConst::TRIGGER_HANDLER, new \EasySwoole\Trigger\Trigger($loggerHandler));
// 開發者自定義設置 error_handler
\EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::ERROR_HANDLER, function ($errorCode, $description, $file = null, $line = null) {
// 開發者對錯誤進行處理
});
// 開發者自定義設置 shutdown
\EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::SHUTDOWN_FUNCTION, function () {
// 開發者對 shutdown 進行處理
});
// 開發者自定義設置 HttpException 全局處理器
\EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::HTTP_EXCEPTION_HANDLER, function ($throwable, Request $request, Response $response) {
$response->withStatus(\EasySwoole\Http\Message\Status::CODE_INTERNAL_SERVER_ERROR);
$response->write(nl2br($throwable->getMessage() . "\n" . $throwable->getTraceAsString()));
Trigger::getInstance()->throwable($throwable);
});
// 開發者自定義設置 onRequest v3.4.x+
\EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::HTTP_GLOBAL_ON_REQUEST, function (\EasySwoole\Http\Request $request, \EasySwoole\Http\Response $response) {
// v3.4.x 之前的版本 onRequest 事件在 EasySwoolEvent.php 中已定義,不必重新設置
});
// 開發者自定義設置 afterRequest v3.4.x+
\EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::HTTP_GLOBAL_AFTER_REQUEST, function (\EasySwoole\Http\Request $request, \EasySwoole\Http\Response $response) {
// v3.4.x 之前的版本 afterRequest 事件在 EasySwoolEvent.php 中已定義,不必重新設置
});
// 注冊數據庫連接及連接池(詳見:http://www.fe88.cn/Components/Orm/install.html)
// 注冊 Redis 連接及連接池(詳見:http://www.fe88.cn/Components/Redis/introduction.html)
}
public static function mainServerCreate(EventRegister $register)
{
}
}
啟用前(在 initialize 事件中)調用協程 API
開發者在 EasySwoole
主服務啟動前調用協程 api
,必須使用如下操作:
$scheduler = new \Swoole\Coroutine\Scheduler();
$scheduler->add(function() {
/* 調用協程API */
});
$scheduler->start();
// 清除全部定時器
\Swoole\Timer::clearAll();
具體使用示例:
<?php
namespace EasySwoole\EasySwoole;
use EasySwoole\EasySwoole\AbstractInterface\Event;
use EasySwoole\EasySwoole\Swoole\EventRegister;
class EasySwooleEvent implements Event
{
public static function initialize()
{
// TODO: Implement initialize() method.
date_default_timezone_set('Asia/Shanghai');
$scheduler = new \Swoole\Coroutine\Scheduler();
$scheduler->add(function() {
/* 調用協程API */
});
$scheduler->start();
// 清除全部定時器
\Swoole\Timer::clearAll();
}
public static function mainServerCreate(EventRegister $register)
{
}
}
在 initialize 事件中調用連接池
initialize
事件在 EasySwoole
生命周期中屬于 主進程
,因此在主進程中創建了連接池可能會導致以下問題:
- 創建了全局的定時器
- 創建了全局的
EventLoop
- 創建的連接被跨進程公用,因此我們以服務啟動前調用數據庫
ORM
為例:
服務啟動前調用數據庫 ORM
:
下文
\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL')
獲取的 MYSQL 配置,詳細參考 配置文件
<?php
namespace EasySwoole\EasySwoole;
use EasySwoole\EasySwoole\AbstractInterface\Event;
use EasySwoole\EasySwoole\Swoole\EventRegister;
class EasySwooleEvent implements Event
{
public static function initialize()
{
// TODO: Implement initialize() method.
date_default_timezone_set('Asia/Shanghai');
$config = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
\EasySwoole\ORM\DbManager::getInstance()->addConnection(new \EasySwoole\ORM\Db\Connection($config));
// 創建一個協程調度器
$scheduler = new \Swoole\Coroutine\Scheduler();
$scheduler->add(function () {
$builder = new \EasySwoole\Mysqli\QueryBuilder();
$builder->raw('select version()');
\EasySwoole\ORM\DbManager::getInstance()->query($builder, true);
// 這邊重置 ORM 連接池的 pool,避免連接被克隆到子進程,造成連接跨進程公用。
// DbManager 如果有注冊多庫連接,請記得一起 getConnection($name) 獲取全部的 pool 去執行 reset
// 其他的連接池請獲取到對應的 pool,然后執行 reset() 方法
// ORM 1.4.31 版本之前請使用 getClientPool()
// DbManager::getInstance()->getConnection()->getClientPool()->reset();
\EasySwoole\ORM\DbManager::getInstance()->getConnection()->__getClientPool()->reset();
});
//執行調度器內注冊的全部回調
$scheduler->start();
//清理調度器內可能注冊的定時器,不要影響到swoole server 的event loop
\Swoole\Timer::clearAll();
}
public static function mainServerCreate(EventRegister $register)
{
}
}