路由服务提供者

Testing Is Documentation

tests/Router/RouterProviderTest.php路由服务提供者 - 图1

路由主要由路由服务来接入框架，可以做一些设置。

  1. namespace Common\Infra\Provider;
  3. use Admin\App\Middleware\Auth as AdminAuth;
  4. use Admin\App\Middleware\Cors;
  5. use Leevel\Auth\Middleware\Auth;
  6. use Leevel\Debug\Middleware\Debug;
  7. use Leevel\Di\IContainer;
  8. use Leevel\Log\Middleware\Log;
  9. use Leevel\Router\RouterProvider;
  10. use Leevel\Session\Middleware\Session;
  11. use Leevel\Throttler\Middleware\Throttler;
  13. class Router extends RouterProvider
  14. {
  15.     /**
  16.      * 控制器相对目录.
  17.      *
  18.      * @var string
  19.      */
  20.     protected string $controllerDir = 'App\\Controller';
  22.     /**
  23.      * 中间件分组.
  24.      *
  25.      * - 分组可以很方便地批量调用组件.
  26.      *
  27.      * @var array
  28.      */
  29.     protected array $middlewareGroups = [
  30.         // web 请求中间件
  31.         'web' => [
  32.             'session',
  33.         ],
  35.         // api 请求中间件
  36.         'api' => [
  37.             // API 限流，可以通过网关来做限流更高效，如果需要去掉注释即可
  38.             // 'throttler:60,60',
  39.         ],
  41.         // 公共请求中间件
  42.         'common' => [
  43.             'log',
  44.         ],
  45.     ];
  47.     /**
  48.      * 中间件别名.
  49.      *
  50.      * - HTTP 中间件提供一个方便的机制来过滤进入应用程序的 HTTP 请求
  51.      * - 例外在应用执行结束后响应环节也会调用 HTTP 中间件.
  52.      *
  53.      * @var array
  54.      */
  55.     protected array $middlewareAlias = [
  56.         'auth'              => Auth::class,
  57.         'cors'              => Cors::class,
  58.         'admin_auth'        => AdminAuth::class,
  59.         'debug'             => Debug::class,
  60.         'log'               => Log::class,
  61.         'session'           => Session::class,
  62.         'throttler'         => Throttler::class,
  63.     ];
  65.     /**
  66.      * 基础路径.
  67.      *
  68.      * @var array
  69.      */
  70.     protected array $basePaths = [
  71.         '*' => [
  72.             'middlewares' => 'common',
  73.         ],
  74.         'foo/*world' => [
  75.         ],
  76.         'api/test' => [
  77.             'middlewares' => 'api',
  78.         ],
  79.         ':admin/*' => [
  80.             'middlewares' => 'admin_auth,cors',
  81.         ],
  82.         'options/index' => [
  83.             'middlewares' => 'cors',
  84.         ],
  85.         'admin/show' => [
  86.             'middlewares' => 'auth',
  87.         ],
  88.     ];
  90.     /**
  91.      * 分组.
  92.      *
  93.      * @var array
  94.      */
  95.     protected array $groups = [
  96.         'pet'     => [],
  97.         'store'   => [],
  98.         'user'    => [],
  99.         '/api/v1' => [
  100.             'middlewares' => 'api',
  101.         ],
  102.         'api/v2' => [
  103.             'middlewares' => 'api',
  104.         ],
  105.         '/web/v1' => [
  106.             'middlewares' => 'web',
  107.         ],
  108.         'web/v2' => [
  109.             'middlewares' => 'web',
  110.         ],
  111.     ];
  113.     /**
  114.      * 创建一个服务容器提供者实例.
  115.      */
  116.     public function __construct(IContainer $container)
  117.     {
  118.         parent::__construct($container);
  119.         if ($container->make('app')->isDebug()) {
  120.             $this->middlewareGroups['common'][] = 'debug';
  121.         }
  122.     }
  124.     /**
  125.      * bootstrap.
  126.      */
  127.     public function bootstrap(): void
  128.     {
  129.         parent::bootstrap();
  130.     }
  132.     /**
  133.      * 返回路由.
  134.      */
  135.     public function getRouters(): array
  136.     {
  137.         return parent::getRouters();
  138.     }
  139. }

Uses

  1. <?php
  3. use Leevel\Di\Container;
  4. use Leevel\Kernel\App;
  5. use Leevel\Router\Router;
  6. use Leevel\Router\RouterProvider;
  7. use Leevel\Router\Url;
  8. use Tests\Router\Middlewares\Demo1;
  9. use Tests\Router\Middlewares\Demo2;
  10. use Tests\Router\Middlewares\Demo3;

基本使用

QueryPHP 路由最终结果主要由 base_paths、groups 和 routers 构成。

fixture 定义

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

  1. namespace Tests\Router;
  3. class RouterProvider1 extends RouterProvider
  4. {
  5.     protected string $controllerDir = 'Tests\\Router\\Apps';
  7.     protected array $middlewareGroups = [
  8.         'group1' => [
  9.             'demo1',
  10.             'demo2',
  11.         ],
  12.         'group2' => [
  13.             'demo1',
  14.             'demo3:10,world',
  15.         ],
  16.         'group3' => [
  17.             'demo1',
  18.             'demo2',
  19.             'demo3:10,world',
  20.         ],
  21.     ];
  23.     protected array $middlewareAlias = [
  24.         'demo1' => Demo1::class,
  25.         'demo2' => Demo2::class,
  26.         'demo3' => Demo3::class,
  27.     ];
  29.     protected array $basePaths = [];
  31.     protected array $groups = [
  32.         'pet'     => [],
  33.         'store'   => [],
  34.         'user'    => [],
  35.         '/api/v1' => [
  36.             'middlewares' => 'group1',
  37.         ],
  38.         '/api/v2' => [
  39.             'middlewares' => 'group2',
  40.         ],
  41.         '/api/v3' => [
  42.             'middlewares' => 'demo1,demo3:30,world',
  43.         ],
  44.         '/api/v3' => [
  45.             'middlewares' => ['demo1', 'group3'],
  46.         ],
  47.         '/api/v4' => [
  48.             'middlewares' => 'notFound',
  49.         ],
  50.     ];
  52.     public function bootstrap(): void
  53.     {
  54.         parent::bootstrap();
  55.     }
  57.     public function getRouters(): array
  58.     {
  59.         return parent::getRouters();
  60.     }
  61. }

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

  1. {
  2.     "base_paths": {
  3.         "\/^\\\/api\\\/v1(\\S*)\\\/$\/": {
  4.             "middlewares": {
  5.                 "handle": [
  6.                     "Tests\\Router\\Middlewares\\Demo2@handle"
  7.                 ],
  8.                 "terminate": [
  9.                     "Tests\\Router\\Middlewares\\Demo1@terminate",
  10.                     "Tests\\Router\\Middlewares\\Demo2@terminate"
  11.                 ]
  12.             }
  13.         },
  14.         "\/^\\\/api\\\/v2(\\S*)\\\/$\/": {
  15.             "middlewares": {
  16.                 "handle": [
  17.                     "Tests\\Router\\Middlewares\\Demo3@handle:10,world"
  18.                 ],
  19.                 "terminate": [
  20.                     "Tests\\Router\\Middlewares\\Demo1@terminate"
  21.                 ]
  22.             }
  23.         },
  24.         "\/^\\\/api\\\/v3(\\S*)\\\/$\/": {
  25.             "middlewares": {
  26.                 "handle": [
  27.                     "Tests\\Router\\Middlewares\\Demo2@handle",
  28.                     "Tests\\Router\\Middlewares\\Demo3@handle:10,world"
  29.                 ],
  30.                 "terminate": [
  31.                     "Tests\\Router\\Middlewares\\Demo1@terminate",
  32.                     "Tests\\Router\\Middlewares\\Demo2@terminate"
  33.                 ]
  34.             }
  35.         }
  36.     },
  37.     "groups": [
  38.         "\/pet",
  39.         "\/store",
  40.         "\/user",
  41.         "\/api\/v1",
  42.         "\/api\/v2",
  43.         "\/api\/v3",
  44.         "\/api\/v4"
  45.     ],
  46.     "routers": {
  47.         "get": {
  48.             "a": {
  49.                 "\/api\/v1": {
  50.                     "\/api\/v1\/petLeevel\/{petId:[A-Za-z]+}\/": {
  51.                         "bind": "\\Tests\\Router\\Apps\\AppScanRouter\\Controllers\\Pet@petLeevel",
  52.                         "var": [
  53.                             "petId"
  54.                         ]
  55.                     },
  56.                     "regex": [
  57.                         "~^(?|\/api\/v1\/petLeevel\/([A-Za-z]+)\/)$~x"
  58.                     ],
  59.                     "map": [
  60.                         {
  61.                             "2": "\/api\/v1\/petLeevel\/{petId:[A-Za-z]+}\/"
  62.                         }
  63.                     ]
  64.                 }
  65.             },
  66.             "static": {
  67.                 "\/web\/petLeevelWithPort\/": {
  68.                     "port": 9527,
  69.                     "bind": "\\Tests\\Router\\Apps\\AppScanRouter\\Controllers\\Pet@petLeevelWithPort"
  70.                 }
  71.             }
  72.         }
  73.     }
  74. }
  1. public function testBaseUse(): void
  2. {
  3.     $container = Container::singletons();
  4.     $app = new App($container, '');
  5.     $app->setAppPath(__DIR__.'/Apps/AppScanRouter');
  6.     $app->setPath(__DIR__.'/Apps/AppScanRouter');
  7.     $app->setRouterCachedPath(__DIR__.'/router_cached.php');
  9.     $container->instance('app', $app);
  10.     $container->instance('router', $router = $this->createRouter($container));
  12.     $provider = new RouterProvider1($container);
  14.     $this->assertNull($provider->register());
  15.     $this->assertNull($provider->bootstrap());
  17.     $data = file_get_contents(__DIR__.'/Apps/AppScanRouter/data.json');
  19.     $this->assertSame(
  20.         $data,
  21.         $this->varJson(
  22.             [
  23.                 'base_paths'  => $router->getBasePaths(),
  24.                 'groups'      => $router->getGroups(),
  25.                 'routers'     => $router->getRouters(),
  26.             ]
  27.         )
  28.     );
  30.     Container::singletons()->clear();
  31. }