《PHP设计模式介绍》第十一章 代理模式

 因为某个对象消耗太多资源,而且你的代码并不是每个逻辑路径都需要此对象, 你曾有过延迟创建对象的想法吗 ( if和else就是不同的两条逻辑路径) ? 你有想过限制访问某个对象,也就是说,提供一组方法给普通用户,特别方法给管理员用户?以上两种需求都非常类似，并且都需要解决一个更大的问题:你如何提供一致的接口给某个对象让它可以改变其内部功能,或者是从来不存在的功能?

问题

你怎样才能在不直接操作对象的情况下,对此对象进行访问?

解决方案

代理模式是给某一个对象提供一个替代者(占位者),使之在client对象和subject对象之间编码更有效率。代理可以提供延迟实例化(lazy instantiation),控制访问, 等等，包括只在调用中传递。 一个处理纯本地资源的代理有时被称作虚拟代理。远程服务的代理常常称为远程代理。强制控制访问的代理称为保护代理。

下面有一个关于远程代理的图(只有一个方法)。 SoapClient是本地对象(客户端)的媒介,通过调用SoapServer(subject)来获得天气信息。全部任务都通过HTTP协议达成,比如创建,传输,接收,通过SoapClient类内部的功能解析复杂XML文档完成远程通信。网络返回的结果跟直接调用SoapServer对象API的效果一样的,因此SoapClient可视为一个本地的代替者(代理),来获得远程SoapServer的资源。

这里有其他不同种类的代理模式叫做smart 代理。它的作用是:在允许访问subject对象之前增加一些各种各样的附加逻辑(additional logic)。(译注:这里的附加逻辑是指在建立了代理模式的基本结构之后,根据自己的需求在代理模式中添加的代码)

注：Handle-Body 模式
代理模式, 装饰器模式, 和适配器模式从编码角度看,都有类似的结构的(后两个模式在下面两章讲)。
三种模式本质区别在于如何使用它们。
这个结构的其他变种在下面网址可以找到:http://www.c2.com/cgi/wiki?HandleBodyPattern。

理的本质是用一个实例化变量对subject对象进行引用,通过调用代理类的方法操作subject类。

让我们看一个代理模式的最简单形态,首先,你需要创建一个subject类用于代理。

// PHP4
class Subject {
function someMethod() {
sleep(1); //do something
}
}

下一步,你需要一个代理类,这个类需要实例化subject类用于代理。

class ProxySubject {
var $subject;
function ProxySubject() {
$this->subject =& new Subject;
}
}

在上面的ProxySubject类,在构造器中创建了subject对象(还有其他的可供选择的方法,比如通过传递一个参数给构造器或者用工厂创建subject对象,这些都是同样可行的)。

最后,你的代理类提供所有公有的方法必须让subject类支持。在这个案例上, someMethod()就是这样一个方法。

class ProxySubject {
var $subject;
function ProxySubject() {
$this->subject =& new Subject;
}
function someMethod() {
$this->subject->someMethod();
}
}

ProxySubject类通过$this->subject->someMethod()才真正的调用Subject类。

代理既可以有一些方法直接调用,又可以在调用之前使用一些附加逻辑(延迟加载,监视)。

这里用了一个UML类图表示ProxySubject类：

 

一个简单的例子

上面的简单例子展示了代理模式的基本结构,当然我们需要一些更有趣和实际的例子。

Web服务变得非常流行,PHP5包含了一些支持的很好的协议,就如SOAP一样可以很容易的理解远程服务。 创建SOAP客户端的部分功能是为了处理WSDL文件。然而,你可以延迟处理WSDL文件直到你需要处理这个文件的时候。席面一个代理的例子将会展示远程代理访问SOAP服务和延迟实例化。

远程代理

首先,基于PHP5风格, 来一段创建简单的SoapClient对象的代码。你必须编译的时候加上—enable-soap选项,才能使用SoapClient类,如果你已经做过了,那么你就可以用URL形式,把WSDL文件传入构造器来创建SoapClient实例:

// PHP5
$client = new SoapClient(
‘http://live。capescience。com/wsdl/GlobalWeather。wsdl’);

注：PHP4风格的SoapClients
在你编码PHP4风格的SOAP客户端之前,PHP5的技术可以忽略。PHP5 的SoapClient是一个扩展,所以它是原生的PHP的代码,速度更加快(译注:这里的原生PHP代码应该是原生代码,原生代码是指编译性语言编写的代码),实际上是用C语言完成解析和格式化XML信息的功能。

PHP4风格 SOAP库包括:

• phpsoaptoolkit (http://phpsoaptoolkit.sf.net/phpsoap/),
• PEAR::SOAP (http://pear.php.net/package/SOAP)
• ez SOAP (http://ez.no/ez_publish/documentation/development/libraries/ez_soap)
• nusoap (http://sf.net/projects/nusoap/).

所有这些php4的库在处理远程信息的格式化和传递的功能是使用PHP代码实现的,并且有远程代理的例子。

首先一个问题是你用什么方法让SoapClient做回应? 运行var_dump(get_class_methods(get_class($client)));,你可以很容易的列举在运行时的方法。需要更加详细的例子的话,你可以参考下面的测试案例：

class ProxyTestCase extends UnitTestCase {
const WSDL = ‘http://live.capescience.com/wsdl/GlobalWeather.wsdl’;
private $client;
function setUp() {
$this->client = new SoapClient(ProxyTestCase::WSDL);
}
function TestMethodsOfSoapClient() {
$soap_client_methods = array(
‘__construct’,
‘__call’,
‘__soapCall’,
‘__getLastRequest’,
‘__getLastResponse’,
‘__getLastRequestHeaders’,
‘__getLastResponseHeaders’,
‘__getFunctions’,
‘__getTypes’,
‘__doRequest’);
$this->assertEqual(
$soap_client_methods,
get_class_methods(get_class($this->client)));
}
}

咋一看,似乎写了一个没有用的测试,难道你只是为了在任意时候显示这些信息而已?或许吧,在PHP升级的时候,这个测试放入程序进行测试对于监视你的程序会很有用,比如发现有什么方法增加了,或者是你可以发现哪些被依赖的方法被删除了,验证PHP编译的时候是否加入了SOAP选项。但必须要说的是,这个测试是极端的脆弱:其弱点就是会因为更改代码的原因,需要重构而且高度依赖函数列表的顺序。目前,虽然这个测试描述了SoapClient如何工作,如果你想要放一个类似的测试进行测试,最好还是重构它,用in_array函数来明确的寻找你需要测试的函数。你可以使用SoapClient::__getFunctions()方法很容易的了解指定的SOAP提供什么服务。 在GlobalWeather.wsdl的案例,你可以按照下面方法做：

class ProxyTestCase extends UnitTestCase {
function TestSoapFunctions() {
$globalweather_functions = array(
The Proxy Pattern 195
‘Station getStation(string $code)’,
‘boolean isValidCode(string $code)’,
‘ArrayOfstring listCountries()’,
‘ArrayOfStation searchByCode(string $code)’,
‘ArrayOfStation searchByCountry(string $country)’,
‘ArrayOfStation searchByName(string $name)’,
‘ArrayOfStation searchByRegion(string $region)’,
‘WeatherReport getWeatherReport(string $code)’
);
$this->assertEqual(
$globalweather_functions,
$this->client->__getFunctions());
}
}

SoapClient::__getFunctions()会返回一个表示API的字符串数组给WEB服务。在每个方法中,都有返回类型,方法名,参数类型会被列出来。(建议你再次把上面那种测试方法放入程序中,已发布的web服务,如果做了变更将立即发出警告。你可以想象一下,由于API的改变产生了一个bug,天气信息忽然停止显示在你的页面,而你又没有察觉到。如果做了这类的检查,你会快速的获得因更改API而产生的警告。)

最后让我们看一个简单的实际例子来理解PHP5风格的SoapClient这个服务。假设有这样的一个例子,我们需要查看美国伊利诺斯州的moline的天气。这个获得当前moline飞机场天气状态的代码称为”KMLI”,需要调用getWeatherReport()方法和传递’KMLI’字符串作为参数。这个调用将返回一个WeatherReport对象。

class ProxyTestCase extends UnitTestCase {
function TestGetWeatherReport() {
$moline_weather = $this->client->getWeatherReport(‘KMLI’);
$this->assertIsA($moline_weather, ‘stdClass’);
}
}

因为WeatherReport实际上并不是你程序中定义的类, SoapClient都象stdClass的实例化一样的返回所有的对象。这时你也可以获得返回对象的属性的值。

class ProxyTestCase extends UnitTestCase {
function TestGetWeatherReport() {
$moline_weather = $this->client->getWeatherReport(‘KMLI’);
$this->assertIsA($moline_weather, ‘stdClass’);
$weather_tests = array(
‘timestamp’ => ‘String’
,’station’ => ‘stdClass’
,’phenomena’ => ‘Array’
,’precipitation’ => ‘Array’
,’extremes’ => ‘Array’
,’pressure’ => ‘stdClass’
,’sky’ => ‘stdClass’
,’temperature’ => ‘stdClass’
,’visibility’ => ‘stdClass’
,’wind’ => ‘stdClass’
);
foreach($weather_tests as $key => $isa) {
$this->assertIsA($moline_weather->$key,
$isa,
“$key should be $isa, actually [%s]”);
}
}
}

上面的代码创建了属性和返回类型的映射。你可以迭代这些预期值的列表,并使用assertIsA()验证正确的类型。当然你以可以同样的验证其他的集合对象。

class ProxyTestCase extends UnitTestCase {
function TestGetWeatherReport() {
// continued ...
$temp = $moline_weather->temperature;
$temperature_tests = array(
‘ambient’ => ‘Float’
,’dewpoint’ => ‘Float’
,’relative_humidity’ => ‘Integer’
,’string’ => ‘String’
);
foreach($temperature_tests as $key => $isa) {
$this->assertIsA($temp->$key,
$isa,
“$key should be $isa, actually [%s]”);
}
}
}

上面的方法输出的实际效果如下：

stdClass Object
(
[timestamp] => 2005-02-27T13:52:00Z
[station] => stdClass Object
(
[icao] => KMLI
[wmo] => 72544
[iata] =>
[elevation] => 179
[latitude] => 41.451
[longitude] => -90.515
[name] => Moline, Quad-City Airport
[region] => IL
[country] => United States
[string] => KMLI - Moline, Quad-City Airport, IL, United States @ 41.451’N -90.515’W 179m
)
// ...
[temperature] => stdClass Object
(
[ambient] => 0.6
[dewpoint] => -2.8
[relative_humidity] => 78
[string] => 0.6c (78% RH)
)
// ...
)

 

延迟代理

现在你基本掌握了PHP5风格的SoapClient(如何做一个远程代理),但是你怎么才能写一个延迟实例化的代理给SoapClient呢?

class GlobalWeather {
private $client;
// ‘Station getStation(string $code)’,
public function getStation($code) {
return $this->client->getStation($code);
}
}

getStation()可以代理$client变量指向的getStation()方法。不管如何,从这点上看, SoapClient实例并没有创建,也没有存储到$client变量,因为上面已说过,对WSDL文件进行远程处理应该延迟到真正需要的时候。

你可以在插入一段延迟加载的代码之前做一下client的调用,来延迟SoapClient的实例化

class GlobalWeather {
private $client;
private function lazyLoad() {
if (! $this->client instanceof SoapClient) {
$this->client = new SoapClient(
‘http://live.capescience.com/wsdl/GlobalWeather.wsdl’);
}
}
// ‘Station getStation(string $code)’,
public function getStation($code) {
$this->lazyLoad();
return $this->client->getStation($code);
}
}

lazyLoad()中创建SoapClient对象是一定要的。这里存在一个问题:如果我是一个懒惰的编码者,让我非常不爽是:我不得不在所有的代理方法中加入$this->lazyLoad();。有更加简便的方法吗?当然有,重写一遍吧,使用PHP5新的特性来返回对象。改lazyLoad()的名字为client(),并在这个方法里面实例化$client,代理中的方法访问client()方法优于访问$client属性。把延迟实例化做的更加简单!

class GlobalWeather {
private function client() {
if (! $this->client instanceof SoapClient) {
$this->client = new SoapClient(
‘http://live.capescience.com/wsdl/GlobalWeather.wsdl’);
}
return $this->client;
}
// ...
// ‘boolean isValidCode(string $code)
public function isValidCode($code) {
return $this->client()->isValidCode($code);
}
// and so on for other SOAP service methods ...
// ‘WeatherReport getWeatherReport(string $code)
The Proxy Pattern 199
public function getWeatherReport($code) {
return $this->client()->getWeatherReport($code);
}
}

你迷上GlobalWeather服务的延迟实例代理类了吗?你有一个类可以在任何时间在你的程序里面创建,并且在不需要它们的时候就不解析的远程资源。使用代理类还有另外一个优势:使用代理可以列举SOAP所支持的方法,你现在就可以对这个类进行测试。

注：延迟代理可延迟异常
在PHP5里,创建一个对象会产生一个异常。使用延迟实例化代理,你可以延迟这个潜在的异常直到第一次使用方法创建对象的时候。。(你可以试试用代理完成这个功能。)这明显不是代理模式的重点,但是往往有一些事情,你需要记住。

动态代理

PHP5提供一些很好的特性,可以快速的封装一个代理类而不用明确的写出每一个方法。

class GenericProxy {
protected $subject;
public function __construct($subject) {
$this->subject = $subject;
}
public function __call($method, $args) {
return call_user_func_array(
array($this->subject, $method),
$args);
}
}

这里的关键是_call()方法(通过EXPERIMENTAL扩展重载,同样可用于PHP4)。代理类中的_call方法允许你通过$subject代替的方式来重定义每个调用。由于__call()比其他方法的优先级别都低,你可以在代理类中定义一个方法,让__call()来代替执行,于是你可以加一些特别的需求到你使用的代理模式。

总结

代理模式在很多情况下都非常有用,特别是你想强行控制一个对象的时候,比如:延迟加载,监视状态变更的方法等等。这章通过开发GlobalWeather类做示范,以后你也可以使用代理模式在你的本地计算机上使用远程资源：

点击放大

动态代理在编写代码的时候非常简单,因此可以很快速和容易的实现在你的程序中。然而(所有的实现都依赖__call()方法),反射并不能在对象内部具备这样的可见性(译注:反射一般是在不了解类的内部情况下操作的)。在特殊情况下,如果你使用一个代理就需要一个接口,你不能老是依赖于__call()方法,至少必须编码的时候,应该把接口所有的方法很明确的写入你的代理类。

评论 (0) All

登陆 还没注册？