《PHP實(shí)戰(zhàn)：Symfony2學(xué)習(xí)筆記之插件格式分析》要點(diǎn)：
本文介紹了PHP實(shí)戰(zhàn)：Symfony2學(xué)習(xí)筆記之插件格式分析，希望對(duì)您有用。如果有疑問(wèn)，可以聯(lián)系我們。

本文講述了Symfony2的插件格式.分享給大家供大家參考,具體如下：PHP學(xué)習(xí)

一個(gè)bundle類似于其它框架中的插件,但是比插件表現(xiàn)更好.它跟其它框架最主要的不同是在Symfony2中所有東西都是bundle,包括核心框架功能和你寫(xiě)的所有應(yīng)用程序代碼.Symfony2中,bundle可是一等公民.這給了你使用其它第三方開(kāi)發(fā)的內(nèi)容包或者分發(fā)你自己的bundle更多靈活性.你可以方便的選擇哪些內(nèi)容可以應(yīng)用到你的程序中那些不用,來(lái)根據(jù)你的想法優(yōu)化它們.PHP學(xué)習(xí)

一個(gè)bundle就是一個(gè)目錄,它具有很好的結(jié)構(gòu)性,它能存放從類到controller和web資源等任何東西.PHP學(xué)習(xí)

一個(gè)bundle僅僅是一個(gè)結(jié)構(gòu)化的文件目錄集合,它實(shí)現(xiàn)一個(gè)單一的內(nèi)容.PHP學(xué)習(xí)

你可以創(chuàng)建一個(gè)BlogBundle,一個(gè)ForumBundle或者一個(gè)實(shí)現(xiàn)用戶管理的bundle(好像已經(jīng)有很多此類開(kāi)源的bundle了).每個(gè)bundle目錄包含跟實(shí)現(xiàn)內(nèi)容有關(guān)的所有東西,包括PHP文件,模板,樣式表,javascript文件,測(cè)試內(nèi)容以及其它任何相關(guān)的東西.要實(shí)現(xiàn)的內(nèi)容的各方面都保存在一個(gè)bundle中.PHP學(xué)習(xí)

一個(gè)應(yīng)用程序是由在AppKernel類中registerBundles()辦法里定義的所有bundle組成.PHP學(xué)習(xí)

// app/AppKernel.php
public function registerBundles()
{
  $bundles = array(
    new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
    new Symfony\Bundle\SecurityBundle\SecurityBundle(),
    new Symfony\Bundle\TwigBundle\TwigBundle(),
    new Symfony\Bundle\MonologBundle\MonologBundle(),
    new Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle(),
    new Symfony\Bundle\DoctrineBundle\DoctrineBundle(),
    new Symfony\Bundle\AsseticBundle\AsseticBundle(),
    new Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle(),
    new JMS\SecurityExtraBundle\JMSSecurityExtraBundle(),
  );
  if (in_array($this->getEnvironment(), array('dev', 'test'))) {
    $bundles[] = new Acme\DemoBundle\AcmeDemoBundle();
    $bundles[] = new Symfony\Bundle\WebProfilerBundle\WebProfilerBundle();
    $bundles[] = new Sensio\Bundle\DistributionBundle\SensioDistributionBundle();
    $bundles[] = new Sensio\Bundle\GeneratorBundle\SensioGeneratorBundle();
  }
  return $bundles;
}

在這里你可以通過(guò)該辦法來(lái)統(tǒng)一控制和管理你的應(yīng)用程序組成.PHP學(xué)習(xí)

一個(gè)bundle可以存放在任何目錄下,只需要能夠通過(guò)配置app/autoload.php文件中的自動(dòng)加載器即可被自動(dòng)加載.PHP學(xué)習(xí)

創(chuàng)建一個(gè)bundlePHP學(xué)習(xí)

Symfony2標(biāo)準(zhǔn)版中已經(jīng)為你準(zhǔn)備好了一全功能的創(chuàng)建bundle的工具文件.你可以運(yùn)行它來(lái)創(chuàng)建bundle的所有內(nèi)容,當(dāng)然你也可以PHP學(xué)習(xí)

選擇自己手工創(chuàng)建.現(xiàn)在我們創(chuàng)建一個(gè)AcmeTestBundle并讓它能夠在我們的應(yīng)用程序中工作.注意,這里的Acme是一個(gè)虛假的提供商名字,你完全可以替換它為你自己組織或公司的名字.PHP學(xué)習(xí)

首先,創(chuàng)建一個(gè)src/Acme/TestBundle/ 目錄并添加新文件AcmeTestBundle.phpPHP學(xué)習(xí)

// src/Acme/TestBundle/AcmeTestBundle.php
namespace Acme\TestBundle;
use Symfony\Component\HttpKernel\Bundle\Bundle;
class AcmeTestBundle extends Bundle
{
}

接下來(lái),讓它在你的應(yīng)用程序可用,則需要在AppKernel類中的registerBundles()辦法中添加它.PHP學(xué)習(xí)

// app/AppKernel.php
public function registerBundles()
{
  $bundles = array(
    // ...
    // register your bundles
    new Acme\TestBundle\AcmeTestBundle(),
  );
  // ...
  return $bundles;
}

雖然現(xiàn)在它不能做任何事情,但是它已經(jīng)成為你應(yīng)用程序的一部分了.PHP學(xué)習(xí)

我們同樣可以使用Symfony2為我們提供給命令行工具來(lái)創(chuàng)建：PHP學(xué)習(xí)

$ php app/console generate:bundle --namespace=Acme/TestBundle

如果你使用上面的命令行工具,則創(chuàng)建的bundle會(huì)自動(dòng)的注冊(cè)到appKernel類中.PHP學(xué)習(xí)

Bundle的目錄結(jié)構(gòu)PHP學(xué)習(xí)

看一下我們Symfony2自帶的Demo bundle的目錄結(jié)構(gòu)：PHP學(xué)習(xí)

PHP學(xué)習(xí)

bundle的目錄機(jī)構(gòu)簡(jiǎn)單靈活,從上面的截圖中可以看到：PHP學(xué)習(xí)

Controller/ 包含bundle的所有controllers文件,比如HelloController.php .
DependencyInjection/ 保存了特定的依賴注入擴(kuò)展類,該類可能會(huì)導(dǎo)入服務(wù)配置,注冊(cè)編譯器傳輸或者更多其它.該目錄并不是必需的.
Resources/config/ 存放著配置文件,包括路由配置(比如：routing.yml).
Resources/views/ 所有的模板被依照對(duì)應(yīng)controller的名字分成文件夾保存在這里.比如Hello/index.html.twig .
Resources/public/ 所有可訪問(wèn)的web資源(圖片,樣式表等)和通過(guò)assets:install控制臺(tái)命令拷貝或者異步鏈接到項(xiàng)目 web/ 目錄的內(nèi)容.
Tests/ 保存bundle所有的測(cè)試PHP學(xué)習(xí)

下面是Symfony2 推薦的一些有關(guān)bundle的標(biāo)準(zhǔn)規(guī)則：PHP學(xué)習(xí)

Bundle名稱：PHP學(xué)習(xí)

一個(gè)bundle同時(shí)也是一個(gè)PHP的命名空間.命名空間必須遵守PHP5.3命名空間和類名的內(nèi)部技術(shù)標(biāo)準(zhǔn).開(kāi)頭使用提供商名,接著是分類段(可以省略),最后是命名空間的簡(jiǎn)寫(xiě)名字,而且該名字必須以Bundle作為后綴.一個(gè)命名空間變?yōu)橐粋€(gè)bundle只需要你在該命名空間內(nèi)添加一個(gè)bundle類即可.PHP學(xué)習(xí)

Bundle類的命名：PHP學(xué)習(xí)

僅適用數(shù)字,字母和下劃線
使用駝峰式命名
使用描述性簡(jiǎn)潔的名字(不超過(guò)兩個(gè)單詞)
使用供應(yīng)商名稱做前綴(可選的分類命名空間)PHP學(xué)習(xí)

添加Bundle作為名稱后綴PHP學(xué)習(xí)

比如：PHP學(xué)習(xí)

Namespace => Bundle 類名稱PHP學(xué)習(xí)

Acme\Bundle\BlogBundle => AcmeBlogBundle
Acme\Bundle\Social\BlogBundle =>AcmeSocialBlogBundle
Acme\BlogBundle => AcmeBlogBundle

定義bundle類時(shí)的getName()辦法應(yīng)該返回類名稱.PHP學(xué)習(xí)

每個(gè)bundle都有一個(gè)別名,它是小寫(xiě)字符簡(jiǎn)寫(xiě)版的bundle名,使用下劃線分割.比如 acme_hello 的bundle原名是AcmeHelloBundle, acme_social_blog 則是Acme\Social\BlogBundle的實(shí)例.PHP學(xué)習(xí)

別名在一個(gè)bundle中必須是唯一的.PHP學(xué)習(xí)

Bundle的目錄結(jié)構(gòu)：HelloBundle的基礎(chǔ)目錄結(jié)構(gòu)PHP學(xué)習(xí)

XXX/...
  HelloBundle/
    HelloBundle.php
    Controller/
    Resources/
      meta/
        LICENSE
      config/
      doc/
        index.rst
      translations/
      views/
      public/
    Tests/

上面的XXX/... 映射到該bundle的命名空間.其中下面的文件是必備的：PHP學(xué)習(xí)

HelloBundle.php;PHP學(xué)習(xí)

Resources/meta/LICENSE: 全文的許可代碼;
Resources/doc/index.rst: bundle說(shuō)明的根目錄文件.PHP學(xué)習(xí)

使用類的子文件夾的深度應(yīng)該保持到最小(2級(jí)是極限).如果更多級(jí)可以定義為非靜態(tài),不過(guò)很少使用.bundle的目錄是只讀的.如果你需要修改臨時(shí)文件,把它們保存到主應(yīng)用程序的cache/ 或者 log/ 目錄下.PHP學(xué)習(xí)

需要強(qiáng)調(diào)的類和文件PHP學(xué)習(xí)

類型 VS 目錄PHP學(xué)習(xí)

Commands??????????????????????????? VS???????? Command/
Controllers???????????????????????????? VS??????? Controller/
Service Container Extensions?? VS??????? /DependencyInjection/
Event Listeners????????????????????? VS???????? EventListener/
Configuration???????????????????????? VS???????? Resources/config
Web Resources????????????????????? VS???????? Resources/public
Translation files????????????????????? VS???????? Resources/translations/
Templates????????????????????????????? VS???????? Resources/views
Unit and Functional Test????????? VS???????? Tests/PHP學(xué)習(xí)

類：PHP學(xué)習(xí)

bundle的目錄結(jié)構(gòu)是被用來(lái)當(dāng)作命名空間層級(jí)的.比如HelloController類保存在 Bundle/HelloBundle/Controller/HelloController.php文件中.PHP學(xué)習(xí)

所以類的完全限定名是 Bundle\HelloBundle\Controller\HelloController . 一些類被看作是裝飾,應(yīng)該越短越好,比如Commands,Helpers, Listeners 和Controllers等,一般都會(huì)被當(dāng)作后綴.PHP學(xué)習(xí)

跟事件分發(fā)器有關(guān)的類應(yīng)該用后綴Listener標(biāo)識(shí).PHP學(xué)習(xí)

異常類應(yīng)該保存到一個(gè)Exception子命名空間中.PHP學(xué)習(xí)

關(guān)于提供商PHP學(xué)習(xí)

一個(gè)bundle不應(yīng)該被嵌入第三方的PHP類庫(kù),它應(yīng)該依靠Symfony2標(biāo)準(zhǔn)來(lái)自動(dòng)加載它們.PHP學(xué)習(xí)

一個(gè)bundle不應(yīng)該被嵌入第三方的javascript,CSS或者其它語(yǔ)言寫(xiě)的任何類庫(kù).PHP學(xué)習(xí)

關(guān)于測(cè)試PHP學(xué)習(xí)

一個(gè)bundle應(yīng)該有一個(gè)使用PHPUnit的測(cè)試單元并把它存儲(chǔ)在Tests/ 目錄下.PHP學(xué)習(xí)

測(cè)試應(yīng)該遵循以下原則：PHP學(xué)習(xí)

測(cè)試套件必須能夠被一個(gè)簡(jiǎn)單的phpunit 命令從一個(gè)簡(jiǎn)單的應(yīng)用程序中執(zhí)行.PHP學(xué)習(xí)

功能測(cè)試應(yīng)該只備用來(lái)測(cè)試回復(fù)輸出和一些監(jiān)控信息.PHP學(xué)習(xí)

測(cè)試代碼覆蓋應(yīng)該至少在95%以上的基本代碼.PHP學(xué)習(xí)

一個(gè)測(cè)試套件可以不包含AllTests.php腳本,但必須依靠外部的phpunit.xml.dist文件.PHP學(xué)習(xí)

文檔說(shuō)明PHP學(xué)習(xí)

所有的類必須帶有PHPDoc.PHP學(xué)習(xí)

ControllersPHP學(xué)習(xí)

最好的情況下,controller應(yīng)該在一個(gè)可以部署到其它地方的bundle中,那么它不能繼承Controller基類.而是通過(guò)實(shí)現(xiàn)ContainerAwareInterface接口或者繼承ContainerAware來(lái)取代繼承Controller.PHP學(xué)習(xí)

RoutingPHP學(xué)習(xí)

如果bundle提供路由,他們必須使用bundle的別名為前綴,比如一個(gè)AcmeBlogBundle實(shí)例,所有的路由名必須是acme_blog_ 開(kāi)頭.PHP學(xué)習(xí)

TemplatesPHP學(xué)習(xí)

如果bundle提供模板,它必須使用Twig. bundle不必低通一個(gè)主布局文件,如果你的bundle是一個(gè)完整的應(yīng)用程序除外.PHP學(xué)習(xí)

翻譯文件PHP學(xué)習(xí)

如果bundle提供信息翻譯,它必須是被定義成XLIFF格式,區(qū)域名必須被命名在bundle名字之后,如bundle.helloPHP學(xué)習(xí)

配置PHP學(xué)習(xí)

為了提供更大的靈活性,一個(gè)bundle可以使用Symfony2的內(nèi)建機(jī)制提供配置設(shè)置.對(duì)于簡(jiǎn)單的設(shè)置,依賴于默認(rèn)的Symfony2的parameters配置入口. Symfony2參數(shù)都是簡(jiǎn)單的 key/value 對(duì).值可以是任意的合法的PHP值. 每個(gè)參數(shù)名應(yīng)該以訛bundle的別名開(kāi)始,這只是一個(gè)最佳的建議.參數(shù)名其余部分用點(diǎn)號(hào)(.)分割,比如 acme_hello.email.fromPHP學(xué)習(xí)

讓最終用戶可以在配置文件中直接提供值信息.PHP學(xué)習(xí)

YAML格式：PHP學(xué)習(xí)

# app/config/config.yml
parameters:
    acme_hello.email.from: fabien@example.com

XML格式：PHP學(xué)習(xí)

<!-- app/config/config.xml -->
<parameters>
   <parameter key="acme_hello.email.from">fabien@example.com</parameter>
</parameters>

PHP代碼格式：PHP學(xué)習(xí)

// app/config/config.php
$container->setParameter('acme_hello.email.from', 'fabien@example.com');

INI格式：PHP學(xué)習(xí)

[parameters]
acme_hello.email.from = fabien@example.com

這樣就可以在代碼中從容器獲取這些配置信息了：PHP學(xué)習(xí)

$container->getParameter('acme_hello.email.from');

如果你定義服務(wù),我們也推薦你使用bundle的別名作為前綴.PHP學(xué)習(xí)

總結(jié)思考：PHP學(xué)習(xí)

以上是關(guān)于Symfony2中最主要的插件格式bundle的大體情況,在整個(gè)Symfony2為基礎(chǔ)開(kāi)發(fā)的應(yīng)用程序中,幾乎全部都是有bundle組成.Symfony2本身的核心組件都是FrameworkBundle.在Symfony2交流社區(qū)中,已經(jīng)有了大量的開(kāi)發(fā)者貢獻(xiàn)了他們的bundle,我們可以直接拿來(lái)集成到我們自己的應(yīng)用程序中使用.上面所說(shuō)的大部分規(guī)則,都是應(yīng)用于你開(kāi)發(fā)貢獻(xiàn)bundle時(shí)應(yīng)該遵循的統(tǒng)一規(guī)則,以方便其它用戶使用.PHP學(xué)習(xí)

帶有第三方貢獻(xiàn)的bundle的Symfony2開(kāi)發(fā)包：PHP學(xué)習(xí)

PHP學(xué)習(xí)

如果你不打算把你的bundle貢獻(xiàn)出來(lái),那么完全可以不用依照這里說(shuō)的大部分規(guī)則進(jìn)行開(kāi)發(fā).PHP學(xué)習(xí)

希望本文所述對(duì)大家基于Symfony框架的PHP程序設(shè)計(jì)有所贊助.PHP學(xué)習(xí)

歡迎參與《PHP實(shí)戰(zhàn)：Symfony2學(xué)習(xí)筆記之插件格式分析》討論，分享您的想法，維易PHP學(xué)院為您提供專業(yè)教程。

轉(zhuǎn)載請(qǐng)注明本頁(yè)網(wǎng)址：
http://www.snjht.com/jiaocheng/7332.html