命名空间介绍
什么是命名空间?从广义上来说,命名空间是一种封装事物的方法。在很多地方都可以见到这种抽象概念。例如,在操作系统中目录用来将相关文件分组,对于目录中的文件来说,它就扮演了命名空间的角色。具体举个例子,文件 foo.txt 可以同时在目录/home/greg 和 /home/other 中存在,但在同一个目录中不能存在两个 foo.txt 文件。另外,在目录 /home/greg 外访问 foo.txt 文件时,我们必须将目录名以及目录分隔符放在文件名之前得到 /home/greg/foo.txt。这个原理应用到程序设计领域就是命名空间的概念,==其实就是按照一种虚拟的目录结构组织PHP代码,将PHP代码放在一个虚拟的沙盒中==。
在PHP中,命名空间用来解决在编写类库或应用程序时创建可重用的代码如类或函数时碰到的两类问题:
1. 用户编写的代码与PHP内部的(底层框架的)类/函数/常量或第三方类/函数/常量之间的名字冲突。
2. 为很长的标识符名称(通常是为了缓解第一类问题而定义的)创建一个别名(或简短)的名称,提高源代码的可读性。
定义命名空间
虽然任意合法的PHP代码都可以包含在命名空间中,但只有以下类型的代码受命名空间的影响,它们是:类(包括抽象类和traits)、接口、函数和常量。
命名空间通过关键字namespace 来声明。如果一个文件中包含命名空间,它必须在其它所有代码之前声明命名空间,除了一个以外:declare关键字。
Example #1 声明单个命名空间
<?php
namespace MyProject;
const CONNECT_OK = 1;
class Connection {}
function connect() {}
?>
Example #2 声明分层次的单个命名空间
<?php
namespace MyProject\Sub\Level;
const CONNECT_OK = 1;
class Connection { }
function connect() {}
?>
Example #3 在同一个文件中定义多个命名空间
namespace member\vip;
class vip{
}
function vipFunction(){
}
const VIPLEVEL=1;
namespace AnotherProject;
const VIPLEVEL=2;
class vip{
}
function vipFunction(){
}
++不建议使用这种语法在单个文件中定义多个命名空间。建议使用下面的大括号形式的语法。++
Example #4 工作中用以下的方式定义多个命令空间
namespace member\vip{
class vip{
}
function vipFunction(){
}
const VIPLEVEL=1;
}
namespace member\vip\sub{
class vip{
}
function vipFunction(){
}
const VIPLEVEL=1;
}
将全局的非命名空间中的代码与命名空间中的代码组合在一起,只能使用大括号形式的语法。全局代码必须用一个不带名称的 namespace 语句加上大括号括起来,例如:
<?php
namespace MyProject {
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */ }
}
namespace { // global code
session_start();
$a = MyProject\connect();
echo MyProject\Connection::start();
}
?>
==注意:所有非 PHP代码包括空白符都不能出现在命名空间的声明之前:==
<html>
<?php
namespace MyProject; // 致命错误 - 命名空间必须是程序脚本的第一条语句
?>
==注意,与PHP其它的语言特征不同,同一个命名空间可以定义在多个文件中,即允许将同一个命名空间的内容分割存放在不同的文件中。==
命令空间的命名不能使用php关键字,使用关键字会导致语法错误~
<?php
namespace Project/Classes/Function; // Causes parse errors
namespace Project/Abstract/Factory; // Causes parse errors
?>
命名空间的使用
- 非限定名称,或不包含前缀的类名称,例如 $a=new foo(); 或foo::Staticmethod();。如果当前命名空间是 currentnamespace,foo 将被解析为 currentnamespace\foo。如果使用 foo 的代码是全局的,不包含在任何命名空间中的代码,则 foo 会被解析为foo。 ==警告:如果命名空间中的函数或常量未定义,则该非限定的函数名称或常量名称会被解析为全局函数名称或常量名称。==
- 限定名称,或包含前缀的名称,例如 $a = new subnamespace\foo(); 或 subnamespace\foo::Staticmethod();。如果当前的命名空间是 currentnamespace,则 foo 会被解析为 currentnamespace\subnamespace\foo。如果使用 foo 的代码是全局的,不包含在任何命名空间中的代码,foo 会被解析为subnamespace\foo。
- 完全限定名称,或包含了全局前缀操作符的名称,例如, $a = new \currentnamespace\foo(); 或 \currentnamespace\foo::Staticmethod();。在这种情况下,foo 总是被解析为代码中的文字名(literal name)currentnamespace\foo。
<?php
namespace Foo\Bar\subnamespace;
const FOO = 1;
function foo() {}
class foo
{
static function staticmethod() {}
}
?>
<?php
namespace Foo\Bar;
include 'file1.php';
const FOO = 2;
function foo() {}
class foo
{
static function staticmethod() {}
}
/* 非限定名称 */
foo(); // 解析为 Foo\Bar\foo resolves to function Foo\Bar\foo
foo::staticmethod(); // 解析为类 Foo\Bar\foo的静态方法staticmethod。resolves to class Foo\Bar\foo, method staticmethod
echo FOO; // resolves to constant Foo\Bar\FOO
/* 限定名称 */
subnamespace\foo(); // 解析为函数 Foo\Bar\subnamespace\foo
subnamespace\foo::staticmethod(); // 解析为类 Foo\Bar\subnamespace\foo,
// 以及类的方法 staticmethod
echo subnamespace\FOO; // 解析为常量 Foo\Bar\subnamespace\FOO
/* 完全限定名称 */
\Foo\Bar\foo(); // 解析为函数 Foo\Bar\foo
\Foo\Bar\foo::staticmethod(); // 解析为类 Foo\Bar\foo, 以及类的方法 staticmethod
echo \Foo\Bar\FOO; // 解析为常量 Foo\Bar\FOO
?>
Example #1 在命名空间内部访问全局类、函数和常量
<?php
namespace vip\demo1{
const VIPDEMO1=12;
class demo1{
function __construct(){
echo "demo1 test";
}
}
function demo1(){
echo "demo1 function";
}
}
namespace vip\demo2{
const VIPDEMO1=134;
class demo1{
function __construct(){
echo "demo2 test";
}
}
function demo1(){
echo "demo2 function";
}
function strlen($str){
echo "strlen is to {$str}";
}
}
调用上面定义的strlen方法和全局的strlen
<?php
include "demo.class.php";
echo \vip\demo2\strlen('test');//调用命名空间中的函数
echo "\r\n";
echo \strlen('test'); //调用全局函数
//strlen is to test
//4
Example #2 动态访问元素
<?php
class classname
{
function __construct()
{
echo __METHOD__,"\n";
}
}
function funcname()
{
echo __FUNCTION__,"\n";
}
const constname = "global";
$a = 'classname';
$obj = new $a; // prints classname::__construct
$b = 'funcname';
$b(); // prints funcname
echo constant('constname'), "\n"; // prints global
Example #3 动态访问命名空间的元素
<?php
namespace namespacename;
class classname
{
function __construct()
{
echo __METHOD__,"\n";
}
}
function funcname()
{
echo __FUNCTION__,"\n";
}
const constname = "namespaced";
include 'example1.php';
$a = 'classname';
$obj = new $a; // prints classname::__construct
$b = 'funcname';
$b(); // prints funcname
echo constant('constname'), "\n"; // prints global
/* note that if using double quotes, "\\namespacename\\classname" must be used */
$a = '\namespacename\classname';
$obj = new $a; // prints namespacename\classname::__construct
$a = 'namespacename\classname';
$obj = new $a; // also prints namespacename\classname::__construct
$b = 'namespacename\funcname';
$b(); // prints namespacename\funcname
$b = '\namespacename\funcname';
$b(); // also prints namespacename\funcname
echo constant('\namespacename\constname'), "\n"; // prints namespaced
echo constant('namespacename\constname'), "\n"; // also prints namespaced
?>
namespace关键字和NAMESPACE常量
常量NAMESPACE的值是包含当前命名空间名称的字符串。在全局的,不包括在任何命名空间中的代码,它包含一个空的字符串。
Example #1 _NAMESPACE_ 示例, 在命名空间中的代码
<?php
namespace MyProject;
echo '"', __NAMESPACE__, '"'; // 输出 "MyProject"
?>
Example #2 _NAMESPACE_ 示例,全局代码
<?php
echo '"', __NAMESPACE__, '"'; // 输出 ""
?>
Example #3 使用_NAMESPACE_动态创建名称
<?php
namespace MyProject;
function get($classname)
{
$a = __NAMESPACE__ . '\\' . $classname;
return new $a;
}
?>
使用命名空间:别名/导入
允许通过别名引用或导入外部的完全限定名称,是命名空间的一个重要特征。这有点类似于在类 unix 文件系统中可以创建对其它的文件或目录的符号连接。
导入的意思是告诉php想使用那个命名空间、类、接口、函数和常量(php5.6开始)。
Example #1 使用命名空间,没有创建别名
<?php
use http\Response;
$response=new Response();
$response->post();
通过use告诉php,使用http\Response类;我么只需输入一次完全限定的域名,以后可以直接使用相关类名进行实例化
Example #2 使用命名空间,自定义别名
<?php
use http\Response as Res;
$response=new Res();
$response->post();
注意:应该在php文件的顶部使用use关键字导入代码。而且要放在
<?php
use func Namespace\functionName
functionName();
导入常量
<?php
use constant Namespace\CONST_NAME
echo CONST_NAME;
多重导入
<?php
//如果想在php文件中导入多个类,接口,函数或者常量,要在php文件的顶部使用多个Use语句
use foo\bar,foo\bar\MyClass;
//为了更明确则,则一般使用下面的方式导入:
use foo\bar;
use foo\bar\MyClass;
命令空间的注意事项:
- 命令空间的名称不能用“/”或者“.”,只能用”\”;
- 命令空间只能是程序的第一条,前面不能有任何的输出;
- 命令空间的名称不能是纯数字,必须以字母开头;
- 除了开始的declare语句外,命名空间的括号外不得有任何PHP代码;
- 注意对命名空间中的名称(包含命名空间分隔符的完全限定名称如 Foo\Bar以及相对的不包含命名空间分隔符的全局名称如 FooBar)来说,前导的反斜杠是不必要的也不推荐的,因为导入的名称必须是完全限定的,不会根据当前的命名空间作相对解析;