我见过很多using the Deprecated annotation on APIs的例子为了将它们标记为“需要尽快更换”。
然而,在几乎所有这些情况下,代码开发人员不仅继续使用已弃用的 API,而且还 suppressed the deprecation warning .
似乎 API 开发人员的最佳意图最终会创建更多与已实现的业务逻辑无关的代码——如果一个 API 被弃用但继续使用并且相关警告被抑制,这似乎是代码的退化在最坏的情况下替换已弃用的库时充其量是潜在的应用程序断点。
这个问题有实际的解决方案吗?至少,如果它确实在 CR 中停留了相对较长的时间,是否可以将这种情况标记为代码气味?
请提出您可能正在使用的实际解决方案(库、SCA、CR 插件等......)
是否有任何计划中的 JRE/JDK 功能可能有助于解决这种情况?我的研究目前没有发现任何东西。
引用资料:
最佳答案
人们可能认为弃用 API 意味着宣布它将被删除,但这不是唯一的用例(如 Java 7 和 Java 9 的相关文章中所述):
The API is dangerous (for example, the
Thread.stopmethod).There is a simple rename (for example, AWT
Component.show/hidereplaced bysetVisible).A newer, better API can be used instead.
The deprecated API is going to be removed.
更复杂的是,在 Java 9 之前,JDK 中没有弃用的 API 被删除(参见 20 Years Of Java Deprecation ),因此如果开发人员不认真对待弃用是可以理解的——无论是在 JDK 中还是在其他地方。
因此,您需要清楚地表明 API 确实、真的将被删除。执行此操作的方法取决于编译 API 时使用的 Java 版本。
在这些 Java 版本中,没有正式的方法来明确区分各种弃用用例。您可以做的最好的事情是添加 Javadoc 标记 @deprecated 并且不仅给出弃用的原因和列出替代方案,而且还明确宣布您打算删除 API。
从 Java 9 开始,使用 Enhanced Deprecation , 你现在可以写
@Deprecated(forRemoval=<boolean>)
明确记录您的意图。我认为与 Javadoc @deprecated(应该详细说明弃用的原因并列出替代方案)一起,这个标准化标志是一个公平的警告。
将此标志设置为 true,编译器将对每次使用弃用元素发出警告,如下所示:
YourClass.java:<line>: warning: [removal] <method> in <class> has been
deprecated and marked for removal
此警告默认启用(而不是必须使用 -Xlint:deprecation 启用)并且不使用 @SuppressWarnings("deprecation")。相反,人们必须使用新的 @SuppressWarnings("removal") 来抑制它,这可能会让开发人员在没有真正充分理由的情况下三思而后行。
此外,您可以明确声明引入弃用的库版本
@Deprecated(since="<version>")
在 Javadoc 或源代码中看到这一点可以帮助开发人员评估更新代码的紧迫性。
如果情况可行,添加运行时提醒:当使用已弃用的 API 时,让它在控制台或日志文件中记录警告(使用您使用的任何日志记录机制),宣布这将不再适用于下一个主要版本。为避免垃圾邮件,您只能记录一次(例如 private static boolean warningLogged)。
静态代码分析器,如 SonarQube (也可用作 hosted service )可以设置为标记这些警告中的每一个。 SonarQube 规则 "deprecated code should not be used"如果抑制编译器的弃用使用警告,甚至应该工作。
SonarQube 还会跟踪引入特定问题(即违反规则)的时间(基于版本控制),您可以根据该日期交互式地过滤其问题列表。例如,您可以列出代码库中已存在一年以上的已弃用代码的所有用法,以便您可以优先考虑修复它们。
实际上不删除 API 会给您的 API 用户留下他们不需要费心更改代码的印象。
关于Java 弃用 API 和 SuppressWarnings "deprecation"- 实用方法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/50302887/
我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div
总的来说,我对ruby还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用
类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc
我正在尝试设置一个puppet节点,但rubygems似乎不正常。如果我通过它自己的二进制文件(/usr/lib/ruby/gems/1.8/gems/facter-1.5.8/bin/facter)在cli上运行facter,它工作正常,但如果我通过由rubygems(/usr/bin/facter)安装的二进制文件,它抛出:/usr/lib/ruby/1.8/facter/uptime.rb:11:undefinedmethod`get_uptime'forFacter::Util::Uptime:Module(NoMethodError)from/usr/lib/ruby
我正在尝试测试是否存在表单。我是Rails新手。我的new.html.erb_spec.rb文件的内容是:require'spec_helper'describe"messages/new.html.erb"doit"shouldrendertheform"dorender'/messages/new.html.erb'reponse.shouldhave_form_putting_to(@message)with_submit_buttonendendView本身,new.html.erb,有代码:当我运行rspec时,它失败了:1)messages/new.html.erbshou
我在从html页面生成PDF时遇到问题。我正在使用PDFkit。在安装它的过程中,我注意到我需要wkhtmltopdf。所以我也安装了它。我做了PDFkit的文档所说的一切......现在我在尝试加载PDF时遇到了这个错误。这里是错误:commandfailed:"/usr/local/bin/wkhtmltopdf""--margin-right""0.75in""--page-size""Letter""--margin-top""0.75in""--margin-bottom""0.75in""--encoding""UTF-8""--margin-left""0.75in""-
我想了解Ruby方法methods()是如何工作的。我尝试使用“ruby方法”在Google上搜索,但这不是我需要的。我也看过ruby-doc.org,但我没有找到这种方法。你能详细解释一下它是如何工作的或者给我一个链接吗?更新我用methods()方法做了实验,得到了这样的结果:'labrat'代码classFirstdeffirst_instance_mymethodenddefself.first_class_mymethodendendclassSecond使用类#returnsavailablemethodslistforclassandancestorsputsSeco
我想用ruby编写一个小的命令行实用程序并将其作为gem分发。我知道安装后,Guard、Sass和Thor等某些gem可以从命令行自行运行。为了让gem像二进制文件一样可用,我需要在我的gemspec中指定什么。 最佳答案 Gem::Specification.newdo|s|...s.executable='name_of_executable'...endhttp://docs.rubygems.org/read/chapter/20 关于ruby-在Ruby中编写命令行实用程序
为了将Cucumber用于命令行脚本,我按照提供的说明安装了arubagem。它在我的Gemfile中,我可以验证是否安装了正确的版本并且我已经包含了require'aruba/cucumber'在'features/env.rb'中为了确保它能正常工作,我写了以下场景:@announceScenario:Testingcucumber/arubaGivenablankslateThentheoutputfrom"ls-la"shouldcontain"drw"假设事情应该失败。它确实失败了,但失败的原因是错误的:@announceScenario:Testingcucumber/ar
我在我的项目中添加了一个系统来重置用户密码并通过电子邮件将密码发送给他,以防他忘记密码。昨天它运行良好(当我实现它时)。当我今天尝试启动服务器时,出现以下错误。=>BootingWEBrick=>Rails3.2.1applicationstartingindevelopmentonhttp://0.0.0.0:3000=>Callwith-dtodetach=>Ctrl-CtoshutdownserverExiting/Users/vinayshenoy/.rvm/gems/ruby-1.9.3-p0/gems/actionmailer-3.2.1/lib/action_mailer