开发 Composer 包详细步骤
开发一个 composer 通用文件上传包，发布到 Packagist，并在 Laravel 中测试。
一、GitHub 创建一个名 uploadfile 新仓库，并克隆至本地
$ git clone [email protected]:guanguans/uploadfile.git
$ cd uploadfile
二、初始化项目，生成composer.json文件
2.1 步骤
yzm@Alert MINGW64 /i/phpstudy/WWW/uploadfile
$ composer init
Welcome to the Composer config generator
This command will guide you through creating your composer.json config.
Package name (/) [yzm/try-make-package]: guanguans/uploadfile
Description []: 一个通用文件上传包
Author [guanguans <[email protected]>, n to skip]: guanguans
Minimum Stability []: dev
Package Type (e.g. library, project, metapackage, composer-plugin) []: l ibrary
License []: MIT
Define your dependencies.
Would you like to define your dependencies (require) interactively [yes] ? yes
Search for a package: php
Enter the version constraint to require (or leave blank to use the lates t version): >=5.4.0
Search for a package:
Would you like to define your dev dependencies (require-dev) interactive ly [yes]? yes
Search for a package: php
Enter the version constraint to require (or leave blank to use the lates t version): >=5.4.0
Search for a package:
{
"name": "guanguans/uploadfile",
"description": "一个通用文件上传包",
"type": "library",
"require": {
"php": ">=5.4"
},
"require-dev": {
"php": ">=5.4"
},
"license": "MIT",
"authors": [
{
"name": "guanguans",
"email": "[email protected]"
}
],
"minimum-stability": "dev"
}
Do you confirm generation [yes]? yes
2.2 步骤解释
yzm@Alert MINGW64 /i/phpstudy/WWW/uploadfile
$ composer init
Welcome to the Composer config generator
This command will guide you through creating your composer.json config.
// 1. 输入项目命名空间
// 注意/ 必须要符合 [a-z0-9_.-]+/[a-z0-9_.-]+
Package name (/) [dell/htdocs]: yourname/projectname
// 2. 项目描述
Description []: 这是一个测试
// 3. 输入作者信息，可以直接回车
Author [guanguans <[email protected]>, n to skip]:
// 4. 输入最低稳定版本，stable, RC, beta, alpha, dev
Minimum Stability []: dev
// 5. 输入项目类型，
Package Type (e.g. library, project, metapackage, composer-plugin) []: library
// 6. 输入授权类型
License []:
> Define your dependencies.
// 7. 输入依赖信息
Would you like to define your dependencies (require) interactively [yes]?
// 如果需要依赖，则输入要安装的依赖
Search for a package: php
// 输入版本号
Enter the version constraint to require (or leave blank to use the latest version): >=5.4.0
// 如需多个，则重复以上两个步骤
// 8. 是否需要require-dev，
Would you like to define your dev dependencies (require-dev) interactively [yes]?
// 操作同上
{
"name": "guanguans/uploadfile",
"description": "一个通用文件上传包",
"type": "library",
"require": {
"php": ">=5.4"
},
"require-dev": {
"php": ">=5.4"
},
"license": "MIT",
"authors": [
{
"name": "guanguans",
"email": "[email protected]"
}
],
"minimum-stability": "dev"
}
// 9. 是否生成composer.json
Do you confirm generation [yes]? yes
三、添加自动加载
在上一步生成的composer.json中追加
"autoload": {
"psr-4": {
"Guanguans\\": "src/"
}
}
四、构建项目
4.1 新建uploadfile/src/UploadFile.php
├─uploadfile
│ ├─src
│ │ ├─UploadFile.php
│ └─composer.json
*
* This source file is subject to the MIT license that is bundled.
*/
namespace Guanguans;
class UploadFile
{
private $config = [
'maxSize' => -1, // 上传文件的最大值
'supportMulti' => true, // 是否支持多文件上传
'allowExts' => [], // 允许上传的文件后缀 留空不作后缀检查
'allowTypes' => [], // 允许上传的文件类型 留空不做检查
'thumb' => false, // 使用对上传图片进行缩略图处理
'imageClassPath' => 'ORG.Util.Image', // 图库类包路径
'thumbMaxWidth' => '', // 缩略图最大宽度
'thumbMaxHeight' => '', // 缩略图最大高度
'thumbPrefix' => 'thumb_', // 缩略图前缀
'thumbSuffix' => '',
'thumbPath' => '', // 缩略图保存路径
'thumbFile' => '', // 缩略图文件名
'thumbExt' => '', // 缩略图扩展名
'thumbRemoveOrigin' => false, // 是否移除原图
'thumbType' => 1, // 缩略图生成方式 1 按设置大小截取 0 按原图等比例缩略
'zipImages' => false, // 压缩图片文件上传
'autoSub' => false, // 启用子目录保存文件
'subType' => 'hash', // 子目录创建方式 可以使用hash date custom
'subDir' => '', // 子目录名称 subType为custom方式后有效
'dateFormat' => 'Ymd',
'hashLevel' => 1, // hash的目录层次
'savePath' => '', // 上传文件保存路径
'autoCheck' => true, // 是否自动检查附件
'uploadReplace' => false, // 存在同名是否覆盖
'saveRule' => 'uniqid', // 上传文件命名规则
'hashType' => 'md5_file', // 上传文件Hash规则函数名
];
// 错误信息
private $error = '';
// 上传成功的文件信息
private $uploadFileInfo;
/**
* 架构函数
* @access public
* @param array $config 上传参数
*/
public function __construct($config = [])
{
if (is_array($config)) {
$this->config = array_merge($this->config, $config);
}
}
public function __get($name)
{
if (isset($this->config[$name])) {
return $this->config[$name];
}
return null;
}
public function __set($name, $value)
{
if (isset($this->config[$name])) {
$this->config[$name] = $value;
}
}
public function __isset($name)
{
return isset($this->config[$name]);
}
/**
* 上传所有文件
* @access public
* @param string $savePath 上传文件保存路径
* @return string
*/
public function upload($savePath = '')
{
//如果不指定保存文件名，则由系统默认
if (empty($savePath)) {
$savePath = $this->savePath;
}
// 检查上传目录
if (! is_dir($savePath)) {
// 检查目录是否编码后的
if (is_dir(base64_decode($savePath))) {
$savePath = base64_decode($savePath);
} else {
// 尝试创建目录
if (! mkdir($savePath)) {
$this->error = '上传目录' . $savePath . '不存在';
return false;
}
}
} else {
if (! is_writeable($savePath)) {
$this->error = '上传目录' . $savePath . '不可写';
return false;
}
}
$fileInfo = [];
$isUpload = false;
// 获取上传的文件信息
// 对$_FILES数组信息处理
$files = $this->dealFiles($_FILES);
foreach ($files as $key => $file) {
//过滤无效的上传
if (! empty($file['name'])) {
//登记上传文件的扩展信息
if (! isset($file['key'])) {
$file['key'] = $key;
}
$file['extension'] = $this->getExt($file['name']);
$file['savepath'] = $savePath;
$file['savename'] = $this->getSaveName($file);
// 自动检查附件
if ($this->autoCheck) {
if (! $this->check($file)) {
return false;
}
}
//保存上传文件
if (! $this->save($file)) {
return false;
}
if (function_exists($this->hashType)) {
$fun = $this->hashType;
$file['hash'] = $fun($this->autoCharset($file['savepath'] . $file['savename'], 'utf-8', 'gbk'));
}
//上传成功后保存文件信息，供其他地方调用
unset($file['tmp_name'], $file['error']);
$fileInfo[] = $file;
$isUpload = true;
}
}
if ($isUpload) {
$this->uploadFileInfo = $fileInfo;
return true;
} else {
$this->error = '没有选择上传文件';
return false;
}
}
/**
* 转换上传文件数组变量为正确的方式
* @access private
* @param array $files 上传的文件变量
* @return array
*/
private function dealFiles($files)
{
$fileArray = [];
$n = 0;
foreach ($files as $key => $file) {
if (is_array($file['name'])) {
$keys = array_keys($file);
$count = count($file['name']);
for ($i = 0; $i < $count; $i++) {
$fileArray[$n]['key'] = $key;
foreach ($keys as $_key) {
$fileArray[$n][$_key] = $file[$_key][$i];
}
$n++;
}
} else {
$fileArray[$key] = $file;
}
}
return $fileArray;
}
/**
* 取得上传文件的后缀
* @access private
* @param string $filename 文件名
* @return bool
*/
private function getExt($filename)
{
$pathinfo = pathinfo($filename);
return $pathinfo['extension'];
}
/**
* 根据上传文件命名规则取得保存文件名
* @access private
* @param string $filename 数据
* @return string
*/
private function getSaveName($filename)
{
$rule = $this->saveRule;
if (empty($rule)) {
//没有定义命名规则，则保持文件名不变
$saveName = $filename['name'];
} else {
if (function_exists($rule)) {
//使用函数生成一个唯一文件标识号
$saveName = $rule() . "." . $filename['extension'];
} else {
//使用给定的文件名作为标识号
$saveName = $rule . "." . $filename['extension'];
}
}
if ($this->autoSub) {
// 使用子目录保存文件
$filename['savename'] = $saveName;
$saveName = $this->getSubName($filename) . $saveName;
}
return $saveName;
}
/**
* 获取子目录的名称
* @access private
* @param array $file 上传的文件信息
* @return string
*/
private function getSubName($file)
{
switch ($this->subType) {
case 'custom':
$dir = $this->subDir;
break;
case 'date':
$dir = date($this->dateFormat, time()) . '/';
break;
case 'hash':
default:
$name = md5($file['savename']);
$dir = '';
for ($i = 0; $i < $this->hashLevel; $i++) {
$dir .= $name{$i} . '/';
}
break;
}
if (! is_dir($file['savepath'] . $dir)) {
mkdir($file['savepath'] . $dir, 0777, true);
}
return $dir;
}
/**
* 检查上传的文件
* @access private
* @param array $file 文件信息
* @return bool
*/
private function check($file)
{
if ($file['error'] !== 0) {
//文件上传失败
//捕获错误代码
$this->error($file['error']);
return false;
}
//文件上传成功，进行自定义规则检查
//检查文件大小
if (! $this->checkSize($file['size'])) {
$this->error = '上传文件大小不符！';
return false;
}
//检查文件Mime类型
if (! $this->checkType($file['type'])) {
$this->error = '上传文件MIME类型不允许！';
return false;
}
//检查文件类型
if (! $this->checkExt($file['extension'])) {
$this->error = '上传文件类型不允许';
return false;
}
//检查是否合法上传
if (! $this->checkUpload($file['tmp_name'])) {
$this->error = '非法上传文件！';
return false;
}
return true;
}
/**
* 获取错误代码信息
* @access public
* @param string $errorNo 错误号码
* @return void
*/
protected function error($errorNo)
{
switch ($errorNo) {
case 1:
$this->error = '上传的文件超过了 php.ini 中 upload_max_filesize 选项限制的值';
break;
case 2:
$this->error = '上传文件的大小超过了 HTML 表单中 MAX_FILE_SIZE 选项指定的值';
break;
case 3:
$this->error = '文件只有部分被上传';
break;
case 4:
$this->error = '没有文件被上传';
break;
case 6:
$this->error = '找不到临时文件夹';
break;
case 7:
$this->error = '文件写入失败';
break;
default:
$this->error = '未知上传错误！';
}
return;
}
/**
* 检查文件大小是否合法
* @access private
* @param int $size 数据
* @return bool
*/
private function checkSize($size)
{
return ! ($size > $this->maxSize) || (-1 == $this->maxSize);
}
// 自动转换字符集 支持数组转换
/**
* 检查上传的文件类型是否合法
* @access private
* @param string $type 数据
* @return bool
*/
private function checkType($type)
{
if (! empty($this->allowTypes)) {
return in_array(strtolower($type), $this->allowTypes);
}
return true;
}
/**
* 检查上传的文件后缀是否合法
* @access private
* @param string $ext 后缀名
* @return bool
*/
private function checkExt($ext)
{
if (! empty($this->allowExts)) {
return in_array(strtolower($ext), $this->allowExts, true);
}
return true;
}
/**
* 检查文件是否非法提交
* @access private
* @param string $filename 文件名
* @return bool
*/
private function checkUpload($filename)
{
return is_uploaded_file($filename);
}
/**
* 上传一个文件
* @access public
* @param mixed $name 数据
* @param string $value 数据表名
* @return string
*/
private function save($file)
{
$filename = $file['savepath'] . $file['savename'];
if (! $this->uploadReplace && is_file($filename)) {
// 不覆盖同名文件
$this->error = '文件已经存在！' . $filename;
return false;
}
// 如果是图像文件 检测文件格式
if (in_array(strtolower($file['extension']), ['gif', 'jpg', 'jpeg', 'bmp', 'png', 'swf'])) {
$info = getimagesize($file['tmp_name']);
if (false === $info || ('gif' == strtolower($file['extension']) && empty($info['bits']))) {
$this->error = '非法图像文件';
return false;
}
}
if (! move_uploaded_file($file['tmp_name'], $this->autoCharset($filename, 'utf-8', 'gbk'))) {
$this->error = '文件上传保存错误！';
return false;
}
if ($this->thumb && in_array(strtolower($file['extension']), ['gif', 'jpg', 'jpeg', 'bmp', 'png'])) {
$image = getimagesize($filename);
if (false !== $image) {
//是图像文件生成缩略图
$thumbWidth = explode(',', $this->thumbMaxWidth);
$thumbHeight = explode(',', $this->thumbMaxHeight);
$thumbPrefix = explode(',', $this->thumbPrefix);
$thumbSuffix = explode(',', $this->thumbSuffix);
$thumbFile = explode(',', $this->thumbFile);
$thumbPath = $this->thumbPath ? $this->thumbPath : dirname($filename) . '/';
$thumbExt = $this->thumbExt ? $this->thumbExt : $file['extension']; //自定义缩略图扩展名
// 生成图像缩略图
import($this->imageClassPath);
for ($i = 0, $len = count($thumbWidth); $i < $len; $i++) {
if (! empty($thumbFile[$i])) {
$thumbname = $thumbFile[$i];
} else {
$prefix = isset($thumbPrefix[$i]) ? $thumbPrefix[$i] : $thumbPrefix[0];
$suffix = isset($thumbSuffix[$i]) ? $thumbSuffix[$i] : $thumbSuffix[0];
$thumbname = $prefix . basename($filename, '.' . $file['extension']) . $suffix;
}
if (1 == $this->thumbType) {
Image::thumb2($filename, $thumbPath . $thumbname . '.' . $thumbExt, '', $thumbWidth[$i], $thumbHeight[$i], true);
} else {
Image::thumb($filename, $thumbPath . $thumbname . '.' . $thumbExt, '', $thumbWidth[$i], $thumbHeight[$i], true);
}
}
if ($this->thumbRemoveOrigin) {
// 生成缩略图之后删除原图
unlink($filename);
}
}
}
if ($this->zipImags) {
// TODO 对图片压缩包在线解压
}
return true;
}
private function autoCharset($fContents, $from = 'gbk', $to = 'utf-8')
{
$from = strtoupper($from) == 'UTF8' ? 'utf-8' : $from;
$to = strtoupper($to) == 'UTF8' ? 'utf-8' : $to;
if (strtoupper($from) === strtoupper($to) || empty($fContents) || (is_scalar($fContents) && ! is_string($fContents))) {
//如果编码相同或者非字符串标量则不转换
return $fContents;
}
if (function_exists('mb_convert_encoding')) {
return mb_convert_encoding($fContents, $to, $from);
} elseif (function_exists('iconv')) {
return iconv($from, $to, $fContents);
} else {
return $fContents;
}
}
/**
* 上传单个上传字段中的文件 支持多附件
* @access public
* @param array $file 上传文件信息
* @param string $savePath 上传文件保存路径
* @return string
*/
public function uploadOne($file, $savePath = '')
{
//如果不指定保存文件名，则由系统默认
if (empty($savePath)) {
$savePath = $this->savePath;
}
// 检查上传目录
if (! is_dir($savePath)) {
// 尝试创建目录
if (! mkdir($savePath, 0777, true)) {
$this->error = '上传目录' . $savePath . '不存在';
return false;
}
} else {
if (! is_writeable($savePath)) {
$this->error = '上传目录' . $savePath . '不可写';
return false;
}
}
//过滤无效的上传
if (! empty($file['name'])) {
$fileArray = [];
if (is_array($file['name'])) {
$keys = array_keys($file);
$count = count($file['name']);
for ($i = 0; $i < $count; $i++) {
foreach ($keys as $key) {
$fileArray[$i][$key] = $file[$key][$i];
}
}
} else {
$fileArray[] = $file;
}
$info = [];
foreach ($fileArray as $key => $file) {
//登记上传文件的扩展信息
$file['extension'] = $this->getExt($file['name']);
$file['savepath'] = $savePath;
$file['savename'] = $this->getSaveName($file);
// 自动检查附件
if ($this->autoCheck) {
if (! $this->check($file)) {
return false;
}
}
//保存上传文件
if (! $this->save($file)) {
return false;
}
if (function_exists($this->hashType)) {
$fun = $this->hashType;
$file['hash'] = $fun($this->autoCharset($file['savepath'] . $file['savename'], 'utf-8', 'gbk'));
}
unset($file['tmp_name'], $file['error']);
$info[] = $file;
}
// 返回上传的文件信息
return $info;
} else {
$this->error = '没有选择上传文件';
return false;
}
}
/**
* 取得上传文件的信息
* @access public
* @return array
*/
public function getUploadFileInfo()
{
return $this->uploadFileInfo;
}
/**
* 取得最后一次错误信息
* @access public
* @return string
*/
public function getErrorMsg()
{
return $this->error;
}
}
4.2 测试
4.2.1 终端下执行 composer install，这时会生成vendor目录，及其他文件
yzm@Alert MINGW64 /i/phpstudy/WWW/uploadfile
$ composer install
4.2.2 新建uploadfile/test/UpploadFileTest.php、uploadfile/test/UpploadFile.html
- UpploadFileTest.php
*
* This source file is subject to the MIT license that is bundled.
*/
require __DIR__.'/../vendor/autoload.php';
use Guanguans\UploadFile;
$upload = new UploadFile();
$upload->maxSize = 1 * 1024 * 1024; // 默认为-1，不限制上传大小
$upload->savePath = './upload/'; // 上传根目录
$upload->saveRule = 'uniqid'; // 上传文件的文件名保存规则
$upload->uploadReplace = true; // 如果存在同名文件是否进行覆盖
$upload->autoSub = true; // 上传子目录开启
$upload->subType = 'date'; // 上传子目录命名规则
$upload->allowExts = ['jpg', 'png']; // 允许类型
if ($upload->upload()) {
var_dump($upload->getUploadFileInfo());
} else {
var_dump($upload->getErrorMsg());
}
- UpploadFile.html
uploadfile test
4.2.3 本地浏览器访问uploadfile/test/UpploadFile.html进行测试
五、添加 README.md、LICENSE、.gitignore等文件，项目最终结构如下：我的包 GitHub 地址
├─uploadfile 扩展包根目录
│ ├─src 扩展包代码目录
│ │ ├─UploadFile.php
│ ├─test 测试目录
│ │ ├─uploadfile.html
│ │ ├─UpploadfileTest.php
│ ├─.gitignore
│ ├─composer.json
│ ├─LICENSE
│ └─README.md
六、推送到 GitHub
git add .
git commit -m 'init'
git tag v1.0.0 // 记住打一个版本号
git push origin master
git push v1.0.0
七、将 GitHub 上的包提交到 Packagist
- 首先要在 Packagist 上注册账号并登录（可以用 GitHub 直接登录）
- 点击顶部导航条中的 Summit 按钮
- 在输入框中输入 GitHub 上的刚才包地址，如：
https://github.com/guanguans/uploadfile - 然后点击 Check 按钮 Packagist 会去检测此仓库地址的代码是否符合 Composer 的 Package 包的要求
检测正常的话，会出现 Submit 按钮，再点击一下 Submit 按钮，我们的包就提交到 Packagist 上了
八、设置 composer 包自动更新
上面提交上的包提交的包，当我们更新 GitHub 仓库时，Packagist 上面的的包并不会自动更新，现在我们来设置一下自动更新
8.1 复制 Profile API Token
8.2 打开 GitHub 项目 setting，选择 Integrations & services，添加 packagist service，点击 Test service
8.3 验证是否已经自动更新
移步 Packagist 包主页，发现已经没有了红色的圈住的提示，说明设置自动更新成功。
九、项目中使用
我以 Laravel 中使用举例
composer create-project laravel/laravel
cd laravel
composer require guanguans/uploadfile
其他
- 本文通用上传类由 ThinkPHP 中 UploadFile.class.php 修改
- 本文首发 琯琯博客，可前往浏览更多文章。
本文为琯琯原创文章,转载无需和我联系,但请注明来自 琯琯博客 - https://guanguans.cn。