Hyperf 软删除实战:SoftDeletes 与 withTrashed 用法【模型操作】

风敏酱_9374

风敏酱_9374

2026-08-08

589人浏览

原创

Hyperf软删除需模型启用SoftDeletes trait、数据库存在DELETED_AT字段且类型匹配、查询链中withTrashed()置于首位三者严格一致,缺一即退化为硬删或查不到数据。

hyperf 软删除实战:softdeletes 与 withtrashed 用法【模型操作】

Hyperf 的 SoftDeletes trait 不是开箱即用的“开关”,它依赖模型定义、数据库字段、查询链顺序三者严格匹配,缺一就会退化为硬删或查不到数据。

模型启用 SoftDeletes 前必须确认两件事

Hyperf 会读取模型类里的 DELETED_AT 常量来决定软删除字段名和类型,但不会自动校验数据库是否存在该字段。如果只加 trait 不建字段,delete() 会直接报错:SQLSTATE[42S22]: Column not found: 1054 Unknown column 'deleted_at' in 'where clause'。

  • 迁移中必须显式添加字段:$table->softDeletes()(等价于 $table->timestamp('deleted_at')->nullable())
  • 若想改字段名(比如用 is_deleted),需在模型里重定义:const DELETED_AT = 'is_deleted';,同时确保该字段是 TINYINT(1) 或 BOOLEAN 类型,否则 withTrashed() 生成的 SQL 条件会失效
  • 已有表追加字段,必须新建独立 migration,不能复用旧文件——Hyperf 的模型代码生成器(如 ModelRewriteSoftDeletesVisitor)只在首次生成时注入 trait,不检测字段变更

withTrashed() 查不到软删数据?先看调用位置和作用域

withTrashed() 的本质是临时移除全局作用域里对 deleted_at IS NULL 的过滤,但它只对当前查询链生效,且必须放在最前面。常见错误是写成 UserModel::where('id', 1)->withTrashed()->find(),结果仍返回 null。

  • withTrashed() 必须置于链首:UserModel::withTrashed()->where('id', 1)->find()
  • 检查模型是否重写了 baseQuery() 或 boot(),手动加了类似 $query->whereNull('deleted_at') 的逻辑——这会覆盖 withTrashed() 的效果
  • Hyperf 默认不启用全局软删除作用域,需确认是否在模型中显式调用了 use SoftDeletes; 并继承了 Hyperf\Database\Model\Model

关联查询时 withTrashed() 不生效的解决方式

withTrashed() 默认只作用于主模型,关联模型仍走默认过滤逻辑。例如 OrderModel::withTrashed()->with('user')->find(1) 中,订单能查到已删的,但关联的 user 若已被软删,依然为 null。

hyperframes-超帧视频
hyperframes-超帧视频

HTML 驱动的视频合成——GSAP 动画、TTS 字幕、音频响应、着色器转场

下载
  • 在关联方法定义里显式调用:public function user() { return $this->belongsTo(UserModel::class)->withTrashed(); }
  • 或使用闭包预载:OrderModel::withTrashed()->with(['user' => function ($q) { $q->withTrashed(); }])->find(1)
  • 注意:子模型也必须启用 SoftDeletes trait 且数据库有对应字段,否则 withTrashed() 调用无实际效果

restore() 和 forceDelete() 的行为边界

restore() 不是通用恢复操作,它只对“从软删上下文加载的实例”有效;而 forceDelete() 是彻底物理删除,绕过所有软删逻辑。

  • 错误用法:UserModel::find(1)->restore() —— find() 默认跳过软删记录,拿到的实例 trashed() 返回 false,调用 restore() 无效
  • 正确做法:UserModel::onlyTrashed()->find(1)->restore() 或 UserModel::withTrashed()->find(1)->restore()
  • 批量恢复不能用 update() 直接改字段:UserModel::onlyTrashed()->where('team_id', 5)->update(['deleted_at' => null]) 会跳过模型事件和类型转换,应使用 UserModel::onlyTrashed()->where('team_id', 5)->restore()
  • forceDelete() 只适用于已加载的模型实例,若要硬删软删状态的数据,得先 restore() 再 delete(true),或直接 UserModel::onlyTrashed()->find(1)->forceDelete()

软删除不是“加个 trait 就完事”的功能,它的字段类型、查询链顺序、关联模型独立性,三者任意一个出偏差,都会导致行为不可预期。尤其在 Hyperf 这类强调约定优于配置的框架里,DELETED_AT 常量和迁移字段必须严格一致,否则连报错都可能被静默吞掉。

相关专题

更多
Hyperf协程并发编程实操指南
Hyperf协程并发编程实操指南

本专题深度解析 Hyperf 协程底层机制,解决协程环境下全局变量污染、Context 上下文丢失等核心痛点,提供规范化的 PHP 高并发编程实战代码建议。

2026.05.19

200

15

深入理解Hyperf AOP切面与注解使用
深入理解Hyperf AOP切面与注解使用

详尽介绍 Hyperf 依赖注入容器与 AOP 面向切面编程的使用技巧,包含自定义注解开发流程及注解不生效的排查方案,助力开发者掌握框架核心架构。

2026.05.19

484

16

Hyperf 数据库操作与连接池优化方案
Hyperf 数据库操作与连接池优化方案

针对 Hyperf Eloquent 模型在大数据量下的表现进行深度优化,讲解连接池断线重连、超时设置及事务处理等生产环境常见技术疑难。

2026.05.19

244

15

基于 Hyperf 的微服务架构集成实战
基于 Hyperf 的微服务架构集成实战

本专题涵盖 Hyperf 微服务全栈解决方案,包括服务注册与发现、配置中心集成、JsonRPC 调用以及分布式限流熔断的落地实践。

2026.05.19

296

18

Hyperf 高并发缓存与分布式系统应用
Hyperf 高并发缓存与分布式系统应用

讲解在协程模式下如何高效操作 Redis,实现高性能分布式锁、处理缓存击穿/雪崩问题,并提供基于 Hyperf 的分布式事务处理思路。

2026.05.19

548

15

Hyperf 项目部署运维与性能调优手册
Hyperf 项目部署运维与性能调优手册

聚焦 Hyperf 在生产环境的落地,包含 Docker 高效打包、Swoole 配置优化、常见的内存溢出(OOM)问题排查方法以及热更新方案。

2026.05.19

505

15

Hyperf PHP 微服务框架高性能开发实战
Hyperf PHP 微服务框架高性能开发实战

本专题围绕 Hyperf 框架展开,讲解微服务架构设计、协程异步处理、服务注册与发现、RPC 通信及性能优化策略。通过完整项目示例,帮助开发者构建高效、稳定、可扩展的 PHP 分布式服务系统。

2026.06.08

196

23

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

20

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

20

15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 2.3万人学习