## 示例:手把手教你发布自己的 Composer 包
## 一、前言
Composer 是 PHP 用来管理依赖(dependency)关系的工具。我们不仅要学会使用别人提供的包,更要学会制作和分享自己的软件包,下面演示如何创建一个自己的 Composer 包。
#### 准备工作:
1. 注册 [Github](https://link.jianshu.com?t=https%3A%2F%2Fgithub.com%2F) 账号
2. 注册 [Packagist](https://link.jianshu.com?t=https%3A%2F%2Fpackagist.org%2F) 账号
## 二、实践
本案例演示如何创建一个第三方消息推送(极光推送)的包。
#### 1\. 创建 Github 仓库
登录 Github,创建仓库 `yanlongma/push`,并将代码克隆到本地:
~~~php
$ git clone https://github.com/yanlongma/push.git
~~~
#### 2\. 创建 Composer 配置文件
进入项目根目录,创建 Composer 配置文件 composer.json,可以使用命令 `compser init` 创建也可以手动创建,最终文件内容大体如下:
~~~json
{
"name": "yanlongma/push",
"description": "Third party message push",
"authors": [
{
"name": "Yanlong Ma"
}
],
"license": "MIT",
"require": {
"php": ">=5.4"
},
"autoload": {
"psr-4": {
"YanlongMa\\Push\\": "src/"
}
}
}
~~~
#### 3\. 提交代码到 Github
根据自己需要实现的功能编写代码,本项目最终项目结构如下:
~~~undefined
.git/
.gitignore
composer.json
README.md
src/
Client.php
JPush.php
~~~
代码编写完成且测试没问题后提交代码到 Github。
#### 4\. 发布包到 Packagist
登录 Packagist,检出 `https://github.com/YanlongMa/push.git` 仓库的代码,系统会根据仓库中 composer.json 文件自动设置包的相关信息。
#### 5\. 设置 Packagist 中的包自动更新
如果不设置自动同步,每次 Github 中的代码更新,需要在对应包中手动更新,所以建议设置自动更新。步骤如下:
1. 进入 yanlongma/push 仓库,选择 "Settings -> Integrations & services";
2. 点击 "Add service",选择 “Packagist”;
3. 填写你的 Packagist 账号对应的信息(登录后点击查看[https://packagist.org/profile/](https://link.jianshu.com?t=https%3A%2F%2Fpackagist.org%2Fprofile%2F) )
4. 配置完成后,点击右上角的“Test service”,如果出现 “Okay, the test payload is on its way.”,则说明配置成功。
#### 6\. 使用共享包
发布包到 Packagist 后,根据包名就可以搜索和使用该包了,在自己的项目中申明该包依赖:
~~~ruby
$ composer require yanlongma/push
~~~
该包的具体使用可以查看 [https://github.com/yanlongma/push](https://link.jianshu.com?t=https%3A%2F%2Fgithub.com%2Fyanlongma%2Fpush)。
***注***:
* 发布包到 Packagist 后,可能过几分钟才能在客户端 search 到;
* 没有打 tag 的要指定 dev,完整命令`composer require "yanlongma/push @dev"`
- composer教程文档
- Composer 的常用命令
- 镜像操作
- 教程收集
- composer命令
- 全局选项
- init命令
- 安装命令
- update命令
- require命令
- remove命令
- check-platform-reqs
- globa命令
- search命令
- show命令
- outdated命令
- Options命令
- browse / home命令
- suggests命令
- depends (why)命令
- prohibits (why-not)命令
- validate验证命令
- status状态命令
- self-update (selfupdate)
- config命令
- create-project命令
- dump-autoload (dumpautoload)
- clear-cache (clearcache)
- licenses命令
- run-script命令
- exec命令
- diagnose命令
- archive命令
- help命令
- 环境变量
- composer.json说明
- composer.json示例1
- 自制composer包
- 制作步骤1、生成composer包
- 制作步骤2:生成目录结构
- 制作步骤3:完善程序
- 制作步骤4:上传程序包
- 示例:手把手教你发布自己的 Composer 包
- 示例:一步一步创建自己的composer包
- 实例2
- 镜像与常用包
- 中国镜像
- 常用包收集
- composer包的使用
- 包的使用
- 本地自定义文件的使用