Share
Embed
Begining Composer
大澤木小鐵
August 30, 2013
Transcript
109 slides
-
為什麼要⽤用 Composer •仿 npm / gem 的套件相依管理 •針對專案的套件做管理 •可以檢查執⾏行環境 •設定檔編寫簡單
(JSON) •⽀支援⽤用常⾒見的版本控制系統做為 套件下載來源 (SVN / GIT) -
套件如何組織? root package package 1 package 2 package 3
我們的專案相依了三個套件 -
套件如何組織? root package package 1 package 2 package 3
package 5 package 4 package 6 package 2 則⼜又相依其他套件 -
套件如何組織? root package package 1 package 2 package 3
package 5 package 4 package 6 在 root package 操作就好 Composer 會協助我們處理剩下的相依問題 -
• composer 的 package 基本上可分為 • application :應⽤用程式 •
library :函式庫 • application 通常是 root-‐package • application 通常相依多個 libraries • library 也有可能相依多個 libraries ⼩小提醒 -
*nix 環境安裝 $ curl -sS https://getcomposer.org/installer | php 下載官⽅方的安裝指令,並透過 PHP
安裝 通常會安裝在專案根⺫⽬目錄下, 安裝好的檔案為 composer.phar -
*nix 環境安裝 $ curl -sS https://getcomposer.org/installer | php $ php
composer.phar <command> 在專案根⺫⽬目錄下,透過 php 來執⾏行 composer.phar -
*nix 環境安裝 $ curl -sS https://getcomposer.org/installer | php $ php
composer.phar <command> $ sudo mv composer.phar /user/local/bin/composer 如果希望讓所有⼈人都可以使⽤用 composer 就將 composer.phar 搬到共⽤用執⾏行⺫⽬目錄, 例如 /usr/local/bin -
*nix 環境安裝 $ curl -sS https://getcomposer.org/installer | php $ php
composer.phar <command> $ sudo mv composer.phar /user/local/bin/composer $ composer <command> 這樣就可以直接執⾏行 composer 若不能執⾏行,則要以 chmod 加⼊入可執⾏行權限 -
初始化 $ cd /path/to/project $ composer init • name •
description • authors • minimum-‐stability • license • require • require-‐dev -
name • 格式: "vendor/package-‐name" • vendor :開發者 (公司) 名稱 •
package-‐name :套件名稱 http://getcomposer.org/doc/04-schema.md#name -
authors • 格式: "Name <email>" • 可以有多個 author (需⼿手動加⼊入) •
預設抓取 ~/.gitconfig 的設定 http://getcomposer.org/doc/04-schema.md#authors -
minimum-stability • ⽤用來過濾相依套件穩定度的設定 • 只能⽤用在 root-‐package • 可設定的值: (由最穩定到最不穩定的順序)
• stable (預設) • RC • beta • alpha • dev • 相依的套件之穩定度不可低於設定值 http://getcomposer.org/doc/04-schema.md#minimum-stability -
license • 指定套件的授權 • 可參考 SPDX 的 identifier 來設定 •
Apache-‐2.0 • BSD-‐2-‐Clause • MIT • ... • 私有專案可⽤用 proprietary http://spdx.org/licenses/ http://getcomposer.org/doc/04-schema.md#minimum-stability -
require • 格式: "vendor/package-‐name": "version" • 指定專案⼀一定要安裝的套件或平台環境 • 如果現存的套件版本不符合 version
條件的話, 就不會安裝任何套件 http://getcomposer.org/doc/04-schema.md#require -
{ "name": "jaceju/first-‐app", "description":
"My First Application", "require": { "psr/log": "*" }, "require-‐dev": { "phpunit/phpunit": ">= 3.7.0" }, "license": "MIT", "authors": [ { "name": "Jace Ju", "email": "[email protected]" } ], "minimum-‐stability": "dev" } composer.json -
套件版本的規則 http://getcomposer.org/doc/01-basic-usage.md#package-versions • 數字版本以 semantic versioning ⽅方式指定 • 版本號寫法分為: •
Exact version :明確指定版本,例如 "1.0.1" • Range :指定版本範圍,可⽤用 ">", ">=", "<", "<=" 及 "!=" ,以 "," 分隔 例如 ">= 1.0.1" 或 ">= 1.0, < 2.0" • Wildcard :萬⽤用字元,例如 "1.0.*" , 等同於 ">= 1.0, < 1.1" • Next Significant Release :下⼀一個重要版本; 即版本號倒數第⼆二位數字加 1 ,例如: "~1.2" ,等同於 ">= 1.2, < 2.0" ; "~1.3.1" ,等同於 ">= 1.3.1, < 1.4.0" -
其他規則 http://getcomposer.org/doc/04-schema.md#package-links • 在版本號後⾯面加上 @<statibility> ,⾮非必要; 例如: "1.0.*@beta" 或 "@dev"
• 分⽀支表⽰示法: <statibility>-‐<branch> ; 例如: "dev-‐master" • 版號表⽰示法: #<ref> ; 例如:"dev-‐master#2eb0c..." 或 "1.0.x-‐dev#abc123" -
$ composer install Loading composer repositories with package information Installing
dependencies (including require-‐dev) -‐ Installing psr/log (dev-‐master fe0936e) Cloning fe0936ee26643249e916849d48e3a51d5f5e278b -‐ Installing sebastian/diff (dev-‐master 1e09170) Cloning 1e091702a5a38e6b4c1ba9ca816e3dd343df2e2d (中略) -‐ Installing phpunit/phpunit (dev-‐master 900b501) Cloning 900b501d8bd3e80da58dc6ff3cc9b01393149717 phpunit/phpunit-‐mock-‐objects suggests installing ext-‐soap (*) phpunit/phpunit suggests installing phpunit/php-‐invoker (>=1.1.0) Writing lock file Generating autoload files -
全新安裝 (專案負責⼈人) composer.json Generate composer.lock Download list Download package 產⽣生
composer.lock 並記住每個套件在此次安裝時的版本, 這樣⼀一來就不⽤用再從清單裡找符合的版本 -
全新安裝 (專案負責⼈人) composer.json Generate composer.lock Download list Download package Generate
autoloading files 將所有相依套件的⾃自動載⼊入設定 加到快取檔案中 -
$ composer update Loading composer repositories with package information Updating
dependencies (including require-‐dev) Generating autoload files 類似第⼀一次 install 的動作,但會找符合條件且較新的版本 -
⼩小提醒 • 只有專案負責⼈人才做第⼀一次 install 及之後的 update (會更動 composer.lock )
• 其他成員⼀一律使⽤用 install • 第⼀一次 install 及之後的 update 會將所有 相依套件的資訊編寫到 composer.lock 上, 並固定套件版本 • -‐-‐prefer-‐source :從版本控制下載 • -‐-‐prefer-‐dist :下載壓縮檔 -
• root-‐package 的 composer.json 及 composer.lock 要放到版本控制系統 裡,這麼⼀一來其他成員可以直接使⽤用 •
library 的 composer.lock 則不要放 到版本控制系統中 • vendor 資料夾不要放到版本控制系統, 應該⽤用 composer install 安裝 版本控制 -
• 記錄常⾒見的 Open Source library 資訊 • 預設 composer 搜尋套件的地⽅方
• 不須審核,⼈人⼈人都可以註冊⾃自⼰己的套件 • 不是實際存放套件內容的地⽅方 packagist.org -
$ composer require Search for a package []: phpunit Found
15 packages matching phpunit [0] phpunit/phpunit [1] phpunit/phpunit-‐mock-‐objects .... [14] ezzatron/phpunit-‐extensions Enter package # to add, or the complete package name if it is not listed []: 0 Enter the version constraint to require []: >= 3.7.0 Search for a package []: -
⼩小提醒 • -‐-‐dev :安裝開發⽤用的套件 • -‐-‐no-‐update :不直接安裝套件 • composer show
-‐i 可以看⺫⽬目前安裝的套件 -
PHP 平台、 Extension 與系統函式庫 root package PHP 5.3 ext-‐xdebug
2.3.3 ext-‐http 1.7.6 lib-‐openssl 0.9.8 -
類型 • php : PHP 平台 • ext-‐<name> :以 PECL
安裝之套件 • lib-‐<name> :系統函式庫 • composer show -‐-‐platform : 查看⺫⽬目前平台的套件 http://getcomposer.org/doc/02-libraries.md#platform-packages -
composer.json 寫法 "require": { "php": ">= 5.3",
"ext-‐xdebug": ">= 2.3.3", "ext-‐http": ">= "1.7.6", "lib-‐openssl": ">= 0.9.8" } 需要⼿手動加⼊入 -
來源類型 Composer VCS PEAR 在 packagist.org 管理的套件 (預設) 以 GIT
/ SVN / HG 管理的套件 以 PEAR 管理的套件 http://getcomposer.org/doc/05-repositories.md -
VCS (GIT) 的 composer.json 寫法 { "require":
{ "vendor/private-‐repo": "dev-‐master" }, "repositories": [ { "type": "vcs", "url": "[email protected]:vendor/private-‐repo.git" } ] } 針對私有的 git 專案採⽤用的寫法 -
• repositories 只作⽤用在 root-‐package 上 • 所以就算在相依套件的 composer.json 有定義
repositories ,也不會被 composer 取⽤用 • 必須在 root-‐package 的 composer.json 中 定義所有的套件來源 ⼩小提醒 http://getcomposer.org/doc/05-repositories.md -
• 統⼀一⾃自動載⼊入的⽅方法 • 每個 Package 的⺫⽬目錄結構不⾒見得相同 • 讓 Package ⾃自⾏行提供載⼊入⽅方式
為什麼 Composer 要提供⾃自動載⼊入? -
composer.json 寫法 { "autoload": {
"psr-‐0": { "Monolog\\": ["src/", "lib/"], "Zend_": "library/" }, "classmap": [ "classes/", "Something.php" ], "files": ["src/MyLibrary/functions.php"] } } -
loader 寫法 // Composer autoloading include 'vendor/autoload.php'; /* @var $loader
Composer\Autoload\ClassLoader */ var_dump(new Zend\Http\Client()); -
• autoload 採相對於 composer.json 的路徑 • 每個套件只需負責⾃自⼰己的 autoload • 在
root-‐package 執⾏行: composer dump-‐autoload 就會把所有相依套件的 autoload 屬性 編譯到 vendor ⺫⽬目錄裡的快取檔案 • 載⼊入 loader 之後就不⽤用⾃自⾏行引⽤用類別定義檔 • MVC Framework 只要在 index.php 載⼊入 loader 即可 ⼩小提醒 http://getcomposer.org/doc/04-schema.md#autoload -
• Namespace 類別名稱格式: Vendor\Package\Class • PEAR-‐like 類別名稱格式: Vendor_Package_Class • "Vendor\",
"Vendor\Package", "Vendor_", "Vendor_Package_" 統稱為 Prefix Namespace vs. PEAR-like -
以 ZF1 與 ZF2 為例 /path/to/zf1/library/ /Zend/Http/Client.php vendor/zendframework/ zendframework/library/ Zend/Http/Client.php
Composer ClassLoader ZF1: Zend_Http_Client ZF2: Zend\Http\Client Composer 提供的 ClassLoader ⽤用了 SPL 的⾃自動載⼊入功能 可以幫我們⾃自動載⼊入類別檔案 -
以 ZF1 與 ZF2 為例 /path/to/zf1/library/ /Zend/Http/Client.php vendor/zendframework/ zendframework/library/ Zend/Http/Client.php
Composer ClassLoader 'Zend_' => '/path/to/zf1/library' ZF1: Zend_Http_Client ZF2: Zend\Http\Client 告訴 ClassLoader ZF1 的類別要去哪裡找 新增 Prefix 的路徑對應 -
以 ZF1 與 ZF2 為例 /path/to/zf1/library/ /Zend/Http/Client.php vendor/zendframework/ zendframework/library/ Zend/Http/Client.php
Composer ClassLoader 'Zend_' => '/path/to/zf1/library' ZF1: Zend_Http_Client ZF2: Zend\Http\Client -
以 ZF1 與 ZF2 為例 /path/to/zf1/library/ /Zend/Http/Client.php vendor/zendframework/ zendframework/library/ Zend/Http/Client.php
Composer ClassLoader 'Zend_' => '/path/to/zf1/library' ZF1: Zend_Http_Client ZF2: Zend\Http\Client -
以 ZF1 與 ZF2 為例 /path/to/zf1/library/ /Zend/Http/Client.php vendor/zendframework/ zendframework/library/ Zend/Http/Client.php
Composer ClassLoader 'Zend_' => '/path/to/zf1/library' ZF1: Zend_Http_Client ZF2: Zend\Http\Client PEAR-like 使⽤用 Prefix 定義 -
以 ZF1 與 ZF2 為例 ZF1: Zend_Http_Client ZF2: Zend\Http\Client /path/to/zf1/library/
/Zend/Http/Client.php vendor/zendframework/ zendframework/library/ Zend/Http/Client.php Composer ClassLoader 'Zend_' => '/path/to/zf1/library' -
以 ZF1 與 ZF2 為例 ZF1: Zend_Http_Client ZF2: Zend\Http\Client /path/to/zf1/library/
/Zend/Http/Client.php vendor/zendframework/ zendframework/library/ Zend/Http/Client.php Composer ClassLoader 'Zend_' => '/path/to/zf1/library' -
以 ZF1 與 ZF2 為例 ZF1: Zend_Http_Client ZF2: Zend\Http\Client /path/to/zf1/library/
/Zend/Http/Client.php vendor/zendframework/ zendframework/library/ Zend/Http/Client.php Composer ClassLoader 'Zend_' => '/path/to/zf1/library' Namespace 則使⽤用預設 vendor 路徑 -
並存的 loader 寫法 // 定義 ZF1 的 library 路徑 $zf1Path
= getenv('ZF1_PATH'); if (!$zf1Path) { $zf1Path = dirname(__DIR__) . '/zf1/library'; } // ZF1 的路徑需要加到 include_path 給 Zend/Loader.php ⽤用 $includePath = implode(PATH_SEPARATOR, array( $zf1Path, )); set_include_path($includePath); // Composer autoloading if (file_exists('vendor/autoload.php')) { $loader = include 'vendor/autoload.php'; /* @var $loader Composer\Autoload\ClassLoader */ $loader-‐>add('Zend_', $zf1Path); } var_dump(new Zend_Http_Client()); var_dump(new Zend\Http\Client()); -
• 預設會以 vendor 下定義的 namespace 來抓取類別定義檔案 • 先試 Namespace
,再試 PEAR-‐like style • Prefix 有沒有底線不重要 例如 'Zend' 或 'Zend_' 是⼀一樣的;加上底線 主要是為了判斷它是不是 PEAR-‐like ⼩小提醒 -
• Skeleton 是⼀一個將⺫⽬目錄結構和檔案定義好的專案 • 部份 MVC Framework 直接提供下載包 • 部份
MVC Framework ⽤用 generator 產⽣生 • 較新的 MVC Framework 可透過 Composer 的 create-‐project 指令來下載 為什麼需要 Skeleton ? -
Laravel Skeleton $ composer create-project \ laravel/laravel \ --prefer-dist Laravel
直接使⽤用 packagist 上的套件定義 http://laravel.com/docs/installation -
ZF2 Skeleton $ composer create-project \ --repository-url=\ "https://packages.zendframework.com" \ -s
dev \ zendframework/skeleton-application \ path/to/install ZF2 使⽤用 Zend 官⽅方⾃自⼰己的套件系統 http://framework.zend.com/manual/2.2/en/user-guide/skeleton-application.html -
• Skeleton 通常是⼀一個 root-‐package • composer create-‐project 預設抓取 packagist.org
的套件 • 可以⽤用 satis 架設私⼈人的 package-‐repository 重點說明 https://github.com/composer/satis