登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  php教程

PHP 8.4 #[Deprecated] 怎样标记待移除 API

来源:17golang原创

时间:2026-11-20 10:14:38 221浏览 收藏

PHP 8.4 可以在函数、方法或类常量声明前使用 #[\Deprecated] 标记弃用,并通过 message 写明替代方案,通过 since 标明从哪个库版本开始弃用。使用被标记的用户态功能会产生 E_USER_DEPRECATED 诊断;这个标记不负责自动删除或禁用 API。

官方地址:https://www.php.net/

先区分弃用提醒与禁止调用

整理一个旧库接口时,我会先问:现在需要的是提醒迁移,还是立即停止旧行为?这两件事需要不同措施。下面以虚构的运费计算接口为例,重点是让旧调用可发现,同时给调用方明确的新入口;不代表实际运行记录。

从风险角度看,要保护的是兼容性和迁移信息。如果某个旧接口必须立即停止提供敏感能力,应单独修改业务实现或访问控制,不能依赖弃用提醒来阻止调用。这里的 Deprecated 是迁移信号。

在旧函数上提供替代入口

以下为 PHP 8.4 及以上环境中的最小示例。旧函数保留委托,新函数承接计算与参数检查;属性中的信息只用于解释迁移方向。

默认错误处理下,调用旧入口会产生弃用诊断,函数仍可继续返回。示例计算值为 18;完整诊断中的文件、行号和格式取决于执行环境。若应用错误处理器主动抛出异常,程序也可能在进入函数体前中断,应把这种应用策略与属性自身行为分开。

弃用属性旧函数替代函数与迁移信息的静态关系
图1:声明关系结构图;属性绑定旧函数,message 指向替代入口,since 描述库的弃用起点。

把 since 当作库的迁移说明

构造参数 message 和 since 都是可空字符串,默认值为 null。message 适合说明替代 API 或弃用原因;since 可以填写项目版本、日期等文本,PHP 不会校验其内容。

示例的 since: '3.2' 表示这个示例库从 3.2 开始弃用旧入口,不是要求 PHP 3.2,也不是运行时倒计时。实际移除时间应另写在库的迁移文档和发布说明里,不要让调用方靠猜测理解版本含义。

限定 PHP 8.4 支持的声明目标

声明对象PHP 8.4 中的本文范围
函数支持弃用标记
方法支持弃用标记
类常量支持弃用标记
trait、类外编译期常量不要套用后续版本能力到 8.4

当前手册记录了 PHP 8.5 对 trait 和类外编译期常量的扩展。因此,维护一个明确支持 PHP 8.4 的库时,应根据最低运行环境选择声明目标。普通类与属性也不能因为名字相近就随意套用这个属性。

用错误处理记录旧调用

可以在受控测试或迁移统计中接管 E_USER_DEPRECATED,把旧调用整理为内部记录。以下片段与前面的函数定义配合使用,不是独立文件;它没有调用外部接口,也不更改全局错误级别。

错误处理器返回 true 表示本次诊断已处理,finally 则负责恢复处理器。这个写法适用于局部示例;在框架已有统一错误处理时,应接入原有机制,避免覆盖后影响其他模块。诊断文本可能包含内部路径,不宜直接显示给终端用户。

用户态弃用诊断与局部错误处理记录的静态关系
图2:诊断职责结构图;E_USER_DEPRECATED、记录容器与处理器恢复各有独立作用,不是执行截图。

移除 API 前还要处理哪些问题

对调用方,最有价值的提醒通常包含替代入口、参数差异和计划移除的版本。对维护方,可以关注旧入口仍被哪些业务使用、替代接口是否保持所需语义,以及移除后有没有恢复策略。这里列出的是迁移工作建议,属性不会自动完成这些事项。

写了 since 会在指定版本自动移除吗?不会。它只是说明文本。

弃用标记等于访问限制吗?不等于。访问控制与业务禁用需要单独实现。

为什么要写成 \Deprecated?全限定类名能避免在命名空间内解析到同名的自定义属性。

官方属性说明:https://www.php.net/manual/en/class.deprecated.php

PHP 8.4 设计背景:https://wiki.php.net/rfc/deprecated_attribute

错误处理说明:https://www.php.net/manual/en/function.set-error-handler.php

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>