開發 Composer 包詳細步驟
開發一個 composer 通用文件上傳包，發佈到 Packagist，並在 Laravel 中測試。php
1、GitHub 建立一個名 uploadfile 新倉庫，並克隆至本地。
$ git clone git@github.com:guanguans/uploadfile.git $ cd uploadfile
2、初始化項目，生成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 (<vendor>/<name>) [yzm/try-make-package]: guanguans/uploadfile
Description []: 一個通用文件上傳包
Author [guanguans <53222411@qq.com>, n to skip]: guanguans <yzmguanguan@gmail.com>
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": "yzmguanguan@gmail.com"
}
],
"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. 輸入項目命名空間
// 注意<vendor>/<name> 必需要符合 [a-z0-9_.-]+/[a-z0-9_.-]+
Package name (<vendor>/<name>) [dell/htdocs]: yourname/projectname
// 2. 項目描述
Description []: 這是一個測試
// 3. 輸入做者信息，能夠直接回車
Author [guanguans <53222411@qq.com>, 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": "yzmguanguan@gmail.com"
}
],
"minimum-stability": "dev"
}
// 9. 是否生成composer.json
Do you confirm generation [yes]? yes
3、添加自動加載
在上一步生成的composer.json中追加css
"autoload": {
"psr-4": {
"Guanguans\\": "src/"
}
}
4、構建項目
4.1 新建uploadfile/src/UploadFile.php
├─uploadfile │ ├─src │ │ ├─UploadFile.php │ └─composer.json
<?php
/**
* 通用文件上傳類
* @author guanguans <yzmguanguan@gmail.com>
*/
namespace Guanguans; // 注意命名空間與 composer.json 中的一致
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 ;
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 array $config 上傳參數
*/
public function __construct($config=[]) {
if(is_array($config)) {
$this->config = array_merge($this->config,$config);
}
}
/**
* 上傳一個文件
* @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;
}
/**
* 上傳全部文件
* @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 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 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 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 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 boolean
*/
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;
}
// 自動轉換字符集 支持數組轉換
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 private
* @param string $type 數據
* @return boolean
*/
private function checkType($type) {
if(!empty($this->allowTypes))
return in_array(strtolower($type),$this->allowTypes);
return true;
}
/**
* 檢查上傳的文件後綴是否合法
* @access private
* @param string $ext 後綴名
* @return boolean
*/
private function checkExt($ext) {
if(!empty($this->allowExts))
return in_array(strtolower($ext),$this->allowExts,true);
return true;
}
/**
* 檢查文件大小是否合法
* @access private
* @param integer $size 數據
* @return boolean
*/
private function checkSize($size) {
return !($size > $this->maxSize) || (-1 == $this->maxSize);
}
/**
* 檢查文件是否非法提交
* @access private
* @param string $filename 文件名
* @return boolean
*/
private function checkUpload($filename) {
return is_uploaded_file($filename);
}
/**
* 取得上傳文件的後綴
* @access private
* @param string $filename 文件名
* @return boolean
*/
private function getExt($filename) {
$pathinfo = pathinfo($filename);
return $pathinfo['extension'];
}
/**
* 取得上傳文件的信息
* @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
<?php
require_once '../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
<!DOCTYPE html>
<html lang="zh">
<head>
<meta charset="UTF-8">
<title>uploadfile test</title>
<link href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
</head>
<body>
<form action="UpploadfileTest.php" method="post" enctype="multipart/form-data">
<div class="form-group">
<label>單文件上傳</label>
<input type="file" name="uploadfile">
</div>
<button type="submit" class="btn btn-primary">Submit</button>
</form>
<hr>
<form action="UpploadfileTest.php" method="post" enctype="multipart/form-data">
<div class="form-group">
<label>多文件上傳</label>
<input type="file" name="uploadfile[]">
<input type="file" name="uploadfile[]">
</div>
<button type="submit" class="btn btn-primary">Submit</button>
</form>
</body>
</html>
4.2.3 本地瀏覽器訪問uploadfile/test/UpploadFile.html進行測試html
5、添加 README.md、LICENSE、.gitignore等文件，項目最終結構以下：個人包GitHub地址
├─uploadfile 擴展包根目錄 │ ├─src 擴展包代碼目錄 │ │ ├─UploadFile.php │ ├─test 測試目錄 │ │ ├─uploadfile.html │ │ ├─UpploadfileTest.php │ ├─.gitignore │ ├─composer.json │ ├─LICENSE │ └─README.md
6、推送到 GitHub
git add . git commit -m 'init' git tag v1.0.0 // 記住打一個版本號 git push origin master git push v1.0.0
7、將 GitHub 上的包提交到 Packagist
- 首先要在 Packagist 上註冊帳號並登陸（能夠用 GitHub 直接登陸）
- 點擊頂部導航條中的 Summit 按鈕
- 在輸入框中輸入 GitHub 上的剛纔包地址，如：
https://github.com/guanguans/uploadfile - 而後點擊 Check 按鈕 Packagist 會去檢測此倉庫地址的代碼是否符合 Composer 的 Package 包的要求
檢測正常的話，會出現 Submit 按鈕，再點擊一下 Submit 按鈕，咱們的包就提交到 Packagist 上了laravel
8、設置 composer 包自動更新
上面提交上的包提交的包，當咱們更新 GitHub 倉庫時，Packagist 上面的的包並不會自動更新，如今咱們來設置一下自動更新git
8.1 複製 Profile API Token
8.2 打開 GitHub 項目 setting，選擇 Integrations & services，添加 packagist service，點擊 Test service
8.3 驗證是否已經自動更新
移步 Packagist 包主頁，發現已經沒有了紅色的圈住的提示，說明設置自動更新成功。github
9、項目中使用
我以 Laravel 中使用舉例thinkphp
composer create-project laravel/laravel cd laravel composer require guanguans/uploadfile
其餘
- 本文通用上傳類由 ThinkPHP 中 UploadFile.class.php 修改
- 本文首發琯琯博客，可前往瀏覽更多文章。
本文爲琯琯原創文章,轉載無需和我聯繫,但請註明來自琯琯博客 https://guanguans.cnjson
相關文章
- 1. laravel composer 擴展包開發（超詳細）
- 2. VUE打包詳細步驟
- 3. 開發與發佈【Python包】的詳細步驟+全程視頻
- 4. 開發與發佈【Python包】的詳細步驟
- 5. maven 打包jar包(詳細步驟)
- 6. Delphi開發OCX詳細步驟總結
- 7. Android之開發BLE 詳細步驟
- 8. NC5單據開發詳細步驟
- 9. 開發VUE插件詳細步驟
- 10. SNMP MIB 功能開發詳細步驟
- 更多相關文章...
- • Spring整合Redis詳細步驟 - Redis教程
- • MySQL下載步驟詳解 - MySQL教程
- • PHP開發工具
- • Composer 安裝與使用
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. Duang!超快Wi-Fi來襲
- 2. 機器學習-補充03 神經網絡之**函數(Activation Function)
- 3. git上開源maven項目部署 多module maven項目（多module maven+redis+tomcat+mysql）後臺部署流程學習記錄
- 4. ecliple-tomcat部署maven項目方式之一
- 5. eclipse新導入的項目經常可以看到「XX cannot be resolved to a type」的報錯信息
- 6. Spark RDD的依賴於DAG的工作原理
- 7. VMware安裝CentOS-8教程詳解
- 8. YDOOK：Java 項目 Spring 項目導入基本四大 jar 包 導入依賴，怎樣在 IDEA 的項目結構中導入 jar 包 導入依賴
- 9. 簡單方法使得putty（windows10上）可以免密登錄樹莓派
- 10. idea怎麼用本地maven
歡迎關注本站公眾號,獲取更多信息
相關文章