注解路由

Testing Is Documentation

tests/Router/RouterAnnotationTest.php注解路由 - 图1

QueryPHP 除了传统的自动匹配 MVC 路由之外，也支持自定义的注解路由。

Uses

  1. <?php
  3. use Leevel\Di\Container;
  4. use Leevel\Di\IContainer;
  5. use Leevel\Http\Request;
  6. use Leevel\Kernel\App;
  7. use Leevel\Router\Router;
  8. use Leevel\Router\RouterProvider;
  9. use Leevel\Router\Url;
  10. use Symfony\Component\HttpFoundation\Response;
  11. use Tests\Router\Middlewares\Demo1;
  12. use Tests\Router\Middlewares\Demo2;
  13. use Tests\Router\Middlewares\Demo3;
  14. use Tests\Router\Middlewares\DemoForAll;
  15. use Tests\Router\Middlewares\DemoForBasePath;

注解路由扫描

QueryPHP 系统会根据路由服务提供者信息，扫描系统的注解生成框架的注解路由，并且支持缓存到文件。

fixture 定义

路由服务提供者 Tests\Router\RouterProviderAnnotation

  1. namespace Tests\Router;
  3. class RouterProviderAnnotation extends RouterProvider
  4. {
  5.     protected string $controllerDir = 'Router\\Controllers';
  7.     protected array $middlewareGroups = [
  8.         'group1' => [
  9.             'demo1',
  10.             'demo2',
  11.         ],
  13.         'group2' => [
  14.             'demo1',
  15.             'demo3:10,world',
  16.         ],
  18.         'group3' => [
  19.             'demo1',
  20.             'demo2',
  21.             'demo3:10,world',
  22.         ],
  23.     ];
  25.     protected array $middlewareAlias = [
  26.         'demo1'              => Demo1::class,
  27.         'demo2'              => Demo2::class,
  28.         'demo3'              => Demo3::class,
  29.         'demo_for_base_path' => DemoForBasePath::class,
  30.         'demo_for_all'       => DemoForAll::class,
  31.     ];
  33.     protected array $basePaths = [
  34.         '*' => [
  35.             'middlewares' => 'demo_for_all',
  36.         ],
  37.         '/basePath/normalize' => [
  38.             'middlewares' => 'demo_for_base_path',
  39.         ],
  40.     ];
  42.     protected array $groups = [
  43.         'pet'     => [],
  44.         'store'   => [],
  45.         'user'    => [],
  46.         '/api/v1' => [
  47.             'middlewares' => 'group1',
  48.         ],
  49.         '/api/v2' => [
  50.             'middlewares' => 'group2',
  51.         ],
  52.         '/api/v3' => [
  53.             'middlewares' => 'demo1,demo3:30,world',
  54.         ],
  55.         '/api/v3' => [
  56.             'middlewares' => ['demo1', 'group3'],
  57.         ],
  58.         '/api/v4' => [
  59.             'middlewares' => 'notFound',
  60.         ],
  61.         'newPrefix/v1'    => [],
  62.     ];
  64.     public function bootstrap(): void
  65.     {
  66.         parent::bootstrap();
  67.     }
  69.     public function getRouters(): array
  70.     {
  71.         return parent::getRouters();
  72.     }
  73. }

路由注解缓存结果 tests/Router/Apps/AppForAnnotation/data.json

  1. {
  2.     "base_paths": {
  3.         "*": {
  4.             "middlewares": {
  5.                 "handle": [
  6.                     "Tests\\Router\\Middlewares\\DemoForAll@handle"
  7.                 ],
  8.                 "terminate": [
  9.                     "Tests\\Router\\Middlewares\\DemoForAll@terminate"
  10.                 ]
  11.             }
  12.         },
  13.         "\/^\\\/basePath\\\/normalize\\\/$\/": {
  14.             "middlewares": {
  15.                 "handle": [
  16.                     "Tests\\Router\\Middlewares\\DemoForBasePath@handle"
  17.                 ]
  18.             }
  19.         },
  20.         "\/^\\\/api\\\/v1(\\S*)\\\/$\/": {
  21.             "middlewares": {
  22.                 "handle": [
  23.                     "Tests\\Router\\Middlewares\\Demo2@handle"
  24.                 ],
  25.                 "terminate": [
  26.                     "Tests\\Router\\Middlewares\\Demo1@terminate",
  27.                     "Tests\\Router\\Middlewares\\Demo2@terminate"
  28.                 ]
  29.             }
  30.         },
  31.         "\/^\\\/api\\\/v2(\\S*)\\\/$\/": {
  32.             "middlewares": {
  33.                 "handle": [
  34.                     "Tests\\Router\\Middlewares\\Demo3@handle:10,world"
  35.                 ],
  36.                 "terminate": [
  37.                     "Tests\\Router\\Middlewares\\Demo1@terminate"
  38.                 ]
  39.             }
  40.         },
  41.         "\/^\\\/api\\\/v3(\\S*)\\\/$\/": {
  42.             "middlewares": {
  43.                 "handle": [
  44.                     "Tests\\Router\\Middlewares\\Demo2@handle",
  45.                     "Tests\\Router\\Middlewares\\Demo3@handle:10,world"
  46.                 ],
  47.                 "terminate": [
  48.                     "Tests\\Router\\Middlewares\\Demo1@terminate",
  49.                     "Tests\\Router\\Middlewares\\Demo2@terminate"
  50.                 ]
  51.             }
  52.         }
  53.     },
  54.     "groups": [
  55.         "\/pet",
  56.         "\/store",
  57.         "\/user",
  58.         "\/api\/v1",
  59.         "\/api\/v2",
  60.         "\/api\/v3",
  61.         "\/api\/v4",
  62.         "\/newPrefix\/v1"
  63.     ],
  64.     "routers": {
  65.         "get": {
  66.             "static": {
  67.                 "\/basePath\/normalize\/": {
  68.                     "bind": "\\Tests\\Router\\Controllers\\Annotation\\BasePath@normalize"
  69.                 },
  70.                 "\/bindNotFound\/test\/": {
  71.                     "bind": "\\Tests\\Router\\Controllers\\Annotation\\BindNotFound@notFound"
  72.                 },
  73.                 "\/bindNotFound\/test2\/": {
  74.                     "bind": "\\Tests\\Router\\Controllers\\Annotation\\BindNotFound"
  75.                 },
  76.                 "\/bindNotFound\/test3\/": {
  77.                     "bind": "\\Tests\\Router\\Controllers\\Annotation\\BindMethodNotFound"
  78.                 },
  79.                 "\/bindNotSet\/test\/": {
  80.                     "bind": null
  81.                 },
  82.                 "\/bindNotSet\/test2\/": {
  83.                     "bind": null
  84.                 },
  85.                 "\/domain\/test\/": {
  86.                     "domain": "queryphp.com",
  87.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Domain@fooNotMatchedDomain"
  88.                 },
  89.                 "\/domain\/test2\/": {
  90.                     "domain": "queryphp.com",
  91.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Domain@barMatchedDomain"
  92.                 },
  93.                 "\/domain\/test3\/": {
  94.                     "domain": "{subdomain:[A-Za-z]+}-vip.{domain}.queryphp.com",
  95.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Domain@barMatchedDomainWithVar",
  96.                     "domain_regex": "\/^([A-Za-z]+)\\-vip\\.(\\S+)\\.queryphp\\.com$\/",
  97.                     "domain_var": [
  98.                         "subdomain",
  99.                         "domain"
  100.                     ]
  101.                 },
  102.                 "\/domain\/test4\/": {
  103.                     "domain": "api.queryphp.com",
  104.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Domain@barMatchedDomainWithoutExtend"
  105.                 },
  106.                 "\/extendVar\/test\/": {
  107.                     "attributes": {
  108.                         "args1": "hello",
  109.                         "args2": "world"
  110.                     },
  111.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\ExtendVar@withExtendVar"
  112.                 },
  113.                 "\/middleware\/test\/": {
  114.                     "middlewares": {
  115.                         "handle": [
  116.                             "Tests\\Router\\Middlewares\\Demo2@handle"
  117.                         ],
  118.                         "terminate": [
  119.                             "Tests\\Router\\Middlewares\\Demo1@terminate",
  120.                             "Tests\\Router\\Middlewares\\Demo2@terminate"
  121.                         ]
  122.                     },
  123.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Middleware@foo"
  124.                 },
  125.                 "\/middleware\/test2\/": {
  126.                     "middlewares": {
  127.                         "handle": [
  128.                             "Tests\\Router\\Middlewares\\Demo2@handle",
  129.                             "Tests\\Router\\Middlewares\\Demo3@handle:10,world"
  130.                         ],
  131.                         "terminate": [
  132.                             "Tests\\Router\\Middlewares\\Demo1@terminate",
  133.                             "Tests\\Router\\Middlewares\\Demo2@terminate"
  134.                         ]
  135.                     },
  136.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Middleware@bar"
  137.                 },
  138.                 "\/middleware\/test3\/": {
  139.                     "middlewares": {
  140.                         "handle": [
  141.                             "Tests\\Router\\Middlewares\\Demo2@handle",
  142.                             "Tests\\Router\\Middlewares\\Demo3@handle:10,world",
  143.                             "Tests\\Router\\Middlewares\\DemoForBasePath@handle"
  144.                         ],
  145.                         "terminate": [
  146.                             "Tests\\Router\\Middlewares\\Demo1@terminate",
  147.                             "Tests\\Router\\Middlewares\\Demo2@terminate"
  148.                         ]
  149.                     },
  150.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Middleware@hello"
  151.                 },
  152.                 "\/middleware\/test4\/": {
  153.                     "middlewares": {
  154.                         "handle": [],
  155.                         "terminate": [
  156.                             "Tests\\Router\\Middlewares\\Demo1@terminate"
  157.                         ]
  158.                     },
  159.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Middleware@world"
  160.                 },
  161.                 "\/port\/test\/": {
  162.                     "port": 9527,
  163.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Port@fooNotMatchedPort"
  164.                 },
  165.                 "\/port\/test2\/": {
  166.                     "port": 9527,
  167.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Port@barMatchedPort"
  168.                 },
  169.                 "\/scheme\/test\/": {
  170.                     "scheme": "https",
  171.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Scheme@fooNotMatchedScheme"
  172.                 },
  173.                 "\/scheme\/test2\/": {
  174.                     "scheme": "http",
  175.                     "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Scheme@barMatchedScheme"
  176.                 }
  177.             },
  178.             "a": {
  179.                 "\/api\/v1": {
  180.                     "\/api\/v1\/petLeevel\/{petId:[A-Za-z]+}\/": {
  181.                         "bind": "\\Tests\\Router\\Controllers\\Annotation\\PetLeevel",
  182.                         "var": [
  183.                             "petId"
  184.                         ]
  185.                     },
  186.                     "regex": [
  187.                         "~^(?|\/api\/v1\/petLeevel\/([A-Za-z]+)\/)$~x"
  188.                     ],
  189.                     "map": [
  190.                         {
  191.                             "2": "\/api\/v1\/petLeevel\/{petId:[A-Za-z]+}\/"
  192.                         }
  193.                     ]
  194.                 },
  195.                 "_": {
  196.                     "\/api\/notInGroup\/petLeevel\/{petId:[A-Za-z]+}\/": {
  197.                         "bind": "\\Tests\\Router\\Apps\\AppForAnnotation\\Controllers\\Pet@petLeevelNotInGroup",
  198.                         "var": [
  199.                             "petId"
  200.                         ]
  201.                     },
  202.                     "regex": [
  203.                         "~^(?|\/api\/notInGroup\/petLeevel\/([A-Za-z]+)\/)$~x"
  204.                     ],
  205.                     "map": [
  206.                         {
  207.                             "2": "\/api\/notInGroup\/petLeevel\/{petId:[A-Za-z]+}\/"
  208.                         }
  209.                     ]
  210.                 }
  211.             },
  212.             "n": {
  213.                 "\/newPrefix\/v1": {
  214.                     "\/newPrefix\/v1\/petLeevel\/{petId:[A-Za-z]+}\/": {
  215.                         "bind": "\\Tests\\Router\\Controllers\\Annotation\\NewPrefix",
  216.                         "var": [
  217.                             "petId"
  218.                         ]
  219.                     },
  220.                     "regex": [
  221.                         "~^(?|\/newPrefix\/v1\/petLeevel\/([A-Za-z]+)\/)$~x"
  222.                     ],
  223.                     "map": [
  224.                         {
  225.                             "2": "\/newPrefix\/v1\/petLeevel\/{petId:[A-Za-z]+}\/"
  226.                         }
  227.                     ]
  228.                 }
  229.             }
  230.         }
  231.     }
  232. }
  1. public function testBaseRouterData(): void
  2. {
  3.     $container = $this->createContainer();
  5.     $container->singleton('router', $router = $this->createRouter($container));
  7.     $provider = new RouterProviderAnnotation($container);
  9.     $this->assertNull($provider->register());
  10.     $this->assertNull($provider->bootstrap());
  12.     $data = file_get_contents(__DIR__.'/Apps/AppForAnnotation/data.json');
  14.     $this->assertSame(
  15.         $data,
  16.         $this->varJson(
  17.             [
  18.                 'base_paths'  => $router->getBasePaths(),
  19.                 'groups'      => $router->getGroups(),
  20.                 'routers'     => $router->getRouters(),
  21.             ]
  22.         )
  23.     );
  24. }

基本使用

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Pet::petLeevel
  2. /**
  3.  * @OA\Get(
  4.  *     path="/api/v1/petLeevel/{petId:[A-Za-z]+}/",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelBind="\Tests\Router\Controllers\Annotation\PetLeevel"
  27.  * )
  28.  */
  29. public function petLeevel();

控制器

  1. namespace Tests\Router\Controllers\Annotation;
  3. use Leevel\Di\IContainer;
  5. class PetLeevel
  6. {
  7.     public function handle(IContainer $container): string
  8.     {
  9.         return 'hello plus for petLeevel, attributes petId is '.
  10.             $container
  11.                 ->make('request')
  12.                 ->attributes
  13.                 ->get('petId');
  14.     }
  15. }
  1. public function testMatchedPetLeevel(): void
  2. {
  3.     $pathInfo = '/api/v1/petLeevel/hello';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = $this->createRequest($pathInfo, $attributes, $method);
  11.     $container->singleton('router', $router = $this->createRouter($container));
  12.     $container->instance('request', $request);
  13.     $container->instance(IContainer::class, $container);
  15.     $provider = new RouterProviderAnnotation($container);
  17.     $router->setControllerDir($controllerDir);
  19.     $provider->register();
  20.     $provider->bootstrap();
  22.     if (isset($GLOBALS['demo_middlewares'])) {
  23.         unset($GLOBALS['demo_middlewares']);
  24.     }
  26.     $response = $router->dispatch($request);
  28.     $this->assertInstanceof(Response::class, $response);
  30.     $this->assertSame('hello plus for petLeevel, attributes petId is hello', $response->getContent());
  32.     $data = <<<'eot'
  33.         [
  34.             "DemoForAll::handle",
  35.             "Demo2::handle"
  36.         ]
  37.         eot;
  39.     $this->assertSame(
  40.         $data,
  41.         $this->varJson(
  42.             $GLOBALS['demo_middlewares']
  43.         )
  44.     );
  46.     $router->throughMiddleware($request, [
  47.         $response,
  48.     ]);
  50.     $data = <<<'eot'
  51.         [
  52.             "DemoForAll::handle",
  53.             "Demo2::handle",
  54.             "DemoForAll::terminate",
  55.             "Demo1::terminate",
  56.             "Demo2::terminate"
  57.         ]
  58.         eot;
  60.     $this->assertSame(
  61.         $data,
  62.         $this->varJson(
  63.             $GLOBALS['demo_middlewares'],
  64.             1
  65.         )
  66.     );
  68.     unset($GLOBALS['demo_middlewares']);
  69. }

基础路径匹配

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\BasePath::foo
  2. /**
  3.  * @OA\Get(
  4.  *     path="/basePath/normalize/",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelBind="Tests\Router\Controllers\Annotation\BasePath@normalize"
  27.  * )
  28.  */
  29. public function foo();

控制器

  1. namespace Tests\Router\Controllers\Annotation;
  3. class BasePath
  4. {
  5.     public function normalize(): string
  6.     {
  7.         return 'hello plus for basePath normalize';
  8.     }
  9. }
  1. public function testMatchedBasePathNormalize(): void
  2. {
  3.     $pathInfo = '/basePath/normalize';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = $this->createRequest($pathInfo, $attributes, $method);
  11.     $container->singleton('router', $router = $this->createRouter($container));
  12.     $container->instance('request', $request);
  13.     $container->instance(IContainer::class, $container);
  15.     $provider = new RouterProviderAnnotation($container);
  17.     $provider->register();
  18.     $provider->bootstrap();
  20.     if (isset($GLOBALS['demo_middlewares'])) {
  21.         unset($GLOBALS['demo_middlewares']);
  22.     }
  24.     $response = $router->dispatch($request);
  26.     $this->assertInstanceof(Response::class, $response);
  28.     $this->assertSame('hello plus for basePath normalize', $response->getContent());
  30.     $data = <<<'eot'
  31.         [
  32.             "DemoForAll::handle",
  33.             "DemoForBasePath::handle"
  34.         ]
  35.         eot;
  37.     $this->assertSame(
  38.         $data,
  39.         $this->varJson(
  40.             $GLOBALS['demo_middlewares']
  41.         )
  42.     );
  44.     $router->throughMiddleware($request, [
  45.         $response,
  46.     ]);
  48.     $data = <<<'eot'
  49.         [
  50.             "DemoForAll::handle",
  51.             "DemoForBasePath::handle",
  52.             "DemoForAll::terminate"
  53.         ]
  54.         eot;
  56.     $this->assertSame(
  57.         $data,
  58.         $this->varJson(
  59.             $GLOBALS['demo_middlewares'],
  60.             1
  61.         )
  62.     );
  64.     unset($GLOBALS['demo_middlewares']);
  65. }

leevelScheme 协议匹配

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Scheme::barMatchedScheme
  2. /**
  3.  * @OA\Get(
  4.  *     path="/scheme/test2",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelScheme="http"
  27.  * )
  28.  */
  29. public function barMatchedScheme();

控制器

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Scheme::barMatchedScheme
  2. public function barMatchedScheme()
  3. {
  4.     return 'barMatchedScheme';
  5. }
  1. public function testMatchedAndSchemeMatched(): void
  2. {
  3.     $pathInfo = '/scheme/test2';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = $this->createRequest($pathInfo, $attributes, $method);
  11.     $container->singleton('router', $router = $this->createRouter($container));
  12.     $container->instance('request', $request);
  13.     $container->instance(IContainer::class, $container);
  15.     $provider = new RouterProviderAnnotation($container);
  17.     $router->setControllerDir($controllerDir);
  19.     $provider->register();
  20.     $provider->bootstrap();
  22.     $result = $router->dispatch($request);
  24.     $this->assertSame('barMatchedScheme', $result->getContent());
  25. }

leevelDomain 域名匹配

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Domain::barMatchedDomain
  2. /**
  3.  * @OA\Get(
  4.  *     path="/domain/test2",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelDomain="queryphp.com"
  27.  * )
  28.  */
  29. public function barMatchedDomain();

控制器

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Domain::barMatchedDomain
  2. public function barMatchedDomain()
  3. {
  4.     return 'barMatchedDomain';
  5. }
  1. public function testMatchedAndDomainMatched(): void
  2. {
  3.     $pathInfo = '/domain/test2';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = new Request([], [], $attributes, [], [], ['HTTP_HOST' => 'queryphp.com']);
  11.     $request->setPathInfo($pathInfo);
  12.     $request->setMethod($method);
  14.     $container->singleton('router', $router = $this->createRouter($container));
  15.     $container->instance('request', $request);
  16.     $container->instance(IContainer::class, $container);
  18.     $provider = new RouterProviderAnnotation($container);
  20.     $router->setControllerDir($controllerDir);
  22.     $provider->register();
  23.     $provider->bootstrap();
  25.     $result = $router->dispatch($request);
  27.     $this->assertSame('barMatchedDomain', $result->getContent());
  28. }

leevelDomain 域名匹配支持变量

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Domain::barMatchedDomainWithVar
  2. /**
  3.  * @OA\Get(
  4.  *     path="/domain/test3",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelDomain="{subdomain:[A-Za-z]+}-vip.{domain}.queryphp.com"
  27.  * )
  28.  */
  29. public function barMatchedDomainWithVar(Request $request);

控制器

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Domain::barMatchedDomainWithVar
  2. public function barMatchedDomainWithVar(Request $request)
  3. {
  4.     return 'barMatchedDomainWithVar and attributes are '.
  5.         json_encode($request->attributes->all());
  6. }
  1. public function testMatchedAndDomainWithVarMatched(): void
  2. {
  3.     $pathInfo = '/domain/test3';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = new Request([], [], $attributes, [], [], ['HTTP_HOST' => 'foo-vip.bar.queryphp.com']);
  11.     $request->setPathInfo($pathInfo);
  12.     $request->setMethod($method);
  14.     $container->instance(Request::class, $request);
  16.     $container->singleton('router', $router = $this->createRouter($container));
  17.     $container->instance('request', $request);
  18.     $container->instance(IContainer::class, $container);
  20.     $provider = new RouterProviderAnnotation($container);
  22.     $router->setControllerDir($controllerDir);
  24.     $provider->register();
  25.     $provider->bootstrap();
  27.     $result = $router->dispatch($request);
  29.     $this->assertSame('barMatchedDomainWithVar and attributes are {"subdomain":"foo","domain":"bar"}', $result->getContent());
  30. }

leevelPort 端口匹配

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Port::barMatchedPort
  2. /**
  3.  * @OA\Get(
  4.  *     path="/port/test2",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelPort=9527
  27.  * )
  28.  */
  29. public function barMatchedPort();

控制器

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Port::barMatchedPort
  2. public function barMatchedPort()
  3. {
  4.     return 'barMatchedPort';
  5. }
  1. public function testMatchedAndPortMatched(): void
  2. {
  3.     $pathInfo = '/port/test2';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = new Request([], [], $attributes, [], [], ['SERVER_PORT' => '9527']);
  11.     $request->setPathInfo($pathInfo);
  12.     $request->setMethod($method);
  14.     $container->singleton('router', $router = $this->createRouter($container));
  15.     $container->instance('request', $request);
  16.     $container->instance(IContainer::class, $container);
  18.     $provider = new RouterProviderAnnotation($container);
  20.     $router->setControllerDir($controllerDir);
  22.     $provider->register();
  23.     $provider->bootstrap();
  25.     $result = $router->dispatch($request);
  27.     $this->assertSame('barMatchedPort', $result->getContent());
  28. }

leevelAttributes 扩展变量匹配

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\ExtendVar::withExtendVar
  2. /**
  3.  * @OA\Get(
  4.  *     path="/extendVar/test",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelAttributes={"args1": "hello", "args2": "world"}
  27.  * )
  28.  */
  29. public function withExtendVar(Request $request);

控制器

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\ExtendVar::withExtendVar
  2. public function withExtendVar(Request $request)
  3. {
  4.     return 'withExtendVar and attributes are '.
  5.         json_encode($request->attributes->all());
  6. }
  1. public function testMatchedWithExtendVar(): void
  2. {
  3.     $pathInfo = '/extendVar/test';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = new Request([], [], $attributes);
  11.     $request->setPathInfo($pathInfo);
  12.     $request->setMethod($method);
  14.     $container->singleton('router', $router = $this->createRouter($container));
  15.     $container->instance(Request::class, $request);
  16.     $container->instance(IContainer::class, $container);
  18.     $provider = new RouterProviderAnnotation($container);
  20.     $router->setControllerDir($controllerDir);
  22.     $provider->register();
  23.     $provider->bootstrap();
  25.     $result = $router->dispatch($request);
  27.     $this->assertSame('withExtendVar and attributes are {"args1":"hello","args2":"world"}', $result->getContent());
  28. }

leevelMiddlewares 中间件匹配

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Middleware::foo
  2. /**
  3.  * @OA\Get(
  4.  *     path="/middleware/test",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelMiddlewares="group1"
  27.  * )
  28.  */
  29. public function foo();

控制器

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Middleware::foo
  2. public function foo()
  3. {
  4.     return 'Middleware matched';
  5. }
  1. public function testMiddleware(): void
  2. {
  3.     $pathInfo = '/middleware/test';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = new Request([], [], $attributes);
  11.     $request->setPathInfo($pathInfo);
  12.     $request->setMethod($method);
  14.     $container->singleton('router', $router = $this->createRouter($container));
  15.     $container->instance(Request::class, $request);
  16.     $container->instance(IContainer::class, $container);
  18.     $provider = new RouterProviderAnnotation($container);
  20.     $router->setControllerDir($controllerDir);
  22.     $provider->register();
  23.     $provider->bootstrap();
  25.     if (isset($GLOBALS['demo_middlewares'])) {
  26.         unset($GLOBALS['demo_middlewares']);
  27.     }
  29.     $result = $router->dispatch($request);
  31.     $data = <<<'eot'
  32.         [
  33.             "DemoForAll::handle",
  34.             "Demo2::handle"
  35.         ]
  36.         eot;
  38.     $this->assertSame(
  39.         $data,
  40.         $this->varJson(
  41.             $GLOBALS['demo_middlewares']
  42.         )
  43.     );
  45.     $router->throughMiddleware($request, [
  46.         $result,
  47.     ]);
  49.     $data = <<<'eot'
  50.         [
  51.             "DemoForAll::handle",
  52.             "Demo2::handle",
  53.             "DemoForAll::terminate",
  54.             "Demo1::terminate",
  55.             "Demo2::terminate"
  56.         ]
  57.         eot;
  59.     $this->assertSame(
  60.         $data,
  61.         $this->varJson(
  62.             $GLOBALS['demo_middlewares'],
  63.             1
  64.         )
  65.     );
  67.     $this->assertSame('Middleware matched', $result->getContent());
  69.     unset($GLOBALS['demo_middlewares']);
  70. }

leevelMiddlewares 中间件匹配支持数组

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Middleware::bar
  2. /**
  3.  * @OA\Get(
  4.  *     path="/middleware/test2",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelMiddlewares={"group1", "group2"}
  27.  * )
  28.  */
  29. public function bar();

控制器

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Middleware::bar
  2. public function bar()
  3. {
  4.     return 'Middleware matched 2';
  5. }
  1. public function testMiddleware2(): void
  2. {
  3.     $pathInfo = '/middleware/test2';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = new Request([], [], $attributes);
  11.     $request->setPathInfo($pathInfo);
  12.     $request->setMethod($method);
  14.     $container->singleton('router', $router = $this->createRouter($container));
  15.     $container->instance(Request::class, $request);
  16.     $container->instance(IContainer::class, $container);
  18.     $provider = new RouterProviderAnnotation($container);
  20.     $router->setControllerDir($controllerDir);
  22.     $provider->register();
  23.     $provider->bootstrap();
  25.     if (isset($GLOBALS['demo_middlewares'])) {
  26.         unset($GLOBALS['demo_middlewares']);
  27.     }
  29.     $result = $router->dispatch($request);
  31.     $data = <<<'eot'
  32.         [
  33.             "DemoForAll::handle",
  34.             "Demo2::handle",
  35.             "Demo3::handle(arg1:10,arg2:world)"
  36.         ]
  37.         eot;
  39.     $this->assertSame(
  40.         $data,
  41.         $this->varJson(
  42.             $GLOBALS['demo_middlewares']
  43.         )
  44.     );
  46.     $router->throughMiddleware($request, [
  47.         $result,
  48.     ]);
  50.     $data = <<<'eot'
  51.         [
  52.             "DemoForAll::handle",
  53.             "Demo2::handle",
  54.             "Demo3::handle(arg1:10,arg2:world)",
  55.             "DemoForAll::terminate",
  56.             "Demo1::terminate",
  57.             "Demo2::terminate"
  58.         ]
  59.         eot;
  61.     $this->assertSame(
  62.         $data,
  63.         $this->varJson(
  64.             $GLOBALS['demo_middlewares'],
  65.             1
  66.         )
  67.     );
  69.     $this->assertSame('Middleware matched 2', $result->getContent());
  71.     unset($GLOBALS['demo_middlewares']);
  72. }

leevelMiddlewares 中间件匹配支持类名

fixture 定义

路由定义

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Middleware::world
  2. /**
  3.  * @OA\Get(
  4.  *     path="/middleware/test4",
  5.  *     tags={"pet"},
  6.  *     summary="Just test the router",
  7.  *     operationId="petLeevel",
  8.  *     @OA\Parameter(
  9.  *         name="petId",
  10.  *         in="path",
  11.  *         description="ID of pet to return",
  12.  *         required=true,
  13.  *         @OA\Schema(
  14.  *             type="integer",
  15.  *             format="int64"
  16.  *         )
  17.  *     ),
  18.  *     @OA\Response(
  19.  *         response=405,
  20.  *         description="Invalid input"
  21.  *     ),
  22.  *     security={
  23.  *         {"petstore_auth": {"write:pets", "read:pets"}}
  24.  *     },
  25.  *     requestBody={"$ref": "#/components/requestBodies/Pet"},
  26.  *     leevelMiddlewares={"Tests\Router\Middlewares\Demo1"}
  27.  * )
  28.  */
  29. public function world();

控制器

  1. # Tests\Router\Apps\AppForAnnotation\Controllers\Middleware::world
  2. public function world()
  3. {
  4.     return 'Middleware matched 4';
  5. }
  1. public function testMiddleware4(): void
  2. {
  3.     $pathInfo = '/middleware/test4';
  4.     $attributes = [];
  5.     $method = 'GET';
  6.     $controllerDir = 'Controllers';
  8.     $container = $this->createContainer();
  10.     $request = new Request([], [], $attributes);
  11.     $request->setPathInfo($pathInfo);
  12.     $request->setMethod($method);
  14.     $container->singleton('router', $router = $this->createRouter($container));
  15.     $container->instance(Request::class, $request);
  16.     $container->instance(IContainer::class, $container);
  18.     $provider = new RouterProviderAnnotation($container);
  20.     $router->setControllerDir($controllerDir);
  22.     $provider->register();
  23.     $provider->bootstrap();
  25.     if (isset($GLOBALS['demo_middlewares'])) {
  26.         unset($GLOBALS['demo_middlewares']);
  27.     }
  29.     $result = $router->dispatch($request);
  31.     $data = <<<'eot'
  32.         [
  33.             "DemoForAll::handle"
  34.         ]
  35.         eot;
  37.     $this->assertSame(
  38.         $data,
  39.         $this->varJson(
  40.             $GLOBALS['demo_middlewares']
  41.         )
  42.     );
  44.     $router->throughMiddleware($request, [
  45.         $result,
  46.     ]);
  48.     $data = <<<'eot'
  49.         [
  50.             "DemoForAll::handle",
  51.             "DemoForAll::terminate",
  52.             "Demo1::terminate"
  53.         ]
  54.         eot;
  56.     $this->assertSame(
  57.         $data,
  58.         $this->varJson(
  59.             $GLOBALS['demo_middlewares'],
  60.             1
  61.         )
  62.     );
  64.     $this->assertSame('Middleware matched 4', $result->getContent());
  66.     unset($GLOBALS['demo_middlewares']);
  67. }