yii2项目实战-图片上传之webuploader的使用

发表于 | 分类于

图片上传几乎是应用必备，前面也针对 kartik 的 fileinput 做了一篇详细的说明，不过很多人反馈各种问题，下面针对 webuploader 的使用单独写了一个组件。该组件可以更好的处理 Yii2 在图片上传过程中带来的一系列问题，目前支持多图多字段多modal的混合上传。

介绍之前我们先演示下效果。

安装
推荐使用composer进行安装

1
$ php composer.phar require bailangzhan/yii2-webuploader dev-master

使用
params.php或者params-local.php内增加webuploader和domain配置项

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// 图片服务器的域名设置，拼接保存在数据库中的相对地址，可通过web进行展示
'domain' => 'http://blog.m/',
'webuploader' => [
    // 后端处理图片的地址，value 是相对的地址
    'uploadUrl' => 'blog/upload',
    // 多文件分隔符
    'delimiter' => ',',
    // 基本配置
    'baseConfig' => [
        'defaultImage' => 'http://img1.imgtn.bdimg.com/it/u=2056478505,162569476&fm=26&gp=0.jpg',
        'disableGlobalDnd' => true,
        'accept' => [
            'title' => 'Images',
            'extensions' => 'gif,jpg,jpeg,bmp,png',
            'mimeTypes' => 'image/*',
        ],
        'pick' => [
            'multiple' => false,
        ],
    ],
],

webuploader[‘baseConfig’] 参考 webuploader官方的参数说明

视图文件

单图

1
2
3
4
<?php 
    echo $form->field($model, 'file')->widget('manks\FileInput', [
    ]); 
?>

多图

1
2
3
4
5
6
7
8
9
10
11
12
<?php 
echo $form->field($model, 'file2')->widget('manks\FileInput', [
    'clientOptions' => [
        'pick' => [
            'multiple' => true,
        ],
        // 'server' => Url::to('upload/u2'),
        // 'accept' => [
        //     'extensions' => 'png',
        // ],
    ],
]); ?>

控制器 controller的地址可以在params.php或者params-local.php中配置 Yii::$app->params[‘webuploader’][‘uploadUrl’], 也可以在 clientOptions中配置 server 项。控制器需要返回的数据格式如下

1
2
3
4
5
// 错误时
{"code": 1, "msg": "error"}
// 正确时， 其中 attachment 指的是保存在数据库中的路径，url 是该图片在web可访问的地址
{"code": 0, "url": "http://domain/图片地址", "attachment": "图片地址"}
clientOptions同样参考 webuploader官方的参数说明

注意
如果是修改的多图片操作，务必保证 $model->file = ‘src1,src2,src3,…’; 或者 $model->file = [‘src1’, ‘src2’. ‘src3’, …];
使用中如果有任何问题，可以下面留言亦可这里反馈。

vip一般的分割线

下面介绍下yii2后端的处理方案

首先假设webuploader是按照前面所配置的，控制器就是 blog/upload，先看下 BlogController的实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
use common\components\Upload as NewUpload;
use yii\web\Response;

public function actionUpload()
{
    try {
        Yii::$app->response->format = Response::FORMAT_JSON;

        $model = new NewUpload();
        $info = $model->upImage();

        if ($info && is_array($info)) {
            return $info;
        } else {
            return ['code' => 1, 'msg' => 'error'];
        }

    } catch (\Exception $e) {
        return ['code' => 1, 'msg' => $e->getMessage()];
    }
}

当然，你的common/components目录下还没有Upload.php，其代码参考如下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<?php
namespace common\components;
use Yii;
use yii\base\Model;
use yii\web\UploadedFile;
use yii\base\Exception;
use yii\helpers\FileHelper;
/**
 * 文件上传处理
 */
class Upload extends Model
{   
    public $file;
    private $_appendRules;
    public function init () 
    {
        parent::init();
        $extensions = Yii::$app->params['webuploader']['baseConfig']['accept']['extensions'];
        $this->_appendRules = [
            [['file'], 'file', 'extensions' => $extensions],
        ];
    }
    public function rules()
    {
        $baseRules = [];
        return array_merge($baseRules, $this->_appendRules);
    }
    /**
     * 
     */
    public function upImage ()
    {
        $model = new static;
        $model->file = UploadedFile::getInstanceByName('file');
        if (!$model->file) {
            return false;
        }
        $relativePath = $successPath = '';
        if ($model->validate()) {
            $relativePath = Yii::$app->params['imageUploadRelativePath'];
            $successPath = Yii::$app->params['imageUploadSuccessPath'];
            $fileName = $model->file->baseName . '.' . $model->file->extension;
            if (!is_dir($relativePath)) {
                FileHelper::createDirectory($relativePath);    
            }
            $model->file->saveAs($relativePath . $fileName);
            return [
                'code' => 0,
                'url' => Yii::$app->params['domain'] . $successPath . $fileName,
                'attachment' => $successPath . $fileName
            ];
        } else {
            $errors = $model->errors;
            return [
                'code' => 1,
                'msg' => current($errors)[0]
            ];
        }
    }
}

注意，你需要额外在params.php或者params-local.php文件内增加 imageUploadRelativePath 和 imageUploadSuccessPath配置项，前者指定相对的图片路径，后者用于保存的图片前缀，参考如下

1
2
'imageUploadRelativePath' => './uploads/', // 图片默认上传的目录
'imageUploadSuccessPath' => 'uploads/', // 图片上传成功后，路径前缀

对于原form对应的AR模型来看，我们假设file和file2字段分别是单图和多图字段，那么在数据库保存的时候，$model->file=”src”; $model->file2=”src1,src2,src3,…”;

AR模型对应的rules我们可以这样写

1
2
3
4
5
6
7
8
public function rules()
{
    return [
        [['file', 'file2'], 'required'],
        [['file', 'file2'], 'safe'],
        [['file'], 'string', 'max' => 255],
    ];
}

即保证file和file2必填且file限制255个字符。

此外，数据入库之前，你还需要对file2进行拆分处理

is_array($this->file2) && $this->file2 && $this->file2 = implode(‘,’, $this->file2);