名前空間の最も明確な目的は名前の重複問題を解決することです。PHPでは2つの関数またはクラスが同じ名前を持つことを許可しておらず、そうなると致命的なエラーが発生します。このような場合、名前の重複を避ければ解決できます。最も一般的な方法の1つは接頭辞を定めることです。

例:プロジェクトにarticleとmessage boardという2つのモジュールがあり、それぞれユーザーのコメントを処理するCommentクラスを持っています。その後、すべてのユーザーコメントに関する統計情報機能を追加したくなったとします。例えば、すべてのコメントの数を取得したいとします。このとき、それぞれのCommentが提供するメソッドを呼び出すのが良い方法ですが、同時にそれぞれのCommentクラスを導入するのは明らかに不可能で、コードはエラーになります。別の場所でどちらかのCommentを書き直すのも保守性を下げます。この場合、クラス名を再構築するしかなく、命名規則を定めて、クラス名の前にモジュール名を追加します。次のように:Article_Comment、MessageBoard_Comment

見てわかるように、名前が非常に長くなり、以後Commentを使用するときにより多くのコードを書くことになります(少なくとも文字数が増えます)。さらに、今後各モジュールに対してより多くの統合機能を追加したり、相互に呼び出したりする場合、名前の重複が発生すると名前を再構築する必要があります。もちろん、プロジェクトの開始時にこの問題に気づき、命名規則を定めれば、この問題をうまく回避できます。もう1つの解決策として名前空間の使用を検討できます。

注記:この記事で言及する定数:PHP5.3以降、constキーワードはクラスの外部で使用できます。constとdefineはどちらも定数を宣言するために使用されます(その違いは詳述しません)。ただし、名前空間内では、defineはグローバルに作用しますが、constは現在の空間に作用します。記事内で言及する定数は、constを使用して宣言された定数を指します。

基礎

名前空間はコードを異なる空間(領域)に分割し、各空間の定数、関数、クラス(以下、これらをまとめて「要素」と呼びます)の名前は互いに影響しません。これはよく言われる「カプセル化」の概念に似ています。

名前空間を作成するにはnamespaceキーワードを使用する必要があります。次のようにします:

<?php
//创建一个名为'Article'的命名空间
namespace Article;
?>

注意すべき点は、現在のスクリプトファイルの最初の名前空間の前にはいかなるコードも置くことができないということです。以下の書き方はすべて誤りです:

例1

//在脚本前面写了一些逻辑代码
<?php
$path = "/";
class Comment { }
namespace Article;
?>

例2

</html>
<?php
namespace Article;
?>

なぜ「最初の名前空間」と言うのでしょうか? 同じスクリプトファイル内に複数の名前空間を作成できるからです。

次に2つの名前空間を作成し、それぞれの空間にCommentクラス要素を追加しました:

<?php
//创建一个名为'Article'的命名空间
namespace Article;

//此Comment属于Article空间的元素
class Comment { }


//创建一个名为'MessageBoard'的命名空间
namespace MessageBoard;

//此Comment属于MessageBoard空间的元素
class Comment { }
?>

異なる空間間では他の要素を直接呼び出すことはできず、名前空間の構文を使用する必要があります:

<?php
namespace Article;
class Comment { }

namespace MessageBoard;
class Comment { }

//调用当前空间(MessageBoard)的Comment类
$comment = new Comment();

//调用Article空间的Comment类
$article_comment = new \Article\Comment();
?>

わかるように、MessageBoard空間でarticle空間のCommentクラスを呼び出すとき、ファイルパスのような構文を使用しています:\空間名\要素名

クラス以外にも、関数や定数の使い方は同じです。次に2つの空間に新しい要素を作成し、MessageBoard空間でそれらの値を出力しました。

<?php
namespace Article;

const PATH = '/article';

function getCommentTotal() {
    return 100;
}

class Comment { }


namespace MessageBoard;

const PATH = '/message_board';

function getCommentTotal() {
    return 300;
}

class Comment { }

//调用当前空间的常量、函数和类
echo PATH; ///message_board
echo getCommentTotal(); //300
$comment = new Comment();

//调用Article空间的常量、函数和类
echo \Article\PATH; ///article
echo \Article\getCommentTotal(); //100
$article_comment = new \Article\Comment();
?>

そして確かにArticle空間の要素データを取得できました。

子空間

名前空間の呼び出し構文がファイルパスのようなものであるのには理由があります。各空間間の関係を記述するために子空間をカスタム定義することができます。

すみません、言い忘れましたが、articleとmessage boardという2つのモジュールは実際には同じblogプロジェクト内にあります。名前空間を使ってそれらの関係を表現すると、次のようになります:

<?php
//我用这样的命名空间表示处于blog下的article模块
namespace Blog\Article;

class Comment { }


//我用这样的命名空间表示处于blog下的message board模块
namespace Blog\MessageBoard;

class Comment { }

//调用当前空间的类
$comment = new Comment();

//调用Blog\Article空间的类
$article_comment = new \Blog\Article\Comment();
?>

さらに、子空間は多くの階層を定義することもできます。例えばBlog\Article\Archives\Date

公共空間

私にはcommon_inc.phpというスクリプトファイルがあり、その中に便利な関数とクラスがいくつかあります:

<?php
function getIP() { }
class FilterXSS { }
?>

名前空間内でこのスクリプトを読み込んでも、スクリプト内の要素はこの名前空間に属しません。このスクリプト内に他の名前空間が定義されていない場合、その要素は常に公共空間に存在します:

<?php
namespace Blog\Article;

//引入脚本文件
include './common_inc.php';
$filter_XSS = new FilterXSS(); //出现致命错误:找不到Blog\Article\FilterXSS类
$filter_XSS = new \FilterXSS(); //正确
?>

公共空間を呼び出す方法は、要素名の前に \ を付けるだけです。そうしないと、PHPパーサーは現在の空間の要素を呼び出そうとしていると見なします。カスタム要素の他に、PHPに組み込まれている要素もすべて公共空間に属します。

ちなみに、公共空間の関数と定数は \ を付けなくても\正常に呼び出せます(なぜPHPがこのようにしているのかはわかりません)が、要素を正しく区別するために、関数を呼び出すときは \ を付けることをお勧めします。\

名称用語

エイリアスとインポートの説明の前に、空間に関する3種類の名称の用語と、PHPがそれらをどのように解析するかを知る必要があります。公式ドキュメントの説明が非常に良いので、そのまま引用します。

  • {'translated': '非限定名称、または接頭辞を含まないクラス名。例:$comment = new Comment();。現在の名前空間がBlog\\Articleの場合、CommentはBlog\\Article\\Commentとして解析されます。Commentを使用するコードがいかなる名前空間にも含まれていない場合(グローバル空間)、CommentはCommentとして解析されます。'}
  • 2.限定名称、または接頭辞を含む名前。例:$comment = new Article\Comment();。現在の名前空間がBlogの場合、CommentはBlog\Article\Commentとして解析されます。Commentを使用するコードがいかなる名前空間にも含まれていない場合(グローバル空間)、CommentはCommentとして解析されます。
  • 3.完全限定名称、またはグローバル接頭辞演算子を含む名前。例:$comment = new \Article\Comment();。この場合、Commentは常にコード内の文字通りの名前(literal name)Article\Commentとして解析されます。

実際には、これら3種類の名称をファイル名(例:comment.php)、相対パス名(例:./article/comment.php)、絶対パス名(例:/blog/article/comment.php)に例えると、より理解しやすいかもしれません。

いくつかの例を使ってそれらを示しました:

<?php
//创建空间Blog
namespace Blog;

class Comment { }

//非限定名称,表示当前Blog空间
//这个调用将被解析成 Blog\Comment();
$blog_comment = new Comment();

//限定名称,表示相对于Blog空间
//这个调用将被解析成 Blog\Article\Comment();
$article_comment = new Article\Comment(); //类前面没有反斜杆\

//完全限定名称,表示绝对于Blog空间
//这个调用将被解析成 Blog\Comment();
$article_comment = new \Blog\Comment(); //类前面有反斜杆\

//完全限定名称,表示绝对于Blog空间
//这个调用将被解析成 Blog\Article\Comment();
$article_comment = new \Blog\Article\Comment(); //类前面有反斜杆\


//创建Blog的子空间Article
namespace Blog\Article;

class Comment { }
?>

実は以前から非限定名称と完全限定名称を使用していましたが、今ようやくそれらの名称を呼べるようになりました。

エイリアスとインポート

エイリアスとインポートは、名前空間の要素を呼び出すためのショートカットと見なせます。PHPは関数や定数のインポートをサポートしていません。

これらはすべてuse演算子を使用して実装します:

<?php
namespace Blog\Article;

class Comment { }


//创建一个BBS空间(我有打算开个论坛)
namespace BBS;

//导入一个命名空间
use Blog\Article;
//导入命名空间后可使用限定名称调用元素
$article_comment = new Article\Comment();

//为命名空间使用别名
use Blog\Article as Arte;
//使用别名代替空间名
$article_comment = new Arte\Comment();

//导入一个类
use Blog\Article\Comment;
//导入类后可使用非限定名称调用元素
$article_comment = new Comment();

//为类使用别名
use Blog\Article\Comment as Comt;
//使用别名代替空间名
$article_comment = new Comt();
?>

気づいたのですが、要素をインポートするときに、現在の空間に同じ名前の要素があるとどうなるでしょうか? 明らかに致命的なエラーが発生します。

<?php
namespace Blog\Article;

class Comment { }


namespace BBS;

class Comment { }

Class Comt { }


//导入一个类
use Blog\Article\Comment;
$article_comment = new Comment(); //与当前空间的Comment发生冲突,程序产生致命错误

//为类使用别名
use Blog\Article\Comment as Comt;
$article_comment = new Comt(); //与当前空间的Comt发生冲突,程序产生致命错误
?>

動的呼び出し

PHPはnamespaceキーワードと__NAMESPACE__マジック定数を提供しており、要素に動的にアクセスできます。__NAMESPACE__は文字列を組み合わせることで動的にアクセスできます:

<?php
namespace Blog\Article;

const PATH = '/Blog/article';

class Comment { }


//namespace关键字表示当前空间
echo namespace\PATH; ///Blog/article
$comment = new namespace\Comment();

//魔法常量__NAMESPACE__的值是当前空间名称
echo __NAMESPACE__; //Blog\Article
//可以组合成字符串并调用
$comment_class_name = __NAMESPACE__ . '\Comment';
$comment = new $comment_class_name();
?>

文字列形式での呼び出しの問題

上記の動的呼び出しの例では、文字列形式の動的呼び出しを見ました。この方法を使用する場合、2つの問題に注意する必要があります。

1. ダブルクォートを使用する場合、特殊文字がエスケープされる可能性があります。

<?php
namespace Blog\Article;

class name { }

//我是想调用Blog\Article\name
$class_name = __NAMESPACE__ . "\name"; //但是\n将被转义为换行符

$name = new $class_name(); //发生致命错误
?>

2. 限定名称とは見なされません。

PHPはスクリプトのコンパイル時に要素が存在する空間とインポート状況を決定します。スクリプト解析時、文字列形式の呼び出しは非限定名称と完全限定名称としてのみ見なされ、限定名称になることは決してありません。

<?php
namespace Blog;

//导入Common类
use Blog\Article\Common;
//我想使用非限定名称调用Blog\Article\Common
$common_class_name = 'Common';
//实际会被当作非限定名称,也就表示当前空间的Common类,但我当前类没有创建Common类
$common = new $common_class_name(); //发生致命错误:Common类不存在

//我想使用限定名称调用Blog\Article\Common
$common_class_name = 'Article\Common';
//实际会被当作完全限定名称,也就表示Article空间下的Common类,但我下面只定义了Blog\Article空间而不是Article空间
$common = new $common_class_name(); //发生致命错误:Article\Common类不存在


namespace Blog\Article;

class Common { }
?>

まとめ

私はPHPの名前空間に触れたばかりで、実践のないアドバイスを軽々しくすることはできません。個人的には、名前空間の役割と機能はどちらも強力で、プラグインや汎用ライブラリを書くときに名前の重複問題を心配する必要がなくなります。ただし、プロジェクトがある程度進行した段階で、名前空間を追加して名前の重複問題を解決しようとする場合、作業量は名前の再構築と変わらないと思います。また、その構文がプロジェクトに一定の複雑さを追加することは否めないため、プロジェクトの開始時点から適切に計画し、命名規範を制定すべきです。

原文アドレス:https://www.cnblogs.com/kuyuecs/p/3556421.html