composer.json 文件是 Composer 用来管理 PHP 项目的依赖和配置的文件。它采用 JSON 格式,定义了项目的基本信息、依赖库以及其他配置项。
以下是 composer.json 文件的一个基本示例及其常见字段:
{ // 项目名称,通常采用 vendor/package 的格式 "name": "vendor/package", // 项目描述 "description": "A short description of your project", // 项目类型,常见值有 library、project、metapackage、composer-plugin 等。 "type": "project", // 生产环境依赖库及其版本要求 "require": { "php": ">=7.4", "monolog/monolog": "^2.0", "symfony/console": "^5.0" }, // 开发环境的依赖库及其版本要求 "require-dev": { "phpunit/phpunit": "^9.0" }, // 自动加载规则。例如,使用 PSR-4 标准来自动加载src/
目录下的类 "autoload": { "psr-4": { "App\\": "src/" } }, // 开发环境的自动加载规则 "autoload-dev": { "psr-4": { "App\\Tests\\": "tests/" } }, // 定义 Composer 的脚本命令,可以在安装或更新时运行特定的 PHP 脚本。 "scripts": { "post-install-cmd": [ "App\\ComposerScripts::postInstall" ], "post-update-cmd": [ "App\\ComposerScripts::postUpdate" ] }, // 配置选项 "config": { // 优先使用打包的版本 "preferred-install": "dist", // 优化自动加载 "optimize-autoloader": true }, // 最小的稳定性要求,常见值有stable
、RC
、beta
、alpha
、dev
"minimum-stability": "stable", // 是否倾向于使用稳定版本的包 "prefer-stable": true }
根据你的项目需要,你可以在 composer.json
文件中添加或修改这些字段。
执行 $ composer install 将安装配置的依赖。