Маршрутизация во фреймворках: Управление адресами URL

<?php
<a href="index.php?r=blog/post&id=<?php echo $post->id; ?>">...</a>

<?php
<a href="/blog/post/view/id/<?php echo $post->id; ?>">...</a>

<?php
<a href="<?php echo Yii::app()->createUrl('post/view', array('id'=>$post->id); ?>">...</a>

# modules/blog/routes.php
return array(
    '#^/blog$#' => 'blog/list/index',
    '#^/blog/category/(?P<category>[\w-]+)$#' => 'blog/list/category',
    '#^/blog/tag/(?P<tag>[\w-]+)$#' => 'blog/list/tag',
    '#^/blog/post/(?P<id>\d+)\.html$#' => 'blog/post/view',
    '#^feed\.xml$#' => 'blog/list/rss',
);

# modules/blog/routes.php
return array(
    'blog' => 'blog/list/index',
    'blog/category/(?P<category>[\w-]+)' => 'blog/list/category',
    'blog/tag/(?P<tag>[\w-]+)' => 'blog/list/tag',
    'blog/post/(?P<id>\d+)\.html' => 'blog/post/view',
    'feed\.xml' => 'blog/list/rss',
);

# modules/blog/controllers/list.php
function action_index() {
    $page = get_page();
    $posts = load_all_posts($page);
    include('modules/blog/views/list/index.php');
}
 
function action_category() {
    $page = get_page();
    $posts = load_posts_by_category($_GET['category'], $page);
    include('modules/blog/views/list/category.php');
}
 
function action_tag() {
    $page = get_page();
    $posts = load_posts_by_tag($_GET['tag'], $page);
    include('modules/blog/views/list/tag.php');
}
 
function action_rss() {
    $posts = load_latest_posts();
    include('modules/blog/views/list/rss.php');
}

# modules/blog/controllers/post.php
function action_view() {
    $post = load_post_by_id($_GET['id']);
    include('modules/blog/views/post/view.php');
}
...

# config.php
 
define('MODULES', 'page, blog, shop');
define('MODULES_PATH', 'modules');

# functions.php
 
// Нам нужно как-то получать список установленных модулей
// Для этого можно брать список папок в директории modules
// или, как у нас, просто хранить в файле настроек
function get_modules() {
    return preg_split('/\s*,\s*/', MODULES);
}
 
// Мы будем смотреть, по какому адресу к нам зашли
function get_request_path() {
    return trim($_SERVER['PATH_INFO'], '/');
}
 
// Часто придётся получать номер страницы
function get_page() {
    $page = intval(isset($_GET['page']) ? $_GET['page']: 0);
    return $page > 0 ? $page : 1;
}
 
// Соберём правила из всех модулей в один массив
function get_modules_rules() {
    $rules = array();
    foreach (get_modules as $module) {
        $rules = array_merge($rules, require_once(MODULES_PATH . '/' . $module . '/routes.php'));
    }
    return $rules;
}
 
// Удалим числовые элементы $matches[0], $matches[1],
// оставим строковые вида $matches['category']
function clear_numberic_matches($matches) {
    $clean = array();
    foreach ($matches as $key=>$value) {
        if (!is_int($key) {
            $clean[$key] = $value;
        }
    }
    return $clean;
}

# index.php
 
require_once('config.php');
require_once('functions.php');
 
$module = 'page';
$controller = 'default';
$action = 'index';
 
$path = get_request_path();
$rules = get_modules_rules();
 
foreach ($rules as $pattern=>$route) {
    if (preg_match('#^/' . ltrim($pattern, '/') . '$#', $path, $matches) {
        list($module, $controller, $action) = explode('/', $route);
        $_GET = array_merge($_GET, clear_numberic_matches($matches));
        break;
    }
}
 
require_once(MODULES_PATH . '/' . $module . '/controllers/' . $controller . '.php');
call_user_func('action_' . $action);

$module = 'blog';
$controller = 'list';
$action = 'category'
 
$_GET = array(
    'category' => 'design',
    'page' => 2,
    'sort' => 'date',
}

return array(
    'shop/cart' => 'shop/cart/index',
    'shop/cart/add' => 'shop/cart/add',
    'shop/cart/remove' => 'shop/cart/remove',
    'shop/cart/clear' => 'shop/cart/clear',
);

'shop/cart/remove/(?P<id>\d+)' => 'shop/cart/remove',

$string = 'shop/cart/remove';
echo preg_replace('#^shop/cart/(add|remove|clear)$#', 'shop/cart/action-$1', $string);

'shop/cart/add' => 'shop/cart/add',
'shop/cart/remove' => 'shop/cart/remove',
'shop/cart/clear' => 'shop/cart/clear',

'shop/cart/(?P<action>add|remove|clear)' => 'shop/cart/<action>',

preg_replace('#^shop/cart/(?P<action>add|remove|clear)$#', 'shop/cart/$1', $string);

foreach ($rules as $pattern=>$route) {
    if (preg_match('#^/' . ltrim($pattern, '/') . '$#', $path, $matches) {
        $symbol_matches = clear_numberic_matches($matches);
        foreach ($symbol_matches as $key=>$value) {
            if (strpos($route, '<' . $key . '>') !== false) {
                $route = str_replace('<' . $key . '>', $value, $route);
                unset($symbol_matches[$key]);
            }
        }
        list($module, $controller, $action) = explode('/', $route);
        $_GET = array_merge($_GET, $symbol_matches);
        break;
    }
}

$route = str_replace('<' . $key . '>', $value, $route);

$module = 'shop';
$controller = 'cart';
$action = 'remove'
 
$_GET = array(
    'id' => 15,
}

'(?P<module>\w+)' => '<module>/default/index',
'(?P<module>\w+)/(?P<controller>\w+)' => '<module>/<controller>/index',
'(?P<module>\w+)/(?P<controller>\w+)/(?P<action>\w+)' => '<module>/<controller>/<action>',

'feed\.xml' => 'blog/list/rss',

<?php
<link rel="alternate" type="application/rss+xml" title="Лента" href="<?php echo create_url('blog/list/rss'); ?>" />

<?php
<link rel="alternate" type="application/rss+xml" title="Лента" href="/feed.xml" />

<?php
<a href="<?php echo create_url('blog/post/view', array('id'=>$post['id'])); ?>">
    <?php echo htmlspecialchars($post['title']); ?>
</a>

'blog/post/(?P<id>\d+)\.html' => 'blog/post/view',

<?php
<a href="/blog/post/42">Как построить дом</a>

<?php
<a href="<?php echo create_url('shop/cart/clear'); ?>">Очистить корзину</a>

'shop/cart/(?P<action>add|remove|clear)' => 'shop/cart/<action>',

<?php
<a href="shop/cart/clear">Очистить корзину</a>

# modules/blog/routes.php
return array(
    'blog' => 'blog/list/index',
    'blog/category/(?P<category>[\w-]+)' => 'blog/list/category',
    'blog/tag/(?P<tag>[\w-]+)' => 'blog/list/tag',
    'blog/post/(?P<id>\d+)\.html' => 'blog/post/view',
    // ...
    'shop/cart/(?P<action>add|remove|clear)' => 'shop/cart/<action>',
);

<?php
# modules/blog/routes.php
return array(
    'blog' => 'blog/list/index',
    'blog/category/' => 'blog/list/category',
    'blog/tag/' => 'blog/list/tag',
    'blog/post/\.html' => 'blog/post/view',
    // ...
    'shop/cart/' => 'shop/cart/',
);
~~~

Теперь при разборе адреса можно простой заменой строки реализовать преобразование псевдошаблона в настоящее регулярное выражение.

Упрощение анализа шаблонов
------

Вторая сложность при парсинге регулярных выражений заключается в поддержке необязательных параметров. Например, вместо указания страницы как GET параметр

~~~
/blog/category/programming?page=2
~~~

для поддержки ЧПУ для страниц

~~~
/blog/category/programming
/blog/category/programming/page/2
~~~

мы могли бы написать одно правило, в котором знаком `?` мы указали бы необязательность параметра `page`:

~~~
[php]
<?php
'blog/category/(?P[\w-]+)(/page/(?P\d+))?' => 'blog/list/category',
~~~

Аналогично мы могли бы добавить другие параметры. В парсере такого выражения нам бы пришлось разбираться во множестве скобок.

Это сложный синтаксис, но вовсе не обязательный. Вместо него мы можем использовать несколько простых для анализатора правил:

~~~
[php]
<?php
'blog/category//page/' => 'blog/list/category',
'blog/category/' => 'blog/list/category',
~~~

При наличии параметра `page` в аргументах функции при вызове `create_url` сработает первое правило. Иначе случится совпадение со вторым.

Введя свой микроязык можно отойти от настоящего синтаксиса регулярных выражений, упростить его и даже добавить свои идеи. Но это нам пока не нужно.

Теперь рассмотрим такое правило

~~~
[php]
<?php
'blog/post/(?P\d+)\.(html|xml|json)' => 'blog/post/view',
~~~

Здесь в произвольном месте вне именованного параметра `id` добавлена группа `(html|xml|json)` для возможности принимать расширение (что может понадобиться для работы сайта по Ajax), но эта группа никак не названа.

При попытке открыть адрес `http://site.com/blog/post/52.xml` это правило вполне себе сработает, но попытка создать адрес по нему

~~~
[php]
<?php
echo create_url('blog/post/view', array('id' => 52));
~~~

ни к чему ни приведёт, так как наш анализатор не будет знать, какое расширение нужно указать после точки.

> Таким образом, произвольная поддержка регулярных выражений в шаблонах правил может привести к невозможности конструирования адресов из этих шаблонов. Поэтому можно разработать язык шаблонов так, чтобы настоящие регулярные выражения можно было использовать не везде, а только внутри именованных параметров ``. Другими словами, обеспечить, чтобы абсолютно все параметры были именованными.

В связи с этим данный шаблон должен выглядеть так:

~~~
[php]
<?php
'blog/post/.' => 'blog/post/view',
~~~

и вызываться он должен с передачей значений всех имеющихся параметров

~~~
[php]
<?php
echo create_url('blog/post/view', array(
    'id' => 52,
    'extension' => 'xml',
));
~~~

При этом точку посреди шаблона не надо экранировать, так как она находится вне регулярных выражений, которые, в свою очередь, теперь разрешены только внутри конструкций `<:>`.

По этой же причине мы не можем указать необязательность параметра на нашем псевдоязыке вот так:

~~~
[php]
<?php
'blog/post/(\.)?' => 'blog/post/view',
~~~

так как теперь мы знаем, что скобки не окажут должного эффекта. Система их примет за обычные символы и при генерации просто выведет как есть:

~~~
/blog/post/52(\.xml)?
~~~

Так что если нужно сделать указание расширения необязательным, то создайте два правила:

~~~
[php]
<?php
'blog/post/.' => 'blog/post/view',
'blog/post/' => 'blog/post/view',
~~~

При передаче идентификатора и расширения сработает первое, а только для идентификатора – второе.

Можно использовать и запасной работоспособный вариант:

~~~
[php]
<?php
'blog/post/' => 'blog/post/view',

<?php
abstract class BaseUrlRule
{
    abstract public function parseUrl($url, $pathInfo);
    abstract public function createUrl($route, $params);
}

class UrlRule extends BaseUrlRule;
{
    public $route;
    public $pattern;
    public $urlSuffix = '';
    public $caseSensitive = false;
    public $defaultParams = array();
    public $routePattern;

    public function __construct($route, $pattern) {
        if (is_array($route))  {
            foreach (array('urlSuffix', 'caseSensitive', 'defaultParams') as $name) {
                if (isset($route[$name])) {
                    $this->$name=$route[$name];
                }
            }
            if (isset($route['pattern'])) {
                $pattern = $route['pattern'];
            }
            $route = $route[0];
        }
        $this->route = trim($route,'/');
        $this->pattern = $pattern;
    }

    public function parseUrl($url, $pathInfo) {
        // Преобразовываем шаблон $this->route в регулярное выражение $this->routePattern
        // и проверяем на совпадение адреса этому выражению.
        // Возвращаем маршрут при успехе или false.
        ...
    }

    public function createUrl($route, $params) {
        // Анализируем шаблон и маршрут, при совпадении строим адрес.
        // Иначе возвращаем адрес по умолчанию на основе $route и $params.
        ...
    }
}
~~~

Каждое правило маршрутизации у нас по будет представлено в виде экземпляра класса `UrlRule` по умолчанию или любого другого наследника `BaseUrlRule`. Каждый объект будет хранить в себе реализацию разбора и создания адреса для своего правила.

Теперь добавим в наше приложение менеджер адресов, который будет хранить список правил и обходить их при поиске нужного:

~~~
[php]
<?php
class UrlManager
{
    /**
     * Список правил-объектов UrlRule или массивов
     * со специфическими опциями
     * @var BaseUrlRule[]|array[]
     */
    public $rules = array();

    /**
     * Добавляет правила в список
     * @param array $rules
     */
    public function addRules($rules) {
        foreach($rules as $pattern => $route) {
            $this->rules[] = $this->createUrlRule($route, $pattern);
        }
    }

    /**
     * Проходит по списку до тех пор, пока какое-либо правило не сработает
     * и не вернёт строку вида модуль/контроллер/действие
     * @param string $url
     */
    public function parseUrl($url, $pathInfo) {
        foreach ($this->rules as $i=>$rule) {
            if (is_array($rule)) {
                $rule = $this->createRuleObject($rule);
                $this->rules[$i] = $rule;
            }
            $route = $rule->parseUrl($url, $pathInfo);
            if ($route !== false) {
                return $route;
            }
        }
        return false;
    }

    /**
     * Проходит по списку до тех пор, пока какое-либо правило не сработает
     * и не вернёт построенный URL
     * @param string $route
     * @param array $params
     */
    public function createUrl($route, $params = array()) {
        foreach ($this->rules as $rule) {
            $url = $rule->createUrl($route, $params);
            if ($url !== false) {
                return '/' . $url;
            }
        }
        return $route . '?' . $this->createPathInfo($params);
    }

    /**
     * Генерирует строку параметров param1=val1&param2=val2
     * @param array $params
     */
    public function createPathInfo($params = array()) {
        $items = array()
        foreach ($params as $key=>$value) {
            $items[] = urlencode($key) . '=' urlencode($value);
        }
        return implode('&', $items);
    }

    /**
     * Оборачивает в класс UrlRule простые пары 'pattern'=>'route'
     * если не указан отдельный класс для правила
     * @param string $route
     * @param string $pattern
     */
    private function createUrlRule($route, $pattern) {
        if (is_array($route) && isset($route['class'])) {
            return $route;
        } else {
            return new UrlRule($route, $pattern);
        }
    }

    /**
     * Если правило задано со своим именем класса, то создать
     * его экземпляр вместо стандартного
     * @param array $options
     */
    private function createRuleObject($options) {
        $class = $options['class'];
        unset($options['class']);
        $rule = new $class();
        foreach ($options as $key=>$value) {
            $rule->$key = $value;
        }
        return $rule;
    }
}
~~~

В самом приложении мы теперь можем использовать наш менеджер:

~~~
[php]
<?php
class MySite
{
    public $urlManager;

    private function __construct() {
        $this->urlManager = new UrlManager();
    }

    private static $_instance;

    public static function app() {
        if (self::$_instance === null) {
            self::$_instance = new App();
        }
        return self::$_instance;
    }

    public function run() {

        // добавляем правила
        foreach ($modules as $module) {
            $rules = require_once(MODULES_PATH . '/' . $module . '/routes.php');
            $this->urlManager->addRules($rules);
        }

        // получаем нужный маршрут на основе текущего адреса
        $route = $this->urlManager->parseUrl($_SERVER['REQUEST_URI'], $_SERVER['PATH_INFO']);

        // если маршрут не нашёлся, то перенаправляем на страницу ошибки
        // в действии DefaultController::actionError модуля site
        if (!$route) {
            $route = 'site/default/error';
        }

        // расщепляем маршрут
        list($module, $controller, $action) = explode('/', $route);

        // подключаем контроллер $controller и запускаем действие $action
        $controller_class = new ucfirst($controller) . 'Controller';
        require_once(MODULES_PATH . '/' . $module . '/controllers/' . $controller_class . '.php');
        $controller = new $controller_class();
        $action_method = 'action' . ucfirst($action);
        $controller->$action_method();
    }
}
~~~

А в представлениях и контроллерах для построения ссылок использовать метод `createUrl`:

~~~
[php]
<?php

'feed\.xml' => 'blog/list/rss',