
这些问题,相信很多开发者都深有体会:
- 分发困难:如何将内部开发的库高效地分发给所有相关项目和团队成员?
- 版本混乱:如何确保所有项目都使用特定且正确的内部库版本,避免“我本地能跑”的尴尬?
-
安装缓慢:当项目依赖的私有包数量增多时,
composer install从私有Git仓库直接拉取会非常耗时。 - 安全顾虑:内部业务逻辑或敏感配置的库,绝不能上传到公共Composer仓库。
这些困境,严重阻碍了团队的协作效率和项目的迭代速度。直到我遇到了 Composer Satis。
Composer在线学习地址:学习地址
Composer Satis:你的专属私有Composer仓库生成器
Satis,全称“Simple Repository Generator”,正如其名,它是一个简单而强大的工具,专为PHP开发者设计,用于创建私有包仓库。它不是一个完整的包管理服务(像Packagist),而是一个静态的Composer仓库生成器。这意味着Satis会抓取你指定的私有Git仓库中的PHP包,将它们打包成.zip或.tar文件,然后生成一个符合Composer规范的packages.json文件。这个文件和这些包的压缩文件,就可以作为一个完整的Composer仓库,被任何HTTP服务器托管。
立即学习“PHP免费学习笔记(深入)”;
它的核心优势在于:
- 高度控制:完全掌握私有包的分发和版本。
- 增强安全:你的私有代码永远不会离开你的控制范围,可以部署在内网或受限访问的服务器上。
-
安装加速:Satis会预先打包所有依赖,Composer客户端可以直接下载压缩包,省去了从Git仓库克隆的步骤,显著提升
composer install的速度。
如何使用Composer Satis?
Satis的安装和使用都非常直接。
1. 安装 Satis
首先,你需要通过Composer来安装Satis本身。推荐使用 create-project 命令:
composer create-project --keep-vcs --no-dev composer/satis:dev-main
这会在当前目录下创建一个名为 satis 的文件夹,其中包含了Satis的所有文件。
2. 配置你的私有仓库
Satis通过一个 satis.json 配置文件来知道要抓取哪些包。在这个文件中,你可以定义你的私有Git仓库地址、包名以及其他相关配置。
创建一个 satis.json 文件(例如在Satis项目根目录),内容大致如下:
{
"name": "My Private Composer Repository",
"homepage": "http://your-satis-domain.com",
"repositories": [
{
"type": "vcs",
"url": "git@github.com:your-organization/your-private-package.git"
},
{
"type": "vcs",
"url": "git@gitlab.com:your-organization/another-private-lib.git"
}
],
"require-all": true,
"archive": {
"directory": "dist",
"format": "zip",
"skip-dev": true
}
}-
homepage: 这是你的Satis仓库将要托管的URL。 -
repositories: 定义了Satis需要监控的Git仓库。这里你可以放置你的私有Git仓库地址。 -
require-all: 设置为true可以让Satis自动包含所有在repositories中找到的包。你也可以手动指定require字段来选择性包含。 -
archive: 这一段配置非常重要,它告诉Satis将包打包成.zip文件,并存放到dist目录。这正是加速composer install的关键!
3. 构建你的仓库
配置完成后,使用Satis的 build 命令来生成你的私有仓库:
php bin/satis build satis.json web/
-
satis.json: 是你刚刚创建的配置文件。 -
web/: 是Satis将生成所有静态文件(packages.json和压缩包)的输出目录。
执行这个命令后,Satis会连接到你配置的Git仓库,拉取代码,打包,并生成 web/packages.json 文件。
4. 托管你的仓库
现在,你只需要将 web/ 目录下的所有内容部署到一个HTTP服务器(如Nginx、Apache)上,使其可以通过 http://your-satis-domain.com 访问。
如果你想快速体验,甚至可以使用PHP内置服务器:
php -S 0.0.0.0:8000 -t web/
5. 在你的项目中使用私有包
最后一步,在你的项目composer.json中添加你的Satis仓库地址:
{
"repositories": [
{
"type": "composer",
"url": "http://your-satis-domain.com"
}
],
"require": {
"your-organization/your-private-package": "^1.0",
"your-organization/another-private-lib": "~2.1"
}
}然后,运行 composer update 或 composer install,Composer就会从你的Satis仓库中获取私有包了!
实际应用效果与优势
自从引入Composer Satis,我们的开发流程得到了质的飞跃:
- 开发效率显著提升:新项目可以快速集成内部库,无需繁琐的配置。团队成员可以专注于业务逻辑,而不是底层依赖管理。
- 版本管理清晰统一:所有项目都通过Satis获取依赖,确保了内部库的版本一致性,减少了因版本不匹配导致的bug。
-
安装速度大幅优化:由于Satis预先打包了所有依赖,
composer install的执行时间缩短了一半以上,尤其是在CI/CD环境中,构建时间得到了极大优化。 - 代码安全有保障:私有代码不再需要暴露给外部,所有内部库都安全地托管在团队内部可控的环境中。
- CI/CD集成更顺畅:自动化部署流程能够稳定、快速地解析依赖,确保了交付的可靠性。
Composer Satis以其简洁高效的方式,完美解决了PHP项目在私有包管理上的痛点。如果你也正被私有依赖管理问题所困扰,不妨尝试一下Satis,它将为你的团队带来前所未有的便利和效率提升!











