JAVA后台开发提升注解篇 @Deprecated

JAVA后台开发提升注解篇 @Deprecated,第1张

前期说明

先说明下,这个注解不加,对代码没有任何影响。

加了的话,会让调用端的人觉得你比较上道。

这是为什么呢?

我们先来简单聊下 @Deprecated这个注解。

@Deprecated注解

作用域:类、方法或者属性上

格式如下

//作用类上
@Deprecated
public Class Test{

    //作用方法上
    @Deprecated
    public void testMethod(){
        //此处省略....
    }

}

说明:这个注解主要是告诉调用方,该方法或类已经成为了弃子,后续请不要调用该类或方法。

在Java8+以后的版本中添加了两个属性。since和forRemoval

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

@Deprecated(since="2.0",forRemoval=true)
总结

如果不加这个注解,代码跑起来是不会有任何问题的。

如果加了之后,你的接口文档(例如swagger)就会在当前接口上增加一条删除线,这样调用端就知道该接口废弃了,他就不会再调用了。

那么他怎么知道调用新的呢?这个就需要你再接口文档中写明对应的接口新文档了。

对于这样好的合作伙伴,前端调用方肯定会很喜欢的,觉得你的接口质量棒棒的,这样是不是给人感觉你的能力很不错呢?

欢迎分享,转载请注明来源:内存溢出

原文地址:https://54852.com/langs/758118.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2022-05-01
下一篇2022-05-01

发表评论

登录后才能评论

评论列表(0条)

    保存