ホームページ > 開発ツール > composer > Composer.jsonの構成設定について

Composer.jsonの構成設定について

藏色散人
リリース: 2020-08-15 15:32:10
転載
5097 人が閲覧しました

composer の次のチュートリアル コラムでは、composer.json の構成設定について説明します。困っている友人の役に立てば幸いです。

Composer.jsonの構成設定について

#構成ファイルの値は key:val であり、二重引用符で囲む必要があります


# #1. 設定ファイル

名前名

パッケージ名はユーザー名とウェアハウス名で構成されますパッケージのバージョン制限Monolog パッケージ 1.0 .* をリクエストします。これは、1.0 開発ブランチ内の任意のバージョン、または 1.0 以上 1.1 未満の任意のバージョン (>=1.0

説明の説明

パッケージの簡単な説明。通常、これは 1 行の長さだけです。

パッケージのバージョン version パッケージ リポジトリが VCS リポジトリ内の VCS タグ名など、どこかからバージョンを推測できる場合はオプションです。この場合は省略することをお勧めします。

タイプ タイプ

このフィールドを省略し、デフォルトでライブラリにすることをお勧めします

キーワードキーワード

これらは次の目的で使用できます。キーワードなどの配列形式での検索とフィルタリング: ["xunsearch"、"search Engine"、"yii"、"yii2"]

Homepagehomepage

プロジェクトの URL Webサイト。

時刻

バージョンのリリース日は、YYYY-MM-DD または YYYY-MM-DD HH:MM:SS 形式である必要があります。

ライセンス ライセンス

パッケージでライセンスを選択できる場合 (「分割ライセンス」)、複数のライセンスを配列として指定できます。

分割されたライセンスの例:

{
      "license": [
           "LGPL-2.1",
           "GPL-3.0+"
      ]
}
ログイン後にコピー
または、「または」で区切って括弧で囲むこともできます;

{
      "license": "(LGPL-2.1 or GPL-3.0+)"
}
ログイン後にコピー

authorsauthors

#
每个作者对象可以具有以下属性:
名称:作者姓名 通常他们的真名。 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"
          }
    ]
ログイン後にコピー

サポート サポート
プロジェクト サポートを取得するためのさまざまな情報。サポート情報には次のものが含まれます。

電子メール: サポート用の電子メール アドレス。 emailIssue: 問題トラッカーの URL。 issuesForum: フォーラムの URL。 forum:
wiki: Wiki の URL。 wiki

irc: IRC チャネルのサポート (irc://server/channel など)。 irc:

Source: ソースを参照またはダウンロードするための URL。 source
docs: ドキュメントの URL。 docs
rss: 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 archive


このコマンドは、指定されたバージョンのパッケージ zip/tar アーカイブを作成します。また、除外/無視されたファイルを除くプロジェクト全体をアーカイブするために使用することもできます。

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 files

グループは次のように除外します。バイナリとみなされ、bin-dir 内のファイルに (config から) シンボリックリンクされます。
ウェアハウス パッケージに対する bin ファイルのディレクトリ アドレス

"bin": [

"util/xs" ]


2. 依存関係管理

パッケージリンク requirerequire プロジェクトが依存するパッケージをコンポーザーに伝えます

"require": {
  "php" : "^5.5 || ^7.0",
  "monolog/monolog": "1.0.*"
}
ログイン後にコピー

require パッケージ名を変更する必要があります (バージョン制約 (例: 1.0.*) にマップされる monolog/monolog など)。 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- で参照できます。使用法 .md#The-

require-Key


@dev は、開発バージョンを取得できることを示します。通常、開発バージョンは不安定なバージョンを意味し、バグが含まれる可能性が高くなります。安定性タグは、特定の依存関係または

グローバルに適用できます。

作用特定依赖项:默认情况下,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";
      }
 }
ログイン後にコピー

同时,文件夹的结构也要修改成:应用根目录\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 &#39;hello ship class&#39;;
      }
}
ログイン後にコピー

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

$orderMgr = new Silk\lib\OrderManager();
$orderMgr->test();
$shipMgr = new Silk\lib\ShipManager();
$shipMgr->test();
ログイン後にコピー

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

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

{
      "autoload": {
            "psr-0": { "UniqueGlobalClass": "" }
      }
}
ログイン後にコピー

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

{
    "autoload": {
          "psr-0": { "": "src/" }
      }
}
ログイン後にコピー

在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
ログイン後にコピー

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

再次运行composer dump-autoload

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

"autoload": {
          "psr-4": { "Monolog\\": ["src/", "lib/"] }
  }
ログイン後にコピー

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

  "autoload": {
          "psr-4": { ""exclude" }
  }
ログイン後にコピー

以上がComposer.jsonの構成設定についての詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

関連ラベル:
ソース:csdn.net
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート