Symfony5的软删除功能怎么实现

蓮花仙者

蓮花仙者

2026-07-22

690人浏览

原创

symfony 5需借助stof/doctrine-extensions-bundle启用gedmo softdeleteable扩展实现软删除,须配置yaml、添加deletedat字段及@gedmo\softdeleteable注解,字段名必须严格匹配,迁移前确保数据库列允许null,否则失败。

symfony5的软删除功能怎么实现

Symfony 5 本身不内置软删除功能,必须依赖 Doctrine 扩展(如 stof/doctrine-extensions-bundle)或手动实现。直接调用 remove() + flush() 仍是物理删除,不会自动加标记字段。

安装并启用 Gedmo 的 SoftDeleteable 扩展

这是最主流、兼容 Symfony 5 的方案,基于 Doctrine 行为扩展,无需重写大量逻辑。

  • 执行 composer require stof/doctrine-extensions-bundle
  • config/packages/stof_doctrine_extensions.yaml 中启用:
    stof_doctrine_extensions:
        default_locale: en_US
        orm:
            default:
                soft_deleteable: true
  • 确保 Doctrine 已配置为使用注解或属性映射(推荐 PHP 8.0+ 属性)

实体类中声明 soft-deleteable 字段和行为

不能只加一个 is_deleted 字段就完事——Doctrine 不会自动识别它为删除标记,必须显式绑定行为。

Symfony Windows版
Symfony Windows版

Symfony Windows版用于下载 Symfony CLI 5.17.1 官方安装包,辅助开发者创建 Symfony 项目并进入框架学习与配置流程。

下载
  • 添加 deletedAt 字段(类型为 \DateTimeInterface|null),不要用布尔型字段,Gedmo 的 SoftDeleteable 默认依赖时间戳
  • 加上 @Gedmo\SoftDeleteable 注解(或 PHP 8 属性)且必须指定 fieldName,例如:
    #[Gedmo\SoftDeleteable(fieldName: 'deletedAt', timeAware: false)]
  • 字段名必须与注解中 fieldName 完全一致,大小写敏感;若写成 isDeleted 却配 fieldName="deletedAt",软删除将静默失效

查询时自动过滤已软删除记录

启用后,所有标准 DQL 查询(包括 $repository->findAll()findBy()findOneBy())默认跳过 deletedAt IS NOT NULL 的行。

  • 想查含软删除数据?用 $repository->createSoftDeleteableQueryBuilder()(需手动构建)或临时禁用过滤:
    $qb = $em->createQueryBuilder()
        ->select('u')
        ->from(User::class, 'u')
        ->where('u.deletedAt IS NULL OR u.deletedAt IS NULL'); // ❌ 错误示例,实际要显式放开
    更稳妥的是用 Repository 自定义方法,绕过默认过滤
  • 恢复数据不是“反向 delete”,而是设 $entity->setDeletedAt(null)$em->flush()
  • 真删(绕过软删)只能用原生 SQL 或 EntityManager::remove() + 禁用监听器,不推荐

容易被忽略的初始化和迁移细节

软删除字段初始值必须为 NULL,且数据库列不允许 NOT NULL;否则迁移生成的 SQL 会失败或插入报错。

  • 运行 php bin/console doctrine:migrations:diff 前,确认实体已加字段和注解,否则迁移不会包含 deleted_at
  • 已有数据表需手动添加列:ALTER TABLE user ADD deleted_at DATETIME DEFAULT NULL
  • timeAware: false 表示用 datetime 类型存删除时间;设为 true 则用 timestamp 并自动处理时区,但 Symfony 5.4+ 对 timestamp 兼容性略差,建议关掉

真正麻烦的不是加字段或装包,而是行为绑定漏写、字段名不匹配、迁移没跑全——这些地方一错,delete() 看似执行了,数据库却毫无变化,也无报错,排查起来最耗时间。

相关文章

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

5456

6

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

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

2023.10.11

3609

5

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

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

2023.10.11

1786

5

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

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

2023.10.23

2272

4

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

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

2023.10.23

2787

6

html怎么上传
html怎么上传

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

2023.11.03

1999

9

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

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

2023.11.09

3051

8

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

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

2023.11.13

2314

8

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

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

2023.11.27

10931

4

热门下载

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

精品课程

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

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

共120课时 | 13.6万人学习