合同设计中什么样的先决条件是合理的？

Question

假设我们有一个带有以下构造函数的类 Student：

/** Initializes a student instance.
 * @param matrNr    matriculation number (allowed range: 10000 to 99999)
 * @param firstName first name (at least 3 characters, no whitespace) 
 */
public Student(int matrNr, String firstName) {
    if (matrNr < 10000 || matrNr > 99999 || !firstName.matches("[^\\s]{3,}"))
        throw new IllegalArgumentException("Pre-conditions not fulfilled");
    // we're safe at this point.
}

如果我错了，请纠正我，但我认为在这个例子中，我通过简单地指定（相当静态的）约束来遵循契约范式的设计可能的输入值，如果不满足，则引发通用的、未经检查的异常。

现在，有一个后端类管理学生列表，按他们的入学号进行索引。它保存一个 Map 来保存此映射，并通过 addStudent 方法提供对其的访问：

public void addStudent(Student student) {
    students.put(student.getMatrNr(), student);
}

现在我们假设此方法有一个约束，例如“< strong>数据库中不得存在具有相同学号的学生”。

我看到了如何实现这一点的两种选择：

选项 A

定义一个自定义 UniquenessException 类，如果学生具有相同的 matr.addStudent 属性，则由 addStudent 引发该类。号码已存在。调用代码将如下所示：

try {
    campus.addStudent(new Student(...));
catch (UniquenessError) {
    printError("student already existing.");
}

选项 B

将要求陈述为先决条件，如果不成立，则简单地引发 IAE。此外，提供一个方法 canAddStudent(Student Stud) 来提前检查 addStudent 是否会失败。然后，调用代码将如下所示：

Student stud = new Student(...);
if (campus.canAddStudent(stud))
    campus.addStudent(stud);
else
    printError("student already existing.");

---

我觉得从软件工程的角度来看，选项 A 更加清晰，至少出于以下原因：

• 它可以轻松地实现线程安全，而无需修改调用代码（感谢 Voo）向我指出 TOCTTOU，这似乎描述了确切的问题）

因此我想知道：

1. 是否有一个第三个选项是甚至更好？
2. 选项B是否有我没有想到的优点？
3. 从合同设计的角度来看，实际上是否允许使用选项 B 并将唯一性定义为 addStudent 方法的前提条件？
4. 何时定义前置条件并简单地引发 IAE 以及何时使用“适当的”异常，是否有经验法则？我认为“将其作为先决条件，除非它取决于系统的当前状态”可能是这样的规则。有更好的吗？

更新：似乎还有另一个不错的选择，那就是提供一个 public boolean tryAddStudent(...) 方法，该方法不会抛出异常，而是发出错误信号/失败使用返回值。

Answer 1

（对于评论来说太长了）

在您的选项 B 中，我不会使用 Map然后执行：

if (campus.hasStudent(12000)) 
    printError("student already existing.");
else
    campus.addStudent(new Student(...));

Map< /em> 抽象对于您的用例来说不够实用（您提到了并发问题），我会使用 ConcurrentMap并执行以下操作：

final Student candidate = new Student(...);
final Student res = putIfAbsent(student.getMatrNr(), candidate)
if ( res != null ) {
    throw new IllegalStateException("Class contract violation: \"student already exists!\", please read the doc");
}

Answer 2

我不认为后端类管理学生列表的方式与合同相关 - 也就是说，它持有 Map 不会成为合同的一部分合同。因此，将学号带入 hasStudent(int matrNr) 的合约中似乎也有点邪恶。

我建议校园可能应该有一个方法 Boolean hasStudent(Student Student)，它将根据任何条件检查校园是否有学生。如果合约要求唯一性，并且确实是异常的，那么您将使用合约检查：

   Student student= new Student(int matrNbr, String name);
   if (campus.hasStudent(student) {
      throw new UniquenessException();
   }
   else {
      campus.add(student);
   }

抛出的异常应该与参数和返回值一样与合约相关

更新

如果添加应该简单地失败如果不满足唯一性并且不是异常，则不要抛出异常。相反，让添加成功返回一个返回值（如 java.util.HashSet.add() 中）。这样，如果学生确实被添加，campus.add(Student) 将返回 true。