动手开发自己的第一个 composer 包

之前用laravel框架开发时,一直用composer工具来安装开源的依赖库文件,没有自己去开发这样的依赖库。本着学习的心态,准备去实现自己的一些PHP相关的依赖库。

本文是借助他人的文档学习了解的
转载地址: http://blog.jayxhj.com/2016/05/basic-composer-package-development/

Composer

是 PHP 用来管理依赖(dependency)关系的工具。你可以在自己的项目中声明所依赖的外部工具库(libraries),Composer 会帮你安装这些依赖的库文件。

开发 composer 包有以下几个步骤:

1.初始化 composer.json 文件
2.定义命名空间及包名
3.实现包需要实现的功能
4.提交到 GitHub
5.在 Packagist 注册包

初始化 composer.json 文件

在项目目录下通过运行composer init 以命令行的方式设置composer.json

下面介绍其中的一些属性,以及常规的设置

1.name
"name": "antik/curl" 此属性定义包名,以 / 隔开,前面的为供应商名字,后面为包名,供应商代表 Packagist 网站为开发者提供的唯一的名字,用来组织包以及防止命名冲突。所以提交时最好先访问 https://packagist.org/packages/yourvendorname 将 url 中的 yourvendorname 替换为你想要取的名字,查看包名是否已经被注册了。

2.type
"type": "library" 包的安装类型,默认为 library。

composer 原生支持以下4种类型:

  • library: 这是默认类型,它会简单的将文件复制到 vendor 目录。
  • project: 这表示当前包是一个项目,而不是一个库。
  • metapackage: 当一个空的包,包含依赖并且需要触发依赖的安装,这将不会对系统写入额外的文件。因此这种安装类型并不需要一个 dist 或 source.
  • composer-plugin: 一个安装类型为 composer-plugin 的包,它有一个自定义安装类型,可以为其它包提供一个 installler。详细请查看 自定义安装类型。

3.license
许可证。关于许可证,建议看两篇文章,开源项目 license 介绍 、 如何选择 license

4.autoload
此配置下主要是 PSR-4 或者 PSR-0 设置,更推荐使用 PSR-4 标准。

使用 composer validate composer.json 来验证文件是否是有错误

演示的设置 composer.json 的视频:https://asciinema.org/a/45460

提交至 GitHub

按照前面的步骤,一个包就有了基本的骨架,接下来就是上传至 GitHub ,配置项目,集成持续集成服务,发布开源项目许可证。

GitHub 初始化项目时可以选择生成 .gitignore 文件,选择许可证,初始化 README.md 文件,切换至本地的项目目录后,按如下步骤即可将目录上传至 GitHub:

git init # 初始化仓库
git remote set-url origin --push --add [email protected]:jayxhj/geosso.git # 添加远程追踪仓库地址
git add .
git commit
git push origin master

提交至 Packagist

Packagist 为 composer 默认获取包元数据信息的地址,从 Packagist 获取到元数据信息后,再从 GitHub 上拉取代码。因此,当把你开发的包上传至 GitHub 后还需要将其在 Packagist 注册,这样全世界的人都能通过 composer 去拉去你的代码了。

提交至 Packagist 只需三个步骤:
1.注册帐号
2.在 https://packagist.org/packages/submit 提交开发包
3.设置 webhook 以便提交包更新后能及时地同步至 Packagist

自此,一个基本的包开发就结束了。通过 composer 来管理 PHP 的依赖,通过编写 composer package 去扩展自己的类库,通过引入其他的类库来填充自己的功能,就不用重复造轮子了。

你可能感兴趣的:(动手开发自己的第一个 composer 包)