本文是帮助初学者搭建基础的 php composer 包, 本项目源码地址

  • github

  • packagist

    目录结构和初建准备

    首先创建一个目录来存放所有文件, 这里我 命名为 util-demo , 目录中需要包含两个目录 src/, tests/, 所有的代码需要放置到 src/ 目录, 所有的测试文件需要放置到 tests/ 目录
    初始化文件夹, 并使用 git 初始化项目, 便于进行版本管理

    1. $ mkdir util-demo
    2. $ cd util-demo
    3. $ git init

    初始化 composer

    这里假定你已经安装了 composer, 如果没有安装, 请到 https://getcomposer.org/download/ 进行安装
    初始化并输入包名, 这里默认使用 duoli/util-demo 包名

    1. $ composer init
    2. Welcome to the Composer config generator
    3. This command will guide you through creating your composer.json config.
    4. Package name (<vendor>/<name>) [duoli/util-demo]:

    输入描述

    1. Description []: first util package demo

    输入作者名称, n 跳过

    1. Author [duoli <zhaody901@126.com>, n to skip]:

    设定包的稳定版本, 默认是 stable, 详细查看 minimum-stability (root-only)

    1. Minimum Stability []:

    安装类型 : Package Type, 默认是 library

    1. Package Type (e.g. library, project, metapackage, composer-plugin) []:

    License, 协议, 关于协议部分, 你可以选择自己需要的协议, 阮老师这里有一个阅读指南, 可以进行参考 如何选择开源许可证？, 对于协议部分的写法可以参考 许可协议 license 这里

    1. License []:

    require
    设定三方依赖, 表明当前项目/包是否有依赖于其他包进行开发, 这里选择 no,

    1. Define your dependencies.
    2. # 生产依赖
    3. Would you like to define your dependencies (require) interactively [yes]?

    require-dev
    开发依赖, 这里我们加入 phpunit 作为单元测试依赖

    1. Would you like to define your dev dependencies (require-dev) interactively [yes]?
    2. Search for a package: phpunit
    3. Found 15 packages matching phpunit
    4.  [0] phpunit/phpunit
    5.  ...
    6.  [14] brianium/paratest
    7. Enter package # to add, or the complete package name if it is not listed: 0
    8. Enter the version constraint to require (or leave blank to use the latest version):
    9. Using version ^8.5 for phpunit/phpunit
    10. Search for a package:

    当不需要额外增加包的时候, 直接回车, 确认安装包依赖, 初始化完成

    1. {
    2.   "name": "duoli/util-demo",
    3.   "description" : "first util package demo",
    4.   "require-dev": {
    5.       "phpunit/phpunit": "^8.5"
    6.   },
    7.   "license": "MIT",
    8.   "authors": [
    9.       {
    10.           "name": "duoli",
    11.           "email": "zhaody901@126.com"
    12.       }
    13.   ],
    14.   "require": {}
    15. }
    16. Do you confirm generation [yes]?
    17. Would you like to install dependencies now [yes]? yes
    18. Loading composer repositories with package information
    19. Updating dependencies (including require-dev)
    20. Package operations: 29 installs, 0 updates, 0 removals
    21. - Installing sebastian/version (2.0.1): Downloading (100%)
    22. ......
    23. - Installing phpunit/phpunit (8.5.8): Downloading (100%)
    24. sebastian/global-state suggests installing ext-uopz (*)
    25. phpunit/phpunit suggests installing phpunit/php-invoker (^2.0.0)
    26. Package phpunit/php-token-stream is abandoned, you should avoid using it. No replacement was suggested.
    27. Writing lock file
    28. Generating autoload files
    29. 5 packages you are using are looking for funding.
    30. Use the `composer fund` command to find out more!

    上边初始化完成之后, 我们文件目录应该如下所示

    1. .
    2. ├── composer.json
    3. ├── composer.lock
    4. └── vendor

    作为包管理来讲, 我们需要忽略 composer.lock 和 vendor 文件夹, 因为在项目中使用此包的时候会进行全局的安装, 不提交是为了不产生冗余代码.
    我们加入 .gitignore 文件, 加入这两个文件夹的忽略, 另外由于要生成 phpunit 测试文件, 我们还需要加入 .phpunit.* , 我这里还额外加入了 IDE 的忽略
    .gitignore

    1. # ide
    2. .idea
    3. # project
    4. composer.lock
    5. vendor/
    6. # phpunit
    7. .phpunit.*

    文件自动加载 autoload

    autoload
    这里是上边初始化没有提及到的, autoload 指定了包的加载方式, Composer 可以自动加载包内文件, 但是你需要指定你的文件的加载方式, 这里我们使用的是 psr-4 标准, 详细的规范可以阅读 PSR-4 自动加载规范
    这里需要在 composer.json 中追加

    1. ...
    2.   "autoload": {
    3.       "psr-4": {
    4.           "Duoli\\UtilDemo\\": "src",
    5.           "Duoli\\UtilDemoTests\\": "tests"
    6.       }
    7.   }
    8.  ...

    因为这个加载是后续添加的, 想要识别需要我们手动运行下 composer dumpautoload, 这样才可以识别我们添加的命名空间映射
    另这里我额外约定了一个测试的命名空间, 方便对测试文件进行命名空间的目录识别

    travis 测试集成

    如果打算在GitHub上托管包，一个不错优点是集成Travis CI，这是一个持续集成应用程序，它会自动运行单元测试文件. 当接受 pr 时，会非常有用，因为你可以快速查看是否所有的测试都通过验证。
    要与 Travis 集成，添加一个名为 .travis.yml 的文件，并复制以下内容

    1. language: php
    2. php:
    3.   – 7.0
    4.   – hhvm
    5. before_script:
    6.   – composer self-update
    7.   – composer install –prefer-source –no-interaction –dev
    8. script: phpunit

    在这里，不会深入讨论使用 Travis 的问题，但这应该是一个很好的开始，你可以自己来进行研究如何使用它.

    编写代码

    现在可以编写代码了, 打开 src 目录创建 File.php 文件, 复制如下代码

    1. class File
    2. {
    3.   public function extension($filename)
    4.   {
    5.       return pathinfo($filename, PATHINFO_EXTENSION);
    6.   }
    7. }

    如果你曾经查看过旧的 PHP 包源码，可能会发现一个 Duoli/UtilDemo 目录。PSR-4 不再使用嵌套的目录结构，而是允许直接在 src 目录下编写类

    编写单元测试

    现在我们已经编写了包源码，可以开始编写一些测试了。PHPUnit 需要一个名为 phpunit.xml 的文件来定义一些设置。在根目录中创建一个新的phpunit.xml文件，并复制以下代码:

    1. <phpunit
    2.   backupGlobals="false"
    3.   backupStaticAttributes="false"
    4.   bootstrap="vendor/autoload.php"
    5.   colors="true"
    6.   convertErrorsToExceptions="true"
    7.   convertNoticesToExceptions="true"
    8.   convertWarningsToExceptions="true"
    9.   processIsolation="false"
    10.   stopOnFailure="false">
    11.   <testsuites>
    12.       <testsuite name="Duoli Util Test Suite">
    13.           <directory suffix=".php">./tests/</directory>
    14.       </testsuite>
    15.   </testsuites>
    16. </phpunit>

    如果不熟悉这个文件中意思，不用担心，你无需关注设置了哪些内容(当前来讲), 这个文件只是定义一些设置和文件应该如何自动加载的约定.
    接下来，在 tests 目录下，创建一个名为 StrTest.php的文件，并复制以下代码:

    1. <?php namespace Duoli\UtilDemoTests;
    2. use Duoli\UtilDemo\File;
    3. use PHPUnit\Framework\TestCase;
    4. class FileTest extends TestCase
    5. {
    6.   public function testExtension()
    7.   {
    8.       $extension = File::extension('readme.md');
    9.       $this->assertEquals('md', $extension);
    10.   }
    11. }

    打开命令行并运行:

    1. $ ./vendor/bin/phpunit

    PHPUnit 会自动运行测试，并给出一个绿色的 OK (1 test, 1 assertion) 输出。
    在编写测试文件时，需要确保测试类继承了 PHPUnit\Framework\TestCase

    文档

    最后要做的是创建一个 Readme.md 的文档。如果打算在 GitHub 上托管代码，这个文件会在代码页面显示出来，目的是描述包以及包如何工作.
    还应该在源代码中包含一个许可证。默认情况下，你发布的任何东西都是你的版权所有，如果你想让其他人使用你的代码，你需要给它一个许可。一个好的选择是 MIT 许可

    发布到 github 和 Packagist

    现在已经完成了你的包，你可以将它推到 GitHub 和 Packagist。
    GitHub 是一个托管的 git 存储库服务，它使得在软件协作变得非常容易。
    Packagist 是查找和使用 PHP 包的服务商
    要将代码推送到 GitHub，创建一个新的存储库, 然后设定 git 的远端, 将代码推上去即可, 命令是

    1. $ git remote add origin git@github.com:username/demo.git
    2. $ git push -u origin master

    在 Github 上集成 Packagist 和 Travis, 需要找到设置, 并且在 Webhooks & Services 部分找到这两个服务, 集成这两个服务需要授权 github 账户并且设置一些简单的步骤.

    概括

    如果以前从未开发过已发布的 php 包，那么需要考虑很多问题。然而，一旦你操作过不止一次就不至于这么复杂了.
    PHP 的包结构非常简单，而 PSR-4 使其更加简单。一旦了解了该结构的每一部分是用于做什么，其他人阅读 PHP 包就会容易很多.

    参考文章

  • How to create a PSR-4 PHP package