关于composer.json的配置设置

互联网 20-8-15
下面由composer教程栏目给大家关于composer.json的配置设置,希望对需要的朋友有所帮助!

配置文件的值为 key:val 必须双引号包裹

一、配置文件

名字 name包名称由用户名名称和仓库名称组成包版本限制来请求Monolog软件包 1.0.*。这意味着1.0开发分支中的任何版本,或大于或等于1.0且小于1.1(>=1.0 <1.1)的任何版本。

描述 description简短描述包装。通常这只是一行长。

类型 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。 wikiirc: IRC通道支持,如irc:// server / channel。 irc:来源:浏览或下载源的 URL。 sourcedocs:文档的 URL。 docsrss: RSS提要的URL。 rss一个例子:

{       "support": {             "email": "support@example.org",             "irc": "irc://irc.freenode.org/composer"       } }
"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
"archive": {   "exclude": ["/foo/bar", "baz", "/*.test", "!/foo/bar/baz"] }

bin文件一组应该被视为二进制文件并符号链接到bin-dir (从config)的文件。bin 文件相对于仓库包的目录地址"bin": [    "util/xs"  ]

二、依赖管理软件包链接 requirerequire告诉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" }

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

作用特定依赖项:默认情况下,composer只会获取稳定版本,如果这个例子我们不加@dev约束,而5.3.*版本都是开发版本,那么在获取的时候composer就会报错,指出改版本不符合要求。如果确定这个开发版本没有问题,那么就可以通过加@dev ,让Composer获取这个开发版本。

require-dev

"require-dev": {       "codeception/codeception": "2.0.0 " }

三、自动加载自动加载lib目录下的OrderManager.php文件1.使用Files方式(ps:通常作为函数库的载入方式(而非类库))

"autoload":{       "files":["lib/OrderManager.php"] }

files键对应的值是一个数组,数组元素是文件的路径,路径是相对于应用的根目录。加上上述内容后,运行命令:

composer dump-autoload

让composer重建自动加载的信息,完成之后,就可以在index.php里调用OrderManager类啦。

2.Classmap方式自动加载

"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,类文件都要求有个命名空间

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

同时,文件夹的结构也要修改成:应用根目录\lib\SilkLib\OrderManager.php然后修改composer.json里的autoload部分如下:

"autoload":{       "psr-0":{             "SilkLib":"lib/"       } }

这里需要注意的是,SlikLib是命名空间,lib是目录名,他们的组合告诉composer,文件搜索是在:lib/SilkLib/ 目录下,而不是在 SilkLib/lib 目录下,这一点要特别注意,有点绕,容易弄错。

如果我们把命名空间改成 Slik\lib, 相应的目录结构要改成:应用根目录\lib\Silk\lib\OrderManager.php,autoload部分的写法相应的也要改成:

"autoload":{       "psr-0":{     "Monolog\\": "src/",             "Silk\\lib":"lib/"       } }
   "autoload": {           "psr-0": { "Monolog\\": ["src/", "lib/"] }     }

注意Silk\lib是双斜杆。好了,那我们试试再加一个类,然后不用运行composer dump-autoload命令,看看新类是否能加载上。在lib目录下,新增一个ShipManager.php文件,内容如下:

namespace Silk\lib; class ShipManager {       public function test()       {             echo 'hello ship class';       } }
$orderMgr = new Silk\lib\OrderManager(); $orderMgr->test(); $shipMgr = new Silk\lib\ShipManager(); $shipMgr->test();

运行成功,说明使用psr-0规范进行自动加载,比classmap更加方便。

{       "autoload": {             "psr-0": { "UniqueGlobalClass": "" }       } }
{     "autoload": {           "psr-0": { "": "src/" }       } }

下面试试psr-4方式,整理下目录结构,改成:应用根目录\lib\OrderManager.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" }   }

以上就是关于composer.json的配置设置的详细内容,更多内容请关注技术你好其它相关文章!

来源链接:
免责声明:
1.资讯内容不构成投资建议,投资者应独立决策并自行承担风险
2.本文版权归属原作所有,仅代表作者本人观点,不代表本站的观点或立场
标签: composer.json
上一篇:php获取远程图片并下载保存到本地的方法分析 下一篇:Composer的波浪线符号~和幂符号^到底有啥区别

相关资讯