README

SDK（软件开发工具包）是一组软件工具和库的集合，旨在帮助开发人员创建应用程序和软件。它本质上是一个提供工具、库、相关文档、代码示例、流程和指南的包，允许开发人员在特定平台上创建软件应用程序。

SDK通常是为特定平台或编程语言设计的。例如，Windows SDK用于开发Windows应用程序，Java SDK用于开发Java应用程序。

在这篇文章中，我们将构建一个简单的PHP SDK，并将其发布到Composer。

什么是Composer？

Composer是PHP的依赖管理工具。它允许您声明项目依赖的库，并为您管理（安装/更新）它们。

什么是Packagist？

Packagist是主要的Composer仓库。它聚合了可通过Composer安装的公共PHP包。

什么是包？

包是可用于您项目的库。该包可以是你自己编写的库，或者使用Composer下载的第三方库。

什么是包管理器？

包管理器是一个工具，它以一致的方式自动化安装、升级、配置和删除库/包的过程。它通常维护一个软件依赖关系和版本信息的数据库，以防止软件不匹配和缺少先决条件。

什么是依赖？

依赖是程序运行所需的文件或库。例如，如果您想使用用PHP编写的库，您需要在您的计算机上安装PHP。在这种情况下，PHP是库的依赖。

什么是依赖管理器？

依赖管理器是一个工具，它以一致的方式自动化安装、升级、配置和删除依赖的过程。它通常维护一个软件依赖关系和版本信息的数据库，以防止软件不匹配和缺少先决条件。

什么是库？

库是一组设计为供其他程序使用的代码。它通常包含可用于执行特定任务（如连接到数据库或发送电子邮件）的函数和类。

什么是框架？

框架是一组设计为协同工作以提供针对特定问题完整解决方案的库。例如，Laravel框架是一组设计为协同工作以提供构建Web应用程序完整解决方案的库。

如何创建PHP SDK

步骤1：创建新项目

创建一个新项目文件夹，并在其中创建一个composer.json文件。composer.json文件用于定义项目依赖项。它还用于定义项目名称、版本和描述。

{
    "name": "umeskia/umeskia-php-sdk",
    "description": "A simple PHP SDK",
    "version": "1.0.0",
    "authors": [
        {
            "name": "Your Name",
            "email": "123@example.com",
            "homepage": "https://example.com"
        }
    ],
    "require": {}
}

步骤2：创建新类

在src文件夹中创建一个新类。类的名称应与包名称相同。例如，如果包名称是php-sdk，则类名称应为PhpSdk.php。

<?php

namespace PhpSdk;

class PhpSdk
{
    public function __construct()
    {
        echo 'Hello World!';
    }
}

您还可以给类添加一个命名空间。例如，如果包名为php-sdk，则命名空间应为PhpSdk。

以下是一个用于测试SDK的示例文件夹及其中的示例文件。例如，如果包名为php-sdk，则示例文件应命名为index.php。

<?php

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

use PhpSdk\PhpSdk;

$phpSdk = new PhpSdk();

这是项目的文件结构

php-sdk
├── composer.json
├── example
│   └── index.php
└── src
    └── PhpSdk.php

步骤3：将类添加到composer.json文件中

将类添加到composer.json文件中。类应添加到自动加载部分。例如，如果包名为php-sdk，则类应添加到自动加载部分。

{
    "name": "umeskia/umeskia-php-sdk",
    "description": "A simple PHP SDK",
    "version": "1.0.0",
    "authors": [
        {
            "name": "Your Name",
            "email": "123@example.com",
            "homepage": "https://example.com"
        }
    ],
    "require": {},
    "autoload": {
        "psr-4": {
            "PhpSdk\\": "src/"
        }
    }
  }

要验证模式是否有效，请运行以下命令

composer validate

或阅读文档此处

步骤4：安装依赖项

使用Composer安装依赖项。依赖项在composer.json文件中定义。例如，如果包名为php-sdk，则依赖项在composer.json文件中定义。

composer install

步骤5：测试SDK

通过运行示例文件来测试SDK。例如，如果包名为php-sdk，则示例文件位于示例文件夹中。

php example/index.php

步骤6：发布SDK

将SDK发布到Packagist。Packagist是主要的Composer仓库。它聚合了公共PHP包，可通过Composer安装。

要将SDK发布到Packagist，您需要在Packagist上创建一个账户，点击此处创建账户。

创建账户后，您需要在Packagist上创建一个新的包。要创建新包，请点击此处创建新包。

将公共仓库添加到composer.json文件中。公共仓库用于将SDK发布到Packagist。例如，如果包名为php-sdk，则公共仓库用于将SDK发布到Packagist。

步骤7：安装SDK

使用Composer安装SDK。Composer是PHP中的依赖管理工具。它允许您声明项目依赖的库，并为您管理（安装/更新）它们。

composer require php-sdk/php-sdk

步骤8：测试SDK

通过运行示例文件来测试SDK。例如，如果包名为php-sdk，则示例文件位于示例文件夹中。

php example/index.php

步骤9：更新SDK

使用Composer更新SDK。Composer是PHP中的依赖管理工具。它允许您声明项目依赖的库，并为您管理（安装/更新）它们。

composer update php-sdk/php-sdk

步骤10：测试SDK

通过运行示例文件来测试SDK。例如，如果包名为php-sdk，则示例文件位于示例文件夹中。

php example/index.php

步骤11：卸载SDK

使用Composer卸载SDK。Composer是PHP中的依赖管理工具。它允许您声明项目依赖的库，并为您管理（安装/更新）它们。

composer remove php-sdk/php-sdk

我已经在Packagist上发布了SDK，您可以通过运行以下命令来测试它

composer require umeskia/umeskia-php-sdk

要发布到生产环境，您需要创建一个标签，如下所示

git add .

git commit -m "Prepare for stable release"

git tag v1.0.0

git push origin v1.0.0