PHP 包开发零基础入门

Composer 包是向 Laravel 或其他 PHP 应用程序添加功能的最佳方式。

让我们开始构建您的 Composer 包吧！

第一步：创建包目录

在本步骤中，您将创建一个用于存储您的 Composer 包的目录。

# 为您的包创建一个新目录。
mkdir name-of-your-package
# 切换到该目录。
cd name-of-your-package

执行以下命令初始化 Composer 文件。

composer init

按照提示设置您的包信息，包括：

• 包名称
• 包版本
• 包作者
• 包描述

第二步：创建包文件

在本步骤中，您将创建您的包的代码。

创建包代码目录。

mkdir src
# 创建包代码文件。
touch src/HelloWorld.php

编辑 src/HelloWorld.php 文件，添加以下内容：

<?php

namespace YourVendor\HelloWorld;

class HelloWorld
{
    public function sayHello()
    {
        return 'Hello, World!';
    }
}

这段代码定义了一个名为 HelloWorld 的类，该类有一个名为 sayHello() 的方法。sayHello() 方法返回一条简单的问候语。

第三步：配置自动加载

在本步骤中，您将配置 Composer 自动加载您的包。

在 composer.json 文件中，添加以下内容：

{
    "autoload": {
        "psr-4": {
            "YourVendor\\HelloWorld\\": "src/"
        }
    },
    "prefer-stable": true,
    "minimum-stability": "dev"
}

这段配置让 Composer 将 src/ 目录下的所有类文件自动加载到 YourVendor\HelloWorld 命名空间中。

然后，运行以下命令更新自动加载器：

composer dump-autoload

这将生成一个 autoload.php 文件，其中包含您的包的所有自动加载信息。

第四步：编写测试

在本步骤中，您将编写测试来确保您的包正常工作。

首先，创建一个 tests 目录并添加一个简单的测试：

mkdir tests
touch tests/HelloWorldTest.php

然后，编辑 tests/HelloWorldTest.php 文件，添加以下代码：

<?php

use YourVendor\HelloWorld\HelloWorld;
use PHPUnit\Framework\TestCase;

class HelloWorldTest extends TestCase
{
    public function testSayHello()
    {
        $helloWorld = new HelloWorld();
        $this->assertEquals('Hello, World!', $helloWorld->sayHello());
    }
}

这段代码测试了 HelloWorld 类的 sayHello() 方法。该方法返回一条简单的问候语。

如果测试成功，您将看到以下输出：

OK (1 test, 1 assertion)

第五步：发布

要使您的包可供其他人使用，您可以将其发布到 Packagist 上。请确保您拥有 Packagist 帐户。

发布包后，您可以使用以下命令要求此包进行项目：

composer require yourvendor/helloworld

第六步：本地测试

想本地测试您的包，您可以将其包含在 Laravel 项目中。

在您的 Laravel 项目的 composer.json 文件中，添加以下内容：

{
    "repositories": [
        {
            "type": "path",
            "url": "/path/to/HelloWorld"
        }
    ],
    "require": {
        "yourvendor/helloworld": "*"
    }
}

将 /path/to/HelloWorld 替换为您的包的实际路径。

然后，运行以下命令以获取您的包：

composer update

您的包现在将包含在您的 Laravel 项目中。使用 composer require yourvendor/helloworld 命令也可以将其包含在您的项目中。

现在您可以在 Laravel 应用程序中使用您的包：

<?php

use YourVendor\HelloWorld\HelloWorld;

$helloWorld = new HelloWorld();
echo $helloWorld->sayHello();

这是一个帮助您入门的基本示例。根据包的复杂性，您可能需要包含其他功能，例如配置文件、视图、迁移等。