Swoft2 框架精华教程：Swoft 的启动过程与核心源代码解析

protected function processors(): array
{
    return [
        new EnvProcessor($this),
        new ConfigProcessor($this),
        new AnnotationProcessor($this),
        new BeanProcessor($this),
        new EventProcessor($this),
        new ConsoleProcessor($this),
    ];
}

// Load env info
$factory = new DotenvFactory([
    new EnvConstAdapter,
    new PutenvAdapter,
    new ServerConstAdapter
]);

define('APP_DEBUG', (int)env('APP_DEBUG', 0));
define('SWOFT_DEBUG', (int)env('SWOFT_DEBUG', 0));

// Find AutoLoader classes. Parse and collect annotations.
AnnotationRegister::load([
    'inPhar'               => IN_PHAR,
    'basePath'             => $app->getBasePath(),
    'notifyHandler'        => [$this, 'notifyHandle'],
    // TODO force load framework components: bean, error, event, aop
    'disabledAutoLoaders'  => $app->getDisabledAutoLoaders(),
    'excludedPsr4Prefixes' => $app->getDisabledPsr4Prefixes(),
]);
// 获取自动加载所有组件类后，对注解信息的一些统计信息，并且打印到控制台
$stats = AnnotationRegister::getClassStats();
CLog::info(
    'Annotations is scanned(autoloader %d, annotation %d, parser %d)',
    $stats['autoloader'],
    $stats['annotation'],
    $stats['parser']
);

public function load(): void
{
    // 获取主项目中相关的 psr4 标准对应的信息
    $prefixDirsPsr4 = $this->classLoader->getPrefixesPsr4();

    // 遍历主项目中的 psr4 相关信息
    foreach ($prefixDirsPsr4 as $ns => $paths) {
        // Only scan namespaces
        // 是否配置了特定的扫描命名空间，如果是只扫描这个命名空间，其他空间直接跳过
        if ($this->onlyNamespaces && !in_array($ns, $this->onlyNamespaces, true)) {
            $this->notify('excludeNs', $ns);
            continue;
        }

        // It is excluded psr4 prefix
        // 判断当前 psr4 是否配置了排除规则，如果配置过，也跳过不扫
        if ($this->isExcludedPsr4Prefix($ns)) {
            AnnotationRegister::addExcludeNamespace($ns);
            $this->notify('excludeNs', $ns);
            continue;
        }

        // Find package/component loader class
        // 在需要扫描的命名空间对应的文件目录中，扫描是否有自动加载类 AutoLoader.php
        foreach ($paths as $path) {
            // 获取 AutoLoader.php 文件的路径(这里注意不要写成 Autoload.php)
            $loaderFile = $this->getAnnotationClassLoaderFile($path);
            // 如果自动加载文件不存在，交给自动加载不存在的处理函数，跳过本次路径扫描
            if (!file_exists($loaderFile)) {
                $this->notify('noLoaderFile', $this->clearBasePath($path), $loaderFile);
                continue;
            }
      			// 自动加载类存在，则获取 AutoLoader 的带命名空间的完全的类名
            $loaderClass = $this->getAnnotationLoaderClassName($ns);
            // 检测自动加载类是否存在，防止文件名和类名不一致情况
            if (!class_exists($loaderClass)) {
                $this->notify('noLoaderClass', $loaderClass);
                continue;
            }

            $isEnabled  = true;
            $autoLoader = new $loaderClass();
      			// 检测实例化的自动加载类是否实现类 swoft 要求的自动加载类的接口
            if (!$autoLoader instanceof LoaderInterface) {
                $this->notify('invalidLoader', $loaderFile);
                continue;
            }

            $this->notify('findLoaderClass', $this->clearBasePath($loaderFile));

            // If is disable, will skip scan annotation classes
            // 最后再次检查是否是被禁用的自动加载类，或者自动加载类自己配置为不启用
            if (isset($this->disabledAutoLoaders[$loaderClass]) || !$autoLoader->isEnable()) {
                $isEnabled = false;

                $this->notify('disabledLoader', $loaderFile);
            } else {
                // 正常的类加载器，保存下类加载器对应的文件路径
                AnnotationRegister::addAutoLoaderFile($loaderFile);
                $this->notify('addLoaderClass', $loaderClass);

                // Scan and collect class bean s
                // 从一个组件的加载配置中，加载注解相关信息
                $this->loadAnnotation($autoLoader);
            }

            // Storage autoLoader instance to register
            // 存储命名空间，自动加载器实例，是否启用信息到注解注册器
            AnnotationRegister::addAutoLoader($ns, $autoLoader, $isEnabled);
        }
    }
}

/**
 * Load annotations from an component loader config.
 *
 * @param LoaderInterface $loader
 *
 * @throws AnnotationException
 * @throws ReflectionException
 */
private function loadAnnotation(LoaderInterface $loader): void
{
    // 获取当前组件的命名空间和目录的绑定关系
    $nsPaths = $loader->getPrefixDirs();
	// 遍历当前组件命名空间
    foreach ($nsPaths as $ns => $path) {
        // 递归获取当前目录中的子目录和文件，获取一个迭代器
        $iterator = DirectoryHelper::recursiveIterator($path);

        /* @var SplFileInfo $splFileInfo */
        foreach ($iterator as $splFileInfo) {
            // 判断本次迭代的文件到底是文件还是目录，如果是目录则跳过
            $filePath = $splFileInfo->getPathname();
            // $splFileInfo->isDir();
            if (is_dir($filePath)) {
                continue;
            }

            $fileName  = $splFileInfo->getFilename();
            $extension = $splFileInfo->getExtension();
			// 判断当前文件是否是个php文件，不是也跳过
            if ($this->loaderClassSuffix !== $extension || strpos($fileName, '.') === 0) {
                continue;
            }

            // It is exclude filename
            // 判断当前文件是否是排除的文件，如果要排除，也加到注解注册器中的排除文件列表中
            if (isset($this->excludedFilenames[$fileName])) {
                AnnotationRegister::addExcludeFilename($fileName);
                continue;
            }

            $suffix    = sprintf('.%s', $this->loaderClassSuffix);
            $pathName  = str_replace([$path, '/', $suffix], ['', '\\', ''], $filePath);
            $className = sprintf('%s%s', $ns, $pathName);

            // Fix repeat included file bug
            // 如果当前文件已经在包含文件列表中
            $autoload = in_array($filePath, $this->includedFiles, true);

            // Will filtering: interfaces and traits
            // 对于没有包含过的文件，通过 class_exists 的方式自动加载到内存
            if (!class_exists($className, !$autoload)) {
                $this->notify('noExistClass', $className);
                continue;
            }

            // Parse annotation
            // 解析当前类的注解信息，保存到注解注册器中
            $this->parseAnnotation($ns, $className);
        }
    }
}

$handler     = new BeanHandler();
$definitions = $this->getDefinitions();
$parsers     = AnnotationRegister::getParsers();
$annotations = AnnotationRegister::getAnnotations();

BeanFactory::addDefinitions($definitions);
BeanFactory::addAnnotations($annotations);
BeanFactory::addParsers($parsers);
BeanFactory::setHandler($handler);
// 将所有存储到 BeanFactory 的核心bean、注解实例化为 bean 对象，以供取用
BeanFactory::init();

/** @var EventManager $eventManager */
$eventManager = bean('eventManager');
// 注册事件管理器对象，返回事件管理器添加的监听器和订阅者数量
[$count1, $count2] = ListenerRegister::register($eventManager);
// 打印目前事件管理器关联的 Listener 和 subscriber
CLog::info('Event manager initialized(%d listener, %d subscriber)', $count1, $count2);

// 触发一个 app 启动的事件（这个事件会被关联到事件管理器上的处理者观察到并处理相关业务）
Swoft::trigger(SwoftEvent::APP_INIT_COMPLETE);

/**
 * Class AppInitCompleteListener
 *
 * @since 2.0
 *
 * @Listener(SwoftEvent::APP_INIT_COMPLETE)
 */

/** @var Router $router */
$router = bean('cliRouter');

// Register console routes
CommandRegister::register($router);

CLog::info('Console command route registered (group %d, command %d)', $router->groupCount(), $router->count());

// Run console application
if ($this->application->isStartConsole()) {
    // 在 console 组件的 Autoloader::beans 方法中可以找到相应类
    bean('cliApp')->run();
}