使用注释的Java中的常量正确性？

Question

是否存在允许我将 Java 方法注释为 @Const 的现有库，以便编译器（我假设使用 apt）在更新字段或调用非 @Const 方法时标记错误场地;并将参数注释为@Const，以便接受方法不能调用其任何非@Const 方法，或更新其任何字段？

（基本上，尝试使用注释向 Java 添加 const 正确性；上面的问题中没有涉及一些明显的细节，例如分配给/来自 @Const 类型的参数等）

我找到了这个：http://confluence.atlassian.com/pages/viewpage.action?pageId=182158080，但它似乎只作为 IDEA 的一部分提供。

根据下面的澄清请求，这里有示例代码来说明我的意思：

class Person {
  private String name;
  private String address;

  @Const public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  ... etc. for address
}

现在，如果我定义一个方法，例如：

void processPerson(@Const Person p)

p.getName() 这样的行在processPerson 中是可以的，因为getName 被标记为@Const 方法。但是从processPerson 中调用p.setName() 会被标记为错误。

请注意，这与final 有很大不同：如果参数被定义为final Person p，任何对p 的赋值都是非法的，但是修改p 所指的内容仍然是完全有效的（或者使用p.setName(...) 或者更直接地使用p.name = ...。

Answer 1

• JSR-305 应该可以满足您的需求

• 就个人而言，我想看看是否可以使用Hibernate Validator - Bean Validation (JSR-303)。这是一个很棒的小库（不依赖于 hibernate，它很小），它对保持数据清洁确实有奇效。请参阅documentation。

• 最近一个google的人也开始Contracts for Java，但可能还没有达到生产质量。

Answer 2

看看Checker Framework，它基本上有检查器，试图通过可扩展的类型注释系统 [JSR-308] 检测软件缺陷 [JSR-305]。

它有一个不变性检查器（实际上是 2 个），它允许您使用 @Mutable、@Immutable 和 @Readonly 等不变性注释来注释代码。此工具区分不可变实例和只读引用。

我喜欢这个框架并且主要将它用于空检查，但我正在尝试开始更多地使用不变性检查器和实习检查器。

将参数注释为@Const，以便接受方法不能调用其任何非@Const 方法，或更新其任何字段？

看起来像：

void addFriend(@ReadOnly Friend friend) { this.friends.add(friend); }

允许我将 Java 方法注释为 @Const，以便编译器（使用 apt 我假定）在更新字段或在字段上调用非 @Const 方法时将标记错误；和

问题中的示例如下所示：

public String getName(@ReadOnly Person this) {
  return name;
}

这里的@ReadOnly 表示接收者（正在调用其方法的this 实例）应该不被修改。尽管有明显的额外参数，该方法仍然照常调用：

@ReadOnly Person person = new Person();
person.getName();

---

Answer 3

我附议@AlexR 评论，这可以使用 AspectJ 来完成，类似以下内容：

public aspect ConstAspect{
declare warning : withincode(* *(..,@Const (*),.. ) ) : "Calling Const Method..";
}

这不符合您的要求，但我基本上想展示一种方法，在上述情况下，任何在参数上具有 @Const 的方法都带有警告标记。有了更好的连接点，所有关注点都可以标记为错误。

Answer 4

const 在 C++ 中。 Java 显然是故意放弃它的。现在，在没有真正经验的情况下长大的人 const 认为这是个好主意。

一旦您将一种方法标记为const，它就会像癌症一样传播，很快您就会发现自己几乎是const。最好有not-const。

完全没用。它只是在学术上吸引人，对实际程序中的任何人都没有帮助。