在介绍如何写composer包之前,大家可以通过composer命令使用图文教程栏目来了解如何安装composer及其相关使用介绍。
composer包怎么写?
写一个属于自己的composer包
composer包适合在需要与其他依赖包配合的情况下使用。
我们下面就来写一个自己的composer包,首先我们创建一个空的目录,并且运行以下命令初始化一个空白的composer包
composer init
可以在命令窗口看到有返回提示;
需要输入包名
This command will guide you through creating your composer.json config.`
Package name (<vendor>/<name>) :
我这里写的是yancoo.cn/test,回车
需要输入描述
Description []:
包的描述内容
需要输入作者
Author [宣言 <59419979@qq.com>, n to skip]:
该选项如果有默认值 可以直接回车
需要输入最低稳定版本
Minimum Stability []:
该选项有可选值:stable, RC, beta, alpha, dev 一般填dev
需要输入包类型
Package Type (e.g. library, project, metapackage, composer-plugin) []:
可选项在提示中已经有了,我们一般选library填l即可
需要输入开源协议
License []:
根据自己情况填写,我们填Apache
设置包需要依赖的其他环境或者包
Define your dependencies.
Would you like to define your dependencies (require) interactively [yes]?
如果需要设置依赖环境或者其他包 则输入yes回车,会让你搜索,我们这里给包设置php版本必须大于5.6,所以搜索php。
Enter the version constraint to require(orleave blank to usethe latest version):
输入最低要求版本号 >=5.6.0
如果需要设置多个环境要求,则重复搜索填写即可,如果不需要了,则在Search for a package:不填写内容,直接回车即可
接下来设置依赖包
Would you like to define your dev dependencies (require-dev) interactively [yes]?
我们不需要 直接回车回车。
{
"name": "yancoo.cn/test",
"description": "This is a test package,form yancoo.cn,author is siam.",
"type": "l",
"require": {
"php": ">=5.6.0"
},
"license": "Apache",
"authors": [
{
"name": "宣言",
"email": "59419979@qq.com"
}
],
"minimum-stability": "dev"
}
Do you confirm generation [yes]?
确认信息,yes 回车 初始化完成
Do you confirm generation [yes]? yes
Would you like to install dependencies now [yes]? yes
安装完成,可以看到我们的目录生成了如下结构。
vendor是composer存放包的地址,所有的包都存放在该路径中统一管理,并且composer提供了命名空间自动加载的功能,我们在使用过程中只需要引入composer的统一入口文件即可
require"vendor/autoload.php";
但是我们也需要在包的配置文件中写上需要自动加载哪个目录才有效哈!
编辑composer.json文件
这里的路径需要根据你自己的来定,也可以参考以上写法即可。
写完之后需要运行一下命令行composer dump-autoload更新composer的命名空间与文件夹映射关系。
上一步骤非常重要 漏了就不正常执行了。
然后我们创建src文件夹,再创建siam文件夹,在里面创建Test.php文件
写上命名空间 Siam; 根据psr-4规范,类名要与文件名相同。
<?php
//Test.php文件
namespaceSiam;
classTest
{
functiontest()
{
echo"Form Test -> test()";
}
}
再在最外层写下index.php测试文件,正确做法是创建demo文件夹 然后再写测试文件。
<?php
require"vendor/autoload.php";
$Test= newSiam\Test();
$Test->test();
于是我们现在的文件目录结构如下,运行index.php正确得到内容Form Test -> test()
可以根据你自己的想法来写类,只需要注意命名空间的层级与文件夹层级相同,类名与文件名相同即可自动加载。
本文来自PHP中文网的composer使用教程栏目:https://www.php.cn/tool/composer/