如何进行composer包开发

保护私人版权，尊重他人版权。转载请注明出处并附带页面链接

一、初始化包

首先

打开控制台
然后 `mkdir testcomposer` 创建文件夹
进入文件夹 cd testcomposer

请看下面设置：

➜  testcomposer composer init

  Welcome to the Composer config generator

This command will guide you through creating your composer.json config.

// 1. 输入项目命名空间
// 注意<vendor>/<name> 必须要符合 [a-z0-9_.-]+/[a-z0-9_.-]+
Package name (<vendor>/<name>) [lumen/testcomposer]: test/test

// 2. 项目描述
Description []: 这个是描述

// 3. 输入作者信息，可以直接回车
Author [lumen <lumen@qq.com>, n to skip]:

// 4. 输入最低稳定版本，stable, RC, beta, alpha, dev
Minimum Stability []: dev

// 5. 输入项目类型 平时的sdk一般就是library
Package Type (e.g. library, project, metapackage, composer-plugin) []: library

// 6. 输入授权类型
License []: MIT

Define your dependencies.

// 7. 输入依赖信息 以交互的方式来添加依赖，也可以自己创建项目完成后手动添加 到 `require` 里面
Would you like to define your dependencies (require) interactively [yes]? no

Would you like to define your dev dependencies (require-dev) interactively [yes]?

// 如果需要依赖，则输入要安装的依赖
Search for a package: php

// 输入版本号
Enter the version constraint to require (or leave blank to use the latest version): >=7.0.0

//如需多个，则重复以上两个步骤

下面就是composer.json文件的内容
{
    "name": "test/test",
    "description": "这描述",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "lumen",
            "email": "lumen@qq.com"
        }
    ],
    "minimum-stability": "dev",
    "require": {}
}

//这个说的是要不要生成composer.json文件
Do you confirm generation [yes]? yes

二、添加自动加载

"autoload": {
        "psr-4": {
            "Lumen\\Util\\": "src/"
        }
    }

三、添加依赖

"require": {
        "php": ">=7.0.0",//php版本限制
    },
"require-dev": {
        "phpunit/phpunit": "^8.3@dev"//这个在开发的时候使用composer引入也可以
    },

可以使用这个不引入只是开发时候需要引入的包 composer install --no-dev

四、目录结构

├─test                      扩展包根目录
│  ├─src                    扩展包代码目录
│  │  ├─TimeHandle.php
│  ├─tests                  测试目录
│  │  ├─TimeHandleTest.php
│  ├─.gitignore
│  ├─composer.json
│  ├─LICENSE
│  └─README.md

五、安装phpunit 进行测试

1. 例如 TimeHandle.php 文件里面如下：

   namespace Lumen\Util;
   
   class TimeHandle
   {
        /**
        * 根据时间戳获取周的时间 1-7 7是周天，系统函数获取的周天是0--这里转换了
        *
        * @param int $timestamp
        * @return int
        */
       public static function getWeekFromTimestamp(int $timestamp): int
       {
           $week = date('w', $timestamp);
           if ($week == 0) {
               return 7;
           }
   
           return (int)$week;
       }
   }

2. 那么tests文件夹里面的 TimeHandleTest.php 文件里面如下：

   namespace Lumen\Util\Test;
   
   class TimeHandleTest
   {
       public function testGetWeekFromTimestamp()
       {
           $timestamp = 1562484344;//需要测试的日期时间戳
           //$this->assertEquals(期望的结果,需要测试的函数返回的结果);
           $this->assertEquals(7, TimeHandle::getWeekFromTimestamp($timestamp));
       }
   }

3. 因为命名空间不一样，所以需要在composer.json文件里面设置自动加载

   "autoload": {
       "psr-4": {
           "Lumen\\Util\\": "src/",
           "Lumen\\Util\\Tests\\": "tests/"
       }
   }

4. 加完后需要使用 composer dump-autoload

5. composer require phpunit/phpunit 就能够安装单元测试套件

6. 然后执行 vendor/bin/phpunit tests 就可以跑tests文件夹里面的测试了

六、发布

1. 如果是内部使用，只需要放到内部的gitlab或者私有github;然后在引用的项目的composer.json如下配置:

   "repositories": [
      {
        "type": "git",
        "url": "https://github.com/lumening/lumen-hprose.git"
      }
    ],

   然后执行 composer require "lumening/lumen-hprose" 引入

2. 如果需要开源发布提供他人使用则可以如下操作:

   • 将代码提交到github,如要设置版本可以自行打tag
   • 用github账号授权登录 https://packagist.org/
   • 然后在 https://packagist.org/packages/submit这个网址填入你需要发布的github项目地址
   • 然后按提示下一步则可
     然后在需要引用的项目根目录执行 composer require lumening/lumen-hprose

Sub

扫码关注微信公众号，随时随地，掌握最新技术资讯

微信