• 服务热重启
    • 热重载进程

    服务热重启

    由于 swoole 常驻内存的特性，修改文件后需要重启worker进程才能将被修改的文件重新载入内存中，我们可以自定义Process的方式实现文件变动自动进行服务重载

    热重载进程

    新建文件 App/Process/HotReload.php 并添加如下内容，也可以放在其他位置，请对应命名空间

    1. <?php
    2. /**
    3.  * Created by PhpStorm.
    4.  * User: evalor
    5.  * Date: 2018-11-26
    6.  * Time: 23:18
    7.  */
    9. namespace App\Process;
    11. use EasySwoole\Component\Process\AbstractProcess;
    12. use EasySwoole\EasySwoole\ServerManager;
    13. use EasySwoole\Utility\File;
    14. use Swoole\Process;
    15. use Swoole\Table;
    16. use Swoole\Timer;
    18. /**
    19.  * 暴力热重载
    20.  * Class HotReload
    21.  * @package App\Process
    22.  */
    23. class HotReload extends AbstractProcess
    24. {
    25.     /** @var \swoole_table $table */
    26.     protected $table;
    27.     protected $isReady = false;
    29.     protected $monitorDir; // 需要监控的目录
    30.     protected $monitorExt; // 需要监控的后缀
    32.     /**
    33.      * 启动定时器进行循环扫描
    34.      */
    35.     public function run($arg)
    36.     {
    37.         // 此处指定需要监视的目录 建议只监视App目录下的文件变更
    38.         $this->monitorDir = !empty($arg['monitorDir']) ? $arg['monitorDir'] : EASYSWOOLE_ROOT . '/App';
    40.         // 指定需要监控的扩展名 不属于指定类型的的文件 无视变更 不重启
    41.         $this->monitorExt = !empty($arg['monitorExt']) && is_array($arg['monitorExt']) ? $arg['monitorExt'] : ['php'];
    43.         if (extension_loaded('inotify') && empty($arg['disableInotify'])) {
    44.             // 扩展可用 优先使用扩展进行处理
    45.             $this->registerInotifyEvent();
    46.             echo "server hot reload start : use inotify\n";
    47.         } else {
    48.             // 扩展不可用时 进行暴力扫描
    49.             $this->table = new Table(512);
    50.             $this->table->column('mtime', Table::TYPE_INT, 4);
    51.             $this->table->create();
    52.             $this->runComparison();
    53.             Timer::tick(1000, function () {
    54.                 $this->runComparison();
    55.             });
    56.             echo "server hot reload start : use timer tick comparison\n";
    57.         }
    58.     }
    60.     /**
    61.      * 扫描文件变更
    62.      */
    63.     private function runComparison()
    64.     {
    65.         $startTime = microtime(true);
    66.         $doReload = false;
    68.         $dirIterator = new \RecursiveDirectoryIterator($this->monitorDir);
    69.         $iterator = new \RecursiveIteratorIterator($dirIterator);
    70.         $inodeList = array();
    72.         // 迭代目录全部文件进行检查
    73.         foreach ($iterator as $file) {
    74.             /** @var \SplFileInfo $file */
    75.             $ext = $file->getExtension();
    76.             if (!in_array($ext, $this->monitorExt)) {
    77.                 continue; // 只检查指定类型
    78.             } else {
    79.                 // 由于修改文件名称 并不需要重新载入 可以基于inode进行监控
    80.                 $inode = $file->getInode();
    81.                 $mtime = $file->getMTime();
    82.                 array_push($inodeList, $inode);
    83.                 if (!$this->table->exist($inode)) {
    84.                     // 新建文件或修改文件 变更了inode
    85.                     $this->table->set($inode, ['mtime' => $mtime]);
    86.                     $doReload = true;
    87.                 } else {
    88.                     // 修改文件 但未发生inode变更
    89.                     $oldTime = $this->table->get($inode)['mtime'];
    90.                     if ($oldTime != $mtime) {
    91.                         $this->table->set($inode, ['mtime' => $mtime]);
    92.                         $doReload = true;
    93.                     }
    94.                 }
    95.             }
    96.         }
    98.         foreach ($this->table as $inode => $value) {
    99.             // 迭代table寻找需要删除的inode
    100.             if (!in_array(intval($inode), $inodeList)) {
    101.                 $this->table->del($inode);
    102.                 $doReload = true;
    103.             }
    104.         }
    106.         if ($doReload) {
    107.             $count = $this->table->count();
    108.             $time = date('Y-m-d H:i:s');
    109.             $usage = round(microtime(true) - $startTime, 3);
    110.             if (!$this->isReady == false) {
    111.                 // 监测到需要进行热重启
    112.                 echo "severReload at {$time} use : {$usage} s total: {$count} files\n";
    113.                 ServerManager::getInstance()->getSwooleServer()->reload();
    114.             } else {
    115.                 // 首次扫描不需要进行重启操作
    116.                 echo "hot reload ready at {$time} use : {$usage} s total: {$count} files\n";
    117.                 $this->isReady = true;
    118.             }
    119.         }
    120.     }
    122.     /**
    123.      * 注册Inotify监听事件
    124.      */
    125.     private function registerInotifyEvent()
    126.     {
    127.         // 因为进程独立 且当前是自定义进程 全局变量只有该进程使用
    128.         // 在确定不会造成污染的情况下 也可以合理使用全局变量
    129.         global $lastReloadTime;
    130.         global $inotifyResource;
    132.         $lastReloadTime = 0;
    133.         $files = File::scanDirectory(EASYSWOOLE_ROOT . '/App');
    134.         $files = array_merge($files['files'], $files['dirs']);
    136.         $inotifyResource = inotify_init();
    138.         // 为当前所有的目录和文件添加事件监听
    139.         foreach ($files as $item) {
    140.             inotify_add_watch($inotifyResource, $item, IN_CREATE | IN_DELETE | IN_MODIFY);
    141.         }
    143.         // 加入事件循环
    144.         swoole_event_add($inotifyResource, function () {
    145.             global $lastReloadTime;
    146.             global $inotifyResource;
    147.             $events = inotify_read($inotifyResource);
    148.             if ($lastReloadTime < time() && !empty($events)) { // 限制1s内不能进行重复reload
    149.                 $lastReloadTime = time();
    150.                 ServerManager::getInstance()->getSwooleServer()->reload();
    151.             }
    152.         });
    153.     }
    155.     public function onShutDown()
    156.     {
    157.         // TODO: Implement onShutDown() method.
    158.     }
    160.     public function onReceive(string $str)
    161.     {
    162.         // TODO: Implement onReceive() method.
    163.     }
    164. }

    添加好后在全局的 EasySwooleEvent.php 中，注册该自定义进程

    1. public static function mainServerCreate(EventRegister $register)
    2. {
    3.     $swooleServer = ServerManager::getInstance()->getSwooleServer();
    4.     $swooleServer->addProcess((new HotReload('HotReload', ['disableInotify' => false]))->getProcess());
    5. }

    因为虚拟机中inotify无法监听到FTP/SFTP等文件上传的事件，将 disableInotify 设置为 true ，可以关闭inotify方式的热重启，使得虚拟机环境下，强制使用文件循环扫描来触发重载操作，同理 OSX 开发环境下，没有Inotify扩展，将自动使用扫描式重载