java - 使用注解确保方法返回的值不被丢弃

Question

String 在 Java 中是不可变的。从广义上讲，以下代码段是“错误的”。

String s = "hello world!";

s.toUpperCase(); // "wrong"!!

System.out.println(s); // still "hello world!"!!!

尽管这是“错误的”，但代码编译并运行，可能会让许多初学者感到困惑，他们必须要么被告知错误是什么，要么通过查阅文档自己找出答案。

阅读文档是理解 API 的重要组成部分，但我想知道这是否可以通过额外的编译时检查来补充。特别是，我想知道是否可以使用 Java 的注释框架来强制某些方法返回的值不被忽略。然后 API 设计者/库作者将在他们的方法中使用此注释来记录不应忽略哪些返回值。

一旦 API 补充了这个注解(或者可能是另一种机制)，那么每当用户编写上述代码时，它就不会编译(或者这样做会发出严厉的警告)。

那么这可以做到吗，你将如何做这样的事情？

---

附录:动机

似乎很清楚，在一般情况下，Java应该允许忽略方法的返回值。 List.add 等方法的返回值(总是 true)，System.setProperty (以前的值)，大多数时候可能可以安全地忽略。

但是，也有许多方法的返回值应该不被忽略。这样做几乎总是一个程序员错误，或者不是正确使用 API。其中包括:

• 不可变类型的方法(例如 String、BigInteger 等)返回操作的结果，而不是改变它被调用的实例开。
• 返回值是其行为的关键部分且不应被忽略的方法，但人们有时还是会这样做(例如 InputStream.read(byte[]) 返回读取的字节数，应该不假设是数组的整个长度)

目前我们可以编写忽略这些返回值的代码，并让它们在没有警告的情况下编译和运行。静态分析检查器/错误查找器/样式执行器/等几乎可以肯定地将这些标记为可能的代码异味，但如果这可以由 API 本身强制执行(可能通过注释)似乎是合适/理想的。

一个类几乎不可能确保它总是“正确”使用，但它可以做一些事情来帮助指导客户正确使用(参见:Effective Java 2nd Edition，Item 58: Use可恢复条件的检查异常和编程错误的运行时异常和第 62 条:记录每个方法抛出的所有异常)。有一个注释可以强制客户端不忽略某些方法的返回值，并在编译时以错误或警告的形式由编译器强制执行，似乎符合这个想法。

---

附录 2:片段

以下是初步尝试，简明扼要地说明了我想要实现的目标:

@interface Undiscardable { }
//attachable to methods to indicate that its
//return value must not be discarded

public class UndiscardableTest {
     public static @Undiscardable int f() {
             return 42;
     }

     public static void main(String[] args) {
             f(); // what do I have to do so this generates
                  // compilation warning/error?

             System.out.println(f()); // this one would be fine!
     }
}

上面的代码编译并运行良好(as seen on ideone.com)。我怎样才能让它不是这样？如何将我想要的语义分配给 @Undiscardable？

Answer 1

您还可以查看 jsr305。它定义了一个 @CheckReturnValue注释:

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.annotation.meta.When;

@Documented
@Target( { ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE,
        ElementType.PACKAGE })
@Retention(RetentionPolicy.RUNTIME)
public @interface CheckReturnValue {
    When when() default When.ALWAYS;
}

它与 findbugs 兼容，并在有人忘记处理返回值时生成警告。

Guavas Splitter 使用它: http://code.google.com/p/guava-libraries/source/browse/guava/src/com/google/common/base/Splitter.java

我必须说我喜欢可以指导静态代码分析的注解。