怎样为开源项目添加赞助打赏链接?在composer.json中配置funding字段

P粉328763957

P粉328763957

2026-06-19

507人浏览

原创

在 composer.json 中正确配置 funding 字段需满足:必须为数组,每项含合法 type(如 github、ko_fi)和完整 https url;github 仅显示首个 type 为 github 的赞助链接且需启用 sponsors 功能;packagist 需手动触发更新。

怎样为开源项目添加赞助打赏链接?在composer.json中配置funding字段

直接在 composer.json 里加 funding 字段就能让 Packagist、GitHub(自动解析)、Composer CLI 等地方显示赞助入口,但字段格式不对或平台不匹配,链接根本不会出现。

composer.json 的 funding 字段必须是数组,且每项含 typeurl

不是字符串,不是对象,也不是随便写个链接——Packagist 只认严格符合 Schema 的数组结构。常见错误包括:"funding": "https://ko-fi.com/xxx"(无效)、"funding": {"github": "user/repo"}(格式错)、漏掉 type

  • type 必须是 Packagist 官方认可的值,比如 githubpatreonopencollectiveko_fitideliftcommunity_bridge 等(注意下划线和连字符)
  • url 必须是完整可访问的 HTTPS 链接,不能是相对路径或短链
  • 支持多个赞助渠道,直接写成数组即可,顺序不影响显示

正确示例:

php版微信js-sdk支付接口类
php版微信js-sdk支付接口类

php版微信js-sdk支付接口类

下载
{
    "funding": [
        {
            "type": "github",
            "url": "https://github.com/sponsors/yourname"
        },
        {
            "type": "ko_fi",
            "url": "https://ko-fi.com/yourname"
        }
    ]
}

GitHub 会自动读取 composer.jsonfunding,但只在特定位置显示

GitHub 不是“解析后展示所有链接”,它只在仓库主页右侧边栏的 Sponsor 按钮处使用第一个合法的 github 类型条目;其他类型(如 ko_fi)即使存在也不会出现在这里。

  • 如果想让 GitHub 显示自己的 Sponsor 按钮,type 必须是 github,且 url 必须指向 https://github.com/sponsors/xxx(不是个人主页或组织页)
  • GitHub 不识别 patreonopencollective 类型——那些只会对 Packagist 和 composer fund 命令生效
  • 确保仓库已启用 GitHub Sponsors(Settings → Sponsorship),否则按钮不显示,哪怕 funding 配置完全正确

composer fund 命令只显示当前项目依赖中声明了 funding 的包

运行 composer fund 后,它列出的是你项目 vendor/ 下所有包的赞助信息,不是你自己的项目——除非你用 composer fund vendor/package-name 指定某一个。

  • 你的项目本身不会出现在 composer fund 默认列表里,因为 Composer 只扫描已安装的依赖,不扫描当前工作目录
  • 想测试自己项目的配置是否生效,得先 composer require your-vendor/your-package:dev-main(本地开发时用 path repo 或 symlink 更方便)
  • type 值影响 CLI 显示图标:比如 github 显示 Octocat,ko_fi 显示 K,拼写错误会导致图标 fallback 为问号

最容易被忽略的一点:Packagist 同步有延迟,改完 composer.json 后要手动触发更新(在 Packagist 页面点 “Update”),或者等下次 webhook 自动抓取——改完就以为立刻生效,其实可能卡在缓存里几个小时。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.25

224

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

176

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

138

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

143

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

69

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

174

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

65

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

84

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

91

26

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 133人学习

Composer 从入门到实战
Composer 从入门到实战

共1课时 | 121人学习

Composer手册
Composer手册

共0课时 | 0人学习