『壹』 thinkphp應用怎麼通過composer載入第三方庫
直接在入口文件中包含composer的autoload腳本
Composer
是PHP的一個包依賴管理工具,類似Ruby中的RubyGems或者Node中的NPM,它並非官方,但現在已經非常流行。此文並不介紹如何使用Composer,而是關注於它的autoload的內容吧。
舉例來說,假設我們的項目想要使用 monolog 這個日誌工具,就需要在composer.json里告訴composer我們需要它:
{
"require": {
"monolog/monolog": "1.*"
}
}
之後執行:
php composer.phar install
好,現在安裝完了,該怎麼使用呢?Composer自動生成了一個autoload文件,你只需要引用它
require '/path/to/vendor/autoload.php';
然後就可以非常方便的去使用第三方的類庫了,是不是感覺很棒啊!對於我們需要的monolog,就可以這樣用了:
use MonologLogger;
use MonologHandlerStreamHandler;
// create a log channel
$log = new Logger('name');
$log->pushHandler(new StreamHandler('/path/to/log/log_name.log', Logger::WARNING));
// add records to the log
$log->addWarning('Foo');
$log->addError('Bar');
在這個過程中,Composer做了什麼呢?它生成了一個autoloader,再根據各個包自己的autoload配置,從而幫我們進行自動載入的工作。(如果對autoload這部分內容不太了解,可以看我之前的
一篇文章
)接下來讓我們看看Composer是怎麼做的吧。
對於第三方包的自動載入,Composer提供了四種方式的支持,分別是
PSR-0和PSR-4的自動載入(我的一篇文章也有介紹過它們),生成class-map,和直接包含files的方式。
PSR-4是composer推薦使用的一種方式,因為它更易使用並能帶來更簡潔的目錄結構。在composer.json里是這樣進行配置的:
{
"autoload": {
"psr-4": {
"Foo\": "src/",
}
}
}
key和value就定義出了namespace以及到相應path的映射。按照PSR-4的規則,當試圖自動載入 "Foo\Bar\Baz"
這個class時,會去尋找 "src/Bar/Baz.php" 這個文件,如果它存在則進行載入。注意,
"Foo\"
並沒有出現在文件路徑中,這是與PSR-0不同的一點,如果PSR-0有此配置,那麼會去尋找
"src/Foo/Bar/Baz.php"
這個文件。
另外注意PSR-4和PSR-0的配置里,"Foo\"結尾的命名空間分隔符必須加上並且進行轉義,以防出現"Foo"匹配到了"FooBar"這樣的意外發生。
在composer安裝或更新完之後,psr-4的配置換被轉換成namespace為key,dir path為value的Map的形式,並寫入生成的
vendor/composer/autoload_psr4.php 文件之中。
{
"autoload": {
"psr-0": {
"Foo\": "src/",
}
}
}
最終這個配置也以Map的形式寫入生成的
vendor/composer/autoload_namespaces.php
文件之中。
Class-map方式,則是通過配置指定的目錄或文件,然後在Composer安裝或更新時,它會掃描指定目錄下以.php或.inc結尾的文件中的class,生成class到指定file
path的映射,並加入新生成的 vendor/composer/autoload_classmap.php 文件中,。
{
"autoload": {
"classmap": ["src/", "lib/", "Something.php"]
}
}
例如src/下有一個BaseController類,那麼在autoload_classmap.php文件中,就會生成這樣的配置:
'BaseController' => $baseDir . '/src/BaseController.php'
Files方式,就是手動指定供直接載入的文件。比如說我們有一系列全局的helper
functions,可以放到一個helper文件里然後直接進行載入
{
"autoload": {
"files": ["src/MyLibrary/functions.php"]
}
}
它會生成一個array,包含這些配置中指定的files,再寫入新生成的
vendor/composer/autoload_files.php
文件中,以供autoloader直接進行載入。
下面來看看composer autoload的代碼吧
<?php
// autoload_real.php @generated by Composer
class
{
private static $loader;
public static function loadClassLoader($class)
{
if ('ComposerAutoloadClassLoader' === $class) {
require __DIR__ . '/ClassLoader.php';
}
}
public static function getLoader()
{
if (null !== self::$loader) {
return self::$loader;
}
spl_autoload_register(array('', 'loadClassLoader'), true, true);
self::$loader = $loader = new ComposerAutoloadClassLoader();
spl_autoload_unregister(array('', 'loadClassLoader'));
$vendorDir = dirname(__DIR__); //verdor第三方類庫提供者目錄
$baseDir = dirname($vendorDir); //整個應用的目錄
$includePaths = require __DIR__ . '/include_paths.php';
array_push($includePaths, get_include_path());
set_include_path(join(PATH_SEPARATOR, $includePaths));
$map = require __DIR__ . '/autoload_namespaces.php';
foreach ($map as $namespace => $path) {
$loader->set($namespace, $path);
}
$map = require __DIR__ . '/autoload_psr4.php';
foreach ($map as $namespace => $path) {
$loader->setPsr4($namespace, $path);
}
$classMap = require __DIR__ . '/autoload_classmap.php';
if ($classMap) {
$loader->addClassMap($classMap);
}
$loader->register(true);
$includeFiles = require __DIR__ . '/autoload_files.php';
foreach ($includeFiles as $file) {
($file);
}
return $loader;
}
}
function ($file)
{
require $file;
}
首先初始化ClassLoader類,然後依次用上面提到的4種載入方式來注冊/直接載入,ClassLoader的一些核心代碼如下:
/**
* @param array $classMap Class to filename map
*/
public function addClassMap(array $classMap)
{
if ($this->classMap) {
$this->classMap = array_merge($this->classMap, $classMap);
} else {
$this->classMap = $classMap;
}
}
/**
* Registers a set of PSR-0 directories for a given prefix,
* replacing any others previously set for this prefix.
*
* @param string $prefix The prefix
* @param array|string $paths The PSR-0 base directories
*/
public function set($prefix, $paths)
{
if (!$prefix) {
$this->fallbackDirsPsr0 = (array) $paths;
} else {
$this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
}
}
/**
* Registers a set of PSR-4 directories for a given namespace,
* replacing any others previously set for this namespace.
*
* @param string $prefix The prefix/namespace, with trailing '\'
* @param array|string $paths The PSR-4 base directories
*
* @throws InvalidArgumentException
*/
public function setPsr4($prefix, $paths)
{
if (!$prefix) {
$this->fallbackDirsPsr4 = (array) $paths;
} else {
$length = strlen($prefix);
if ('\' !== $prefix[$length - 1]) {
throw new InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
}
$this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
$this->prefixDirsPsr4[$prefix] = (array) $paths;
}
}
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
*/
public function register($prepend = false)
{
spl_autoload_register(array($this, 'loadClass'), true, $prepend);
}
/**
* Loads the given class or interface.
*
* @param string $class The name of the class
* @return bool|null True if loaded, null otherwise
*/
public function loadClass($class)
{
if ($file = $this->findFile($class)) {
includeFile($file);
return true;
}
}
/**
* Finds the path to the file where the class is defined.
*
* @param string $class The name of the class
*
* @return string|false The path if found, false otherwise
*/
public function findFile($class)
{
//這是PHP5.3.0 - 5.3.2的一個bug 詳見https://bugs.php.net/50731
if ('\' == $class[0]) {
$class = substr($class, 1);
}
// class map 方式的查找
if (isset($this->classMap[$class])) {
return $this->classMap[$class];
}
//psr-0/4方式的查找
$file = $this->findFileWithExtension($class, '.php');
// Search for Hack files if we are running on HHVM
if ($file === null && defined('HHVM_VERSION')) {
$file = $this->findFileWithExtension($class, '.hh');
}
if ($file === null) {
// Remember that this class does not exist.
return $this->classMap[$class] = false;
}
return $file;
}
private function findFileWithExtension($class, $ext)
{
// PSR-4 lookup
$logicalPathPsr4 = strtr($class, '\', DIRECTORY_SEPARATOR) . $ext;
$first = $class[0];
if (isset($this->prefixLengthsPsr4[$first])) {
foreach ($this->prefixLengthsPsr4[$first] as $prefix => $length) {
if (0 === strpos($class, $prefix)) {
foreach ($this->prefixDirsPsr4[$prefix] as $dir) {
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $length))) {
return $file;
}
}
}
}
}
// PSR-4 fallback dirs
foreach ($this->fallbackDirsPsr4 as $dir) {
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
return $file;
}
}
// PSR-0 lookup
if (false !== $pos = strrpos($class, '\')) {
// namespaced class name
$logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
. strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
} else {
// PEAR-like class name
$logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext;
}
if (isset($this->prefixesPsr0[$first])) {
foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
if (0 === strpos($class, $prefix)) {
foreach ($dirs as $dir) {
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
return $file;
}
}
}
}
}
// PSR-0 fallback dirs
foreach ($this->fallbackDirsPsr0 as $dir) {
if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
return $file;
}
}
// PSR-0 include paths.
if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
return $file;
}
}
/**
* Scope isolated include.
*
* Prevents access to $this/self from included files.
*/
function includeFile($file)
{
include $file;
『貳』 怎麼使用php 包依賴管理工具 composer 執行命令安裝
CentOS7下安裝Composer安裝Composer1、將composer.phar下載到項目中使用curl-sShttps://getcomposer.org/installer|php下載Composer的二進制文件,是一個PHAR包(PHP的歸檔)2、可以通過--install-dir選項指定Composer的安裝目錄(它可以是一個絕對或相對路徑):curl-sShttps://getcomposer.org/installer|php----install-dir=lumen3、如果把composer.phar放在系統的PATH目錄中,就能在全局訪問composer.phar。在類Unix系統中,你甚至可以在使用時不加php前綴。可以執行這些命令讓composer在你的系統中進行全局調用:#mvcomposer.phar/usr/local/bin/composer現在只需要運行composer命令就可以使用Composer而不需要輸入phpcomposer.phar。4、檢查Composer是否正常工作,只需要通過php來執行PHAR:phpcomposer.phar這將返回給你一個可執行的命令列表。使用Composer要在項目中使用Composer,只需要一個composer.json文件。該文件包含了項目的依賴和其它的一些元數據。現在使用Composer來安裝項目的依賴。1、創建composer.json文件在當前目錄下創建composer.json文件,在composer.json文件中指定requirekey的值。簡單的告訴Composer你的項目需要依賴哪些包。例如:{"require":{"monolog/monolog":"1.0.*"}}可以看到,require需要一個包名稱monolog/monolog映射到包版本1.0.*的對象。包名稱由供應商名稱和其項目名稱構成。2、安裝依賴包執行install命令獲取定義的依賴到本地項目:phpcomposer.pharinstall如果你進行了全局安裝,並且沒有phar文件在當前目錄,使用下面的命令代替:composerinstall這將會找到monolog/monolog的最新版本,並將它下載到vendor目錄。這是一個慣例把第三方的代碼到一個指定的目錄vendor。如果是monolog將會創建vendor/monolog/monolog目錄。注意:install命令將創建一個composer.lock文件到你項目的根目錄中。3、自動載入除了庫的下載,Composer還准備了一個自動載入文件,它可以載入Composer下載的庫中所有的類文件。使用它,你只需要將下面這行代碼添加到你項目的引導文件中:require'vendor/autoload.php';現在我們就可以使用monolog了
『叄』 怎麼查找php包 composer
3、如果把composer.phar放在系統的 PATH 目錄中,就能在全局訪問composer.phar。 在類Unix系統中,你甚至可以在使用時不加 php 前綴。可以執行這些命令讓 composer 在你的系統中進行全局調用:
#mv composer.phar /usr/local/bin/composer
現在只需要運行 composer 命令就可以使用 Composer 而不需要輸入 php composer.phar。
4、檢查 Composer 是否正常工作,只需要通過 php 來執行 PHAR:php composer.phar這將返回給你一個可執行的命令列表。
使用 Composer
要在項目中使用 Composer,只需要一個 composer.json 文件。該文件包含了項目的依賴和其它的一些元數據。現在使用 Composer 來安裝項目的依賴。
1、創建 composer.json 文件
在當前目錄下創建 composer.json 文件,在 composer.json 文件中指定 require key 的值。簡單的告訴 Composer 你的項目需要依賴哪些包。
例如:
{ "require": { "monolog/monolog": "1.0.*" } }
可以看到, require 需要一個 包名稱 monolog/monolog映射到 包版本 1.0.*的對象。包名稱由供應商名稱和其項目名稱構成。