0

0

如何为自己创建的 PHP 包编写 composer.json 并发布到 Packagist?

尼克

尼克

发布时间:2025-12-26 15:08:02

|

605人浏览过

|

来源于php中文网

原创

发布PHP包到Packagist需三步:规范编写composer.json(含name、description、type、autoload、require)、推送代码至公开Git仓库(主分支为main/master并打语义化tag)、在Packagist提交仓库URL并启用webhook自动更新。

如何为自己创建的 php 包编写 composer.json 并发布到 packagist?

为自己开发的 PHP 包编写 composer.json 并发布到 Packagist,核心是三步:规范定义包信息、托管代码到公开 Git 仓库、在 Packagist 上提交仓库地址。只要配置准确,整个过程不复杂但容易忽略细节。

写好 composer.json:关键字段不能少

根目录下的 composer.json 是 Composer 识别和安装你的包的依据。至少要包含以下字段:

  • name:格式必须为 vendor/name(如 myname/my-awesome-package),且 vendor 名需与你在 Packagist 的用户名一致
  • description:简明描述功能,Packagist 会直接展示
  • type:推荐填 library(普通类库)或 wordpress-plugin 等特定类型
  • autoload:定义自动加载规则,最常用 PSR-4:
    "autoload": { "psr-4": { "MyName\\MyAwesomePackage\\": "src/" } }
    表示 src/ 目录下对应命名空间,确保类文件路径与命名空间严格匹配
  • require:列出运行时依赖(如 "php": "^8.0""ext-json": "*"),避免写死版本号,用版本约束更稳妥

把代码推送到公开 Git 仓库

Packagist 不托管代码,只抓取你提供的 Git 仓库(GitHub、GitLab、Bitbucket 均可)。操作要点:

  • 仓库必须是公开的(Private 仓库无法被 Packagist 抓取)
  • 主分支建议命名为 mainmaster(Packagist 默认以此为稳定版源)
  • 打上语义化版本 tag(如 v1.0.0v2.1.3),Packagist 会自动识别并生成对应版本
  • 确保 composer.json 在仓库根目录,且所有源码、测试、文档结构清晰

在 Packagist 上提交并启用自动更新

访问 packagist.org,登录后点击右上角 “Submit”:

立即学习PHP免费学习笔记(深入)”;

云模块网站管理系统3.1.03
云模块网站管理系统3.1.03

云模块_YunMOK网站管理系统采用PHP+MYSQL为编程语言,搭载自主研发的模块化引擎驱动技术,实现可视化拖拽无技术创建并管理网站!如你所想,无限可能,支持创建任何网站:企业、商城、O2O、门户、论坛、人才等一块儿搞定!永久免费授权,包括商业用途; 默认内置三套免费模板。PC网站+手机网站+适配微信+文章管理+产品管理+SEO优化+组件扩展+NEW Login界面.....目测已经遥遥领先..

下载
  • 粘贴你的 Git 仓库 URL(如 https://github.com/myname/my-awesome-package
  • 首次提交后,Packagist 会立即抓取并显示包页面;后续新 tag 推送后,需手动点击包页上的 “Update” 按钮,或更推荐启用自动更新
  • 启用自动更新:进入包设置页 → 连接 GitHub/GitLab 账户 → 安装 Packagist webhook(GitHub 叫 “Packagist” app),之后每次 push tag 都会自动同步

验证和使用

发布成功后,别人就能通过 Composer 安装了:

composer require myname/my-awesome-package

你自己也可以新建测试项目验证:

  • 运行 composer init 创建新项目
  • 执行 composer require myname/my-awesome-package
  • 检查 vendor/myname/my-awesome-package 是否存在,尝试 new MyName\MyAwesomePackage\SomeClass() 是否能正常实例化

基本上就这些。重点是 name 格式对得上、autoload 配置正确、Git 公开且带有效 tag。不需要手动上传文件,也不需要注册“包名”,只要仓库可访问,Packagist 就能认出来。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

1703

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1134

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1036

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

948

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1396

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1228

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1439

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1303

2023.11.13

虚拟号码教程汇总
虚拟号码教程汇总

本专题整合了虚拟号码接收验证码相关教程,阅读下面的文章了解更多详细操作。

25

2025.12.25

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 7.9万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号