[転送] Composer 入門、Composer 入門_PHP チュートリアル

【転送】Composer入門、composer入門

JavaにはMaven、Node.jsにはnpm、RORにはgemがある一方で、これらの言語のプログラマーは開発効率を高めるために喜んでパッケージ管理ツールを使用しています。 PHPer は依然として暗闇の中でコピー アンド ペーストを行っています。 Composer が登場する以前、PHP にはパッケージ管理に関して悲惨な歴史がありました。

長い間、アプリケーションがサードパーティのライブラリに依存している場合、PHPer はこれらのライブラリのソース コードをコピーするか、PEAR または PECL を介してインストールする必要がありました。サードパーティ ライブラリがさらに多くのサードパーティ ライブラリに依存すると、すぐに依存関係のブラックホールに陥ります。 Composer が登場するまで、PHP 愛好家は PHP パッケージ管理の夜明けを目にしていました。

以下では、ECサイトの作成を例にComposerの使い方を紹介します。

プロフィール

プロジェクトを開始するときは、まずプロジェクトに名前を付けます。とりあえず、コードネームを「シルクロード」と呼びます。まず、プロジェクトを記述する Composer 構成ファイルを作成する必要があります。これを行うには、プロジェクトのルート ディレクトリに、composer.json という名前の構成ファイルを作成します。内容は以下の通りです

リーリー

JSON 形式に精通している場合は、上の段落は一目瞭然です。実際、これらのキーと値のペアはオプションです。言い換えれば、まったく書く必要はありません。ただし、リリース用にプロジェクトをパブリック パッケージにパッケージ化する場合は、パッケージに名前を付ける必要があります。これらのキーと値のペアの意味を見てみましょう。

リーリー

name、パッケージの名前を表します。 Github を頻繁に利用する場合は、この値の表現によく馴染みがあるはずです。説明すると、通常、パッケージ名には / で区切られた 2 つの部分が含まれます。斜めのバーの前部分はバッグの所有者を表します。現在、ほとんどのパッケージ作成者は、この部分の値として Github ユーザー名を使用することを好みます。斜線の後ろの部分はパッケージ名を表します。覚えやすく、広めやすいように、シンプルかつ意味のあるものにするようにしてください。ほとんどの場合、多くの人は Github コード ライブラリ名にちなんで名前を付けます。もちろん、この場合、コードは Github 上に存在する方が合理的です。

リーリー

アプリケーションの紹介 この部分では、できるだけ簡潔にプロジェクトを紹介するようにしてください。本当に言いたいことがたくさんある場合は、README.md ファイルに書き込んでください。

リーリー

キーワードの値は文字列配列であり、パブリック ライブラリとして公開されるときにパッケージの検索と検出を容易にするためのメタデータ情報として使用されます。

リーリー

ホームページには、任意のページアドレスを入力できます。

リーリー

パッケージを一般公開する場合は、適切なライセンスを選択することを忘れないでください。このようにして、他のプログラマがパッケージを参照するときに、ライセンスをチェックして法的問題がないことを確認できます。

リーリー

著者フィールドにはオブジェクトの配列を含めることができます。これは、複数の著者情報を提供できることを意味します。

ここまではパッケージ自体に関する情報です。電子商取引 Web サイトとして、電子メールを送信し、注文を Excel テーブルにエクスポートできることは基本的な要件です。この時点では、これらの機能を実装するために既存のライブラリを使用することを考えるのは自然でした。これらのライブラリを入手する最も簡単な方法は、これらのライブラリを検索し、ダウンロード アドレスを見つけて zip パッケージをダウンロードし、対応するディレクトリに解凍して、ドキュメントに従って対応するファイルをインポートすることです。 Composer を使用すると、このプロセスをより自動的かつエレガントに完了できます。これが Composer の依存関係管理です。

依存関係管理

composer.json ファイルに新しいフィールドを追加します: require。このフィールドの値はオブジェクトであり、これもキーと値のペアの形式です。上記の 2 つの依存関係の場所を考慮すると、コンポーザーの管理メソッドは次のように記述されます:

リーリー

swiftmailer を例に挙げると、swiftmailer/swiftmailer はパッケージ名を表し、5.3.@dev はバージョン情報を表します。これが意味することは、これから開発するアプリケーションは swiftmailer のバージョン 5.3. に依存するということです。その中には:

5.3.* は、バージョン 5.3.1 またはバージョン 5.3.2 を使用できることを意味します。これを取得する場合、composer はバージョン 5.3 の下で最新バージョンを探します。バージョン番号は、>=1.0、>=1.0、<2.0 などのより広範な制約をサポートしています。詳細については、http://docs.phpcomposer.com/01-basic-usage.md# を参照してください。 - require-Key

@dev は、開発バージョンが利用可能であることを示します。通常、開発バージョンは不安定なバージョンを意味し、バグが含まれる可能性が高くなります。安定性ラベルは、特定の依存関係に適用することも、グローバルに適用することもできます。

特定の依存関係: デフォルトでは、composer は安定バージョンのみを取得します。この例で @dev 制約を追加せず、5.3.* バージョンがすべて開発バージョンである場合、composer はバージョンが取得されていないことを示すエラーを報告します。非対応に変更されました。この開発バージョンに問題がないことが確実な場合は、@dev を追加することで Composer にこの開発バージョンを取得させることができます。

グローバル安定性設定: minimum-stability の値を設定することで、現在開発されているプロジェクトの依存関係に必要なパッケージのグローバル安定性レベルを Composer に伝えることができます。その値には、dev、alpha、beta、RC、stable が含まれます。 、安定した値がデフォルト値です。

この時点で、2 つの依存関係が追加されました。Composer パッケージの更新コマンドを実行して、その効果を確認できます。

リーリー

正常に実行されると、ルート ディレクトリにベンダー フォルダーが見つかります。このフォルダーには、先ほどリストした 2 つのパッケージ ファイル コードが含まれています。

require-dev

有时候，我们会发现，有些包依赖只会在开发过程中使用，正式发布的程序不需要这些包，这个时候，就需要用到另外一个键，即require-dev。例如，我们想用codeception进行单元测试，那么就可以通过require-dev引入这个开发环境下的依赖包：

<code class="hljs dust"><span class="xml"><span class="hljs-comment"><!-- lang: js -->
&ldquo;require-dev&rdquo;: <span class="hljs-expression">{
<span class="hljs-string">"codeception/codeception": <span class="hljs-string">"2.0.0 "
}</span></span></span></span></span></code>

加了这个依赖后，再运行下命令看看效果。

<code class="hljs xml"><span class="hljs-comment"><!-- lang: shell -->
composer install
</span></code>

自动加载

自此，composer已经帮我们把需要的库文件下载下来啦，接下去想到的就是如何引用这些库文件。最简单的方式就是require或者 include，但这就不够高大上了啊，需要花时间去库文件里查看需要引入哪些文件，费事而且容易出错。好在composer可以帮我们解决这个问题。那 就是autoload。

在运行完composer install命令后，怎么调用PHPExcel库呢？很简单，只要引入vendor目录下的autoload.php文件就可以了。可以在根目录下，建一个index.php文件，加入一下内容：

<code class="hljs php">
<span class="hljs-keyword">include &ldquo;vendor/autoload.php&rdquo;
<span class="hljs-variable">$excel = <span class="hljs-keyword">new PHPExcel();
var_dump(<span class="hljs-variable">$excel);
</span></span></span></span></code>

用浏览器访问一下这个页面，就会发现PHPExcel对象已经被成功创建啦，是不是很方便？

其实到目前为止，我们并没用在composer.json文件里加入autoload字段，那么什么时候需要加入呢？ 那就是当我们想让composer帮我们自动加载我们自己定义的类的时候。例如，我们自己写了个订单管理类，取名OrderManager，放在lib目 录下的OrderManager.php文件里。内容如下：

<code class="hljs php">
<span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">OrderManager
{
    <span class="hljs-keyword">public <span class="hljs-function"><span class="hljs-keyword">function <span class="hljs-title">test<span class="hljs-params">()
    {
        <span class="hljs-keyword">echo <span class="hljs-string">"hello";
    }
}
</span></span></span></span></span></span></span></span></span></span></code>

那么如何让composer帮我们自动加载这个类呢？ 在composer.json里加入下面的内容：

<code class="hljs dust"><span class="xml"><span class="hljs-comment"><!-- lang: js -->
&ldquo;autoload&rdquo;:<span class="hljs-expression">{
    <span class="hljs-string">"files":[<span class="hljs-string">"lib/OrderManager.php"]
}</span></span></span></span></span></code>

files键对应的值是一个数组，数组元素是文件的路径，路径是相对于应用的根目录。加上上述内容后，运行命令：

<code class="hljs xml"><span class="hljs-comment"><!-- lang: js -->
composer dump-autoload
</span></code>

让composer重建自动加载的信息，完成之后，就可以在index.php里调用OrderManager类啦。

通过文件引入的方法虽然直观，但是很费劲，每个文件都得引入一次，实在不是好的解决办法。有没有更好的办法呢？尝试将autoload的值改成：

<code class="hljs xml"><span class="hljs-comment"><!-- lang: js -->
 "classmap":["lib"]
</span></code>

再此运行composer dump-autoload，尝试调用，依然能够成功创建OrderManager类。其实，classmap通过建立类到文件的对应关系，当程序需要 OrderManager类时，compoer的自动加载类通过查找OrderManager类所在的文件，然后再将改文件include进来。因此，这 又导致了一个问题，那就是每加一个新类，就需要运行一次composer dump-autoload来创建类到文件到对应关系，比files方法虽然好一点，但是还是很不够舒爽啊！于是，PSR-0出场了。先了解下什么是 PSR-0。

FIG组织制定的一组PHP相关规范，简称PSR，其中

PSR-0自动加载
PSR-1基本代码规范
PSR-2代码样式
PSR-3日志接口
PSR-4 自动加载

目前就这五个规范，乍一看，PSR-0和PSR-4是重复了，实际上，在功能上确实有所重复。区别在于PSR-4的规范比较干净，去除了兼容PHP 5.3以前版本的内容，有一点PSR-0升级版的感觉。当然，PSR-4也不是要完全替代PSR-0，而是在必要的时候补充PSR-0——当然，如果你愿 意，PSR-4也可以替代PSR-0。PSR-4可以和包括PSR-0在内的其他自动加载机制共同使用。

PSR-0规范的具体内容见：https://github.com/hfcorriez/fig-standards/blob/zh_CN/%E6%8E%A5%E5%8F%97/PSR-0.md
PSR-4规范的具体内容见：https://github.com/hfcorriez/fig-standards/blob/zh_CN/%E6%8E%A5%E5%8F%97/PSR-4-autoloader.md

简而言之，就是希望通过一组约定的目录，文件名，类名定义方式，来实现快速通过类查找到文件，然后包含进来，实现自动加载。
PSR-4和PSR-0最大的区别是对下划线（underscore）的定义不同。PSR-4中，在类名中使用下划线没有任何特殊含义。而PSR-0则规定类名中的下划线_会被转化成目录分隔符。

不管是PSR-0还是PSR-4，都要求有个命名空间，所以我们需要对OrderManager类进行一些小的修改，加上命名空间：

<code class="hljs php">
<span class="hljs-keyword">namespace <span class="hljs-title">SilkLib;
<span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">OrderManager
{
    <span class="hljs-keyword">public <span class="hljs-function"><span class="hljs-keyword">function <span class="hljs-title">test<span class="hljs-params">()
    {
        <span class="hljs-keyword">echo <span class="hljs-string">"hello";
    }
 }
</span></span></span></span></span></span></span></span></span></span></span></span></code>

同时，文件夹的结构也要修改成：应用根目录\lib\SilkLib\OrderManager.php

然后修改composer.json里的autoload部分如下：

<code class="hljs dust"><span class="xml"><span class="hljs-comment"><!-- lang: js -->
"autoload":<span class="hljs-expression">{
    <span class="hljs-string">"psr-0":{
        <span class="hljs-string">"SilkLib":<span class="hljs-string">"lib/"
    }<span class="xml">
}
</span></span></span></span></span></span></span></code>

这里需要注意的是，SlikLib是命名空间，lib是目录名，他们的组合告诉composer，文件搜索是在：lib/SilkLib/ 目录下，而不是在 SilkLib/lib 目录下，这一点要特别注意，有点绕，容易弄错。

如果我们把命名空间改成 Slik\lib, 相应的目录结构要改成：应用根目录\lib\Silk\lib\OrderManager.php，autoload部分的写法相应的也要改成：

<code class="hljs dust"><span class="xml"><span class="hljs-comment"><!-- lang: js -->
"autoload":<span class="hljs-expression">{
    <span class="hljs-string">"psr-0":{
        <span class="hljs-string">"Silk\\lib":<span class="hljs-string">"lib/"
    }<span class="xml">
}
</span></span></span></span></span></span></span></code>

注意Silk\lib是双斜杆。好了，那我们试试再加一个类，然后不用运行composer dump-autoload命令，看看新类是否能加载上。在lib目录下，新增一个ShipManager.php文件，内容如下：

<code class="hljs php">
<span class="hljs-keyword">namespace <span class="hljs-title">Silk\<span class="hljs-title">lib;
<span class="hljs-class"><span class="hljs-keyword">class <span class="hljs-title">ShipManager
{
    <span class="hljs-keyword">public <span class="hljs-function"><span class="hljs-keyword">function <span class="hljs-title">test<span class="hljs-params">()
    {
        <span class="hljs-keyword">echo <span class="hljs-string">'hello ship class';
    }
}
</span></span></span></span></span></span></span></span></span></span></span></span></span></code>

尝试在index.php文件中调用：

<code class="hljs lasso">
<span class="hljs-variable">$orderMgr <span class="hljs-subst">= <span class="hljs-literal">new Silk<span class="hljs-subst">\lib<span class="hljs-subst">\OrderManager();
<span class="hljs-variable">$orderMgr<span class="hljs-subst">->test();
<span class="hljs-variable">$shipMgr <span class="hljs-subst">= <span class="hljs-literal">new Silk<span class="hljs-subst">\lib<span class="hljs-subst">\ShipManager();
<span class="hljs-variable">$shipMgr<span class="hljs-subst">->test();
</span></span></span></span></span></span></span></span></span></span></span></span></span></span></code>

运行成功，说明使用psr-0规范进行自动加载，比classmap更加方便。下面试试psr-4方式，整理下目录结构，改成：应用根目录\lib\OrderManager.php，修改命名空间为Silk, 修改autoload部分为：

<code class="hljs 1c">
<span class="hljs-string">"autoload":{
    <span class="hljs-string">"psr-4":{
        <span class="hljs-string">"Silk":<span class="hljs-string">"lib"
    }
}
</span></span></span></span></code>

尝试调用，发现报错Fatal error: Uncaught exception 'InvalidArgumentException' with message 'A non-empty PSR-4 prefix must end with a namespace separator. 提示要加上分隔符，那就加上吧：

<code class="hljs dust"><span class="xml"><span class="hljs-comment"><!-- lang: js -->
"autoload":<span class="hljs-expression">{
    <span class="hljs-string">"psr-4":{
        <span class="hljs-string">"Silk\\":<span class="hljs-string">"lib"
    }<span class="xml">
}
</span></span></span></span></span></span></span></code>

再次composer dump-autoload，运行测试，OK通过！

掌握require和autoload部分，其实就算Compoer入门啦，在详细的内容，可以通过查看composer文档来了解。Happy Coding！

原文转于：http://my.oschina.net/u/248080/blog/359008

感谢原著

http://www.bkjia.com/PHPjc/1104656.htmlwww.bkjia.comtruehttp://www.bkjia.com/PHPjc/1104656.htmlTechArticle【转】Composer入门，composer入门 Java有Maven, Node.js有npm, ROR有gem, 这些语言的程序员在开心地使用包管理工具加速开发效率时，PHPer们还在复制...