0

0

如何创建一个自己的 composer 包并发布到 Packagist?

冰火之心

冰火之心

发布时间:2025-11-21 12:41:02

|

324人浏览过

|

来源于php中文网

原创

答案:创建Composer包需准备项目结构、编写composer.json、推送至GitHub并发布到Packagist。具体步骤为:构建含src、composer.json等文件的标准目录,配置composer.json中的名称、自动加载和依赖信息,将代码推送到GitHub仓库并打v1.0.0标签,登录Packagist提交仓库URL,设置Webhook实现自动更新,最后通过composer require安装使用。

如何创建一个自己的 composer 包并发布到 packagist?

创建并发布自己的 Composer 包到 Packagist 是一个非常实用的技能,尤其当你想复用代码或为社区贡献组件时。整个过程并不复杂,只要按步骤操作即可。

准备你的项目结构

一个标准的 Composer 包需要清晰的目录结构和必要的文件。基本结构如下:

  • src/:存放你的 PHP 类文件
  • tests/(可选):测试代码
  • composer.json:核心配置文件
  • README.md:说明文档
  • license 文件:如 MIT、GPL 等

例如,你的项目根目录可能长这样:

/my-awesome-package
├── src/
│   └── Calculator.php
├── composer.json
├── README.md
└── LICENSE

编写 composer.json 文件

这是最关键的一步。composer.json 定义了包的基本信息、自动加载方式和依赖关系。

示例内容:

{
  "name": "your-username/my-awesome-package",
  "description": "A simple calculator package",
  "type": "library",
  "license": "MIT",
  "authors": [
    {
      "name": "Your Name",
      "email": "you@example.com"
    }
  ],
  "require": {
    "php": "^7.4 || ^8.0"
  },
  "autoload": {
    "psr-4": {
      "MyAwesomePackage\\": "src/"
    }
  },
  "minimum-stability": "stable",
  "prefer-stable": true
}
注意:
  • name 格式为 用户名/包名,这必须与你在 Packagist 上的账户一致
  • autoload.psr-4 定义命名空间映射,确保类能被正确加载
  • 提交前运行 composer validate 检查语法是否正确

托管到 GitHub 或 GitLab

Packagist 会从 Git 仓库拉取你的包,所以你需要将代码推送到公开平台。

  • 创建一个新的 GitHub 仓库(比如:my-awesome-package
  • 初始化 git 并推送代码:
git init
git add .
git commit -m "Initial release"
git remote add origin https://github.com/your-username/my-awesome-package.git
git push -u origin main

然后打一个版本标签,比如:

GForge5.7.1
GForge5.7.1

GForge是一个基于Web的协同开发平台。它提供一组帮助你的团队进行协同开发的工具,如论坛,邮件列表等。用于创建和控制访问源代码管理库(如CVS,Subversion)的工具。GForge将自动创建一个源代码库并依据项目的角色设置进行访问控制。其它工具还包括:管理文件发布,文档管理,新闻公告,缺陷跟踪,任务管理等。

下载
git tag v1.0.0
git push origin v1.0.0
Packagist 推荐使用语义化版本(Semantic Versioning)。

发布到 Packagist

访问 https://www.php.cn/link/ec811d0d775adc62776ba80fadd4ed19 并登录(支持 GitHub 登录)。

  • 点击右上角“Submit”
  • 输入你的仓库 URL(如:https://github.com/your-username/my-awesome-package
  • 点击“Check”然后“Submit”

Packagist 会抓取你的 composer.json 信息并展示你的包。

你还可以设置 Webhook,让 Packagist 在你推送新标签时自动更新:

  • 在 GitHub 仓库中进入 Settings → Webhooks
  • Add webhook
  • Payload URL: https://www.php.cn/link/ec811d0d775adc62776ba80fadd4ed19/api/github
  • Content type: application/json
  • Events: 选择 “Just the push event” 或 “Let me select individual events”,勾上 “Create”

使用你的包

发布成功后,任何人都可以通过 Composer 安装:

composer require your-username/my-awesome-package

在代码中使用命名空间引入类:

use MyAwesomePackage\Calculator;
$calc = new Calculator();
基本上就这些。只要你的 composer.json 正确、Git 标签清晰、命名空间匹配,整个流程很顺畅。维护好 README 和版本更新日志,会让你的包更受欢迎。

相关专题

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

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

2788

2023.09.01

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

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

1687

2023.10.11

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

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

1548

2023.10.11

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

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

1036

2023.10.23

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

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

1485

2023.10.23

html怎么上传
html怎么上传

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

1256

2023.11.03

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

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

1569

2023.11.09

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

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

1307

2023.11.13

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

热门下载

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

相关下载

更多

精品课程

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

共137课时 | 9.1万人学习

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

共6课时 | 9.9万人学习

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

共13课时 | 0.9万人学习

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

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