composer 配置 artifact 仓库可从本地 ZIP 安装私有或离线包,要求 ZIP 根目录含 composer.json,通过 repositories 指定 ZIP 所在目录,安装时按 name 和 version 匹配并解压到 vendor。

在 Composer 中配置 artifact 类型仓库,是为了让项目能从本地 ZIP 文件安装包(比如未发布到 Packagist 的私有包、离线环境下的预构建包,或临时测试用的打包版本)。它不依赖网络源,直接读取本地 ZIP 文件并解析其 composer.json 内容。
1. 准备符合要求的 ZIP 包
Composer 的 artifact 机制要求 ZIP 文件内部必须包含一个有效的 composer.json 文件,且该文件需位于 ZIP 根目录下(不能嵌套在子文件夹中)。例如:
-
my-package-1.0.0.zip解压后结构应为:composer.jsonsrc/...tests/... - ZIP 文件名建议遵循
{vendor}/{package}-{version}.zip格式(如acme/utils-2.1.0.zip),Composer 会从中提取 vendor、package 和 version 信息;若命名不规范,可通过 ZIP 内部composer.json的"name"和"version"字段补全。
2. 配置 artifact 仓库路径
在项目的 composer.json 中添加 repositories 配置,指定存放 ZIP 文件的本地目录(支持绝对路径或相对于 composer.json 的相对路径):
{ "repositories": [ { "type": "artifact", "url": "./packages/" } ], "require": { "acme/utils": "^2.1" } }
上面例子中,Composer 会扫描 ./packages/ 目录下所有 ZIP 文件(包括子目录),匹配所需包和版本。注意:url 必须是目录路径,不是单个 ZIP 文件路径。
3. 安装时确保版本可匹配
Composer 不会自动解压或校验 ZIP 内容,但会检查:
- ZIP 中
composer.json的"name"是否与require中一致 -
"version"是否满足所要求的版本约束(如^2.1匹配2.1.0、2.1.5等) - 若 ZIP 名称含版本(如
utils-2.1.5.zip),而composer.json里写的是"version": "2.1.0",以文件内声明为准
运行 composer install 或 composer update acme/utils 即可安装——Composer 会复制 ZIP 到 vendor/ 并解压,行为与从 Packagist 安装一致。
4. 注意事项与常见问题
- artifact 仓库只在当前项目生效,不会影响全局;多个 artifact 源可共存,Composer 按顺序查找首个匹配项
- ZIP 文件修改后,需运行
composer update --lock或删掉composer.lock重新生成,否则可能仍用旧缓存 - 不支持 http URL 作为 artifact
url(那是package或composer类型的事);artifact 仅限本地文件系统 - 如果 ZIP 解压失败(比如权限问题或损坏),Composer 会报错,提示类似
Failed to extract acme/utils: unable to create ...
基本上就这些。配置简单,适合离线集成、CI 构建产物复用或快速验证私有包,不复杂但容易忽略 ZIP 结构和命名细节。