PHP Namespace

PHP 在 5.3 版本中映入了 Namespace 机制, 避免协同开发中遇到的同名问题. 同时增加了魔术常量: __NAMESPACE__ 和关键字: namespace

命名空间使用

• 声明 namespace 需要在所有代码的最前面, 通常在PHP脚本第一行声明.
• 声明 namespace 时可以直接声明子命名空间. 子命名空间用 \ 隔开.
• 一个PHP文件内可以声明多个命名空间. 如果声明多个命名空间, 建议使用 {} 包起来.

<?php
/**
 * file: ns1.php
 * 
 * 脚本声明 Namespace 需要在所有代码前面.
 * 除非脚本内有 declare 声明可以在 Namespace 语句前.
 */
namespace Test\One;

class MyClass {
    public function sayHello() {
        echo 'Hello, NS: ' . __NAMESPACE__ . ' on: ' . date('r') . PHP_EOL;
    }
}

class TestClass {
    public function sayHello() {
        echo 'Hello, NS: ' . __NAMESPACE__ . ' on: ' . \date('r') . PHP_EOL;
    }
}

<?php
/**
 * file: ns2.php
 * 
 * 脚本声明 Namespace 需要在所有代码前面.
 * 除非脚本内有 declare 声明可以在 Namespace 语句前.
 */
namespace Test\Two;

class MyClass {
    public function sayHello() {
        echo 'Hello, NS: ' . __NAMESPACE__ . ' on: ' . \date('r') . PHP_EOL;
    }
}

<?php
/**
 * file: nss.php
 * 
 * 声明多个命名空间, 第一条 Namespace 声明需要在所有代码前面.
 */

namespace Test\Three {
    class MyClass {
        public function sayHello() {
            echo 'Hello, NS: ' . __NAMESPACE__ . ' on: ' . \date('r') . PHP_EOL;
        }
    }    
}

namespace Test\Four {
    class MyClass {
        public function sayHello() {
            echo 'Hello, NS: ' . __NAMESPACE__ . ' on: ' . \date('r') . PHP_EOL;
        }
    } 
}

• PHP 脚本里引入带命名空间的代码, 不影响当前的命名空间.

<?php
/**
 * file: ns.php
 * 
 * 本脚本无任何 Namespace 声明. 默认为顶级命名空间
 */

// 载入 ns1.php 及 ns2.php 脚本, 
// 被载入的脚本里的声明的 Namespace 不在本脚本内生效 
require_once __DIR__ . '/ns1.php';
require_once __DIR__ . '/ns2.php';
require_once __DIR__ . '/nss.php';

class MyClass {
    public function sayHello() {
        echo 'Hello, NS: ' . __NAMESPACE__ . ' on: ' . date('r') . PHP_EOL;
    }
}

// test1: 调用无命名空间的对象或函数. 
$obj = new MyClass(); // $obj = new \MyClass(); 效果一样
$obj->sayHello();

// test2: 使用指定命名空间的对象
$obj = new \Test\One\MyClass();
$obj->sayHello();

// test3: 使用指定命名空间的对象
$obj = new \Test\Two\MyClass();
$obj->sayHello();

// 即使 require 了声明了 Namespace 定义的类, 也无法直接使用类名创建对象
// test4: 以下代码会抛出 Fatal error
//$obj = new TestClass(); // 即使 TestClass 在 ns1.php 文件中进行了定义. 无法进行创建对象.
//$obj->sayHello(); 

// 实例化带有命名空间的类, 必须使用 Namespace + Classname 进行声明. 类似上面的 test2 和 test3
// 使用 use 对 Namespace 中的类进行声明, 带 Namespace 中定义的类名和当前脚本中定义的类同名时,
// 只能使用全名称(Namespace + Classname) 或者用 use 进行声明别名.
// test5
use Test\Three\MyClass as MyClassThree;
$obj = new MyClassThree();
$obj->sayHello();

use Test\Four\MyClass as MyClassFour;
$obj = new MyClassFour();
$obj->sayHello();

• 在命名空间的代码中使用PHP原生函数或者PHP原生变量使用 \ 声明, 不使用 \ 声明的话, PHP解释器会优先搜索当前命名空间下的同名函数或者变量名.

<?php
namespace Test;

function strlen($str) {
    return 10;
}

function strtoupper($str) {
    return $str;
}

echo strlen('aaa') . PHP_EOL; // Out: 10
echo \strlen('aaa') . PHP_EOL; // Out: 3
echo strtoupper('aaa') . PHP_EOL; // Out: aaa
echo \strtoupper('aaa') . PHP_EOL; // Out: AAA

• __NAMESPACE__ 是全局常量, 等于被定义的脚本里声明的命名空间值.
• namespace 关键字执行当前的命名空间, 等于 self