第五天：路由配置

如果你完成了第4天的教程，你应该熟悉了MVC模式，它是非常自然的编码模式。如果你和 它接触的时间长一点，你将不会再想回到以前的编码模式。复习一下昨天的内容，我们 自定义了Jobeet页面，学习了symfony中一些概念，如layout、helper和slot。

今天，我们将接触到symfony路由的奇妙世界。

链接

如果你以前开发过php网站，你可能习惯了/job.php?id=1这样形式的URL。但如果 你点击jobeet主页的任何一个job链接，你会注意到它URL类似：/job/show/id/1。 symfony是如何让这种样式的URL工作的？symfony如何确定这个URL调用哪个动作？ 为什么使用$request->getParameter('id')来请求参数？今天我们将回答这些问题。

回答这些问题之前，先让我们讨论一下URL，它们究竟是什么。在web环境里， URL是 web资源的唯一标识。当你访问一个URL时，你实际是告诉浏览器取回有这个标识（URL） 的资源。所以作为连接网站和用户的纽带，URL应该传递给用户一些关于资源的、有意义的 信息。但是传统的URL没有真正传递这些信息，它们做的只是传递一些用户并不关心的 数据库标识，和暴露程序内部结构。暴露程序的内部工作，将给你的网站带来很大的 安全隐患：用户可能尝试猜测URL访问不允许访问的资源。当然开发者必须使用合适的方法 去保护这些资源，但首先你最好先隐藏URL中的敏感信息。

链接如此重要，以至于在symfony中有一个专门用来管理路由的框架routing framework。 路由管理内部URI和外部URL。当接到请求时，路由分析URL并转化成内部的URI。

我们已经在showSuccess.php模板中见过内部URI样式：

'job/show?id='.$job->getId()

url_for()将这个内部URI转换成适当的URL：

/job/show/id/1

内部URI由几部分组成：job是模块名，show是动作名，查询字符串将参数传递给动作。 内部URI的一般模式：

MODULE/ACTION?key=value&key_1=value_1&...

因为symfony路由是双向处理，所以你可不需要修改程序代码，就能修改URL样式。这是 前端控制器设计模式的一个主要优点。

路由配置

routing.yml是路由配置文件，用来设置外部URL和内部URI的映射关系：

# apps/frontend/config/routing.yml
homepage:
  url:   /
  param: { module: default, action: index }
 
default_index:
  url:   /:module
  param: { action: index }
 
default:
  url:   /:module/:action/*

这个routing.yml描述了几个路由规则。这些路由，由名称(homepage)、式样(/:module/:action/*) 和一些参数构成（param后面的内容）。

当用户发出一个请求时，路由会尝试将URL与配置文件中的规则匹配。并使用最先匹配的 路由规则来分析URL，所以路由的排列顺序很重要。让我们看些例子，更好的理解它是 如何工作的。

当你用含有/job的 URL访问Jobeet主页时，第一个匹配的是default_index。在一个式样中， 以冒号开始字符串表示变量，所以/:module式样表示：匹配/后有内容的URL。在例子中， 变量module将以job作为值。这个值可以在动作里用$request->getParameter(’module’) 获取，这条规则给action定义了一个默认值。所以，匹配这条规则的 URL，请求中将自动带有 action参数，其值为index。

当你请求/job/show/id/1页面时，symfony将匹配最后一个式样：/:module/:action/*。 在一个式样中(*)匹配一个或多个以(/) 分隔的“变量名/变量值”集合：

URL /job/show/id/1可以在模板中通过url_for()辅助函数生成：

url_for('job/show?id='.$job->getId())

你也可以使用“@路由规则名”的方式：

url_for('@default?module=job&action=show&id='.$job->getId())

这两中方式是一样的，不过使用“@路由规则名”方式速度更快一些，因为程序不需要 匹配所有路由，而是直接匹配与名称相对的规则。并且它不包含模块名和动作名，更加 灵活（修改的时候直接改相应的规则，而不用修改每一个url_for()中模块和动作名）。

自定义路由

现在你用/URL访问网站会看到symfony默认的congratulations页面。因为URL匹配了 主页的路由。现在我们修改主页的路由规则，将主页改为jobeet的主页，将module设为 job：

# apps/frontend/config/routing.yml
homepage:
  url:   /
  param: { module: job, action: index }

用主页的路由修改Jobeet logo的链接：

<!-- apps/frontend/templates/layout.php -->
<h1>
  <a href="<?php echo url_for('@homepage') ?>">
    <img src="/legacy/images/jobeet.gif" alt="Jobeet Job Board" />
  </a>
</h1>

多么简单！

For something a bit more involved, 我们将job页的URL改成更有意义的式样

/job/sensio-labs/paris-france/1/web-developer

Without knowing anything about Jobeet, and without looking at the page, you can understand from the URL that Sensio Labs is looking for a Web developer to work in Paris, France.

下面的式样可以用来匹配上面的URL：

/job/:company/:location/:id/:position

编辑routing.yml在文件开始处添加job_show_user路由规则：

job_show_user:
  url:   /job/:company/:location/:id/:position
  param: { module: job, action: show }

刷新首页，你会发现job的链接并没有变。这是因为必须传递给路由规则所有需要的变量， 路由规则才能生成相应的URL。修改indexSuccess.php的url_for()语句:

url_for('job/show?id='.$job->getId().'&company='.$job->getCompany().
  '&location='.$job->getLocation().'&position='.$job->getPosition())

也可以用数组表示内部URI：

url_for(array(
  'module'   => 'job',
  'action'   => 'show',
  'id'       => $job->getId(),
  'company'  => $job->getCompany(),
  'location' => $job->getLocation(),
  'position' => $job->getPosition(),
))

路由匹配条件(Requirements)

在第1天我们提到了验证和错误处理的好处，路由系统内建了验证器。每个式样中的变量 都可以用正则表达式进行验证，使用~requirements|Requirements~项定义验证规则：

job_show_user:
  url:   /job/:company/:location/:id/:position
  param: { module: job, action: show }
  requirements:
    id: \d+

上面的requirements要求id必须是数字，否则，将不匹配这条路由规则。

路由类

默认的routing.yml文件中，每个路由规则被内部转换为sfRoute 类的一个对象。我们可以在路由规则中设置class项，指定该条路由规则转换为哪个类的对象。 如果你熟悉HTTP协议，应该了解它的几个“method”，像~GET|GET (HTTP Method)~, ~POST|POST (HTTP Method)~, ~HEAD|HEAD (HTTP Method)~, ~DELETE|DELETE (HTTP Method)~ 和 ~PUT|PUT (HTTP Method)~。浏览器支持前3个，后2个则不支持。

限制路由只匹配某种请求方式，你可以将路由类修改为sfRequestRoute， 并设置requirements 的sf_method项：

job_show_user:
  url:   /job/:company/:location/:id/:position
  class: sfRequestRoute
  param: { module: job, action: show }
  requirements:
    id: \d+
    sf_method: [get]

对象路由类

新的内部URI很长，书写起来很不方便(url_for('job/show?id='.$job->getId().'&company='.$job->getCompany().'&location='.$job->getLocation().'&position='.$job->getPosition()))。 我们可以通过改变路由类的方法，来让它变的简洁。对于这条路由规则， 使用sfDoctrineRoute 作为类是最佳选择，它表现为Doctrine对象或对象集合：

job_show_user:
  url:     /job/:company/:location/:id/:position
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: show }
  requirements:
    id: \d+
    sf_method: [get]

options项可以用来定制路由规则的行为。这里model选项定义了与路由规则相互关联的 Doctrine模型类(JobeetJob)，type选项定义了这个路由规则对应的是一个对象 （如果这个路由规则对应的是对象集合，用list代替object）

现在job_show_user与JobeetJob建立了联系，我们简化url_for()|url_for()语句为：

url_for(array('sf_route' => 'job_show_user', 'sf_subject' => $job))

或:

url_for('job_show_user', $job)

这个路由规则的工作原理：路由规则中的所有变量在JobeetJob类中都有一个对应存取器 （例如，company路由变量对应getCompany()的值），可以自动获取需要参数。

访问生成的URL，它们可能不完全像你想象的样子：

http://jobeet.localhost/frontend_dev.php/job/Sensio+Labs/Paris%2C+France/1/Web+Developer

我们需要对生成的URL进行格式化("slugify")，用-替换所有非ASCII字符。 添加下边代码到JobeetJob.php：

// lib/model/doctrine/JobeetJob.class.php
public function getCompanySlug()
{
  return Jobeet::slugify($this->getCompany());
}
 
public function getPositionSlug()
{
  return Jobeet::slugify($this->getPosition());
}
 
public function getLocationSlug()
{
  return Jobeet::slugify($this->getLocation());
}

然后新建lib/Jobeet.class.php文件，创建slugify方法：

// lib/Jobeet.class.php
class Jobeet
{
  static public function slugify($text)
  {
    // replace all non letters or digits by -
    $text = preg_replace('/\W+/', '-', $text);
 
    // trim and lowercase
    $text = strtolower(trim($text, '-'));
 
    return $text;
  }
}

我们创建了3个模拟存取器getCompanySlug(), getPositionSlug()和 getLocationSlug()，它们返回转换后的字符串。用它们替换job_show_user 路由规则中原来的字段名：

job_show_user:
  url:     /job/:company_slug/:location_slug/:id/:position_slug
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: show }
  requirements:
    id: \d+
    sf_method: [get]

因为我们添加了新类(Jobeet)，刷新Jobeet主页之前，先要清空缓存:

$ php symfony cc

现在我们得到想要的URL形式：

http://jobeet.localhost/frontend_dev.php/job/sensio-labs/paris-france/1/web-developer

通过对象生成URL只是路由的一部分功能，路由还能通过URL找到相应的对象。相关的对象 可以用路由对象的getObject()方法获取。当分析一个请求时，路由存储匹配的路由对象， 在动作中使用。可以修改executeShow()为：

class jobActions extends sfActions
{
  public function executeShow(sfWebRequest $request)
  {
    $this->job = $this->getRoute()->getObject();
 
    $this->forward404Unless($this->job);
  }
 
  // ...
}

如果你试图通过一个不存在的id浏览job,会看到一个404错误页，但显示错误信息不同了：

因为，getRoute()已经自动抛出了404|404 Error错误。所以可以再简化一下executeShow方法：

class jobActions extends sfActions
{
  public function executeShow(sfWebRequest $request)
  {
    $this->job = $this->getRoute()->getObject();
  }
 
  // ...
}

动作和模板中路由设定

在模板中，url_for()辅助函数将内部URI转换成外部URL。symfony 中还有一些辅助函数也用URI作参数， 像link_to()，它生成一个<a>标签：

<?php echo link_to($job->getPosition(), 'job_show_user', $job) ?>

生成下面的HTML代码：

<a href="/job/sensio-labs/paris-france/1/web-developer">Web Developer</a>

url_for()和link_to()都可以生成绝对链接：

url_for('job_show_user', $job, true);
 
link_to($job->getPosition(), 'job_show_user', $job, true);

如果你想在动作中生成一个URL，你可以使用generateUrl()方法：

$this->redirect($this->generateUrl('job_show_user', $job));

路由集

对job模块而言， show动作已经使用了自定义的路由规则，但是其它动作(index, new, edit, create, update, and delete)还在使用默认的路由规则：

default:
  url: /:module/:action/*

对于编程的初期，default路由规则是一种很好的方式，它没有定义太多规则。 但当我们需要特殊的配置时，这种一把抓的方式就不适合了。

因为所有的动作都与JobeetJob类有联系，我们可以像给show动作定制路由一样， 用sfDoctrineRoute给每一个动作轻松定制路由。但是，因为job模块定义的7个动作 使用了同一个数据模型，所以我们也可以使用sfDoctrineRouteCollection类：

打开routing.yml文件修改如下：

# apps/frontend/config/routing.yml
job:
  class:   sfDoctrineRouteCollection
  options: { model: JobeetJob }
 
job_show_user:
  url:     /job/:company_slug/:location_slug/:id/:position_slug
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: show }
  requirements:
    id: \d+
    sf_method: [get]
 
# default rules
homepage:
  url:   /
  param: { module: job, action: index }
 
default_index:
  url:   /:module
  param: { action: index }
 
default:
  url:   /:module/:action/*

上面的job路由规则实际上是一个快捷方式，它自动生成下面7个sfDoctrineRoute路由规则：

job:
  url:     /job.:sf_format
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: list }
  param:   { module: job, action: index, sf_format: html }
  requirements: { sf_method: get }
 
job_new:
  url:     /job/new.:sf_format
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: new, sf_format: html }
  requirements: { sf_method: get }
 
job_create:
  url:     /job.:sf_format
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: create, sf_format: html }
  requirements: { sf_method: post }
 
job_edit:
  url:     /job/:id/edit.:sf_format
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: edit, sf_format: html }
  requirements: { sf_method: get }
 
job_update:
  url:     /job/:id.:sf_format
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: update, sf_format: html }
  requirements: { sf_method: put }
 
job_delete:
  url:     /job/:id.:sf_format
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: delete, sf_format: html }
  requirements: { sf_method: delete }
 
job_show:
  url:     /job/:id.:sf_format
  class:   sfDoctrineRoute
  options: { model: JobeetJob, type: object }
  param:   { module: job, action: show, sf_format: html }
  requirements: { sf_method: get }

job_delete和job_update路由规则匹配的请求方式是浏览器不支持的~DELETE|DELETE (HTTP Method)~ 和 ~PUT|PUT (HTTP Method)~。symfony模拟了它们，所以同样可以工作。打开_form.php模板看个例子：

// apps/frontend/modules/job/templates/_form.php
<form action="..." ...>
<?php if (!$form->getObject()->isNew()): ?>
  <input type="hidden" name="sf_method" value="PUT" />
<?php endif; ?>
 
<?php echo link_to(
  'Delete',
  'job/delete?id='.$form->getObject()->getId(),
  array('method' => 'delete', 'confirm' => 'Are you sure?')
) ?>

无论你想通过sf_method传送何种HTTP 请求方式 ，所有的symfony 辅助函数都能将它 告知模拟程序。

路由调试

路由集在输出多条路由规则方面非常有用。如命令行app:routes就使用它输出 一个程序所有路由规则：

$ php symfony app:routes frontend

将一个路由规则名作为额外的参数，可以获得一个路由许多调试信息。

$ php symfony app:routes frontend job_edit

默认路由

为URL定义路由规则是一个好习惯。可以通过添加或移除默认规则前边(#)来配置路由规则：

# apps/frontend/config/routing.yml
#default_index:
#  url:   /:module
#  param: { action: index }
#
#default:
#  url:   /:module/:action/*

The Jobeet application must still work as before.

明天见

今天学习很多新东西。你学习了如何使用Symfony路由框架，从代码中分离出URL。

明天的教程不会涉及任何新的概念，我们会花一些时间深入学习一下我们学过的知识。