当前位置: 首页 > 工具软件 > deprecated > 使用案例 >

注解 @Deprecated、@deprecated 的使用、说明

湛联
2023-12-01

今天偶然在项目中注意到一个注解:@Deprecated

  1. 说明:

@Deprecated 表示此方法已废弃、暂时可用,但以后此类或方法都不会再更新、后期可能会删除,建议后来人不要调用此方法。

  1. 用法:

此注解可用于类上、方法上、属性上。

通常在给定此注解后,应该在方法注释中同样说明:废弃此方法后的代替方法是哪个、处理原逻辑代替方案是什么 、本身不打算代替,而是直接清除的,则最好给出会清除此方法的具体代码版本号 。

  1. 相似注解: @deprecated :

有此注解后,Javadoc 工具生成文档时会标注此类/接口、方法、字段已经被废止。

  1. 调用有 @Deprecated 注解的方法的风险:

可能导致错误、可能在以后版本中代码不兼容、可能在以后版本中原方法已被删除、可能已有更优的方案取代它。

坚持调用时,开发工具也会在调用处方法上加上横线,划掉方法:表示被调用方法已经过时。

  1. Java 9 中注解增加了两个新元素:since 和 forRemoval。

since: 指定已注解的API元素已被弃用的版本。
forRemoval: 表示在将来的既定版本中会被删除,应该迁移 API。
如:

@Deprecated(since = "1.2", forRemoval = true)
 类似资料: