写点什么

JSR-305:供检查软件缺陷用的注解

  • 2008-07-07
  • 本文字数:1859 字

    阅读完需:约 6 分钟

诸如 FindBugs、IntelliJ、Checkstyle 和 PMD 这样的静态分析工具在 Java 开发中得到了广泛应用。这些工具都很强大,但是有一些共同的问题它们都很难解决。在 API 的设计中,有一些决策是不言而喻的,比如何时值可以为 null,或者何时数字值不能为负。完备的 API 会将这些设计细节记录在 JavaDoc 之中,但是分析工具却无法发现类似细节,从而有可能将其忽略或是导致错误的检测结果。

为了解决这些问题,有些静态分析工具开发人员试图使用注解来定义相关细节。比如 FindBugs 和 IntelliJ 都定义了自己的注解,以表示方法何时返回 null。不过,这两个工具使用的注解有细微不同,也因此有了标准化的需求。由 FindBugs 创建人 Bill Pugh 带领制定的 JSR-305 标准,试图创建一套标准注解供分析工具使用,同时希望允许开发人员根据自己的需要添加额外的注解。当前提案中包括供判断是否为空、正负号、开发语言和线程等方面的众多注解。

在为 Google 所做的技术报告中,Bill Pugh 从是否为空的判断开始,简要回顾了一些具体实例。他的想法是:应该允许方法的参数、返回值和用到的字段永远不能为空,而且允许方法接受null 值参数。Pugh 希望使用三个注解来解决这些问题:

@Nonnull——对象被初始化后不能为空。

@NullFeasible——代码应该注意该值可能为空。对于没有检查是否为空的取值操作(dereference),代码分析工具应该标识出来。如果将返回值加上 @NullFeasible 注解,可能其他代码就要做改变,因为这个空返回值可能被作为参数影响到其他代码。

@UnknownNullness——与不加注解效果相同,但对于支持缺省和继承的注解来说是必要的。

标准还可能包含:对正负号判断的注解,它会被用作标识一个数值是否允许使用正负号,比如 @Nonnegative、@Signed、@CheckForNegative、@Positive 和 @CheckForNonpositive;于开发语言的注解允许开发人员标识一个字符串是否属于某种特定的开发语言(SQL、正则表达式等等);线程注解会标识方法是否必须(或者不应该)被某特定线程(或线程组)调用。在 JSR-305 所属的 Google 讨论组中,Pugh 这样说道:

“在特定情形下,由于操作需要,某些方法只能被特定线程调用,或者永远不能被某线程调用。最明显的例子就是 Java GUI 开发中的 AWT/Swing 线程问题。特定的 AWT/Swing 操作要求只能在事件线程中进行,否则就会导致各种微妙问题,而在事件线程中要用很长时间才能完成的操作,会让用户觉得应用程序反应迟钝(这也是为什么 swing 总被人认为性能太差的原因)。为解决类似问题,我提议使用 @ThreadRestrictions 注解,可以用它来说明总能调用 / 或永远不能调用本操作的线程和 / 或线程组。 为开发人员方便计,由于 Swing/AWT 问题会影响到所有的 Java 桌面应用开发,我建议使用 @EventThreadOnly 和 @NeverEventThread 注解。”

除定义了一些基础注解之外,JSR-305 还试图提供元注解(meta annotation),供类型限定符使用,以允许开发人员为 Java 的类型系统定义自己的属性。Java 5 预览版发布时没有提供枚举类型,很多 Java API 都被迫使用整形和字符串作为公共常量,如果有枚举的话,那设计起来就方便多了。这也是促使提供元注解的主要原因。一个类似于 JDBC createStatement 这样的方法,使用三个整数参数(resultSetType, resultSetConcurrency 和 resultSetHoldability),会暴露一系列公共静态整数常量供程序员使用,比如 TYPE_FORWARD_ONLY、CONCUR_READ_ONLY、HOLD_CURSOR_OVER_COMMIT 等等。编译器无法知道在调用方法时参数传递顺序是否正确,因为它们只是三个整数而已。通过给类型限定符添加元注解,这个 JSR 提供了让开发人员可以添加必要的类型限定符的机制。前面返回非空值的例子可以被描述成:

<pre id="rg:59">@Documented<br id="rg:510"></br>@TypeQualifier<br id="rg:511"></br>@Retention(RetentionPolicy.RUNTIME)<br id="rg:512"></br>public @interface Nonnull{<br id="rg:513"></br> When when() default When.ALWAYS;<br id="rg:514"></br> ElementType[] defaultFor() default{};<br id="rg:515"></br>}<br id="rg:516"></br>其中,@Documented 标识它是否进入 JavaDoc,@TypeQualifier 告诉我们这是一个类型限定符,@Retention 告诉我们它是否可以通过反射使用。而 When 参数可用作提供位置特定信息。

预期这个 JSR 会作为 Java 7 的一部分推出,不过它不需要开发语言上的变更;而且专家组正在试图支持 Java 5 和以上版本。Sun、Google、JetBrains 和 Doug Lea 都是专家组的成员。

查看英文原文: JSR-305: Annotations for Software Defect Detection

2008-07-07 00:569150
用户头像

发布了 479 篇内容, 共 171.5 次阅读, 收获喜欢 52 次。

关注

评论

发布
暂无评论
发现更多内容

KaiwuDB 亮相 2023 可信数据库发展大会

KaiwuDB

KaiwuDB 2023可信数据库发展大会

直播软件开发知识:实现感知网络质量功能

山东布谷科技

源码 软件 软件开发 直播 源码搭建

软件测试 | 接口自动化测试,如何实现多套环境的自动化测试?

测吧(北京)科技有限公司

测试

以“信”数智,筑“广”生态:亚信科技CEO高念书受邀出席中国广电数字化赋能大会

亚信AntDB数据库

数据库 AntDB AntDB数据库

华为云“盘古气象”登上Nature!

新消费日报

专利技术系列 001 | 鹏云网络分布式系统脑裂问题解决方案

鹏云网络

云计算 分布式系统 分布式存储 分布式系统脑裂 软件定义存储

软件测试 | 测试工具与技术总结

测吧(北京)科技有限公司

测试

从php5.6到golang1.19-文库App性能跃迁之路

百度Geek说

golang App 百度文库

AI for Science交流会来了!科学计算前沿邀您共同探讨

飞桨PaddlePaddle

人工智能 百度 paddle 飞桨 百度飞桨

如何通过云管平台实现降本?降低云成本?

行云管家

云计算 云平台 云资源 云成本

极限科技受邀参加 2023 可信数据库发展大会并入选 “中国数据库产业图谱”

极限实验室

中国信通院 数据库· 北京 极限科技 2023可信数据库发展大会

前端开发需要了解的工具集合

树上有只程序猿

用Vue3编写一个简单的组件

互联网工科生

Vue 3 slots

prometheus Histogram 统计原理

蓝胖子的编程梦

Grafana Prometheus #Grafana #Prometheus #监控

云堡垒机比硬件堡垒机便宜吗?为什么呢?

行云管家

网络安全 堡垒机 硬件堡垒机

软件测试 |瓶颈分析方法

测吧(北京)科技有限公司

测试

华为云盘古气象大模型研究成果在《Nature》正刊发表

新消费日报

星辰天合公司产品完成阿里云PolarDB数据库产品生态集成认证

阿里云数据库开源

polarDB PolarDB-X PolarDB for PostgreSQL

软件测试 | 测试设计技巧—游戏类

测吧(北京)科技有限公司

测试

打工人都在用的AI工具

不在线第一只蜗牛

人工智能 工具 ChatGPT

Monibuca 中的内存复用

不卡科技

GC go语言 流媒体开发 内存池 Monibuca

对线面试官-Redis(六 如何保证 Redis 高并发 主从复制原理)

派大星

Java 面试题

[BitSail] Connector开发详解系列二:SourceSplitCoordinator

字节跳动数据平台

沙漠觅绿洲——华为HMS生态强势赋能伙伴成功掘金中东非

最新动态

软件测试 | 性能测试人力资源规划

测吧(北京)科技有限公司

测试

陶建辉在“2023 可信数据库发展大会”发表演讲,TDengine 入选中国数据库产业图谱

爱倒腾的程序员

涛思数据 tdengine 时序数据库

软件测试/测试开发丨Python常用数据结构-元组Tuple

测试人

Python 程序员 软件测试 元组 tuple

如何用大模型 Prompt 解决行业场景问题?大厂中文教程来了!

飞桨PaddlePaddle

人工智能 百度 paddle 飞桨

华为云代码托管CodeArts Repo:保护企业核心代码资产安全

华为云PaaS服务小智

云计算 华为云 代码托管 华为开发者大会2023

软件测试/测试开发丨Python常用数据结构-集合Set

测试人

Python 程序员 软件测试 测试开发

JSR-305:供检查软件缺陷用的注解_Java_Charles Humble_InfoQ精选文章