下面由composer教程栏目给大家关于composer.json的配置设置,希望对需要的朋友有所帮助!
配置文件的值为 key:val 必须双引号包裹
一、配置文件
名字 name
包名称由用户名名称和仓库名称组成
包版本限制来请求Monolog软件包 1.0.*。这意味着1.0开发分支中的任何版本,或大于或等于1.0且小于1.1(>=1.0 <1.1)的任何版
本。
描述 description
简短描述包装。通常这只是一行长。
包的版本 version
如果软件包存储库可以从某处推断版本,例如VCS存储库中的VCS标记名称,则可选。在这种情况下,建议省略它。
类型 type
建议省略此字段,并将其默认为library
关键字 keywords
这些可用于搜索和过滤,数组形式例如keywords: ["xunsearch", "search engine", "yii", "yii2"]
主页 homepage
项目网站的网址。
时间 time
版本发布日期,必须在YYYY-MM-DD或YYYY-MM-DD HH:MM:SS格式。
许可证 license
对于一个包,当许可证之间有一个选择(“分离许可”)时,可以将多个指定为数组。
分离许可证示例:
{ "license": [ "LGPL-2.1", "GPL-3.0+" ] }
或者,它们可以用“或”分隔并括在括号中;
{ "license": "(LGPL-2.1 or GPL-3.0+)" }
作者 authors
每个作者对象可以具有以下属性: 名称:作者姓名 通常他们的真名。 name 电子邮件:作者的电子邮件地址。 email 主页:作者网站的网址。 homepage 作用:作者在项目中的作用(如开发者或翻译者) role "authors": [ { "name": "Nils Adermann", "email": "naderman@naderman.de", "homepage": "http://www.naderman.de", "role": "Developer" }, { "name": "Jordi Boggiano", "email": "j.boggiano@seld.be", "homepage": "http://seld.be", "role": "Developer" } ]
支持 support
各种信息获得项目支持,支持信息包括以下内容:
电子邮件:电子邮件地址支持。email
问题:问题跟踪器的URL。 issues
论坛:论坛的 URL。 forum:
wiki:维基的 URL。 wiki
irc: IRC通道支持,如irc:// server / channel。 irc:
来源:浏览或下载源的 URL。 source
docs:文档的 URL。 docs
rss: RSS提要的URL。 rss
一个例子:
{ "support": { "email": "support@example.org", "irc": "irc://irc.freenode.org/composer" } }
建议 suggest
"suggest": { "monolog/monolog": "Allows more advanced logging of the application flow", "ext-xml": "Needed to support XML format in class Foo" }
archive 归档
此命令用来对指定包的指定版本进行 zip/tar 归档。它也可以用来归档你的整个项目,不包括 excluded/ignored(排除/忽略)的文件。
composer 命令:php composer.phar archive vendor/package 2.0.21 --format=zip
exclude:允许配置排除路径的模式列表。模式语法匹配.gitignore文件。领先的感叹号(!)将导致任何匹配的文件被包括,即使
以前的模式排除它们。领先的斜杠只能在项目相对路径的开始处匹配。星号不会扩展到目录分隔符。
设置创建包时的选项,exclude 属性可以设置排除哪些目录,例如:
"archive": { "exclude": ["/foo/bar", "baz", "/*.test", "!/foo/bar/baz"] }
bin文件
一组应该被视为二进制文件并符号链接到bin-dir (从config)的文件。
bin 文件相对于仓库包的目录地址
"bin": [
"util/xs"
]
二、依赖管理
软件包链接 require
require告诉composer你的项目所依赖的包
"require": { "php" : "^5.5 || ^7.0", "monolog/monolog": "1.0.*" }
require需要将包名称(例如monolog/monolog)映射 到版本约束(例如 1.0.*)的对象。
composer show –platform命令列出了系统上可用的所有PHP扩展
限制PHP版本[ php 版本要求 ]
"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是默认值。例如:"minimum-stability": "stable"
require-dev
有时候,我们会发现,有些包依赖只会在开发过程中使用,正式发布的程序不需要这些包,这个时候,就需要用到另外一个键,即
require-dev。例如,我们想用codeception进行单元测试,那么就可以通过require-dev引入这个开发环境下的依赖包:
"require-dev": { "codeception/codeception": "2.0.0 " }
加了这个依赖后,再运行下命令看看效果。
composer install
三、自动加载
自动加载lib目录下的OrderManager.php文件
1.使用Files方式(ps:通常作为函数库的载入方式(而非类库))
"autoload":{ "files":["lib/OrderManager.php"] }
files键对应的值是一个数组,数组元素是文件的路径,路径是相对于应用的根目录。加上上述内容后,运行命令:
composer dump-autoload
让composer重建自动加载的信息,完成之后,就可以在index.php里调用OrderManager类啦。
2.Classmap方式自动加载
通过文件引入的方法虽然直观,但是很费劲,每个文件都得引入一次,实在不是好的解决办法。有没有更好的办法呢?尝试将
autoload的值改成:
"autoload": { "classmap": ["src/", "lib/", "Something.php"] }
再此运行composer dump-autoload,尝试调用,依然能够成功创建OrderManager类。其实,classmap通过建立类到文件的对应关系,
当程序需要OrderManager类时,compoer的自动加载类通过查找OrderManager类所在的文件,然后再将改文件include进来。因此,这
又导致了一个问题,那就是每加一个新类,就需要运行一次composer dump-autoload来创建类到文件到对应关系。
从classmap中排除文件
如果要从类映射中排除某些文件或文件夹,可以使用“from-classmap”属性,这些类将从类映射中跳过
"autoload": { "exclude-from-classmap": ["/Tests/", "/test/", "/tests/"] }
3. PSR0/4加载方式
PSR-0,PSR-4,类文件都要求有个命名空间
PSR-0则规定类名中的下划线_会被转化成目录分隔符
namespace SilkLib; class OrderManager { public function test() { echo "hello"; } }
同时,文件夹的结构也要修改成:应用根目录libSilkLibOrderManager.php
然后修改composer.json里的autoload部分如下:
"autoload":{ "psr-0":{ "SilkLib":"lib/" } }
这里需要注意的是,SlikLib是命名空间,lib是目录名,他们的组合告诉composer,文件搜索是在:lib/SilkLib/ 目录下,而不是
在 SilkLib/lib 目录下,这一点要特别注意,有点绕,容易弄错。
如果我们把命名空间改成 Sliklib, 相应的目录结构要改成:应用根目录libSilklibOrderManager.php,autoload部分的写法
相应的也要改成:
"autoload":{ "psr-0":{ "Monolog\": "src/", "Silk\lib":"lib/" } }
如果您需要在多个目录中搜索相同的前缀,则可以将它们指定为数组:
"autoload": { "psr-0": { "Monolog\": ["src/", "lib/"] } }
注意Silklib是双斜杆。好了,那我们试试再加一个类,然后不用运行composer dump-autoload命令,看看新类是否能加载上。在
lib目录下,新增一个ShipManager.php文件,内容如下:
namespace Silklib; class ShipManager { public function test() { echo 'hello ship class'; } }
尝试在vendor 同级目录下的index.php文件中调用:
$orderMgr = new SilklibOrderManager(); $orderMgr->test(); $shipMgr = new SilklibShipManager(); $shipMgr->test();
运行成功,说明使用psr-0规范进行自动加载,比classmap更加方便。
可以直接指定到类级别。这对于在全局命名空间中只有一个类的库很有用,
php源文件也位于包的根目录中,则可以如下声明:
{ "autoload": { "psr-0": { "UniqueGlobalClass": "" } } }
如果您想要有一个可以使用命名空间的备用目录,则可以使用空的前缀,如:
{ "autoload": { "psr-0": { "": "src/" } } }
在psr-4关键字下,您可以定义相对于包根的命名空间到路径的映射
下面试试psr-4方式,整理下目录结构,改成:应用根目录libOrderManager.php,类文件修改命名空间为Silk[包根目录文件夹名/
包里文件夹名称],
修改autoload
"autoload":{ "psr-4": { "Silk\":"lib", // Silk 代表着--->项目类文件中的命令空间,将Silk 命名空间绑定到 /用户名/仓库名/lib 目录下 // 文件夹路径: vedor/ 用户名/ 仓库名称/ composer.json lib/ Classname.php lib这文件夹下的类文件 ----> 类名要和类文件同名, 类文件的命名空间统一为 Silk "Monolog\": "src/", }}//调用是 先引入vendor/autoload.php
使用命名空间:
use Silk类名—->等同于 使用包里的 lib类文件—->类名
再次运行composer dump-autoload
如果您需要在多个目录中搜索相同的前缀,则可以将它们指定为数组:
"autoload": { "psr-4": { "Monolog\": ["src/", "lib/"] } }
如果您想要有一个可以在任何命名空间中查找的备用目录,您可以使用一个空的前缀,如:
"autoload": { "psr-4": { ""exclude" } }