Laravelルーティングの詳しい説明ルート-PHPチュートリアル-php.cn

ルーティングは、外部の世界が Laravel アプリケーションにアクセスするための方法、またはルーティングは、Laravel アプリケーションが外部の世界にサービスを提供する特定の方法を定義します。指定された URI、HTTP リクエストメソッド、およびルーティングパラメーター (オプション) を介してのみ、正しくサービスを提供できます。ルーティング定義プログラムの処理にアクセスします。 URI に対応するハンドラーが単純なクロージャであっても、コントローラーメソッドに対応するルートがない場合でも、外部からアクセスすることはできません。今日は、Laravel がルーティングをどのように設計して実装するかを見ていきます。

通常、ルーティングファイルで次のようにルートを定義します:

Route::get('/user', 'UsersController@index');

ログイン後にコピー

上記のルーティングを通じて、クライアントがHTTP GET経由でURI「/user」をリクエストすると、Laravelが最終的にリクエストをディスパッチすることがわかります。インデックスメソッドを与えます。 UsersController クラスの応答を処理し、index メソッドでクライアントに応答を返します。

上記のルートを登録する際に使用されるRouteクラスは、LaravelではFacadeと呼ばれ、サービスコンテナにバインドされたサービスルータにアクセスする簡単な方法を提供します。今後はFacadeの設計概念と実装方法を使用する予定です。ここでは、呼び出される Route ファサードの静的メソッドがサービスコンテナ内のルーターサービスのメソッドに対応することだけを知っておく必要があるため、上記のルートが次のように登録されていることも確認できます。

app()->make('router')->get('user', 'UsersController@index');

ログイン後にコピー

router このサービスは、アプリケーションのインスタンス化時にコンストラクターに RoutingServiceProvider を登録することによってサービスコンテナにバインドされます。アプリケーション:

//bootstrap/app.php
$app = new Illuminate\Foundation\Application(
    realpath(__DIR__.'/../')
);

//Application: 构造方法
public function __construct($basePath = null)
{
    if ($basePath) {
        $this->setBasePath($basePath);
    }

    $this->registerBaseBindings();

    $this->registerBaseServiceProviders();

    $this->registerCoreContainerAliases();
}

//Application: 注册基础的服务提供器
protected function registerBaseServiceProviders()
{
    $this->register(new EventServiceProvider($this));

    $this->register(new LogServiceProvider($this));

    $this->register(new RoutingServiceProvider($this));
}

//\Illuminate\Routing\RoutingServiceProvider: 绑定router到服务容器
protected function registerRouter()
{
    $this->app->singleton('router', function ($app) {
        return new Router($app['events'], $app);
    });
}

ログイン後にコピー

上記のコードを通じて、Route によって呼び出される静的メソッドはすべて

IlluminateRoutingRouter に対応することがわかります。 code>クラス内のメソッド、Router クラスには、ルーティングの登録、アドレス指定、およびスケジューリングに関連するメソッドが含まれています。 <p><code>IlluminateRoutingRouter

类里的方法，Router这个类里包含了与路由的注册、寻址、调度相关的方法。

下面我们从路由的注册、加载、寻址这几个阶段来看一下laravel里是如何实现这些的。

路由加载

注册路由前需要先加载路由文件，路由文件的加载是在AppProvidersRouteServiceProvider这个服务器提供者的boot方法里加载的:

class RouteServiceProvider extends ServiceProvider
{
    public function boot()
    {
        parent::boot();
    }

    public function map()
    {
        $this->mapApiRoutes();

        $this->mapWebRoutes();
    }

    protected function mapWebRoutes()
    {
        Route::middleware('web')
             ->namespace($this->namespace)
             ->group(base_path('routes/web.php'));
    }

    protected function mapApiRoutes()
    {
        Route::prefix('api')
             ->middleware('api')
             ->namespace($this->namespace)
             ->group(base_path('routes/api.php'));
    }
}

ログイン後にコピー

namespace Illuminate\Foundation\Support\Providers;

class RouteServiceProvider extends ServiceProvider
{

    public function boot()
    {
        $this->setRootControllerNamespace();

        if ($this->app->routesAreCached()) {
            $this->loadCachedRoutes();
        } else {
            $this->loadRoutes();

            $this->app->booted(function () {
                $this->app['router']->getRoutes()->refreshNameLookups();
                $this->app['router']->getRoutes()->refreshActionLookups();
            });
        }
    }

    protected function loadCachedRoutes()
    {
        $this->app->booted(function () {
            require $this->app->getCachedRoutesPath();
        });
    }

    protected function loadRoutes()
    {
        if (method_exists($this, 'map')) {
            $this->app->call([$this, 'map']);
        }
    }
}

class Application extends Container implements ApplicationContract, HttpKernelInterface
{
    public function routesAreCached()
    {
        return $this['files']->exists($this->getCachedRoutesPath());
    }

    public function getCachedRoutesPath()
    {
        return $this->bootstrapPath().'/cache/routes.php';
    }
}

ログイン後にコピー

laravel 首先去寻找路由的缓存文件，没有缓存文件再去进行加载路由。缓存文件一般在 bootstrap/cache/routes.php 文件中。
方法loadRoutes会调用map方法来加载路由文件里的路由，map这个函数在AppProvidersRouteServiceProvider类中，这个类继承自IlluminateFoundationSupportProvidersRouteServiceProvider。通过map方法我们能看到laravel将路由分为两个大组：api、web。这两个部分的路由分别写在两个文件中：routes/web.php、routes/api.php。

Laravel5.5里是把路由分别放在了几个文件里，之前的版本是在app/Http/routes.php文件里。放在多个文件里能更方便地管理API路由和与WEB路由

路由注册

我们通常都是用Route这个Facade调用静态方法get, post, head, options, put, patch, delete......等来注册路由，上面我们也说了这些静态方法其实是调用了Router类里的方法:

public function get($uri, $action = null)
{
    return $this->addRoute(['GET', 'HEAD'], $uri, $action);
}

public function post($uri, $action = null)
{
    return $this->addRoute('POST', $uri, $action);
}
....

ログイン後にコピー

可以看到路由的注册统一都是由router类的addRoute方法来处理的：

//注册路由到RouteCollection
protected function addRoute($methods, $uri, $action)
{
    return $this->routes->add($this->createRoute($methods, $uri, $action));
}

//创建路由
protected function createRoute($methods, $uri, $action)
{
    if ($this->actionReferencesController($action)) {
        //controller@action类型的路由在这里要进行转换
        $action = $this->convertToControllerAction($action);
    }

    $route = $this->newRoute(
        $methods, $this->prefix($uri), $action
    );

    if ($this->hasGroupStack()) {
        $this->mergeGroupAttributesIntoRoute($route);
    }

    $this->addWhereClausesToRoute($route);

    return $route;
}

protected function convertToControllerAction($action)
{
    if (is_string($action)) {
        $action = ['uses' => $action];
    }

    if (! empty($this->groupStack)) {        
        $action['uses'] = $this->prependGroupNamespace($action['uses']);
    }
    
    $action['controller'] = $action['uses'];

    return $action;
}

ログイン後にコピー

注册路由时传递给addRoute的第三个参数action可以闭包、字符串或者数组，数组就是类似['uses' => 'Controller@action', 'middleware' => '...']这种形式的。如果action是Controller@action类型的路由将被转换为action数组, convertToControllerAction执行完后action的内容为：

[
    'uses' => 'App\Http\Controllers\SomeController@someAction',
    'controller' => 'App\Http\Controllers\SomeController@someAction'
]

ログイン後にコピー

可以看到把命名空间补充到了控制器的名称前组成了完整的控制器类名，action数组构建完成接下里就是创建路由了，创建路由即用指定的HTTP请求方法、URI字符串和action数组来创建IlluminateRoutingRouteこれがLaravelでどのように実装されるかを、ルーティングの登録、読み込み、アドレス指定の段階から見てみましょう。

ルートのロード

ルートを登録する前に、ルーティングファイルをロードする必要があります。ルーティングファイルは、サーバープロバイダー AppProvidersRouteServiceProvider のブートメソッドにロードされます。まず、

protected function newRoute($methods, $uri, $action)
{
    return (new Route($methods, $uri, $action))
                ->setRouter($this)
                ->setContainer($this->container);
}

ログイン後にコピー

protected function addRoute($methods, $uri, $action)
{
    return $this->routes->add($this->createRoute($methods, $uri, $action));
}

ログイン後にコピー

laravel のキャッシュを探します。ルートファイル。キャッシュされたファイルがない場合は、ルートをロードします。キャッシュファイルは通常、bootstrap/cache/routes.php ファイル内にあります。
loadRoutes メソッドは、map メソッドを呼び出してルーティングファイルにルートを読み込みます。map 関数は、IlluminateFoundationSupportProvidersRouteServiceProvider を継承する AppProvidersRouteServiceProvider クラスにあります。 Map メソッドを通して、laravel がルーティングを API と Web という 2 つの大きなグループに分割していることがわかります。これら 2 つの部分のルートは、それぞれ Route/web.php と Route/api.php の 2 つのファイルに書き込まれます。

Laravel 5.5 では、ルートは複数のファイルに配置されます。以前のバージョンは app/Http/routes.php ファイルにありました。複数のファイルに配置すると、 API ルートと WEB ルートの管理が容易になります

ルート登録

通常、Route Facade を使用して静的メソッド get、post、head、options、put を呼び出します。上で述べたように、これらの静的メソッドは実際には Router クラスのメソッドを呼び出します。

class RouteCollection implements Countable, IteratorAggregate
{
    public function add(Route $route)
    {
        $this->addToCollections($route);

        $this->addLookups($route);

        return $route;
    }
    
    protected function addToCollections($route)
    {
        $domainAndUri = $route->getDomain().$route->uri();

        foreach ($route->methods() as $method) {
            $this->routes[$method][$domainAndUri] = $route;
        }

        $this->allRoutes[$method.$domainAndUri] = $route;
    }
    
    protected function addLookups($route)
    {
        $action = $route->getAction();

        if (isset($action['as'])) {
            //如果时命名路由，将route对象映射到以路由名为key的数组值中方便查找
            $this->nameList[$action['as']] = $route;
        }

        if (isset($action['controller'])) {
            $this->addToActionList($action, $route);
        }
    }

}

ログイン後にコピー

ルートの登録は Router クラスによって均一に行われることがわかります。 addRoute メソッド:

[
    'GET' => [
        $routeUri1 => $routeObj1
        ...
    ]
    ...
]

ログイン後にコピー

ルートを登録するときに addRoute に渡される 3 番目のパラメーターアクションは、クロージャ、文字列、または配列にすることができます。配列は ['uses' => 'Controller@action', 'middleware' に似ています。 = > '...'] この形式で。アクションがタイプ Controller@action のルートの場合、convertToControllerAction の実行後、アクションの内容は次のようになります。

[
    'GET' . $routeUri1 => $routeObj1
    'GET' . $routeUri2 => $routeObj2
    ...
]

ログイン後にコピー

名前空間が次であることがわかります。完全なコントローラークラス名とアクション配列が作成されます。次の手順では、ルートを作成します。ルートを作成するには、指定された HTTP リクエストメソッド、URI 文字列、およびアクション配列を使用してインスタンスを作成します。 `IlluminateRoutingRoute` クラス:

[
    $routeName1 => $routeObj1
    ...
]

ログイン後にコピー

ルートの作成が完了したら、RouteCollection に Route を追加します:

[
    'App\Http\Controllers\ControllerOne@ActionOne' => $routeObj1
]

ログイン後にコピー

RouteCollection にルートを追加するとき、ルーターの $routes 属性は RouteCollection オブジェクトです。 RouteCollection オブジェクトのルート、allRoutes、nameList、および actionList 属性が更新されます

//Illuminate\Foundation\Http\Kernel
class Kernel implements KernelContract
{
    protected function sendRequestThroughRouter($request)
    {
        $this->app->instance('request', $request);

        Facade::clearResolvedInstance('request');

        $this->bootstrap();

        return (new Pipeline($this->app))
                    ->send($request)
                    ->through($this->app->shouldSkipMiddleware() ? [] : $this->middleware)
                    ->then($this->dispatchToRouter());
    }
    
    protected function dispatchToRouter()
    {
        return function ($request) {
            $this->app->instance('request', $request);

            return $this->router->dispatch($request);
        };
    }
    
}

ログイン後にコピー

RouteCollection 4 つの属性

routes は、HTTP リクエストメソッドとルーティングオブジェクト間のマッピングを保存します。

$destination = function ($request) {
    $this->app->instance('request', $request);
    return $this->router->dispatch($request);
};

ログイン後にコピー

🎜 allRoutes 属性に保存される内容は次のとおりです。 Routes 属性の 2 桁の配列を 1 桁の配列にプログラムした後の内容: 🎜

class Router implements RegistrarContract, BindingRegistrar
{    
    public function dispatch(Request $request)
    {
        $this->currentRequest = $request;

        return $this->dispatchToRoute($request);
    }
    
    public function dispatchToRoute(Request $request)
    {
        return $this->runRoute($request, $this->findRoute($request));
    }
    
    protected function findRoute($request)
    {
        $this->current = $route = $this->routes->match($request);

        $this->container->instance(Route::class, $route);

        return $route;
    }
    
}

ログイン後にコピー

🎜nameList はルーティング名とルーティングオブジェクトの間のマッピングテーブルです🎜

class RouteCollection implements Countable, IteratorAggregate
{
    public function match(Request $request)
    {
        $routes = $this->get($request->getMethod());

        $route = $this->matchAgainstRoutes($routes, $request);

        if (! is_null($route)) {
            return $route->bind($request);
        }

        $others = $this->checkForAlternateVerbs($request);

        if (count($others) > 0) {
            return $this->getRouteForMethods($request, $others);
        }

        throw new NotFoundHttpException;
    }

    protected function matchAgainstRoutes(array $routes, $request, $includingMethod = true)
    {
        return Arr::first($routes, function ($value) use ($request, $includingMethod) {
            return $value->matches($request, $includingMethod);
        });
    }
}

class Route
{
    public function matches(Request $request, $includingMethod = true)
    {
        $this->compileRoute();

        foreach ($this->getValidators() as $validator) {
            if (! $includingMethod && $validator instanceof MethodValidator) {
                continue;
            }

            if (! $validator->matches($this, $request)) {
                return false;
            }
        }

        return true;
    }
}

ログイン後にコピー

🎜actionList はルーティングコントローラーのメソッド文字列とルーティングオブジェクトの間のマッピングテーブルです🎜rreee🎜これでルートが登録されました。 🎜🎜ルーティングアドレッシング🎜🎜 ミドルウェアに関する記事で、HTTP リクエストはパイプラインチャネルでのミドルウェアの事前操作を経た後に宛先に到達すると言いました:🎜

class UriValidator implements ValidatorInterface
{
    public function matches(Route $route, Request $request)
    {
        $path = $request->path() == '/' ? '/' : '/'.$request->path();

        return preg_match($route->getCompiled()->getRegex(), rawurldecode($path));
    }
}

ログイン後にコピー

🎜 上記のコードから、宛先が次のとおりであることがわかります。パイプラインは、dispatchToRouter 関数によって返されます。クロージャ: 🎜

class Route
{
    public function bind(Request $request)
    {
        $this->compileRoute();

        $this->parameters = (new RouteParameterBinder($this))
                        ->parameters($request);

        return $this;
    }
}

class RouteParameterBinder
{
    public function parameters($request)
    {
        $parameters = $this->bindPathParameters($request);

        if (! is_null($this->route->compiled->getHostRegex())) {
            $parameters = $this->bindHostParameters(
                $request, $parameters
            );
        }

        return $this->replaceDefaults($parameters);
    }
    
    protected function bindPathParameters($request)
    {
            preg_match($this->route->compiled->getRegex(), '/'.$request->decodedPath(), $matches);

            return $this->matchToKeys(array_slice($matches, 1));
    }
    
    protected function matchToKeys(array $matches)
    {
        if (empty($parameterNames = $this->route->parameterNames())) {
            return [];
        }

        $parameters = array_intersect_key($matches, array_flip($parameterNames));

        return array_filter($parameters, function ($value) {
            return is_string($value) && strlen($value) > 0;
        });
    }
}

ログイン後にコピー

🎜 ルーターのディスパッチメソッドは、ディスパッチの最初の段階である findRoute で行われます: 🎜

class Router implements RegistrarContract, BindingRegistrar
{    
    public function dispatch(Request $request)
    {
        $this->currentRequest = $request;

        return $this->dispatchToRoute($request);
    }
    
    public function dispatchToRoute(Request $request)
    {
        return $this->runRoute($request, $this->findRoute($request));
    }
    
    protected function runRoute(Request $request, Route $route)
    {
        $request->setRouteResolver(function () use ($route) {
            return $route;
        });

        $this->events->dispatch(new Events\RouteMatched($route, $request));

        return $this->prepareResponse($request,
            $this->runRouteWithinStack($route, $request)
        );
    }
    
}

ログイン後にコピー

🎜 ルートを見つけるタスクは、RouteCollection によって処理されます。関数はルートの照合を担当し、リクエスト URL パラメーターをルートにバインドします。 🎜

class RouteCollection implements Countable, IteratorAggregate
{
    public function match(Request $request)
    {
        $routes = $this->get($request->getMethod());

        $route = $this->matchAgainstRoutes($routes, $request);

        if (! is_null($route)) {
            return $route->bind($request);
        }

        $others = $this->checkForAlternateVerbs($request);

        if (count($others) > 0) {
            return $this->getRouteForMethods($request, $others);
        }

        throw new NotFoundHttpException;
    }

    protected function matchAgainstRoutes(array $routes, $request, $includingMethod = true)
    {
        return Arr::first($routes, function ($value) use ($request, $includingMethod) {
            return $value->matches($request, $includingMethod);
        });
    }
}

class Route
{
    public function matches(Request $request, $includingMethod = true)
    {
        $this->compileRoute();

        foreach ($this->getValidators() as $validator) {
            if (! $includingMethod && $validator instanceof MethodValidator) {
                continue;
            }

            if (! $validator->matches($this, $request)) {
                return false;
            }
        }

        return true;
    }
}

ログイン後にコピー

$routes = $this->get($request->getMethod());会先加载注册路由阶段在RouteCollection里生成的routes属性里的值，routes中存放了HTTP请求方法与路由对象的映射。

然后依次调用这堆路由里路由对象的matches方法， matches方法, matches方法里会对HTTP请求对象进行一些验证，验证对应的Validator是：UriValidator、MethodValidator、SchemeValidator、HostValidator。
在验证之前在$this->compileRoute()里会将路由的规则转换成正则表达式。

UriValidator主要是看请求对象的URI是否与路由的正则规则匹配能匹配上:

class UriValidator implements ValidatorInterface
{
    public function matches(Route $route, Request $request)
    {
        $path = $request->path() == '/' ? '/' : '/'.$request->path();

        return preg_match($route->getCompiled()->getRegex(), rawurldecode($path));
    }
}

ログイン後にコピー

MethodValidator验证请求方法, SchemeValidator验证协议是否正确(http|https), HostValidator验证域名, 如果路由中不设置host属性，那么这个验证不会进行。

一旦某个路由通过了全部的认证就将会被返回，接下来就要将请求对象URI里的路径参数绑定复制给路由参数:

路由参数绑定

class Route
{
    public function bind(Request $request)
    {
        $this->compileRoute();

        $this->parameters = (new RouteParameterBinder($this))
                        ->parameters($request);

        return $this;
    }
}

class RouteParameterBinder
{
    public function parameters($request)
    {
        $parameters = $this->bindPathParameters($request);

        if (! is_null($this->route->compiled->getHostRegex())) {
            $parameters = $this->bindHostParameters(
                $request, $parameters
            );
        }

        return $this->replaceDefaults($parameters);
    }
    
    protected function bindPathParameters($request)
    {
            preg_match($this->route->compiled->getRegex(), '/'.$request->decodedPath(), $matches);

            return $this->matchToKeys(array_slice($matches, 1));
    }
    
    protected function matchToKeys(array $matches)
    {
        if (empty($parameterNames = $this->route->parameterNames())) {
            return [];
        }

        $parameters = array_intersect_key($matches, array_flip($parameterNames));

        return array_filter($parameters, function ($value) {
            return is_string($value) && strlen($value) > 0;
        });
    }
}

ログイン後にコピー

赋值路由参数完成后路由寻址的过程就结束了，结下来就该运行通过匹配路由中对应的控制器方法返回响应对象了。

class Router implements RegistrarContract, BindingRegistrar
{    
    public function dispatch(Request $request)
    {
        $this->currentRequest = $request;

        return $this->dispatchToRoute($request);
    }
    
    public function dispatchToRoute(Request $request)
    {
        return $this->runRoute($request, $this->findRoute($request));
    }
    
    protected function runRoute(Request $request, Route $route)
    {
        $request->setRouteResolver(function () use ($route) {
            return $route;
        });

        $this->events->dispatch(new Events\RouteMatched($route, $request));

        return $this->prepareResponse($request,
            $this->runRouteWithinStack($route, $request)
        );
    }
    
}

ログイン後にコピー

这里我们主要介绍路由相关的内容，在runRoute的过程通过上面的源码可以看到其实也很复杂，会收集路由和控制器里的中间件，将请求通过中间件过滤才会最终调用控制器方法来生成响应对象，这个过程还会设计到我们以前介绍过的中间件过滤、服务解析、依赖注入方面的信息，如果在看源码时有不懂的地方可以翻看我之前写的文章。