第四章:在symfony2中创建页面

在symfony2中创建一个页面只需要简单的两个步骤:

  • 创建一个路由:一个路由定义了一个url并指定了一个路由器,当传入的请求URL匹配该路由时,Symfony2将执行指定的控制器;
  • 创建一个控制器:控制器是一个PHP函数,它接受传入的请求并将其转换成Symfony2的Response对象。

 

我们喜欢这样简单的实现,因为它符合Web的工作方式。每一个Web交互都是由HTTP请求开始,应用程序的任务就是简单地解释请求并返回相应的HTTP响应。

Symfony2遵循这一原则,并为你提供工具,以保证在应用程序的用户和复杂性增长时仍保持良好地组织性。

环境和前端控制器

每一个symfony应用程序都运行着一个环境。一个环境是一组特定的配置和包,可以用一个字符串表示。这些应用程序能运行不同的配置就需要应用程序中运行不同的环境。symfony2中有三个环境定义 – -dev,test和 prod –但是你也可以创建自己的。
环境是很有用的,它允许应用程序在开发环境进行调试并在生产环境下优化速度。你也可以基于特定的环境加载特定的包。例如,symfony2的WebProfilerBundle(说明如下),只支持 dev 和 test 环境。
symfony2有两个前端访问控制器:app_dev.php 在dev 环境下使用,app.php 在prod 环境下使用。
所有的web访问symfony2通常都通过其中一个前端控制器。(测试环境通常只用于运行单元测试,所以没有专门的前端控制器。控制台工具还提供了一个前端控制器,可用于任何环境。)
当前端控制器初始化内核,它提供了两个参数:环境和内核是否运行在debug模式下。symfony2有一个缓存目录 app/cache/ 来让你的应用程序运行的更快。当你启用debug模式(app_dev.php的默认模式),如果你改变任何代码或者配置缓存都会自动刷新。当运行debug模式下,symfony2会运行的慢一些,但是它会自动反应出相应的变化而不用手动清空缓存。
例如,代码

“hello Symfony” 页

让我们从经典的“hello,world”程序开始,当我们完成后,用户可以通过访问下列URL来得到一声问候:

其实,你可以将Symfony换成其它的名称来问候。 去创建这个页面,需要以下两个步骤:

本教程假设您已经下载了Symfony2和配置好了您的web服务器。上述URL假设localhost指向你新的Symfony2项目。这一过程的详细信息,要看文档的web服务配置。这里有相关文档教你如何配置web服务器:

从现在开始创建Bundle

在开始之前,你需要创建一个Bundle。在Symfony2中,Bundle相当于插件,你应用程序中的所有代码都需要放在Bundle中。
Bundle只是一个目录,里面有很多相关的特定功能,包含php类、配置、样式表和javascript文件(参见Bundle系统)。

去创建一个AcmeHelloBundle (在这一章玩转你需要建设的bundle),按照屏幕上的指令,运行以下命令(使用默认选项):

在幕后,将创建一个 src/Acme/HelloBundle 目录。

下面这一行代码也被自动添加到 app/AppKernel.php 文件,注册到kernel内核。

现在你已经建设了一个bundle,你可以开始在这个bundle里构建你的应用程序了。

步骤1:创建路由

默认,路由配置在symfony2应用程序的 app/config/routing.yml 里. 在Symfony2中所有的配置文件也可以采用PHP或XML格式编写。

如果你看一下主路由文件,你会看到它已经添加了AcmeDemoBundle相关路由文件

yml

xml

php

这些是非常基础的东西:他告诉symfony由去加载路由配置Resources/config/routing.yml(在xml和php的代码分别为routing.xml和routing.php)在AcmeDemoBundle里的文件。这意味着,您将可以直接在路由app/config/routing.yml配置或导入自己应用程序的路由到这里。

这个路由系统在你的应用程序中创建了灵活而强大的URL结构,如果想了解更多更强大的功能,请阅读有关章节 路由

步骤2:创建控制器

当一个URL /random/10 被应用程序处理时,randomAcmeDemoBundle:random:index 相匹配并由框架执行。页面创建过程的第二个步骤是创建一个控制器。

该控制器- AcmeDemoBundle:random:index 是逻辑控制器,并将其映射到Acme/DemoBundle/Controller/RandomController类的 indexAction方法中。首先在AcmeDemoBundle中创建这个文件:

事实上,这个控制器无非是一个PHP创建的方法并由Symfony执行。这是你的代码来构建和准备所请求的资源的请求使用信息。除了在一些先进的情况下,始终产品的控制器总是相同的:一个Symfony2的 Response 对象。

当这个random 路由匹配时,那symfony需要执行创建的indexAction方法:

控制器很简单吧:他创建了一个新的 Response 对象,其第一个参数是在response中使用的(在本例中的html里)。

恭喜你!仅在创建一个路由和控制器之后,您就已经有了一个全功能的网页!如果你已经正确安装了一切,你的应用程序应该产生一个随机数给你:

你可以查看你的应用在“prod”环境下的访问:

如果你得到一个错误,很可能是因为你需要清除缓存再运行:

在这个过程中的第三步是创建一个模版。

控制器在你的代码中是一个入口点并且在你创建页面时也是一个关键因素。更多的信息可以在 Controller Chapter 中找到。

 

步骤3:创建模版

模板允许你把所有的(html代码)分别放到不同文件中,能够重用页面布局构成不同的区块。下面就是使用模板来替代控制器中的html代码。

为了使用 render() 方法,你的路由器必须继承 Controller 类,该类添加了一些常用的快捷方式。在上面的例子中通过添加声明第四行才能使RandomController继承Controller 

render()方法创建一个Response对象,该对象使用特定的内容填充并通过模板渲染的。与其它控制器一样,你最终得到的是一个Response对象。

注意,这里有两种不同渲染模板的例子,缺省情况下,Symfony2支持两种渲染模板的方式:传统的PHP模板和简洁强大的Twig模板。你可以随意选择使用其中的一种,也可以在同一项目中混用它们,这都不成问题。

控制器渲染AcmeStudyBundle:Hello:index.html.twig模板,该模板使用以下命名约定:

Bundle名:Controller名:Template名

这是合乎模板逻辑的,他被映射到如下物理位置。

/path/to/Bundle名/Resources/views/Controller名/Template名

在本例中,AcmeStudyBundle是Bundle名,Hello是控制器,index.html.twig是模板名。

让我们一步一步来看看模板:

  • 第二行:extends定义了一个父模板,模板明确定义了一个将被替换的布局文件;
  • 第四行:block表示其中的内容将会替换掉名为body的block,如我们所知,它在最终渲染时将负责layout.html.twig中名为body的block的渲染。

父模板:::base.html.twig,省略了 bundle名和Controller名(用两个冒号::代替),这意味着该模板在app目录中:

 

基本模板文件定义了HTML布局,并用我们在index.html.twig模板中定义的名为body的区块渲染。这里还定义了一个名为title的区块,我们也可以选择在index.html.twig模板中定义。由于我们没有在子模板中定义title区块,所以它还是使用缺省值”Hello Application”。

模板在渲染和组织页面内容方面的功能非常强大,它可以是HTML标识语言、CSS代码或者控制器可能需要返回的东东。模板引擎只是达到目标的手段。每个控制器的目标是返回一个Response对象,模板虽然强大,但它却是可选的,它只是为Response对象创建内容的工具而已。

 

目录结构

经过前面几段的学习,你已经理解了在Symfony2中创建和渲染页面的步骤,也开始明白了Symfony2的组织和结构,在本章的最后,你将学会在哪儿找到和放置不同类型的文件以及为什么这样做。

虽然Symfony2的目录结构相当灵活,但在缺省状态下,Symfony2还是有着相同的、被推荐的基本目录结构:

app/ : 该目录包含应用程序配置;
src/ : 所有项目的PHP代码都保存在该目录下;
vendor/ : 根据约定放置所有供应商的库文件;
web/ : 这是web根目录,包括一些公众可以访问的文件。

 

web目录

web根目录是所有静态的、公共文件的家目录,包括图像、样式表和javascript文件,这里也是前端控制器所在的地方。

前端控制器(在这里是app.php)其实是一个PHP文件,在使用Symfony2应用程序时执行。它的功能就是使用内核类AppKernel,来引导应用程序。

使用前端控制器意味着要比使用传统的纯PHP程序有着更为灵活多变的URL,当使用前端控制器时,URL格式如下所示:

前端控制器app.php,根据 /random/10 执行内部路由。通过使用Apache的重写规则,你可以在不指定app.php的情况下强制执行它:

虽然前端控制器在处理请求时必不可少,但你很少会去修改甚至想到它,我们只是在环境一章中简要地提及它。

 

应用程序(app)目录

正如你在前端控制器所看到的那样,AppKernel类是整个应用程序的主入口,它负责所有的配置,它被保存在app/目录中。

这个类必须实现两个方法,定义了Symfony2的需要了解您的应用程序的一切。你甚至在一开始就无须担心这些方法 -因为Symfony2会智能地为你填充它们。

  • registerBundles(): 返回所有需要在应用程序中运行的bundle数组 (参见Bundle系统 );
  • registerContainerConfiguration(): 引导应用程序的主配置资源文件 (参见应用程序配置章节);

在日常开发中,你会经常用到app/目录,你会在app/config/目录中修改配置和路由文件(参见应用程序配置),也会使用app/cache/目录做为应用程序的缓存目录、使用app/logs/目录做为日志目录、使用app/Resources/目录做为应用程序级别的资源目录。在下面的章节中你将会学到更多关于这些目录的内容。

 

自动加载

symfony的加载包含一个特殊的文件:app/autoload.php。该文件负责自动加载src/和第三方库composer.json目录中的所有文件。

因为有自动加载器,你永远无须为使用include或require语句担心。Symfony2利用类的名称空间确定它的位置,并自动加载包含你所需的类文件。

自动加载器看起来已经配置了 src/ 目录下的任何php类。对于自动加载的工作原理,类名和文件路径必须遵循相同的模式:

 源(src)目录

简单的说,src/ 目录包含所有的实际代码(php代码,模板,配置文件,样式表等)驱动你的应用程序。在开发,你工作的绝大多数时间会进入你这个目录中,创建一个或多个bundle。

究竟有什么事bundle?

这个bundle系统

一个bundle在symfony中类似一个插件,甚至更加重要。关键的不同点在于在Symfony2中什么都是bundle,包括框架的核心功能和你为应用程序所写的代码。在Symfony2中,Bundle是一类公民,这让使用第三方Bundle的预建功能包或发布你自己的Bundle变得十分灵活。它也可以使你很容易地选择应用程序所需功能,并用你自己的方式去优化它们。

您将在这里学习基本的知识,整个cookbook致力于bundle的组织和最佳实践。

Bundle简单来说就是在一个目录里用来实现单一功能的结构化文件集。你可以创建BlogBundle、ForumBundle或用户管理的Bundle(许多都已经以开源Bundle的形式存在)。每个目录都包含与功能相关的内容,如PHP文件、模板、样式表、Javascripts、测试等。每个Bundle都包含某种功能的方方面面,而每种功能都必须在Bundle中实现。

应用程序由在AppKernel类中的registerBundles()方法中定义的Bundle组成:

通过registerBundles()方法,你就拥有了应用程序所有Bundles的全部控制权(包含Symfony2的核心Bundle)。

一个bundle可以在任何地方,只要他可以自动加载(通过配置自动加载机制 app/autoload.php)。

 

创建一个Bundle

symfony标准版自带了一个方便任务为您创建了全功能的bundle。当然,手工创建一个bundle也是很容易的。

为了向你展示Bundle系统是如何之简单,让我们创建一个名为AcmeTestBundle的新Bundle,并激活它。

Acme部分只是一个假名字,取而代之的是一些“供应商”的名字,代表您或您的组织(例如ABCTestBundle对应公司名叫ABC)。

首先,创建一个src/Acme/TestBundle/ 目录,并添加一个名为AcmeTestBundle.php的新文件:

AcmeTestBundle遵循Bundle命名约定

这个空类仅仅只是我们需要创建新Bundle的一部分。虽然是空的,但这个类已经足够强大,并能够用来自定义Bundle的行为。
现在我们已经创建了我们的Bundle,我们需要通过Appkernel类激活它:

虽然目前它还不能做任何事情,但AcmeTestBundle现在已经可以使用了。

同样方便的是,Symfony也提供命令行接口去生成Bundle的基本框架:

命令行会生成一个基本控制器、模板和可自定义的路由资源。接下来我们将会讨论更多的Symfony2命令行工具。

当创建一个新的bundle或者使用第三方bundle,总是你想registerBundles()自动加入并启用这些bundle。那么当你使用 generate:bundle 命令时,他就会为你完成。

 

bundle的目录结构

Bundle的目录结构是简单而灵活的。默认状态下,Bundle系统遵循Symfony2所有Bundle之间保持代码一致性的约定集。让我们看看AcmeDemoBundle,因为它包含了Bundle的大多数元素:

  • Controller/目录:包含该Bundle的控制器(如:RandomController.php);
  • DependencyInjection/ 持有一定的依赖注入扩展类,他可以导入服务配置,注册编译通过,当然(这个目录也可能是不必要的,如果你不需要做这些)。
  • Resources/config/目录:配置目录,包括路由配置(如:routing.yml);
  • Resources/views/目录:通过控制器名组织的模板(如:Hello/index.html.twig);
  • Resources/public/目录:包含web资源(图片、样式表等),并被拷贝或软链接到项目的web/目录;
  • Tests/目录:存放该Bundle的所有测试。

根据Bundle实现的功能,它可小可大,它只包含你所需要的文件。

你在本书中还将学习到如何持久化对象到数据库、创建和验证表单、翻译你的应用程序和编写测试等等,它们在Bundle中都有自己的位置和所扮演的角色。

 

应用程序配置

应用程序由代表应用程序所有功能和特征的Bundle集构成。每个Bundle都可以通过YAML、XML或PHP编写的配置文件来自定义。缺省情况下,主配置文件放置在app/config/目录中,被命名为config.yml、config.xml或config.php,这取决于你所使用的格式:

在下一节环境中你将学会如何准确地选择要引导的文件/格式。

每一个顶级条目,如framework或twig都被配置成一个特定的Bundle。例如,framework被配置成Symfony2的核心FrameworkBundle,并包含路由、模板和其它核心系统的配置。

现在别担心配置文件中各段中的特定配置选项,配置文件缺省值都是合理的。当你浏览Symfony2的各部分时,你将学到每个部分的特定配置选项。

配置格式

纵观整个章节,所有的配置示例都用三种格式(YAML、XML和PHP)展示。它们每个都有自己的优缺点,以下是三种格式的说明:

1、YAML:简单、干净和易读
2、XML:有时比YAML更强大且支持IDE的自动完成
3、PHP:非常强大,但与标准配置格式相比易读性差

 

默认配置 dump

您能够通过命令行  config:dump-reference  去dump 一个bundle在YAML的默认配置。这里有一个例子就是dump frameworkBundle配置:

扩展别名(配置键)也可以使用:

查看cookbook 文章:How to Load Service Configuration inside a Bundle 的信息添加配置到自己的bundle

环境

应用程序可以在不同的环境中运行。不同的环境共享相同的PHP代码(由前端控制 器区分),但却有着完全不同的配置。开发环境记录警告和错误,而生产环境只记录错误。在开发环境中一些文件在每次请求之后被重构,而在生产环境中却被缓存 。所有的环境都在同一机制中生活。

虽然创建新的环境是容易的,但Symfony2项目通常会从三个环境开始(开发、测试和生产)。通过在你浏览器中改变前端控制器,你可以很方便地让应用程序在不同的环境中切换。要将应用程序切换到开发环境,只需要通过开发前端控制器去访问应用程序即可。

如果你想看看你的应用程序在生产环境中的表现 ,可以调用生产前端控制器:

由于生产环境优化了速度;这个项目中的配置,路由和twig模板都会被编译成原生php类并加入到缓存。当生产环境发生变化后,你需要清楚缓存并让他重建。

如果你打开 web/app.php文件,你将发现它已经很明确地被配置成使用生产环境:

 
你可以为一个新的环境创建一个新的前端控制器,只需要拷贝该文件,并将prod修改成其它值。

当进行自动测试时使用测试环境,它并不能从浏览器直接访问。参见测试章节以得到更多细节。

 

环境配置

AppKernel类负责加载你所选的配置文件:

我们已经知道.yml扩展名可以转换成.xml或.php,只要你喜欢使用XML或PHP来写配置。注意每种环境也可以加载它们自己的配置文件。下面是为生产环境准备的配置文件。

 

import关键词与PHP格式中include语句一样,都是首先引导主配置文件(config.yml),文件的其它部分是为了增长的日志和其它有利于开发环境的设置而对缺省配置进行的调整。

在生产环境和测试环境都遵循同样一个模型:每个环境导入基本配置文件,然后修改它们的配置值去适应特殊环境的需要。这只是一个惯例,但可以重用你的配置并仅仅定义区块到这个环境中。

 

小结

恭喜你,你现在已经明白了Symfony2的基本原理,并惊喜地发现它是那样的方便灵活。尽管有许多的功能,但我们可以牢记以下几个基本点:

  • 创建页面需要三个步骤,包括路由、控制器和模板(可选);
  • 每个应用程序都应该包含四个目录:web/(web资源和前端控制器)、app/(配置)、src/(你的Bundle)和vendor/(第三方代码)(还有一个bin/ 目录有助于帮助应用更新vendor 库);
  • Symfony2的每个功能(包括Symfony2框架核心)都被组织进一个Bundle,Bundle是该功能的结构化文件集;
  • 每个Bundle的配置都存放在Resources/config目录中,可以使用YAML、XML和PHP编写;
  • 这个全局应用配置被放到 app/config 目录下;
  • 通过不同的前端控制器(如:app.php或app_dev.php)和配置文件,每种环境都可以被访问。

从本章开始,接下来的每个章节都将向你介绍越来越多的强大工具和越来越先进的理念。随着你对Symfony2了解得越多,你就越发欣赏它架构的灵活和强大,它可以让你更加快速地开发应用程序。

3 Comments

发表评论