在 PHP 中创建更好的名称空间

developerWorks 2009年07月20日 07:36 查看18692次 作者: Nathan A. Good  【
文章分类:PHP5研究[新]
PHP V5.3 支持为 PHP 类、常量和函数提供名称空间。使用名称空间避免命名冲突,并为 PHP 代码提供上下文。这些技巧为构建名称空间提供一些指导原则,从而充分利用名称空间带来的好处。

在 PHP V5.3 中引入的名称空间是为 PHP 类、常量和函数提供上下文的一种方式,从而可以将使用相同名称的元素看作是惟一的。惟一的名称避免了命名冲突,当两个类或函数使用相同的名称时就会发生这 种情况。有时这些 PHP 类表示现实世界中的相同对象,但它们的行为是完全不同的。名称空间能够确保您拥有正确的 PHP 类、常量或函数,并且要使用您的 PHP 类的人能够确保他们使用了正确的类。

代码中的名称空间就像现实世界中的上下文。考虑一个表示现实世界中的汽车对象的类。例如,通过 Internet 销售汽车的公司使用的 Automobile 类的行为可能与保险销售公司使用的 Automobile 类完全不同。

作为应用程序开发人员,您可能使用其他人编写的组件。您不能保证其他人永远不使用您已经使用的类名,但这些类的行为却大相径庭。在出现名称空间之前,PHP 开发人员通常将上下文构建到类名中,例如 My_Enterprise_PersonXML_Validator

清单 1 显示了一个位于名称空间中的类。


清单 1. 在名称空间中声明类
				
<?php
namespace IBM;
class Foo {
...
}
?>

下面给出了一个例子,展示了如何在名称空间中引用类。


清单 2. 在名称空间中引用类
				
<?php
$foo = new \IBM\Foo();
?>

在向所有类添加名称空间之前定义一个名称空间策略是个不错的 主意。尽管在某种程度上也可以不断地构建名称空间,但最好为名称空间确定一个通用结构,以方便名称空间的组织,并减少以后可能需要的修改。只要正确使用, 除了提供上下文之外,名称空间还可以用来组织 PHP 代码。

其他语言(比如 Java™ 和 C#)在很久以前就使用名称空间。在选择名称空间命名方式上,我使用的约定类似于这些语言的约定,因为许多开发人员都对此比较熟悉,便于他们理解。不过, 与 Java 语言不同的是,PHP 中的名称空间与类所在的目录之间没有联系。您可以给类、函数或常量选择任意的名称空间。您甚至可以对一个文件使用多个名称空间。同时,PHP 名称空间也不同于 C#,您可以对类以外的函数或常量使用名称空间。

顶级名称空间

如果您为某个组织构建名称空间,您可以使用组织名作为顶级域。一般情况下,使用组织名称创建顶级名称空间已经足以为 PHP 代码提供上下文,以及避免命名冲突,除非该组织编写大量用途不一的应用程序。

清单 3 的示例显示了如何声明顶级名称空间。


清单 3. 顶级名称空间
				
<?php
namespace IBM;
...
?>







次级名称空间

次级名称空间 是顶级名称空间内部的名称空间。当顶级名称空间还不足以为 PHP 类建立上下文时,它们提供进一步说明。

在创建次级名称空间时,不要凭一时的兴趣而过多地创建,这很重要。随着次级名称空间的增多,组织和引用它们就会变得越来越困难。如果您希望名称空间发挥双重作用,即避免命名冲突和组织 PHP 代码,那么就要更加注意这点了。

在决定为了方便组织代码应该向另一个名称空间引入多少个次级名称空间时,我尝试将该数量限制为 7 个(上下浮动不超过 2),以利用数字 7 更加容易记住这个优势。这并不总是奏效的,但我将它作为一个指导原则,以确保不将名称空间划分为过多的次级名称空间。

清单 4 的示例显示了在顶级名称空间中声明次级名称空间。


清单 4. 次级名称空间
				
<?php
namespace IBM\DeveloperWorks;
...
?>

反斜杠(\)将次级名称空间 “developerWorks” 与顶级名称空间 “IBM” 分开。

在声明次级名称空间时,您可以使用两个常见技巧,或同时使用它们。获取名称空间的常见地方是项目名或应用程序名;另一个地方是域名。

通过项目定义

如果您使用组织名作为顶级名称空间,并且想通过次级名称空间来进一步提供上下文,那么可以使用项目名或应用程序名作为次级名称空间。例如,如果您构建一个称为 Greeter 的新应用程序(用于获取用户的名称并问候他们),那么清单 5 中的名称空间将为称为 Prompt 的类提供完整的上下文。


清单 5. 使用应用程序名作为次级名称空间
				
<?php
namespace IBM\Greeter;
class Prompt {
...
}
?>

由于 Prompt 可能是多个应用程序或库的类名,所以为该名称空间添加组织名和项目名能够让这个 Prompt 类与其他同名的类区分开来。

通过域定义

使用域名是另一种选择次级名称空间的常见方式,如 清单 6 所示。它也可以用于项目名之后,是否使用取决于您对可重用性的计划(见 “根据可重用性命名”)。

是对更大的问题域的一组分类。域的一个例子是在更大型的应用程序中处理帐户、客户和产品的 “Account”、“Customers” 或 “Products”。


清单 6. 使用域作为次级名称空间
				
<?php
namespace IBM\MyApp\Account;
class Address {
...
}
?>







根据可重用性命名

除了应用支持可重用性的模块概念之外,类和名称空间的命名方式也能够实现可重用性。有时不良的命名方式会损害可重用性,因为不佳的名称暗示着类仅能用于特定目的。同样,错误地应用名称空间可能会不必要地局限类的使用范围,让它们的重用变得困难。

在 使用组织名的顶级名称空间中,应该保留 “Common”、“Core”、“Lib” 等可跨应用程序重用的名称空间。一个常见的例子是验证,其中针对整个企业的库存单位(SKU)、帐号或发票号的规则是一样的,从而获得合适的规则和长度。 对于 Validator 类,类似清单 7 的名称空间是不错的选择。


清单 7. 使用通用的 validation 名称空间
				
<?php
namespace MyCompany\Common\Validation;
class NotNullValidator {
...
}
?>

在这里,组织名用作顶级域(“MyCompany”)。“Common” 名称空间用作项目。即使在编写这个类的同时也许正在编写一个特定的应用程序,该类一样可以在组织的任何项目中使用。最后,“Validation” 用作类的域。







使用别名

尽管名称空间能够帮助您组织类并避免命名约定,但其缺点是名称过长。幸运的是,PHP 支持使用别名,因此可以在代码中使用更短的别名。清单 8 提供了一个示例。


清单 8. 使用别名
				
<?php
use MyCompany\Common\Validation as Validators;
?>







命名约定

名称空间命名使用单词首字母大写或 PASCAL 命名约定,这与其他 PHP 约定一样,比如 PHP Extension 和 Application Repository (PEAR) 包命名和文件名。例如,清单 9 中的名称空间比 清单 10 中的名称空间要好。


清单 9. 单词首字母大写或 PASCAL 命名
				
<?php
namespace MyNamespace;
?>

避免使用与其他 PHP 约定冲突的命名和大小写约定。


清单 10. 使用糟糕的大小写约定
				
<?php
namespace mynamespace;
...
?>





结束语

PHP 中的名称空间能够用于组织代码、避免命名冲突以及为类、函数和常量提供上下文。在名称空间中使用模式或约定让代码更易于理解,并且更易于引用和使用。

责任编辑:admin

给文章打分...

平均分:2.2(40 次)

-5 -4 -3 -2 -1 0 1 2 3 4 5
28

顶一下

发表我的见解...

  • 您的大名: 留空为匿名
  • 您的主页:
  • 您的邮箱: