如何发布自己的composer包(详细配图)

思考

当你有一个好的idea,写了一个自我感觉还不错的工具或者组件,并迫不及待的想让别人去试试的时候,你会怎么做?

把代码贴在博客 需要花时间复制粘贴,阅读代码
把代码发布在github 还是需要花时间down\clone,不能直接组件化加载
把代码发布在composer ✔️ 只需要知道是干嘛的,组件化引入直接使用

或者你看到一个好的composer的类库,为什么可以直接加载进来,它是怎样被发布出来供大家使用的呢?

介绍

Composer 是一个用于 PHP 依赖管理的工具。它实现了让你声明项目所依赖的库,并帮你完成安装 / 更新过程。

composer.json

最熟悉的文件,可以手写也可以命令行生成,其中定义了我们当前项目的依赖项。json里有很多配置项,下面我们用一个熟悉的包guzzlehttp来举例说一下每个字段代表的意义。

{
     "name": "guzzlehttp/guzzle",//composer 包名
     "type": "library",//这是默认类型,它会简单的将文件复制到vendor目录
     "description": "Guzzle is a PHP HTTP client library",//一个包的简短描述。通常这个最长只有一行。
     "keywords": ["framework", "http", "rest", "web service", "curl", "client", "HTTP client"],//在composer搜索用到
     "homepage": "http://guzzlephp.org/",//项目主页
     "license": "MIT",//包的许可协议
     "authors": [//作者
         {
             "name": "Michael Dowling",
             "email": "mtdowling@gmail.com",
             "homepage": "https://github.com/mtdowling"
         }
     ],
     "require": {//必要的依赖
         "php": ">=5.5",
         "guzzlehttp/psr7": "^1.4",
         "guzzlehttp/promises": "^1.0"
     },
     "require-dev": {//开发版的依赖,一般帮助开发阶段使用
             "ext-curl": "*",//可以帮你指定需要的 PHP 扩展(包括核心扩展)例如在编辑器的自动提示功能
             "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.4 || ^7.0",
             "psr/log": "^1.0"
     },
     "autoload": {//自动加载映射
             "files": ["src/functions_include.php"],//自动加载的函数库文件 相当于直接require该文件,直接使用其中function 数组可配置多个
             "psr-4": {
                "GuzzleHttp\\": "src/"
             }
     },
     "autoload-dev": {//一般将单元测试的路径放在这里
             "psr-4": {
                "GuzzleHttp\\Tests\\": "tests/"
             }
     },
     "suggest": {//建议安装的包
             "psr/log": "Required for using the Log middleware"
     },
     "extra": {//可选项
             "branch-alias": {
                "dev-master": "6.3-dev"
             }
     },
     "bin": [//composer安装时会将script脚本文件复制到vendor/bin中 比如 php vendor/bin/script 执行一些组件的脚本功能
         "bin/script"
     ]
}

Coding

下面我写了一个最简单的工具类,目录如下

├── README.md
├── composer.json
└── src
    ├── Db.php
    ├── DbInterface.php
    ├── Test.php
    └── function.php

代码都在src目录下,composer.json内容如下

{
    "name": "ty_coder/composertest",
    "description": "a test composer library ",
    "authors": [
        {
        "name": "tyCoder"
        }
    ],
    "license": "MIT",
    "require": {
        "php": ">=5.4"
    },
    "autoload": {
        "psr-4": {
            "ty\\": "src/"
        },
        "files": [
            "src/function.php"
        ]
    }
}

然后发布在github上,下一步我们将项目发布在composer。

发布

登陆composer仓库,访问https://packagist.org/packages/submit

composer仓库会帮我们验证项目是否满足发布条件,在我们完成发布后,就可以通过composer require 在任何项目中加载我们编写的工具类库了。不过还有一个问题,我们想要更新我们的工具类库,并保留之前的版本,我们该怎样做?这些composer其实都为我们准备了超级方便的钩子设置方案了,请看下图。

通过个人资料我们拿到自己的API token,然后去我们的github的仓库页,在设置里找到Webhooks选项,设置一下钩子即可,我们每次git事件都会同步给composer,每次的tag会在composer发布一个版本,注意composer会忽略前缀,所以v这个字母被忽略了奥。

image

image

image

require

执行composer require ty_coder/composertest 后,我们的工具类库被加载到vendor目录下,让我们简单测试一下。

image

好的,我们发现编辑器已经提示我们,我们的类库文件被找到啦,那么本文在这里对composer的一些常用知识的简单介绍也告一段落了。

other

在阅读源码的过程中我们会发现,优良的composer类库或者项目中还会有单元测试模块tests目录,二进制脚本目录bin目录,自动化部署文件.travis.yml文件,还有Dokerfile等等。所以composer中是可以有其他类型文件存在的,特定的文件还会触发特定的功能事件,详细的我们可以去官方文档进一步学习奥。

reference

https://learnku.com/docs/composer/2018 Composer 中文文档

https://packagist.org/ Composer官方库

https://travis-ci.org/ Travis CI 持续集成服务

https://github.com/ziadoz/awesome-php#php-websites 收录很多优秀Composer组件的好地方

12.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,463评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,868评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,213评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,666评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,759评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,725评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,716评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,484评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,928评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,073评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,718评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2 352