【轉】Composer入門

来源:http://www.cnblogs.com/zhenghongxin/archive/2016/03/02/5233835.html
-Advertisement-
Play Games

Java有Maven, Node.js有npm, ROR有gem, 這些語言的程式員在開心地使用包管理工具加速開發效率時，PHPer們還在複製粘貼的黑暗中。PHP在Composer之前，包管理的歷史不堪迴首。 在相當長的一段時間內，如果應用依賴於第三方庫，PHPer需要拷貝這些庫的源代碼， 或者通過


Java有Maven, Node.js有npm, ROR有gem, 這些語言的程式員在開心地使用包管理工具加速開發效率時，PHPer們還在複製粘貼的黑暗中。PHP在Composer之前，包管理的歷史不堪迴首。

在相當長的一段時間內，如果應用依賴於第三方庫，PHPer需要拷貝這些庫的源代碼， 或者通過PEAR、PECL安裝。如果第三方庫又依賴於更多的第三方庫，那麼很快就會進入依賴的黑洞。直到Composer出現，PHPer們看到了屬於PHP的包管理的曙光。

下麵將以創建一個電商網站為例，介紹Composer的使用方法。

配置文件

在我們開始一個項目的時候，首先會給項目取一個名字，我們暫且叫絲綢之路吧，代號silk。首先要寫一個Composer的配置文件，來描述項目，為此，在項目的根目錄下，建立文件名為composer.json的配置文件。內容如下：

<!-- lang: js -->
{
"name":             "meta/silk",
"description":      "another e-commerce website",
"keywords":         ["silk", "online shop", "good"],
"homepage":         "http://www.xxx.com ",
"time":             "2014-12-30",
"license":          "MIT",
"authors": [
    {
        "name":         "Elvis Lim",
        "email":        "[email protected]",
        "homepage":     "http://www.xxx.com",
        "role":         "Engineer"
    }
]}

如果您熟悉JSON格式，那麼上面這段內容不言而喻。事實上，這些鍵值對都是可選的。也就是說，可以都不寫。但是如果要把項目打包成公共包發佈，那麼這些還是需要寫上的，給你的包取個名字總不為過。讓我們來過一下這些鍵值對的意義吧。

<!-- lang: js -->
"name":             "meta/silk",

name, 表示包的名稱。如果你經常在Github上混，那這個值的表達方式一定非常熟悉啦。解釋下，通常包名包含兩部分，並且以 / 分隔。斜桿前面部分，代表包的所有者。目前大部分的包作者都喜歡用Github的用戶名作為這部分的值。斜桿後面部分代表包的名稱。儘量保持簡單和有意義 些，便於記憶和傳播。大部分情況下，很多人會用Github的代碼庫名稱來命名，當然，這種情況下，代碼要存在Github比較有意義。

<!-- lang: js -->
"description":      "another e-commerce website",

應用簡介，這部分儘量簡潔介紹下項目，別長篇大論。如果確實有很多話要說，那麼可以寫在README.md文件里。

<!-- lang: js -->
"keywords":         ["silk", "online shop", "good"],

關鍵詞的值是一個字元串數組，在發佈成公用庫的是時候，作為元數據信息，有利於包的搜索和發現。

<!-- lang: js -->
"homepage":         "http://www.xxx.com ",

主頁，可以放你想放的任何頁面地址。

<!-- lang: js -->
"license": "MIT",

如果你決定將包公開發佈，那麼記得選擇一個合適的許可證。這樣別的程式員在引用包的時候，通過查看許可證，確保沒有法律上的問題。

<!-- lang: js -->
 "authors":[{}]

作者欄位可以包含一個對象數組，也就是說可以提供多個作者信息。

目前為止，都是關於包本身的信息描述。作為一個電商網站，能夠發送電子郵件、導出訂單到Excel表是基本需求，這個時候自然想到了使用現有的庫來 實現這些功能。要獲取這些庫，最簡單的方式是，搜索下這些庫，找到下載地址，下載個zip包，然後解壓到相應目錄下，根據文檔引入相應的文件。使用 Composer，可以更加自動和優雅地完成這個過程，這就是Composer的依賴管理。

依賴管理

在composer.json文件里增加一個新的欄位：require。這個欄位的值是一個對象，同樣以鍵值對的形式構成。以上述提到的兩個依賴位置，寫成composer管理的方式如下：

<!-- lang: js -->
“require”: {
"swiftmailer/swiftmailer": 5.3.*@dev,
"phpoffice/phpexcel": "dev-master"
}

以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#The- require-Key

@dev表示可以獲取開發版本。通常，開發版本意味非穩定版本，很可能存在bug。穩定性標簽可以作用於特定的依賴項，也可以作用於全局。

作用特定依賴項：預設情況下，composer只會獲取穩定版本，如果這個例子我們不加@dev約束，而5.3.*版本都是開發版本，那麼在獲取的時候composer就會報錯，指出改版本不符合要求。如果確定這個開發版本沒有問題，那麼就可以通過加@dev ，讓Composer獲取這個開發版本。

全局穩定性設置：通過設置minimum-stability的值，來告訴Composer當前開發的項目的依賴要求的包的全局穩定性級別，它的值包括：dev、alpha、beta、RC、stable，stable是預設值。

至此，兩個依賴添加完畢，我們可以運行下Composer包更新命令，看看效果啦。

<!-- lang: shell -->
composer install

成功運行完畢，會在根目錄下發現vendor文件夾，裡面包含了剛剛我們列出來的兩個包文件代碼。

require-dev

有時候，我們會發現，有些包依賴只會在開發過程中使用，正式發佈的程式不需要這些包，這個時候，就需要用到另外一個鍵，即require-dev。例如，我們想用codeception進行單元測試，那麼就可以通過require-dev引入這個開發環境下的依賴包：

<!-- lang: js -->
“require-dev”: {
"codeception/codeception": "2.0.0 "
}

加了這個依賴後，再運行下命令看看效果。

<!-- lang: shell -->
composer install

自動載入

自此，composer已經幫我們把需要的庫文件下載下來啦，接下去想到的就是如何引用這些庫文件。最簡單的方式就是require或者 include，但這就不夠高大上了啊，需要花時間去庫文件里查看需要引入哪些文件，費事而且容易出錯。好在composer可以幫我們解決這個問題。那 就是autoload。

在運行完composer install命令後，怎麼調用PHPExcel庫呢？很簡單，只要引入vendor目錄下的autoload.php文件就可以了。可以在根目錄下，建一個index.php文件，加入一下內容：


include “vendor/autoload.php”
$excel = new PHPExcel();
var_dump($excel);

用瀏覽器訪問一下這個頁面，就會發現PHPExcel對象已經被成功創建啦，是不是很方便？

其實到目前為止，我們並沒用在composer.json文件裡加入autoload欄位，那麼什麼時候需要加入呢？ 那就是當我們想讓composer幫我們自動載入我們自己定義的類的時候。例如，我們自己寫了個訂單管理類，取名OrderManager，放在lib目 錄下的OrderManager.php文件里。內容如下：


class OrderManager
{
    public function test()
    {
        echo "hello";
    }
}

那麼如何讓composer幫我們自動載入這個類呢？ 在composer.json裡加入下麵的內容：

<!-- lang: js -->
“autoload”:{
    "files":["lib/OrderManager.php"]
}

files鍵對應的值是一個數組，數組元素是文件的路徑，路徑是相對於應用的根目錄。加上上述內容後，運行命令：

<!-- lang: js -->
composer dump-autoload

讓composer重建自動載入的信息，完成之後，就可以在index.php里調用OrderManager類啦。

通過文件引入的方法雖然直觀，但是很費勁，每個文件都得引入一次，實在不是好的解決辦法。有沒有更好的辦法呢？嘗試將autoload的值改成：

<!-- lang: js -->
 "classmap":["lib"]

再此運行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類進行一些小的修改，加上命名空間：


namespace SilkLib;
class OrderManager
{
    public function test()
    {
        echo "hello";
    }
 }

同時，文件夾的結構也要修改成：應用根目錄\lib\SilkLib\OrderManager.php

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

<!-- lang: js -->
"autoload":{
    "psr-0":{
        "SilkLib":"lib/"
    }
}

這裡需要註意的是，SlikLib是命名空間，lib是目錄名，他們的組合告訴composer，文件搜索是在：lib/SilkLib/ 目錄下，而不是在 SilkLib/lib 目錄下，這一點要特別註意，有點繞，容易弄錯。

如果我們把命名空間改成 Slik\lib, 相應的目錄結構要改成：應用根目錄\lib\Silk\lib\OrderManager.php，autoload部分的寫法相應的也要改成：

<!-- lang: js -->
"autoload":{
    "psr-0":{
        "Silk\\lib":"lib/"
    }
}

註意Silk\lib是雙斜桿。好了，那我們試試再加一個類，然後不用運行composer dump-autoload命令，看看新類是否能載入上。在lib目錄下，新增一個ShipManager.php文件，內容如下：


namespace Silk\lib;
class ShipManager
{
    public function test()
    {
        echo 'hello ship class';
    }
}

嘗試在index.php文件中調用：


$orderMgr = new Silk\lib\OrderManager();
$orderMgr->test();
$shipMgr = new Silk\lib\ShipManager();
$shipMgr->test();

運行成功，說明使用psr-0規範進行自動載入，比classmap更加方便。下麵試試psr-4方式，整理下目錄結構，改成：應用根目錄\lib\OrderManager.php，修改命名空間為Silk, 修改autoload部分為：


"autoload":{
    "psr-4":{
        "Silk":"lib"
    }
}

嘗試調用，發現報錯Fatal error: Uncaught exception 'InvalidArgumentException' with message 'A non-empty PSR-4 prefix must end with a namespace separator. 提示要加上分隔符，那就加上吧：

<!-- lang: js -->
"autoload":{
    "psr-4":{
        "Silk\\":"lib"
    }
}

再次composer dump-autoload，運行測試，OK通過！

掌握require和autoload部分，其實就算Compoer入門啦，在詳細的內容，可以通過查看composer文檔來瞭解。Happy Coding！

原文轉於：http://my.oschina.net/u/248080/blog/359008

感謝原著


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • java第一課：環境、變數、數據類型
    一、java編程註意事項1.java區分大小寫2.每條語句結尾有分號3.上下級代碼註意縮進4.大括弧要成對出現5.標點符號要用英文半形（半形全形區別）二、eclipse1.eclipse是自編譯及時編譯2.java ee包含java se 三、變數 1.+表示將多段文字拼接成一句話 2.使用變數就相
  • 【微信開發】微信支付參數設置【圖】
    設置微信支付需要的4個參數APPID APPSECRET MCHID KEY在哪裡找呢 其中APPID APPSECRET為公眾號的appid和appsecret，在微信公眾平臺後臺查看 開發》基本配置》開發者ID MCHID和KEY為微信支付商戶號和API密鑰，在微信支付商戶平臺後臺查看 MCHI
  • IP地址、子網掩碼和地址分類
    http://blog.csdn.net/bluishglc/article/details/47909593?utm_source=tuicool&utm_medium=referral 實際工作中用到網路知識的機會並不多，雖然以前學習過，但是許久不用自然也就生疏了。最近拿到幾台雲上的虛擬機，需要
  • MyEclispe 2016 CI 0發佈（附下載）
    MyEclipse 2016基於Eclipse Mars 1 (4.5.1)，除了在Eclipse基礎上做了更新之外，我們還更新了集成在MyEclipse上的第三方工具，比如STS, m2e, BIRT, Webtools, eGit等等。 Mars集成對Java的一些核心進行了改進，比如編譯器的...
  • PHP PDO函數庫詳解
    PDO是一個“資料庫訪問抽象層”，作用是統一各種資料庫的訪問介面，與mysql和mysqli的函數庫相比，PDO讓跨資料庫的使用更具有親和力；與ADODB和MDB2相比，PDO更高效。目前而言，實現“資料庫抽象層”任重而道遠，使用PDO這樣的“資料庫訪問抽象層”是一個不錯的選擇。 PDO中包含三個預
  • 抓包獲得東北大學的課程表，考試成績
    假期本想要嘗試做一些不同的事，卻一直荒廢，偶然看到了幕課，頓時後悔，再借我一個假期，一定在幕課上認真學習。比自己看書效率高很多啊！ 於是反正無聊，用了一個晚上瞭解了一下python（僅限於瞭解），總想做點啥有意思的，想來想去還是和抓包聯繫上了。 鑒於Wireshark我是真不怎麼會用，這次抓包用的軟
  • myeclipse10安裝findbugs
    嘗試過myeclipse10環境下，線上安裝findbugs，插件包是能下載到指定目錄下，可是由於版本問題，findbugs插件是不能使用的。所以才有了下麵的離線安裝
  • 數據可視化（二）
    本文來源：https://www.dataquest.io/mission/132/data-visualization-and-exploration 本文數據來源https://github.com/fivethirtyeight/data/blob/master/college-majors/...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類