Skip to content

Commit

Permalink
refactor(router): use php 8 attributes instead of `zircote/swagger-ph…
Browse files Browse the repository at this point in the history 
…p` as annotation routing
  • Loading branch information
@doyouhaobaby
doyouhaobaby committed Nov 26, 2020
1 parent b0d16bc commit 1bb015c
Show file tree
Hide file tree
Showing 58 changed files with 424 additions and 3,539 deletions.
4 changes: 1 addition & 3 deletions composer.json
View file
Expand Up @@ -17,7 +17,6 @@
"ext-mbstring": "*",
"ext-openssl": "*",
"clio/clio": "@stable",
"doctrine/annotations": "^1.11.1",
"egulias/email-validator": "^2.1.10",
"gettext/gettext": "^4.6.0",
"laminas/laminas-diactoros": "^2.2",
Expand All @@ -37,8 +36,7 @@
"symfony/process": "~5.1",
"symfony/psr-http-message-bridge": "~2.0",
"symfony/var-dumper": "~5.1",
"vlucas/phpdotenv": "~4.1.0",
"zircote/swagger-php": "^3.1.0"
"vlucas/phpdotenv": "~4.1.0"
},
"replace": {
"leevel/auth": "self.version",
Expand Down
2 changes: 1 addition & 1 deletion src/Leevel/Router/Matching/PathInfo.php
View file
Expand Up @@ -94,7 +94,7 @@ protected function matchApp(array $path): array
}

/**
* 匹配路由 Mvc.
* 匹配路由 MVC.
*/
protected function matchMvc(array $path): array
{
Expand Down
201 changes: 99 additions & 102 deletions src/Leevel/Router/OpenApiRouter.php
View file
Expand Up @@ -21,21 +21,19 @@
namespace Leevel\Router;

use InvalidArgumentException;
use Leevel\Kernel\Utils\ClassParser;
use function Leevel\Support\Arr\normalize;
use Leevel\Support\Arr\normalize;
use function Leevel\Support\Type\arr;
use Leevel\Support\Type\arr;
use OpenApi\Annotations\OpenApi;
use OpenApi\Annotations\PathItem;
use OpenApi\Context;
use function OpenApi\scan;
use ReflectionClass;
use Symfony\Component\Finder\Finder;

/**
* OpenApi 注解路由.
* 注解路由.
*
* - 忽略已删除的路由 deprecated 和带有 leevelIgnore 的路由.
* - 如果没有绑定路由参数 leevelBind,系统会尝试自动解析注解所在控制器方法.
* - 只支持最新的 zircote/swagger-php 3，支持最新的 OpenApi 3.0 规范.
* - 1.1.0-alpha2 之前在最新的 zircote/swagger-php 3 上构建的路由，支持最新的 OpenApi 3.0 规范.
* - 新版本采用 PHP 8 属性作为数据源提供。
*/
class OpenApiRouter
{
Expand Down Expand Up @@ -120,7 +118,7 @@ public function __construct(MiddlewareParser $middlewareParser, ?string $domain
public function addScandir(string $dir): void
{
if (!is_dir($dir)) {
$e = sprintf('OpenApi scandir %s is exits.', $dir);
$e = sprintf('Annotation routing scandir %s is not exits.', $dir);

throw new InvalidArgumentException($e);
}
Expand All @@ -129,22 +127,29 @@ public function addScandir(string $dir): void
}

/**
* 处理 OpenApi 注解路由.
* 查找视图目录中的视图文件.
*/
public function handle(): array
protected function findFiles(array $paths): Finder
{
// 忽略 OpenApi 扩展字段警告,改变 set_error_handler 抛出时机
// 补充基于标准 OpenApi 路由，并可以扩展注解路由的功能
$oldErrorReporting = error_reporting();
error_reporting(E_ERROR | E_PARSE | E_STRICT);

$openApi = $this->makeOpenApi();
$routers = $this->normalizeFastRoute($this->parseRouters($openApi));
$result = $this->packageRouters($routers);
return (new Finder())
->in($paths)
->exclude(['vendor', 'node_modules'])
->followLinks()
->name('*.php')
->sortByName()
->files();
}

error_reporting($oldErrorReporting);
/**
* 处理注解路由.
*/
public function handle(): array
{
$routers = $this->parseControllerAnnotationRouters();
$routers = $this->parseRouters($routers);
$routers = $this->normalizeFastRoute($routers);

return $result;
return $this->packageRouters($routers);
}

/**
Expand All @@ -153,46 +158,87 @@ public function handle(): array
protected function packageRouters(array $routers): array
{
return [
'base_paths' => $this->basePaths,
'groups' => $this->groups,
'routers' => $routers,
'base_paths' => $this->basePaths,
'groups' => $this->groups,
'routers' => $routers,
];
}

/**
* 解析路由.
* 分析控制器注解路由.
*/
protected function parseRouters(OpenApi $openApi): array
protected function parseControllerAnnotationRouters(): array
{
$finder = $this->findFiles($this->scandirs);
$classParser = new ClassParser();
$routers = [];
if ($openApi->paths) {
foreach ($openApi->paths as $path) {
$routers = $this->parseOpenApiPath($path, $routers);
foreach ($finder as $file) {
$content = file_get_contents($file->getRealPath());
if (false !== strpos($content, '#[Route(')) {
$controllerClassName = $classParser->handle($file->getRealPath());
$this->parseEachControllerAnnotationRouters($routers, $controllerClassName);
}
}

return $routers;
}

/**
* 分析每一个控制器注解路由.
*/
protected function parseEachControllerAnnotationRouters(array &$routers, string $controllerClassName): void
{
$ref = new ReflectionClass($controllerClassName);
$routeAttribute = (substr($controllerClassName, 0, strrpos($controllerClassName, '\\')).'\\Route');
foreach ($ref->getMethods() as $v) {
if($routeAttributes = $v->getAttributes($routeAttribute)) {
$temp = $routeAttributes[0]->getArguments();
if (empty($temp['method'])) {
$temp['method'] = 'get';
}
$temp['method'] = strtolower($temp['method']);
if (!array_key_exists('bind', $temp)) {
$temp['bind'] = $controllerClassName.'@'.$v->getName();
}
if ($temp['bind']) {
$temp['bind'] = '\\'.trim($temp['bind'], '\\');
}
$routers[$temp['method']][] = $temp;
}
}
}

/**
* 解析路由.
*/
protected function parseRouters(array $result): array
{
$routers = [];
foreach ($result as $httpMethod => $items) {
$this->parseHttpMethodAnnotationRouters($routers, $httpMethod, $items);
}

return $routers;
}

/**
* 解析 openApi 每一项路径.
* 解析 HTTP 不同类型请求路由.
*/
protected function parseOpenApiPath(PathItem $path, array $routers): array
protected function parseHttpMethodAnnotationRouters(array &$routers, string $httpMethod, array $annotationRouters): void
{
foreach ($this->methods as $m) {
$method = $path->{$m};
if (!in_array($httpMethod, $this->methods, true)) {
return;
}

foreach ($annotationRouters as $router) {
// 忽略已删除和带有忽略标记的路由
if ($this->isRouterIgnore($method, $path->path)) {
if ($this->isRouterIgnore($sourceRouterPath = $router['path'])) {
continue;
}

// 支持的自定义路由字段
$router = $this->parseRouterField($method);

// 根据源代码生成绑定
$this->parseRouterBind($method, $router);

$router = $this->parseRouterField($router);

// 解析中间件
$this->parseRouterMiddlewares($router);

Expand All @@ -203,68 +249,45 @@ protected function parseOpenApiPath(PathItem $path, array $routers): array
$this->parseRouterPort($router);

// 解析基础路径
list($prefix, $groupPrefix, $routerPath) = $this->parseRouterPath($path->path, $this->groups);
list($prefix, $groupPrefix, $routerPath) = $this->parseRouterPath($sourceRouterPath, $this->groups);

// 解析路由正则
if ($this->isStaticRouter($routerPath)) {
$routers[$m]['static'][$routerPath] = $router;
\ksort($router);
$routers[$httpMethod]['static'][$routerPath] = $router;
} else {
$routers[$m][$prefix][$groupPrefix][$routerPath] =
$this->parseRouterRegex($routerPath, $router);
$router = $this->parseRouterRegex($routerPath, $router);
\ksort($router);
$routers[$httpMethod][$prefix][$groupPrefix][$routerPath] = $router;
}
}

return $routers;
}

/**
* 判断是否为忽略路由.
*
* - 首页 `/` 默认提供 Home::index 需要过滤
*/
protected function isRouterIgnore(object|string $method, string $path): bool
protected function isRouterIgnore(string $path): bool
{
if (!is_object($method) || true === $method->deprecated ||
(property_exists($method, 'leevelIgnore') && $method->leevelIgnore)) {
return true;
}

// 首页 `/` 默认提供 Home::index 需要过滤
if ('//' === $this->normalizePath($path)) {
return true;
}

return false;
return '//' === $this->normalizePath($path);
}

/**
* 解析自定义路由字段.
*/
protected function parseRouterField(object $method): array
protected function parseRouterField(array $method): array
{
$result = [];
foreach ($this->routerField as $f) {
$field = 'leevel'.ucfirst($f);
if (property_exists($method, $field)) {
$result[$f] = $method->{$field};
if (array_key_exists($f, $method)) {
$result[$f] = $method[$f];
}
}

return $result;
}

/**
* 解析路由绑定.
*/
protected function parseRouterBind(object $method, array &$router): void
{
if (empty($router['bind'])) {
$router['bind'] = $this->parseBindBySource($method->_context);
}

if ($router['bind']) {
$router['bind'] = '\\'.trim($router['bind'], '\\');
}
}

/**
* 解析基础路径和分组.
*
Expand Down Expand Up @@ -403,21 +426,16 @@ protected function parseGroupRegex(array $routers): array
$ruleMap = [];
$ruleKey = 0;
$regex[] = '~^(?';

foreach ($routers as $key => $router) {
$countVar = $minCount + $ruleKey;
$emptyMatche = $countVar - count($router['var']);
$ruleMap[$countVar + 1] = $key;
$regex[] = '|'.$router['regex'].($emptyMatche ? str_repeat('()', $emptyMatche) : '');
$ruleKey++;
}

$regex[] = ')$~x';

return [
implode('', $regex),
$ruleMap,
];
return [implode('', $regex), $ruleMap];
}

/**
Expand All @@ -435,18 +453,6 @@ protected function computeMinCountVar(array $routers): int
return $minCount;
}

/**
* 根据源代码生成绑定.
*/
protected function parseBindBySource(Context $context): ?string
{
if (!$context->class || !$context->method) {
return null;
}

return $context->fullyQualifiedName($context->class).'@'.$context->method;
}

/**
* 格式化正则.
*/
Expand Down Expand Up @@ -559,7 +565,6 @@ protected function filterBasePath(array &$basePath): void
if (empty($basePath['middlewares']['handle'])) {
unset($basePath['middlewares']['handle']);
}

if (empty($basePath['middlewares']['terminate'])) {
unset($basePath['middlewares']['terminate']);
}
Expand Down Expand Up @@ -588,14 +593,6 @@ protected function prepareRegexForWildcard(string $regex): string

return $regex;
}

/**
* 生成 OpenApi.
*/
protected function makeOpenApi(): OpenApi
{
return scan($this->scandirs);
}
}

// import fn.
Expand Down
5 changes: 2 additions & 3 deletions src/Leevel/Router/composer.json
View file
Expand Up @@ -18,9 +18,8 @@
"leevel/pipeline": "1.1.*",
"leevel/di": "1.1.*",
"leevel/filesystem": "1.1.*",
"zircote/swagger-php": "^3.1.0",
"doctrine/annotations": "^1.11.1",
"symfony/http-foundation": "~5.1"
"symfony/http-foundation": "~5.1",
"symfony/finder": "~5.1"
},
"autoload": {
"psr-4": {
Expand Down

0 comments on commit 1bb015c

Please sign in to comment.