Symfony5.4 使用 VichUploaderBundle 管理附件完整步骤

轻墨酱_3868

轻墨酱_3868

2026-10-10

938人浏览

原创

vichuploaderbundle 在 symfony 5.4 中实现附件自动管理,通过实体注解绑定上传字段、配置 mapping 映射路径与命名策略,并在表单提交时由 bundle 自动完成上传、重命名、持久化及旧文件清理。

symfony5.4 使用 vichuploaderbundle 管理附件完整步骤

在 Symfony 5.4 中用 VichUploaderBundle 管理附件,核心是把“文件上传逻辑”从控制器中解耦出来,交由实体和 Bundle 自动处理。它不直接存文件,而是通过映射(mapping)绑定字段、配置存储路径、自动生成唯一文件名,并支持自动删除旧文件。下面是最简可行的完整步骤,已适配 Symfony 5.4+(无废弃方法,兼容 Flex 目录结构)。

1. 安装与启用 Bundle

运行命令安装两个必需组件:

  • composer require vich/uploader-bundle:^1.20(注意:1.20+ 支持 Symfony 5.4,避免用 ^1.4)
  • composer require liip/imagine-bundle:^2.7(可选,但强烈建议搭配用于图片缩略图)

Bundle 会自动注册(Symfony Flex),无需手动改 config/bundles.php;若未自动注册,补上:

  • Vich\UploaderBundle\VichUploaderBundle::class => ['all' => true],
  • Liip\ImagineBundle\LiipImagineBundle::class => ['all' => true],

2. 配置 VichUploaderBundle

编辑 config/packages/vich_uploader.yaml:

vich_uploader:
  db_driver: orm
  mappings:
    product_image:  # 名称需与实体注解中的 mapping 一致
      uri_prefix: /uploads/products
      upload_destination: '%kernel.project_dir%/public/uploads/products'
      namer: vich_uploader.namer_origname  # 或用 uniqid 更安全
      delete_on_update: true
      delete_on_remove: true
      inject_on_load: false

说明:

  • upload_destination 必须是 public/ 下的子目录(如 public/uploads/products),确保 Web 可直接访问
  • uri_prefix 是浏览器请求该文件时的 URL 前缀,要与目录路径对应
  • 不推荐用 %kernel.root_dir%/../web —— Symfony 5.4 默认用 public/ 作 Web 根目录

3. 绑定实体与上传字段

以 Product 实体为例,在 src/Entity/Product.php 中添加:

use Vich\UploaderBundle\Mapping\Annotation as Vich;
<p>/**</p><div class="aritcle_card flexRow artxards">
											<div class="artcardd flexRow">
												<a class="aritcle_card_img" rel="nofollow" href="/xiazai/gongju/2491" title="Symfony Linux版"><img
														src="https://img.php.cn/upload/zhuanqu/000/000/086/6a5f5ae8906a0613.png" alt="Symfony Linux版" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
												<div class="aritcle_card_info flexColumn">
													<a rel="nofollow" href="/xiazai/gongju/2491" title="Symfony Linux版" class="overflowclass">Symfony Linux版</a>
													<p class="overflowclass">Symfony Linux版整理 Symfony CLI 5.17.1 官方下载入口和 Symfony 框架安装配置说明。</p>
												</div>
												<a rel="nofollow" href="/xiazai/gongju/2491" title="Symfony Linux版" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span>
												</a>
											</div>
										</div>
  • @Vich\Uploadable */ class Product { /**

    • @Vich\UploadableField(mapping="product_image", fileNameProperty="imageName") */ private $imageFile;

    /**

    • @ORM\Column(type="string", length=255, nullable=true) */ private $imageName;

    /**

    • @ORM\Column(type="datetime_immutable", nullable=true) */ private $updatedAt;

    // getter/setter for imageFile and imageName (required) public function setImageFile(?File $file = null): void { $this->imageFile = $file; } public function getImageFile(): ?File { return $this->imageFile; } public function setImageName(?string $imageName): void { $this->imageName = $imageName; } public function getImageName(): ?string { return $this->imageName; }

    // 在 setUpdatedAt() 后触发更新时间,确保文件变更时刷新

    [PreUpdate]

    public function preUpdate(): void { $this->setUpdatedAt(new \DateTimeImmutable()); } }

    关键点:

    • @Vich\Uploadable 是必需类注解
    • fileNameProperty 指向一个 string 字段(imageName),用于持久化保存文件名
    • 必须提供 imageFile 的 setter/getter,类型为 Symfony\Component\HttpFoundation\File\File
    • updatedAt 配合 PreUpdate,确保修改附件时实体能被 Doctrine 正确识别为“已更改”

4. 表单与控制器集成

在表单类型中使用 VichFileType:

// src/Form/ProductType.php
use Vich\UploaderBundle\Form\Type\VichFileType;
<p>->add('imageFile', VichFileType::class, [
'required' => false,
'allow_delete' => true,
'download_uri' => true,
'asset_helper' => true,
])
</p>

控制器中只需正常处理表单提交,无需手动移动文件:

$product = new Product();
$form = $this->createForm(ProductType::class, $product);
$form->handleRequest($request);
<p>if ($form->isSubmitted() && $form->isValid()) {
$entityManager->persist($product);
$entityManager->flush(); // 此时 Vich 自动完成上传、重命名、保存 imageName
return $this->redirectToRoute('product_index');
}
</p>

上传后的文件路径即为:/uploads/products/{imageName},可通过 Twig 直接输出:

@@##@@

5. (可选)配合 LiipImagineBundle 生成缩略图

配置 config/packages/liip_imagine.yaml:

liip_imagine:
  filter_sets:
    thumb_150x150:
      quality: 85
      filters:
        thumbnail: { size: [150, 150], mode: outbound }

Twig 中调用:

@@##@@

注意:vich_uploader_asset 返回原始 URL,imagine_filter 会自动触发缓存生成并返回带 hash 的缩略图地址。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10364

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6101

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2115

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3828

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4534

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3571

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5077

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3982

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11942

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

Symfony5【从0开始开发博客系统】
Symfony5【从0开始开发博客系统】

共120课时 | 15.5万人学习