Loading

Composer使用

是什么

如果你知道yumapt-getnpmbower等命令中的一种或者多种,那么,你也能很快知道composer是什么了。没错,它就是PHP里快速安装类库的。平时,我们安装一个PHP类库,需要搜索->下载;使用composer,我们只要知道包名,直接composer insatll就可以了。

PHP 语言本身就带有强大的网络功能、文件管理功能和丰富的系统 API,Composer 也只是一段 PHP 脚本而已。

引自Composer中文网的描述:

是 PHP 用来管理依赖(dependency)关系的工具。你可以在自己的项目中声明所依赖的外部工具库(libraries),Composer 会帮你安装这些依赖的库文件。

作用

安装PHP包、依赖库。

示例:

$ composer require monolog/monolog

这是在安装monolog库。

$ composer create-project laravel/laravel learnlaravel5 5.0.22

这是在安装laravel框架并创建项目。

YII框架也是通过composer安装的。

为什么用composer

通过过composer,我们可以使用大量的第三方库,而无需自己造轮子。优秀项目示例:

  • overtrue/wechat 让微信开发更简单!
  • catfan/medoo 一款ORM框架
  • monolog/monolog 日志记录
  • hprose/hprose RPC框架

你可以在 https://packagist.org/ 找到你需要的库。甚至你可以提交自己写的优秀的库到该平台里供大家使用。

如果不会composer,流行的laravelyii框架安装都成为问题,更不用谈学习了;很多优秀的轮子你无法使用。所以,推荐phper必须学会composer。

安装Composer

先下载composer.phar:

wget https://mirrors.aliyun.com/composer/composer.phar

其它下载源详见后文"Composer镜像加速"。

各系统按照下面的操作执行安装:

Linux/Mac:

mv composer.phar /usr/local/bin/composer
chmod +x /usr/local/bin/composer

Windows:
下载后放到php安装位置里,然后新建文件:

composer.bat #windows用
composer #git-bash用

composer.bat

@ECHO OFF
php "%~dp0composer.phar" %*

composer

#!/bin/sh

dir=$(d=$(dirname "$0"); cd "$d" && pwd)

# see if we are running in cygwin by checking for cygpath program
if command -v 'cygpath' >/dev/null 2>&1; then
	
	# cygwin paths start with /cygdrive/ which will break windows PHP,
	# so we need to translate the dir path to windows format. However
	# we could be using cygwin PHP which does not require this, so we
	# test if the path to PHP starts with /cygdrive/ rather than /usr/bin.
	if [[ $(which php) == /cygdrive/* ]]; then
  		dir=$(cygpath -m $dir);
  	fi
fi

dir=$(echo $dir | sed 's/ /\ /g')
php "${dir}/composer.phar" $*

如果上述链接下载不了,请使用: http://pan.baidu.com/s/1gfmSIbD 密码: f4vr 。

我还专门建了github仓库:https://github.com/52fhy/composer。

Linux需要给composer可执行权限。之后就可以使用composer了:

$ composer -V
 Composer version 1.9-dev (1.9-dev+e022c073706769d0486de96de0f98719cd9950b5) 2019-06-27 12:06:49

生成一个空的Composer项目

在合适的地方新建一个文件夹,命名为 MFFC(My First Framework based on Composer),在文件夹下新建文件 composer.json

{
  "require": {
  }
}

命令行切换到 MFFC 目录下,运行:

composer update

就会在该目录下生成一个vendor文件夹。以后所有的第三扩展包都会安装在这里。

里面的代码大家可以看看。

安装扩展包

以下以monolog为例:

声明依赖

在项目目录下创建一个composer.json文件,指明依赖,比如,你的项目依赖 monolog:

{
    "require": {
        "monolog/monolog": "1.2.*"
    }
}

如果不需要使用https,可以这么写,以解决有时候因为https造成的问题:

{
    "require": {
        "monolog/monolog": "1.2.*"
    },
    "config": {
        "secure-http": false
    }
}

安装依赖

安装依赖非常简单,只需在项目目录下运行:

composer install

如果没有全局安装的话,则运行:

php composer.phar install

更新全部的包(谨慎使用):

composer update

注意:使用composer install或者composer update命令将会更新所有的扩展包,项目中使用需谨慎!!!

若只安装指定的包推荐在命令行使用:

composer require monolog/monolog

进行安装。

如果需要指定版本:

composer require "monolog/monolog:1.2.*"

更新某个包:

composer update monolog/monolog

移除某个包:

composer remove monolog/monolog

如果手动更新了composer.json需要更新autoload:

composer dump-autoload

包版本约束

精确版本:示例: 1.0.2

范围:使用比较操作符你可以指定包的范围。这些操作符包括:>,>=,<,<=,!=。你可以定义多个范围,使用空格 或者逗号,表示逻辑上的与,使用双竖线||表示逻辑上的或。其中与的优先级会大于或。示例:

>=1.0
>=1.0 <2.0
>=1.0 <1.1 || >=1.2

范围(使用连字符):
例子:1.0 - 2.0,等同于>=1.0.0 <2.1(2.0相当于2.0.*)。

通配符:可以使用通配符去定义版本。1.0.*相当于>=1.0 <1.1
例子:1.0.*

下一个重要版本操作符:使用波浪号~。示例:
~1.2相当于>=1.2 <2.0.0,而~1.2.3相当于>=1.2.3 <1.3.0

折音号^:例如,^1.2.3相当于>=1.2.3 <2.0.0,因为在2.0版本前的版本应该都没有兼容性的问题。而对于1.0之前的版本,这种约束方式也考虑到了安全问题,例如^0.3会被当作>=0.3.0 <0.4.0对待。

自动加载

Composer提供了自动加载的特性,只需在你的代码的初始化部分中加入下面一行:

require 'vendor/autoload.php';

详细示例

{
	"require": {
		"php": ">=5.4.0",
		"illuminate/database": "*",
		"monolog/monolog": "1.2.*"
	},
	"config": {
		"secure-http": false
	},
	"autoload": {
		"classmap": [
		  "app/models"
		],
		"files": [
			"vendor/yjc/src/Alipay/autoload.php"
			],
		"psr-4": {
			"Yjc\\Sms\\": "vendor/yjc/src/Sms"
		}
	}
}

autoload部分指定自动加载的文件夹,每次里面的文件有新增,使用composer dump-autoload即可。

详见:http://docs.phpcomposer.com/03-cli.html#dump-autoload

命令汇总

composer list  列出所有可用的命令
composer init   初始化composer.json文件(就不劳我们自己费力创建啦),会要求输入一些信息来描述我们当前的项目,还会要求输入依赖包
composer install  读取composer.json内容,解析依赖关系,安装依赖包到vendor目录下
composer update   更新最新的依赖关系到compsoer.lock文件,解析最新的依赖关系并且写入composer.lock文件
composer search packagename 搜索包,packagename替换为你想查找的包名称
composer require packagename 添加对packagename的依赖,packagename可修改为你想要的包名称
composer show packagename
composer self-update 更新 composer.phar文件自身
composer dump-autoload --optimize 优化一下自动加载

composer command --help 以上所有命令都可以添加 --help选项查看帮助信息

更多可用命令,可以在命令行输入composer进行查看。

模块仓库

packagist.org是Composer的仓库,很多著名的PHP库都能在其中找到。你也可以提交你自己的作品

当你安装完Composer后,使用时,却发现不能下载包,或者很慢,这是一个『众所周知』的原因。

所以,我们使用国内的镜像站点进行代替,常用方法有两种:

1、修改全局配置:全局配置的文件一般放在C:\Users\XXX\AppData\Roaming\Composer\config.json,例如C:\Users\YJC\AppData\Roaming\Composer\config.json
(这里以windows路径为例)。可以通过命令composer config -l查看配置,其中[home]为配置所在目录。config.json即为配置文件。

{
    "config": {

    },
    "repositories": [
        {"type": "composer", "url": "http://pkg.phpcomposer.com/repo/packagist/"},
        {"packagist": false}
    ]
}

或者命令行直接修改:

composer config -g repo.packagist composer https://packagist.phpcomposer.com

2、修改当前配置:即项目当前的composer.json文件;

{
  "require": {
  	"noahbuscher/macaw": "dev-master"
  },
  "repositories": [
        {   
            "packagist": false
        },  
        {   
            "type": "composer", 
            "url": "http://packagist.cn"
        }   
    ]
}

3、常见镜像地址:
https://packagist.org 国外的
http://packagist.phpcomposer.com 中国全量镜像

推荐的包

overtrue/wechat 让微信开发更简单!
thenbsp/wechat
catfan/medoo
illuminate/database
psr/log
monolog/monolog
symfony/event-dispatcher
phpunit/phpunit
phpunit/php-timer
michelf/php-markdown markdown 文档解析
intervention/image 图片处理
mytharcher/alipay-php-sdk

更多查看:https://packagist.org/explore/popular

发布自己的包

大概步骤如下:

在github上创建一个项目(项目名称可以随意)
编写composer.json
copy代码文件并修改命名空间
在https://packagist.org/上递交自己的包
设置github的hook

编写composer.json
先看一个示例:

{
    "name": "jenner/message_queue",
    "description": "php message queue wrapper",
    "license": "MIT",
    "keywords": ["message queue"],
    "version": "1.0.0",
    "authors": [
        {
            "name": "Jenner",
            "email": "hypxm@qq.com"
        }
    ],
    "require": {
        "php": ">=5.3.0"
    },
 
    "autoload": {
        "psr-0": {
            "Jenner\\Zebra\\MessageQueue": "src/"
        }
    }
}

需要注意的几个字段说明如下:

name:包名称,递交时packagist会检测报名字是否合法。必须是一个/分隔的字符串。当别人引入你的包时,vendor下会自动创建这个目录。例如org/package包,则会在vender下创建org/package目录。

autoload:包的加载方式,具体加载方式可以参考composer中文网说明。这里使用的是psr-0标准加载方式。composer会在src目录下根据命名空间执行自动加载。

PSR规范

Framework Interoperability Group(框架可互用性小组),简称 FIG,成立于 2009 年。FIG 最初由几位知名 PHP 框架开发者发起,在吸纳了许多优秀的大脑和强健的体魄后,提出了 PSR-0 到 PSR-4 五套 PHP 非官方规范:

  1. PSR-0 (Autoloading Standard) 自动加载标准
  2. PSR-1 (Basic Coding Standard) 基础编码标准
  3. PSR-2 (Coding Style Guide) 编码风格向导
  4. PSR-3 (Logger Interface) 日志接口
  5. PSR-4 (Improved Autoloading) 自动加载优化标准

之后,在此标准之上,Composer 横空出世!Composer 利用 PSR-0 和 PSR-4 以及 PHP5.3 的命名空间构造了一个繁荣的 PHP 生态系统。Composer 类似著名的 npm 和 RubyGems,给海量 PHP 包提供了一个异常方便的协作通道,Composer Hub 地址:https://packagist.org/。Composer 中文网站:http://www.phpcomposer.com/。

目前 PHP 界风头正劲的 Laravel 和 Symfony 均直接基于 Composer,大家耳熟能详著名框架 CI 和 Yii 的正开发版本 CodeIgniter 3 和 Yii 2 也都基于 Composer(更新:北京时间2014年10月13日 Yii 2 已经发布)。Composer 就是 PHP 框架的未来,有了它,让 CI 的路由和 Laravel 的 Eloquent ORM 协作就会变的非常简单。

常见问题

1、Windows下出现:Fxp\Composer\AssetPlugin\Repository\NpmRepository does not exist
进入C:\Users\YJC\AppData\Roaming\Composer目录,删除vendor目录。

Composer镜像加速

设置镜像

请尽可能用比较新的 Composer 版本。

使用 Composer 镜像加速有两种选项:

  • 选项一:全局配置,这样所有项目都能惠及(推荐);
  • 选项二:单独项目配置;

选项一、全局配置(推荐)

$ composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

选项二、单独使用

如果仅限当前工程使用镜像,去掉 -g 即可,如下:

$ composer config repo.packagist composer https://mirrors.aliyun.com/composer/

解除镜像

如果需要解除镜像并恢复到 packagist 官方源,请执行以下命令:

composer config -g --unset repos.packagist

执行之后,composer 会利用默认值(也就是官方源)重置源地址。

镜像源列表

参考

1、利用 Composer 一步一步构建自己的 PHP 框架(一)——基础准备 - 岁寒
https://lvwenhan.com/php/405.html

2、PHP 开发者该知道的 5 个 Composer 小技巧 - 新闻 - SegmentFault
https://segmentfault.com/a/1190000000355928

3、Composer 中文网
http://www.phpcomposer.com/

4、Packagist / Composer 中国全量镜像
http://pkg.phpcomposer.com/

5、Composer安装
https://getcomposer.org/download/

6、composer之创建自己的包 - 始终不够
http://www.huyanping.cn/composer之创建自己的包/

7、php - 请各位分享或推荐一下composer里面好用的包 - SegmentFault
https://segmentfault.com/q/1010000000484379

8、给 CI 插上翅膀——在 CodeIgniter 2 中使用 Laravel Eloquent ORM - 岁寒
https://lvwenhan.com/php/414.html

9、Composer进阶使用 —— 常用命令和版本约束 - icyfire - SegmentFault
https://segmentfault.com/a/1190000005898222

10、Composer 国内加速:可用镜像列表 | Composer 技术论坛
https://learnku.com/composer/wikis/30594

(本文完)

本文优先在公众号"飞鸿影的博客(fhyblog)"发布,欢迎关注公众号及时获取最新文章推送!

作者:飞鸿影

出处:http://52fhy.cnblogs.com/


版权申明:没有标明转载或特殊申明均为作者原创。本文采用以下协议进行授权,自由转载 - 非商用 - 非衍生 - 保持署名 | Creative Commons BY-NC-ND 3.0,转载请注明作者及出处。


posted @ 2016-03-05 21:52  飞鸿影  阅读(46181)  评论(5编辑  收藏  举报