到现在,我们谈论了一些基本概念,前两篇中的例子对于我们理解依赖注入的实现很有帮助,现在我们将深入 Symfony 2服务容器的实现。
Symfony中的依赖注入容器是一个名叫sfServiceContainer的类来管理的
Symfony容器可以单独作为一个独立的组件而存在,Symfony的官方Subversion仓库可下载:http://svn.symfony-project.com/components/dependency_injection/trunk/
。值得注意的是该组件仍在不停的迭代开发,所以可能随时在更新(09年说的,现在好像停了)。
按照Symfony的设计思路,任何一个服务都可以是容器管理的对像。在上一篇介绍的Zend_Mail的例子中,就有两个对像:mailer和mail_transport
class Container
{
static protected $shared = array();
protected $parameters = array();
public function __construct(array $parameters = array())
{
$this->parameters = $parameters;
}
public function getMailTransport()
{
return new Zend_Mail_Transport_Smtp('smtp.gmail.com', array(
'auth' => 'login',
'username' => $this->parameters['mailer.username'],
'password' => $this->parameters['mailer.password'],
'ssl' => 'ssl',
'port' => 465,
));
}
public function getMailer()
{
if (isset(self::$shared['mailer']))
{
return self::$shared['mailer'];
}
$class = $this->parameters['mailer.class'];
$mailer = new $class();
$mailer->setDefaultTransport($this->getMailTransport());
return self::$shared['mailer'] = $mailer;
}
}
如果让Container类继承Symfony的sfServiceContainer类,可以让代码稍简洁一点
class Container extends sfServiceContainer
{
static protected $shared = array();
protected function getMailTransportService()
{
return new Zend_Mail_Transport_Smtp('smtp.gmail.com', array(
'auth' => 'login',
'username' => $this['mailer.username'],
'password' => $this['mailer.password'],
'ssl' => 'ssl',
'port' => 465,
));
}
protected function getMailerService()
{
if (isset(self::$shared['mailer']))
{
return self::$shared['mailer'];
}
$class = $this['mailer.class'];
$mailer = new $class();
$mailer->setDefaultTransport($this->getMailTransportService());
return self::$shared['mailer'] = $mailer;
}
}
通过观察:省去了构造函数以及参数配置管理的代码。
但这不是全部,sfServiceContainer可以给我们强大而又简洁的接口,以下是使用接口时要注意的几点:
1、获取服务的方法的名字必须以Service作为后缀。通常我们约定方法的名字以get开始,以Service结尾。每个服务都有唯一的标志,标志一般是方法名去掉前后缀,中间以下划线分隔。如定义了getMailTransportService()方法,那么服务名则为mail_transport
2、方法是protected类型的,意味着你无法直接调用方法来获得服务。稍后会介绍如何用容器获取服务。
3、可以将容器以数组访问的方式来获取传递的参数。如:$this[‘mailer.class’]
服务标志必须是唯一,且只能由字母、数字、’_’和’.’ 组成。’.’可以当作命名空间来使用(如mail.mailer 和 mail.transport)。
现在看看如何使用这个新的容器
require_once 'PATH/TO/sf/lib/sfServiceContainerAutoloader.php';
sfServiceContainerAutoloader::register();
$sc = new Container(array(
'mailer.username' => 'foo',
'mailer.password' => 'bar',
'mailer.class' => 'Zend_Mail',
));
$mailer = $sc->mailer;
因为Container类继承了sfServiceContainer ,接口变得很整洁。
if ($sc->hasService('mailer'))
{
$mailer = $sc->getService('mailer');
}
$sc->setService('mailer', $mailer);
if (isset($sc->mailer))
{
$mailer = $sc->mailer;
}
$sc->mailer = $mailer;
if (!$sc->hasParameter('mailer_class'))
{
$sc->setParameter('mailer_class', 'Zend_Mail');
}
echo $sc->getParameter('mailer_class');
// Override all parameters of the container
$sc->setParameters($parameters);
// Adds parameters
$sc->addParameters($parameters);
if (!isset($sc['mailer.class']))
{
$sc['mailer.class'] = 'Zend_Mail';
}
$mailerClass = $sc['mailer.class'];
foreach ($sc as $id => $service)
{
echo sprintf("Service %s is an instance of %s.\n", $id, get_class($service));
}
如果需要管理的服务不多,尽管你还是要做大量的基础工作并且拷贝大量的代码,但是不得不承认使用sfServiceContainer是很有用的。
如果要管理的服务变得越来越多,就必须有一种更好的方式来描述服务了。
这就是为什么大多数时侯,我们不会直接使用sfServiceContainer类。仅管如此,花一些时间来讲述它还是很有必要的,因为它是Symfony实现依赖注入容器的重要基石。
接下来要讲到sfServiceContainerBuilder类,利用它可以轻松完成对一个服务的定义。