Маршрутизация модулей: подходы и реализации

Расширенные примеры кода

Пример 1: модульная маршрутизация с кешированием через файл

Используем решение из rbase, но добавляем кеширование объединённых маршрутов в файл, чтобы не перезагружать модули при каждом запросе.

class CachedModuleRouter {
    private string $cacheFile;
    private array $moduleConfig;

    public function __construct(array $moduleConfig, string $cacheFile = 'routes_cache.php') {
        $this->moduleConfig = $moduleConfig;
        $this->cacheFile = $cacheFile;
    }

    public function loadRoutes(bool $forceReload = false): array {
        if (!$forceReload && file_exists($this->cacheFile)) {
            return include $this->cacheFile;
        }

        $routes = [];
        foreach ($this->moduleConfig as $moduleName => $modulePath) {
            $file = $modulePath . '/routes.php';
            if (file_exists($file)) {
                $moduleRoutes = require $file;
                $prefix = '/' . $moduleName;
                foreach ($moduleRoutes as $route => $handler) {
                    $fullRoute = $prefix . $route;
                    $pattern = preg_replace('/\{([a-zA-Z_]+)\}/', '(?P<$1>[^/]+)', $fullRoute);
                    $routes[] = [
                        'route' => $fullRoute,
                        'pattern' => '#^' . $pattern . '$#',
                        'handler' => $handler,
                    ];
                }
            }
        }

        file_put_contents($this->cacheFile, '<?php return ' . var_export($routes, true) . ';');
        return $routes;
    }
}

// Использование
$router = new CachedModuleRouter(['admin' => __DIR__ . '/modules/admin']);
$routes = $router->loadRoutes(false);

// Содержимое routes_cache.php (пример)
<?php return array (
  0 => array (
    'route' => '/admin/dashboard',
    'pattern' => '#^/admin/dashboard$#',
    'handler' => array (0 => 'AdminController', 1 => 'dashboard'),
  ),
);

Пояснение:

При первом запуске маршруты собираются из всех модулей и сериализуются в PHP-файл. При последующих запросах файл просто подключается (быстро). Метод loadRoutes с параметром true принудительно перезагружает кеш.

Пример 2: атрибуты с группировкой и middleware

Усложнённый вариант атрибута #[Route] с поддержкой middleware и групп.

#[Attribute(Attribute::TARGET_METHOD)]
class Route {
    public function __construct(
        public string $path,
        public string $method = 'GET',
        public array $middleware = []
    ) {}
}

// Контроллер с middleware
class UserController {
    #[Route('/profile', middleware: ['auth', 'log'])]
    public function profile() { /* ... */ }
}

// Анализатор, собирающий middleware
class AdvancedAttributeRouter {
    private array $routes = [];

    public function registerClass(string $className, string $modulePrefix): void {
        $refClass = new ReflectionClass($className);
        foreach ($refClass->getMethods() as $method) {
            $attrs = $method->getAttributes(Route::class);
            foreach ($attrs as $attr) {
                $route = $attr->newInstance();
                $fullPath = $modulePrefix . $route->path;
                $this->routes[] = [
                    'path' => $fullPath,
                    'method' => $route->method,
                    'handler' => [$className, $method->getName()],
                    'middleware' => $route->middleware,
                ];
            }
        }
    }

    public function getRoutes(): array { return $this->routes; }
}

// Использование
$router = new AdvancedAttributeRouter();
$router->registerClass('UserController', '/user');
var_dump($router->getRoutes());

array(1) {
  [0] =>
  array(4) {
    'path' => string(9) "/user/profile"
    'method' => string(3) "GET"
    'handler' => array(2) {
      [0] => string(14) "UserController"
      [1] => string(7) "profile"
    }
    'middleware' => array(2) {
      [0] => string(4) "auth"
      [1] => string(3) "log"
    }
  }
}

Пояснение:

Теперь каждый маршрут может нести дополнительную информацию (например, список middleware). Это позволяет строить гибкую цепочку обработки без жёсткой привязки к роутеру.

Пример 3: FastRoute с загрузкой маршрутов из YAML-файлов модулей

Используем YAML для описания маршрутов, а FastRoute для диспетчеризации.

// modules/shop/routes.yaml
routes:
  - path: /products
    method: GET
    handler: ShopController::list
  - path: /product/{id}
    method: GET
    handler: ShopController::detail
    requirements:
      id: '\d+'

// Загрузчик YAML
use Symfony\Component\Yaml\Yaml;
use FastRoute\RouteCollector;

function loadYamlRoutes(string $yamlFile, string $prefix, RouteCollector $collector): void {
    $parsed = Yaml::parseFile($yamlFile);
    foreach ($parsed['routes'] as $route) {
        $fullPath = $prefix . $route['path'];
        $collector->addRoute($route['method'], $fullPath, $route['handler']);
    }
}

$collector = new RouteCollector(new FastRoute\RouteParser\Std(), new FastRoute\DataGenerator\GroupCountBased());
loadYamlRoutes(__DIR__ . '/modules/shop/routes.yaml', '/shop', $collector);
loadYamlRoutes(__DIR__ . '/modules/admin/routes.yaml', '/admin', $collector);

$dispatcher = new FastRoute\Dispatcher\GroupCountBased($collector->getData());

// После диспетчеризации запроса /shop/product/123
$routeInfo = $dispatcher->dispatch('GET', '/shop/product/123');
// $routeInfo[0] === FastRoute\Dispatcher::FOUND
// $routeInfo[1] => 'ShopController::detail'
// $routeInfo[2] => ['id' => '123']

Пояснение:

YAML-формат удобен для нетехнических специалистов или для интеграции с CI/CD. Каждый модуль содержит свой YAML-файл, который загружается с префиксом модуля. FastRoute обеспечивает быструю диспетчеризацию.

Пример 4: динамическая загрузка модулей из БД или API

Иногда маршруты могут храниться в базе данных (например, для плагинов). Пример загрузки из PDO:

class DatabaseModuleRouter {
    private PDO $pdo;
    private array $routes = [];

    public function loadFromDatabase(): void {
        $stmt = $this->pdo->query('SELECT module, route, handler, method FROM routes');
        $rows = $stmt->fetchAll();
        foreach ($rows as $row) {
            $fullRoute = '/' . $row['module'] . $row['route'];
            $this->routes[] = [
                'pattern' => '#^' . $fullRoute . '$#',
                'handler' => $row['handler'],
                'method' => $row['method'],
            ];
        }
    }

    public function dispatch(string $method, string $uri): ?array {
        foreach ($this->routes as $route) {
            if ($route['method'] === $method && preg_match($route['pattern'], $uri)) {
                return $route;
            }
        }
        return null;
    }
}

Пояснение:

Этот подход позволяет добавлять маршруты без изменения кода (горячая замена). Однако требует синхронизации кеша и может быть медленнее файловых методов.