Программирование по контракту

Программирование по контракту обеспечивает проверку предусловий и постусловий при выполнении методов классов, пользовательских функций. Также немаловажную роль в правильности написания функций играют инварианты.

Предусловие

Определение:

Предусловие - должно быть выполнено до исполнения действия.

Постусловие

Определение:

Постусловие - должно быть выполнено после исполнения действия.

Инвариант

Определение:

Инвариант - определяет глобальные свойства некоторого класса, которые должны соблюдаться после его создания на протяжении всего времени жизни.

Пример

Необходимо гарантировать, что функции данного класса будут возвращать корректные данные, либо, вообще не будут работать.

 public class Time {
   private int hours;
   private int minutes;
   private int seconds;
   public int getHours();
   {
       return hours;
   }    
   public int getMinutes();
   {
       return minutes;
   }
   public int getSeconds()
   {
       return seconds;
   }
   public void setHours(int newHOURS);
   {
       hours = newHOURS;
   }
   public void setMinutes(int newMINUTES);
   {
       minutes = newMINUTES;
   }
   public void setSeconds(int newSECONDS)
   {
       seconds = newSECONDS;
   }
 }

Инвариант:

hours >= 0 and  hours <= 23 

[math] minutes \gt = 0 [/math] [math] and[/math] [math] minutes \lt 60 [/math]

[math] seconds \gt = 0 [/math] [math] and[/math] [math] seconds \lt 60 [/math]

Постусловия и предусловия:

[math]int[/math] [math] getHours() [/math]

[math]post:[/math] возвращенное значение будет являться текущим часом.

[math]int[/math] [math] getMinutes() [/math]

[math]post:[/math] возвращенное значение будет являться текущей минутой.

[math]int[/math] [math] getSeconds() [/math]

[math]post:[/math] возвращенное значение будет являться текущей секундой.

[math] void [/math] [math]setHours(int[/math] [math] newHours)[/math]

[math] pre: [/math] [math]0 \lt = newHours \lt = 23[/math]

[math] post: [/math] [math]hours == newHours[/math]

[math] void [/math] [math]setMinutes(int[/math] [math]newMinutes)[/math]

[math] pre: [/math] [math]0 \lt = newMinutes \lt 60[/math]

[math] post: [/math] [math]minutes == newMinutes [/math]

[math] void [/math] [math]setSeconds(int[/math] [math]newSeconds)[/math]

[math] pre: [/math] [math]0 \lt = newSeconds \lt 60[/math]

[math] post: [/math] [math]seconds == newSeconds[/math]

Решение 1

Выбрасывать исключение. Имеет недостатки: неочевидность проверки, необходимость писать кучу кода вручную.

 void setHours(int newHours){
       if (newHours < 0 || newHours > 23) 
           throw GREAT_Time_Exception;
        hours = newHours;
 }

Решение 2

Java поддерживает механизм аннотаций (рекомендаций компилятору, препроцессору) – метаданные, которые могут быть добавлены в исходный код программы, не влияя на него семантически, т.е. не меняя его поведение. При этом, они могут использоваться на этапе анализа кода, компиляции и выполнения.

 @Contracted // говорит о том, что класс использует контракты – для отображения в IDE
 class Time
 {   
   void setHours(int newHours);
   {
       hours = newHours;
   }
   @Requires ({“newHOURS>= 0”,“newHOURS<= 23” })
   @Ensures (“hours == newHOURS”)
 }

@Requires – буквально означает, «Убедиться, что ДО выполнения подпрограммы («условие выполняется»)» Иначе – бросить исключение.

@Ensures – буквально означает, «Убедиться, что ПОСЛЕ выполнения подпрограммы ( «условие выполняется»)»

Здесь мы видим, что, как и в Решение 1, осуществляется проверка пред и пост условий для наших методов. В чем разница? Разница в том, что во втором случае это более наглядно и удобно.

Пример

Рассмотрим стек на массиве. У него есть переменные

[math] size - [/math] число элементов

[math] elements - [/math] массив элементов

Методы:

[math]push - [/math] добавить элемент

[math] pop - [/math] удалить элемент

[math] peek - [/math] получить элемент на вершине

[math] size - [/math] число элементов

[math] isEmpty - [/math] проверка на пустоту

public class ArrayStack {
  private int size;
  private Object[] elements;
  public void push(Object element){
      assert element != null;
      ensureCapacity(size + 1);
      elements[size++] = element;
  }
  private void ensureCapacity(int capacity) {
    if (capacity <= elements.length) {
       return;
    }
    Object[] newElements = new Object[2 * capacity];
    for (int i = 0; i < size; i++) {
        newElements[i] = elements[i];
    }
    elements = newElements;
  }
  public Object pop() {
    assert size > 0;
    return elements[--size];
  } 
  public int size() {
    return size;
  }
  public boolean isEmpty() {
    return size == 0;
  }
  public Object peek() {
    assert size > 0;
    return elements[size - 1];
  }
}

Инвариант:

Размер не отрицателен, [math]size \gt =0[/math]

Элементы заполнены [math]elements[0..size - 1] != NULL [/math]

Контракты:

[math]push [/math]

[math]pre: element != NULL [/math]

[math]post: size = size' + 1[/math] [math] and [/math] [math] elements[size'] == element [/math]

[math] void[/math] [math] push (Object[/math] [math] element) [/math]

[math] pop:[/math]

[math] pre: size \gt 0 [/math]

[math]post: size == size' - 1[/math] [math] and [/math] [math]result == elements[size][/math]

[math] Object[/math] [math] pop() [/math]

[math] peek:[/math]

[math]pre: size \gt 0[/math]

[math]post: result == elements[size - 1][/math]

[math] Object[/math] [math] peek() [/math]

[math] size:[/math]

[math]post: result == size [/math]

[math]int[/math] [math] size()[/math]

[math]isEmpty:[/math]

[math]post: result == size \gt 0[/math]

[math]boolean[/math] [math]isEmpty() [/math]