Maison > outils de développement > composer > À propos des paramètres de configuration de composer.json

À propos des paramètres de configuration de composer.json

藏色散人
Libérer: 2020-08-15 15:32:10
avant
5084 Les gens l'ont consulté

La colonne tutorielle suivante de composer vous donnera les paramètres de configuration de composer.json. J'espère qu'elle sera utile aux amis dans le besoin !

À propos des paramètres de configuration de composer.json

La valeur du fichier de configuration est key:val et doit être placée entre guillemets doubles

1. Fichier de configuration

Nom
Le nom du package se compose du nom d'utilisateur et du nom de l'entrepôt
Limite de version du package à demander Paquet Monologue 1.0 .*. Cela signifie toute version dans la branche de développement 1.0, ou toute version
supérieure ou égale à 1.0 et inférieure à 1.1 (>=1.0 <1.1).

description description
Une brève description du colis. Habituellement, il ne s’agit que d’une seule ligne.

La version de la version du package
Facultatif si le référentiel du package peut déduire la version de quelque part, comme le nom de la balise VCS dans le référentiel VCS. Dans ce cas, il est recommandé de l’omettre.

type type
Il est recommandé d'omettre ce champ et de le définir par défaut sur library

keywordskeywords
Ceux-ci peuvent être utilisés pour recherches et filtrage, sous forme de tableau tels que des mots-clés : ["xunsearch", "search engine", "yii", "yii2"]

Page d'accueil de la page d'accueil
L'URL de la site Web du projet.

Heure heure
Date de sortie de la version, doit être au format AAAA-MM-JJ ou AAAA-MM-JJ HH:MM:SS.

Licence licence
Pour un package, plusieurs peuvent être spécifiés sous forme de tableau lorsqu'il y a un choix entre les licences ("licence fractionnée").
Exemple de licences séparées :

{
      "license": [
           "LGPL-2.1",
           "GPL-3.0+"
      ]
}
Copier après la connexion

Alternativement, elles peuvent être séparées par "ou" et mises entre parenthèses ;

{
      "license": "(LGPL-2.1 or GPL-3.0+)"
}
Copier après la connexion

auteurs auteurs

每个作者对象可以具有以下属性:
名称:作者姓名 通常他们的真名。 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"
          }
    ]
Copier après la connexion

Support
Diverses informations pour obtenir un support de projet, les informations de support comprennent les éléments suivants :

E-mail : adresse e-mail pour l'assistance. email
Problème : URL vers le système de suivi des problèmes. questions
Forum : URL du forum. forum:
wiki : URL du wiki. wiki
irc : prise en charge des canaux IRC, tels que irc://server/channel. irc:
Source : URL pour parcourir ou télécharger la source. source
docs : URL du document. docs
rss : L'URL du flux RSS. rss
Un exemple :

{
      "support": {
            "email": "support@example.org",
            "irc": "irc://irc.freenode.org/composer"
      }
}
Copier après la connexion

Suggestion

"suggest": {
          "monolog/monolog": "Allows more advanced logging of the application flow",
          "ext-xml": "Needed to support XML format in class Foo"
    }
Copier après la connexion

archive archive

Cette commande est utilisée pour spécifier la version spécifiée du package Créez une archive zip/tar. Il peut également être utilisé pour archiver l'intégralité de votre projet, à l'exclusion des fichiers exclus/ignorés.

composer 命令:php composer.phar archive vendor/package 2.0.21 --format=zip
Copier après la connexion

exclude : Permet de configurer une liste de modèles pour exclure les chemins. La syntaxe du modèle correspond aux fichiers .gitignore. Un point d'exclamation (!) entraînera l'inclusion de tous les fichiers correspondants, même si le modèle précédent de
les excluait. Les barres obliques de début ne peuvent correspondre qu'au début des chemins relatifs au projet. Les astérisques ne sont pas étendus aux séparateurs de répertoires.

Définissez les options lors de la création d'un package. L'attribut d'exclusion peut définir les répertoires à exclure, par exemple :

"archive": {
  "exclude": ["/foo/bar", "baz", "/*.test", "!/foo/bar/baz"]
}
Copier après la connexion

fichiers bin
Un groupe doit être considéré comme binaire et lié symboliquement au fichier dans bin-dir (à partir de la configuration).
L'adresse du répertoire du fichier bin relatif au package d'entrepôt
"bin": [
  "util/xs"
 ]

2. gestion
Lien du package require
require indique au compositeur le package dont dépend votre projet

"require": {
  "php" : "^5.5 || ^7.0",
  "monolog/monolog": "1.0.*"
}
Copier après la connexion

require requiert le nom du package (tel que monolog /monolog ) est mappé à un objet avec une contrainte de version (par exemple 1.0.*).
La commande composer show --platform répertorie toutes les extensions PHP disponibles sur le système
Restreindre la version PHP [exigences de la version php]

"require": {
      "swiftmailer/swiftmailer": 5.3.*@dev,
      "phpoffice/phpexcel": "dev-master"
}
Copier après la connexion

Prenons Swiftmailer comme exemple, Swiftmailer/swiftmailer représente le nom du package,5.3 .@dev, sont les informations de version. Ce que cela signifie ensemble, c'est que l'application
que nous allons développer dépend de la version 5.3 de Swiftmailer. Parmi eux :

5.3.* signifie que vous pouvez utiliser la version 5.3.1 ou la version 5.3.2 Lors de son obtention, composer recherchera la dernière version sous la version 5.3. Le numéro de version prend en charge certaines
contraintes plus larges, telles que >=1.0, >=1.0, <2.0. Des informations plus spécifiques peuvent être consultées sur : http://docs.phpcomposer.com/01-basic-usage. .md#The-
require-Key

@dev indique que la version de développement peut être obtenue. Habituellement, une version de développement signifie une version instable et est susceptible de contenir des bugs. Les balises de stabilité peuvent s'appliquer à des dépendances spécifiques ou globalement.

作用特定依赖项:默认情况下,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 "
}
Copier après la connexion

加了这个依赖后,再运行下命令看看效果。
composer install

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

"autoload":{
      "files":["lib/OrderManager.php"]
}
Copier après la connexion

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

composer dump-autoload
Copier après la connexion

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

2.Classmap方式自动加载

通过文件引入的方法虽然直观,但是很费劲,每个文件都得引入一次,实在不是好的解决办法。有没有更好的办法呢?尝试将
autoload的值改成:

"autoload": {
          "classmap": ["src/", "lib/", "Something.php"]
    }
Copier après la connexion

再此运行composer dump-autoload,尝试调用,依然能够成功创建OrderManager类。其实,classmap通过建立类到文件的对应关系,
当程序需要OrderManager类时,compoer的自动加载类通过查找OrderManager类所在的文件,然后再将改文件include进来。因此,这
又导致了一个问题,那就是每加一个新类,就需要运行一次composer dump-autoload来创建类到文件到对应关系。

从classmap中排除文件
如果要从类映射中排除某些文件或文件夹,可以使用“from-classmap”属性,这些类将从类映射中跳过

"autoload": {
          "exclude-from-classmap": ["/Tests/", "/test/", "/tests/"]
    }
Copier après la connexion

3. PSR0/4加载方式
PSR-0,PSR-4,类文件都要求有个命名空间

PSR-0则规定类名中的下划线_会被转化成目录分隔符

namespace SilkLib;
class OrderManager
{
      public function test()
      {
            echo "hello";
      }
 }
Copier après la connexion

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

"autoload":{
      "psr-0":{
            "SilkLib":"lib/"
      }
}
Copier après la connexion

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

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

"autoload":{
      "psr-0":{
    "Monolog\\": "src/",
            "Silk\\lib":"lib/"
      }
}
Copier après la connexion

如果您需要在多个目录中搜索相同的前缀,则可以将它们指定为数组:

   "autoload": {
          "psr-0": { "Monolog\\": ["src/", "lib/"] }
    }
Copier après la connexion

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

namespace Silk\lib;
class ShipManager
{
      public function test()
      {
            echo &#39;hello ship class&#39;;
      }
}
Copier après la connexion

尝试在vendor 同级目录下的index.php文件中调用:

$orderMgr = new Silk\lib\OrderManager();
$orderMgr->test();
$shipMgr = new Silk\lib\ShipManager();
$shipMgr->test();
Copier après la connexion

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

可以直接指定到类级别。这对于在全局命名空间中只有一个类的库很有用,
php源文件也位于包的根目录中,则可以如下声明:

{
      "autoload": {
            "psr-0": { "UniqueGlobalClass": "" }
      }
}
Copier après la connexion

如果您想要有一个可以使用命名空间的备用目录,则可以使用空的前缀,如:

{
    "autoload": {
          "psr-0": { "": "src/" }
      }
}
Copier après la connexion

在psr-4关键字下,您可以定义相对于包根的命名空间到路径的映射

下面试试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
Copier après la connexion

使用命名空间:
use \Silk\类名---->等同于 使用包里的 lib\类文件---->类名

再次运行composer dump-autoload

如果您需要在多个目录中搜索相同的前缀,则可以将它们指定为数组:

"autoload": {
          "psr-4": { "Monolog\\": ["src/", "lib/"] }
  }
Copier après la connexion

如果您想要有一个可以在任何命名空间中查找的备用目录,您可以使用一个空的前缀,如:

  "autoload": {
          "psr-4": { ""exclude" }
  }
Copier après la connexion

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Étiquettes associées:
source:csdn.net
Déclaration de ce site Web
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn
Tutoriels populaires
Plus>
Derniers téléchargements
Plus>
effets Web
Code source du site Web
Matériel du site Web
Modèle frontal