关于php:PHP-Composer-自动加载

前言：这篇文章是从外国网站看到的，把composer写得很贴地，翻译回来记录下。

简介：在本教程中，您将学习如何应用 Composer 从应用 PSR-4 规范的文件主动加载 PHP 类。

应用 require_once 结构加载类
首先，应用文件创建以下目录构造：

.
├── app
│ ├── bootstrap.php
│ └── models
│ └── User.php
└── index.php
代码语言： PHP （php ）
在User.php该文件models夹蕴含的User 类：

class User{  private $username;  private $password;  public function __construct($username, $password)  {      $this->username = $username;      $this->password = password_hash($password);  }  public function getUsername(): string  {      return $this->username;  }}

代码语言： PHP （php ）
这User是一个简略的类。它有两个属性$username和$password。该构造函数初始化从它的参数属性。此外，它应用该password_hash()函数对$password.

该bootstrap.php文件应用require_once结构User从User.php文件models夹中的文件加载类：

<?phprequire_once 'models/User.php';

代码语言： PHP （php ）
当models文件夹中有更多类时，您能够require_once向bootstrap.php文件中增加更多语句以加载这些类。

该index.php文件加载bootstrap.php文件并应用User该类：

<?php    require './app/bootstrap.php';    $user = new User('admin', '$ecurePa$$w0rd1');

代码语言： PHP （php ）
如果您有大量类，则此应用程序构造很无效。然而，当应用程序有大量的类时，require_once就不能很好地扩大。在这种状况下，您能够应用该spl_autoload_register()函数从文件中主动加载类。

该spl_autoload_register()性能的问题在于您必须本人实现主动加载器性能。而且您的主动加载器可能不喜爱其余开发人员开发的主动加载器。

因而，当您应用不同的代码库时，您须要钻研该特定代码库中的主动加载器以理解它们的工作原理。

这就是 Composer 发挥作用的起因。

作曲家简介
Composer是 PHP 的依赖管理器。Composer 容许您治理 PHP 我的项目中的依赖项。在本教程中，咱们将重点介绍如何应用 Composer 主动加载类。

在应用 Composer 之前，您须要下载并装置它。官网文档为您提供了如何在您的计算机上下载和装置 Composer的具体步骤。

要查看 Composer 是否装置胜利，请从 Windows 上的命令提示符或 macOS 和 Linux 上的终端运行以下命令：

composer -v
代码语言： PHP （php ）
它将返回以后版本以及您能够与composer命令一起应用的许多选项。

应用 Composer 主动加载类
回到后面的示例，要应用 Composer，首先要composer.json在我的项目的根文件夹下创立一个名为的新文件。我的项目目录将如下所示：

.
├── app
│ ├── bootstrap.php
│ └── models
│ └── User.php
├── composer.json
└── index.php
代码语言： PHP （php ）
在中composer.json，增加以下代码：

{        "autoload": {        "classmap": ["app/models"]        }}

代码语言： PHP （php ）
此代码意味着 Composer 将主动加载定义该app/models文件夹的所有类文件。

如果您要加载来自其余文件夹的类，您能够在classmap数组中指定它们：

{    "autoload": {        "classmap": ["app/models", "app/services"]    }}

代码语言： PHP （php ）
在这个例子中，Composer 将从文件夹下的文件夹models和services文件夹中加载类app。

接下来，在 Windows 上启动命令提示符或在 macOS 和 Linux 上启动终端，而后导航到我的项目目录。

而后，从我的项目目录中键入以下命令：

composer dump-autoload
代码语言： PHP （php ）
Composer 将生成一个名为的目录vendor，其中蕴含许多如下文件：

.
├── app
│ ├── bootstrap.php
│ └── models
│ └── User.php
├── composer.json
├── index.php
└── vendor

  ├── autoload.php  └── composer      ├── autoload_classmap.php      ├── autoload_namespaces.php      ├── autoload_psr4.php      ├── autoload_real.php      ├── autoload_static.php      ├── ClassLoader.php      └── LICENSE

代码语言： PHP （php ）
当初对您来说最重要的文件是autoload.php文件。

之后，应用结构autoload.php将bootstrap.php文件加载到文件中require_once：

<?php    require_once __DIR__ . '/../vendor/autoload.php';

代码语言： PHP （php ）
最初，您能够User在以下地位应用该类index.php：

<?php    require './app/bootstrap.php';    $user = new User('admin', '$ecurePa$$w0rd1');

代码语言： PHP （php ）
从当初开始，只有models目录中有新类，就须要composer dump-autoload再次运行该命令以从新生成autoload.php文件。

例如，上面定义了一个Comment在Comment.php文件models夹下的文件中调用的新类：

  <?phpclass Comment{    private $comment;    public function __construct(string $comment)    {        $this->comment = $comment;    }    public function getComment(): string    {        return strip_tags($this->comment);    }}

代码语言： PHP （php ）
如果不运行composer dump-autoload命令并应用文件中的Comment类index.php，则会呈现谬误：

<?php    require './app/bootstrap.php';    $user = new User('admin', '$ecurePa$$w0rd1');    $comment = new Comment('<h1>Hello</h1>');    echo $comment->getComment();

代码语言： PHP （php ）
谬误：

Fatal error: Uncaught Error: Class 'Comment' not found in...

代码语言： PHP （php ）
然而，如果您composer dump-autoload再次运行该命令，该index.php文件将失常工作。

应用 PSR-4 主动加载 Composer
PSR 代表 PHP 规范举荐。PSR 是 PHP Framework Interop Group 或 PHP-FIG 公布的 PHP 标准。

PSR 的指标是实现 PHP 组件的互操作性，并为 PHP 编程中最佳实际的实现提供通用的技术根底。

PHP-FIG 从 PSR-0 开始公布了很多 PSR。无关 PSR 的残缺列表，请查看 PSR 页面。

PSR-4 是主动加载规范，形容了从文件门路主动加载类的标准。https://www.php-fig.org/psr/p...

依据 PSR-4，齐全限定的类名具备以下构造：

\<NamespaceName>(\<SubNamespaceNames>)*\<ClassName>
代码语言： PHP （php ）
该构造以一个命名空间开始，而后是一个或多个子命名空间，以及类名。

为了合乎 PSR-4，您须要像这样构建以前的应用程序：

.
├── app
│ ├── Acme
│ │ ├── Auth
│ │ │ └── User.php
│ │ └── Blog
│ │ └── Comment.php
│ └── bootstrap.php
├── composer.json
└── index.php
代码语言： PHP （php ）
新构造有以下变动：

首先，models删除目录。

二User.php是在Acme/Auth文件夹下。并且User该类的命名空间为Acme/Auth. 留神命名空间如何映射到目录构造。这也有助于您通过查看其命名空间更快地找到类文件。

<?phpnamespace Acme\Auth;class User{    // implementation    // ...}

代码语言： PHP （php ）
第三，Comment.php在Acme/Blog文件夹下。该Comment班有命名空间Acme\Blog：

<?phpnamespace Acme\Blog;class Comment{    // implementation    // ...}

代码语言： PHP （php ）
四、composer.json文件如下所示：

{    "autoload": {        "psr-4": {            "Acme\\":"app/Acme"        }    }}

代码语言： PHP （php ）
而不是应用classmap，该composer.json文件当初应用psr-4。该psr-4映射名称空间"Acme\"的"app/Acme"文件夹中。

请留神，命名空间中的第二个反斜杠 ( )Acme\用于本义第一个反斜杠 ( )。

五、要应用文件中的User和Comment类index.php，须要运行composer dump-autoload命令生成autoload.php文件：

composer dump-autoload
代码语言： PHP （php ）
因为User和Comment类具备命名空间，因而您须要具备如下use语句index.php：

<?phprequire './app/bootstrap.php';use Acme\Auth\User as User;use Acme\Blog\Comment as Comment;$user = new User('admin', '$ecurePa$$w0rd1');$comment = new Comment('<h1>Hello</h1>');echo $comment->getComment();

代码语言： PHP （php ）
概括
Composer 是 PHP 中的一个依赖管理工具。
应用 PSR-4 来组织目录和类文件。
应用composer dump-autoload命令生成autoload.php文件。