PHP 개발자가 알아야 할 패키지 종속성 관리 도구: Composer

Composer는 매우 인기 있는 PHP 패키지 종속성 관리 도구입니다. 이는 PHP 개발자가 Composer를 마스터하는 데 필요합니다.

사용자의 경우 Composer는 간단한 명령을 통해 필요한 항목을 다운로드합니다. 코드 패키지를 공급업체 디렉터리에 추가하면 개발자가 패키지를 도입하고 사용할 수 있습니다. 핵심은 프로젝트에서 정의한 작곡가.json에 있으며, 이는 프로젝트가 의존해야 하는 패키지를 정의할 수 있습니다(여러 개가 있을 수 있음). 종속 패키지는 다른 패키지에 따라 달라질 수 있습니다(이것은 구성 요소의 이점입니다). 이에 대해 걱정할 필요가 없습니다. Composer는 필요한 모든 것을 자동으로 다운로드하며 모든 것은 Composer.json의 정의에 있습니다. 매우 투명하다고는 하지만 그 뒤에 숨은 개념은 여전히 ​​이해가 필요합니다. Github의 급속한 발전 덕분에 PHP 언어는 점점 더 현대화되고 더 커진 것 같습니다.

Composer를 이해하려면 먼저 구조에 대한 일반적인 이해를 갖습니다.

Composer의 구조

Composer 명령줄 도구:

이 이해는 비교적 간단합니다. 다음을 통해 다운로드하세요. 사용자 정의 Composer.json 필요한 코드, 단순히 Composer를 사용하면 몇 가지 특정 명령을 마스터할 수 있습니다

자동 로딩 코드 로더:

Composer를 통해 개발자는 이를 다양한 방법으로 사용할 수 있으며, 핵심은 Composer가 PHP의 네임스페이스 개념과 PSR-4 표준의 개발을 기반으로 코드 자동 로더를 개발했다는 ​​것입니다

Github:

Github을 사용하면 PHP 개발자는 여기에서 오픈 소스 코드를 호스팅할 수 있습니다. 위, Composer의 개발은 다음에서 시작되었습니다. Github.Composer는 기본적으로 Github의 코드를 로컬로 다운로드합니다.

Packagist:

사용자의 경우 Composer의 명령줄 도구를 사용하므로 사용자가 사용할 수 있는 패키지 수는 어떻습니까? Packagist는 주로 Packagist에 의존합니다. 패키지 개발자는 Github에서 특정 코드를 호스팅하고 패키지 정보를 Packagist에 제출하므로 Composer는 로컬로 정의된 작곡가.json을 기반으로 Composer를 쿼리합니다. Packagist는 Composer.json/Package.json 정보를 기반으로 파싱하여 최종적으로 github Warehouse에 해당합니다. Composer가 최종적으로 코드를 다운로드하면 Github Warehouse의 Composer.json에도 의존하며, Composer.json에는 세 가지 유형이 있습니다.

Composer.json:

이것이 Composer의 핵심이자 Composer의 규칙입니다. Composer.json에는 세 가지 유형이 있습니다.

Composer 명령줄 도구

composer init사용자가 직접 할 수 있습니다. 프로젝트의 종속성 패키지를 정의하려면 프로젝트 아래에 Composer.json을 만드세요. Composer init를 통해 대화형으로 Composer.json을 생성할 수 있습니다.

composer install

은 가장 일반적으로 사용되는 명령이어야 하며, 작곡가는 로컬 작곡가 json 설치 패키지를 기반으로 하며, 다운로드한 패키지를 아래의 공급업체 디렉터리에 넣습니다. 프로젝트를 진행하고, 설치 중 패키지 버전 정보를 Composer.lock에 넣어서 버전을 잠급니다.

실제로 설치 시, Composer.lock 버전이 발견되면 현재 벤더 디렉터리의 코드 버전과 일치하면 Composer가 실행합니다. Composer.lock의 목적은 최신 버전의 패키지를 얻지 않고도 현재 버전에서 작업할 수 있도록 하는 것입니다.

composer update

최신 버전을 얻기 위해 작곡가.lock을 업데이트하는 방법은 무엇입니까? 패키지? 이 명령을 통해 패키지의 최신 버전을 업데이트할 수 있습니다.

composer config

이 명령을 이해하는 것이 좋습니다. 전역 구성은 COMPOSER_HOME/config .json에 저장되며, 비전역 구성 정보가 저장됩니다.

composer config --list -g
composer config -g notify-on-install false
composer global config bin-dir --absolute
composer create-project

이 명령은 일반적으로 사용되지 않지만, 개인적으로 여전히 매우 중요하다고 생각합니다. 다음을 통해 프로젝트의 모든 종속성 패키지를 다운로드합니다. 이 명령을 사용하면 모든 코드와 해당 종속 패키지가 디렉터리에 배치됩니다. 이는 일반적으로 패키지 개발자가 버그를 수정하기 위해 이 명령을 사용할 수 있습니다.

작곡가 글로벌

이것은 COMPOSER_HOME 디렉터리에서 설치 및 업데이트와 같은 Composer 명령을 실행할 수 있는 전역 설치 명령입니다. 물론 COMPOSER_HOME은 $PATH 환경에 있어야 합니다.

예를 들어, composer global require fabpot/ php-를 실행합니다. cs-fixer, 이제 php-cs-fixer 명령줄을 전역적으로 실행할 수 있습니다. 나중에 업데이트하려면 아래에서 작곡가를 수정할 때 작곡가 전역 업데이트

composer dump-autoload

만 실행하면 됩니다. project.json 파일은 반드시 작곡가 업데이트 명령을 실행하여 업데이트할 필요는 없습니다. 때로는 이 명령을 사용하여 로더를 업데이트할 수 있습니다(패키지스트가 아닌). 나중에 연습해서 설명해주세요.

작곡가 필요

假如手动或者交互式创建composer.json文件,可以直接使用该命令来安装包

composer require  cerdic/css-tidy:1.5.2
composer require "ywdblog/phpcomposer:dev-master"

–prefer-source和–prefer-dist参数

–prefer-dist:对于稳定的包来说,一般Composer安装默认使用该参数,这也能加快安装,比如有可能直接从packagist安装了相应的包,而不用实际去Github上下载包.

–prefer-source:假如使用该参数,则会直接从Github上安装,安装包后vendor目录下还含有.git信息

composer require "ywdblog/phpcomposer:dev-master" --prefer-source
#在vendor/ywdblog/phpcomposer目录下含有.git信息

如何给Composer添加代理

在国内使用Composer下载特别慢,可以通过二个方法进行加速

composer config repo.packagist composer “https://packagist.phpcomposer.com“

编辑composer.json

"repositories": {
  "packagist": {
      "type": "composer",
      "url": "https://packagist.phpcomposer.com"
  }
}

Autoloading代码加载器

composer本身集成一个autoloader,支持PSR-4,PSR-0,classmap,files autoloading.

这里通过一个例子来说明通过Composer如何引用classmap,files,本地符合PSR-4标准的代码

编辑composer.json

"autoload": {
  "classmap": ["othsrc/","classsrc.php"],
  "files": ["othsrc/filesrc.php"],
  "psr-4": {"Foo\Bar\": "src"}  }

composer dump-autoload

通过上述的操作,对于PSR-4来说等同注册了一个PSR-4 autoloader(从FooBar命名空间)

假如不想使用Composer的autoloader,可以直接包含vendor/composer/autoload_*.php文件,配置自己的加载器.

具体的例子托管在github上,可参考.

Repositories

关于Repositories,了解其不是必须的,但是假如掌握则更能理解Composer,对于Repositories,其中文文档和英文文档解释的很好,这里也进行了一些摘抄.

基本概念

包:

Composer是一个依赖管理工具,它在本地安装一些资源包和包的描述(比如包名称和对应的版本),比较重要的元数据描述是dist和source,dist指向一个存档,该存档是对一个资源包的某个版本的数据进行的打包.source指向一个开发中的源,这通常是一个源代码仓库(比如git)

资源库:

一个资源库是一个包的来源.它是一个packages/versions的列表.

Composer将查看所有你定义的repositories以找到项目需要的资源包(这句话很重要).

默认情况下已经将http://Packagist.org注册到Composer(或者理解为http://Packagist.org是Composer资源库默认的仓库类型)

Composer资源库类型

Composer资源库包括四种类型,默认的是composer类型,也就是http://packagist.org所使用的资源类型.

它使用一个单一的packages.json文件,包含了所有的资源包元数据.当你将包发布到http://pckagist.org上,则默认系统会创建一个packages.json,不过我没有找到我的包对应的文件.

VCS资源库类型

假如你想构建一个私有的Composer私有资源库类型,可以使用该类型,这里举一个例子,比如你在自己项目的composer.json定义如下,则就可以使用对应的Github上的代码了.

{
    "repositories": [
    {
        "type": "vcs",
        "url": "https://github.com/ywdblog/phpcomposer"
    }
    ],
    "require": {
        "ywdblog/phpcomposer": "dev-master"
    }
}

当运行composer update的时候,Comoser实际上是从Github上下载包而不是从http://pckagist.org上下载.

另外假如需要使用Package资源库类型或者PEAR资源库类型,参考官方文档即可,一般在composer.json中定义name、version属性即可.

Composer.json

在本文上面也多次提到了composer.json,比如你希望使用第三方包则需要在本地定义composer.json,Composer安装第三方包后,也会在第三方包目录下发现composer.json,那么这二者都叫composer.json,有什么区别呢?理解这非常的重要.

假如你在自己的项目下面定义一个composer.json,则这个包称之为ROOT包,这个composer.json定义你项目需要的条件(比如你的项目可能依赖一个第三方包).

composer.json中有些属性只能被ROOT包使用,比如config属性只在ROOT包中生效.

一个资源包是不是ROOT包,取决于它的上下文,比如你git clone ywdblog/phpcomposer,则这时候本地phpcomposer目录就是ROOT包,假如你在本地phpcomposer目录下composer require ywdblog/phpcomposer,则这时候你的项目phpcomposer就是ROOT包.

了解composer-schema.json可参考该网址,Laravel作为一个成熟的框架,其定义的composer.json非常经典

关于包的版本

当使用者在本地配置composer.json的时候,可以指定需要包的特定版本,Composer支持从Github仓库中下载Tag或者分支下的包.

对于Github上的Tag来说,Packagist会创建对应包的版本,它符合X.Y.Z,vX.Y.Z,X.Y.Z-包类型,就是说Github上虽然只有一个特定版本的包,但Composer支持多种形式的引用方式,比如:

composer require monolog/monolog  1.0.0-RC1
composer require monolog/monolog  v1.0.0-RC1
composer require monolog/monolog  1.0.*
composer require monolog/monolog  ~1.10

对于Github上的分支来说,Packagist会创建对应包的版本,假如分支名看起来像一个版本,将创建{分支名}-dev的包版本号,如果分支名看起来不像一个版本号,它将会创建dev-{分支名}形式的版本号

总结:

理解Composer,最重要的是实践,最后也能明白PSR-4和命名空间,也可以尝试将你的项目发布到http://pckagist.org上.

PHP中文网，有大量免费的PHP教程，欢迎大家学习！

本文转自：https://www.jianshu.com/p/d8bb33c53482