{"id":13446,"date":"2017-06-08T15:34:52","date_gmt":"2017-06-08T12:34:52","guid":{"rendered":"https:\/\/belvg.com\/blog\/?p=13446"},"modified":"2025-02-11T13:12:57","modified_gmt":"2025-02-11T11:12:57","slug":"request-routing-in-magento-2","status":"publish","type":"post","link":"https:\/\/belvg.com\/blog\/request-routing-in-magento-2.html","title":{"rendered":"Request Routing in Magento 2"},"content":{"rendered":"

In the article, we’re going to compare routing in Magento 1 and Magento 2. <\/span>Actually, there’s an article containing routing description in Magento 1<\/a>, so in case you’d like to have a closer look at routing in Magento 1, read our blog.<\/span><\/p>\n

Route determination starts from searching for current route defined in the system. The process starts here:<\/span><\/p>\n

\/vendor\/magento\/framework\/App\/FrontController.php<\/span><\/em><\/p>\n

public function dispatch(RequestInterface $request)\r\n    {\r\n        \\Magento\\Framework\\Profiler::start('routers_match');\r\n        $routingCycleCounter = 0;\r\n        $result = null;\r\n        while (!$request->isDispatched() && $routingCycleCounter++ < 100) {\r\n            \/** @var \\Magento\\Framework\\App\\RouterInterface $router *\/\r\n            foreach ($this->_routerList as $router) {\r\n                try {\r\n                    $actionInstance = $router->match($request);\r\n                    if ($actionInstance) {\r\n                        $request->setDispatched(true);\r\n                        $this->response->setNoCacheHeaders();\r\n                        if ($actionInstance instanceof \\Magento\\Framework\\App\\Action\\AbstractAction) {\r\n                            $result = $actionInstance->dispatch($request);\r\n                        } else {\r\n                            $result = $actionInstance->execute();\r\n                        }\r\n                        break;\r\n                    }\r\n                } catch (\\Magento\\Framework\\Exception\\NotFoundException $e) {\r\n                    $request->initForward();\r\n                    $request->setActionName('noroute');\r\n                    $request->setDispatched(false);\r\n                    break;\r\n                }\r\n            }\r\n        }\r\n        \\Magento\\Framework\\Profiler::stop('routers_match');\r\n        if ($routingCycleCounter > 100) {\r\n            throw new \\LogicException('Front controller reached 100 router match iterations');\r\n        }\r\n        return $result;\r\n    }\r\n<\/pre>\n
In the method dispatch()<\/em> as well as in Magento 1 file app\/code\/core\/Mage\/Core\/Controller\/Varien\/Front.php<\/em> there are some matches:<\/span><\/p>\n
    \n
  • Checking is a request by dispatcher ($request->isDispatched()<\/em>);<\/span><\/li>\n
  • Searching for matches ($router->match($request)<\/em>).<\/span><\/li>\n<\/ul>\n
    In comparison with Magento 1, there are only two routings determined in Magento 2:<\/span><\/p>\n
      \n
    • \/vendor\/magento\/framework\/App\/Router\/Base.php;<\/span><\/em><\/li>\n
    • \/vendor\/magento\/framework\/App\/Router\/DefaultRouter.php.<\/span><\/em><\/li>\n<\/ul>\n
      The same as in Magento 1, after 100 iterations if a router is not found, there will be a message displayed. Here we can find attributes of Magento 1:<\/span><\/p>\n
      if ($routingCycleCounter > 100) {\r\n            throw new \\LogicException('Front controller reached 100 router match iterations');\r\n        }\r\n<\/pre>\n
      The main steps of routing process are the same as in Magento 1:<\/span><\/p>\n
        \n
      • Determining module<\/span><\/li>\n
      • Determining controller<\/span><\/li>\n
      • Action for detection<\/span><\/li>\n
      • Data for current request detection<\/span><\/li>\n<\/ul>\n
        Router initialization in Magento 2 differs from Magento 1:<\/span><\/p>\n
        protected function _getRoutes($scope = null)\r\n    {\r\n        $scope = $scope ?: $this->_configScope->getCurrentScope();\r\n        if (isset($this->_routes[$scope])) {\r\n            return $this->_routes[$scope];\r\n        }\r\n        $cacheId = $scope . '::' . $this->_cacheId;\r\n        $cachedRoutes = unserialize($this->_cache->load($cacheId));\r\n        if (is_array($cachedRoutes)) {\r\n            $this->_routes[$scope] = $cachedRoutes;\r\n            return $cachedRoutes;\r\n        }\r\n \r\n        $routers = $this->_reader->read($scope);\r\n        $routes = $routers[$this->_areaList->getDefaultRouter($scope)]['routes'];\r\n        $this->_cache->save(serialize($routes), $cacheId);\r\n        $this->_routes[$scope] = $routes;\r\n        return $routes;\r\n    }\r\n \r\npublic function read($scope = null)\r\n{\r\n\t$scope = $scope ?: $this->_defaultScope;\r\n\t$fileList = $this->_fileResolver->get($this->_fileName, $scope);\r\n\tif (!count($fileList)) {\r\n\t\treturn [];\r\n\t}\r\n\t$output = $this->_readFiles($fileList);\r\n \r\n\treturn $output;\r\n}\r\n<\/pre>\n
        Initialization occurs when searching for an appropriate router:<\/span><\/p>\n
        …\r\nwhile (!$request->isDispatched() && $routingCycleCounter++ < 100) {\r\n            \/** @var \\Magento\\Framework\\App\\RouterInterface $router *\/\r\n            foreach ($this->_routerList as $router) {\r\n                try {\r\n                    $actionInstance = $router->match($request);\r\n                    if ($actionInstance) { \r\n\t\t\t…\r\n<\/pre>\n
        Further routing process resembles Magento 1:<\/span><\/p>\n
        protected function parseRequest(\\Magento\\Framework\\App\\RequestInterface $request)\r\n    {\r\n        $output = [];\r\n \r\n        $path = trim($request->getPathInfo(), '\/');\r\n \r\n        $params = explode('\/', $path ? $path : $this->pathConfig->getDefaultPath());\r\n        foreach ($this->_requiredParams as $paramName) {\r\n            $output[$paramName] = array_shift($params);\r\n        }\r\n \r\n        for ($i = 0, $l = sizeof($params); $i < $l; $i += 2) {\r\n            $output['variables'][$params[$i]] = isset($params[$i + 1]) ? urldecode($params[$i + 1]) : '';\r\n        }\r\n        return $output;\r\n    }\r\n<\/pre>\n
        The first three elements are considered as main. They define a module, controller, and action for a current request. <\/span><\/p>\n
        Then module is determined from its moduleFrontName:<\/span><\/p>\n
        \/**\r\n         * Searching router args by module name from route using it as key\r\n         *\/\r\n        $modules = $this→_routeConfig→getModulesByFrontName($moduleFrontName);\r\n<\/pre>\n
        Then a controller and action for a current request are determined:<\/span><\/p>\n
         \/**\r\n         * Going through modules to find appropriate controller\r\n         *\/\r\n        $currentModuleName = null;\r\n        $actionPath = null;\r\n        $action = null;\r\n        $actionInstance = null;\r\n \r\n        $actionPath = $this->matchActionPath($request, $params['actionPath']);\r\n        $action = $request->getActionName() ?: ($params['actionName'] ?: $this->_defaultPath->getPart('action'));\r\n        $this->_checkShouldBeSecure($request, '\/' . $moduleFrontName . '\/' . $actionPath . '\/' . $action);\r\n \r\n        foreach ($modules as $moduleName) {\r\n            $currentModuleName = $moduleName;\r\n \r\n            $actionClassName = $this->actionList->get($moduleName, $this->pathPrefix, $actionPath, $action);\r\n            if (!$actionClassName || !is_subclass_of($actionClassName, $this->actionInterface)) {\r\n                continue;\r\n            }\r\n \r\n            $actionInstance = $this->actionFactory->create($actionClassName);\r\n            break;\r\n        }\r\n \r\n        if (null == $actionInstance) {\r\n            $actionInstance = $this->getNotFoundAction($currentModuleName);\r\n            if ($actionInstance === null) {\r\n                return null;\r\n            }\r\n            $action = 'noroute';\r\n        }\r\n<\/pre>\n
        Besides, it is checked whether the connection is safe if there is a controller file, as well as previous realization, is stored:<\/span><\/p>\n
        $this->_checkShouldBeSecure($request, '\/' . $moduleFrontName . '\/' . $actionPath . '\/' . $action);\r\n<\/pre>\n
        It implies that route is processed. Module, controller, and action are determined. Moreover, an action for a current request is being processed. <\/span><\/p>\n
        \/\/ set values only after all the checks are done\r\n        $request->setModuleName($moduleFrontName);\r\n        $request->setControllerName($actionPath);\r\n        $request->setActionName($action);\r\n        $request->setControllerModule($currentModuleName);\r\n        $request->setRouteName($this->_routeConfig->getRouteByFrontName($moduleFrontName));\r\n        if (isset($params['variables'])) {\r\n            $request->setParams($params['variables']);\r\n        }\r\n        return $actionInstance;\r\n<\/pre>\n
        Control element returns for performing action:<\/span><\/p>\n
        …\r\n\t\tif ($actionInstance) {\r\n                        $request->setDispatched(true);\r\n                        $this->response->setNoCacheHeaders();\r\n                        if ($actionInstance instanceof \\Magento\\Framework\\App\\Action\\AbstractAction) {\r\n                            $result = $actionInstance->dispatch($request);\r\n                        } else {\r\n                            $result = $actionInstance->execute();\r\n                        }\r\n                        break;\r\n                    }\r\n\t\t...\r\n<\/pre>\n
        Where for a current request output is determined.<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"In the article, we’re going to compare routing in Magento 1 and Magento 2. Actually, …","protected":false},"author":2,"featured_media":13448,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"image","meta":{"_acf_changed":false,"footnotes":""},"categories":[35,14,389,471],"tags":[],"class_list":["post-13446","post","type-post","status-publish","format-image","has-post-thumbnail","hentry","category-certification","category-magento","category-magento2-development","category-magento-developer","post_format-image"],"acf":[],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t