Лекция
контрактное программирование (design by contract (DbC), programming by contract, contract-based programming) — это метод проектирования программного обеспечения. Он предполагает, что проектировщик должен определить формальные, точные и верифицируемые спецификации интерфейсов для компонентов системы. При этом, кроме обычного определения абстрактных типов данных, также используются предусловия, постусловия и инварианты. Данные спецификации называются «контрактами» в соответствии с концептуальной метафорой условий и ответственности в гражданско-правовых договорах.
можно сказать, что контрактное программирование похоже на расширенную валидацию, но с более четкой концепцией и структурой. Оно использует пред- и постусловия, чтобы задавать "контракты" для методов и классов, определяя условия, при которых методы будут выполняться, и гарантируя корректный результат.
В отличие от обычной валидации, контрактное программирование помогает описать строгие правила взаимодействия с кодом, проверяя:
Предусловия – правила, которые должны быть выполнены перед запуском метода. Например, аргументы метода должны быть в допустимом диапазоне.
Постусловия – условия, которые должны быть выполнены после завершения метода. Например, возвращаемое значение метода должно соответствовать определенным критериям.
Инварианты – состояния, которые должны всегда быть истинными для объекта. Например, свойство объекта не должно выходить за определенные границы.
Таким образом, контрактное программирование не просто проверяет корректность входных данных, а еще и гарантирует, что код работает в согласии с четко определенными правилами и ограничениями.
Термин предложил Бертран Мейер в связи с разработкой языка Eiffel. Контрактное программирование выросло из формальной верификации, формальной спецификациии логики Хоара. Контрактное программирование — это не только простая метафора, указывающая способ проектирования. Условия, облегчающие применение контрактного программирования:
рис. проектирование модуля по контракту
Основная идея контрактного программирования — это модель взаимодействия элементов программной системы, основывающаяся на идее взаимных обязательств и преимуществ. Как и в бизнесе, клиент и поставщик действуют в соответствии с определенным контрактом. Контракт некоторого метода или функции может включать в себя:
Многие языки программирования позволяют учитывать такие обязательства. Контрактное программирование подразумевает эти требования критическими для корректности программ, поэтому они должны быть утверждены при проектировании. Таким образом, контрактное программирование предписывает начинать писать код с написания формальных утверждений корректности (assertions).
В объектно-ориентированном программировании контракт метода обычно включает следующую информацию:
При использовании контрактов сам код не обязан проверять их выполнение. Обычно в таких случаях в коде делают жесткое падение[уточнить] («fail-fast»), таким образом облегчая отладку выполнения контрактов. Во многих языках, таких как C, C++, Delphi, PHP, такое поведение реализуется оператором assert. В релизовом варианте кода это поведение может быть сохранено, либо проверки могут быть убраны чтобы повысить производительность.
Юнит-тесты проверяют модуль изолированно от других, проверяя, что модуль удовлетворяет предположениям контракта, а также свои контракты выполняют используемые им модули. Интеграционные тесты проверяют, что модули работают корректно вместе.
Контрактное программирование может повысить уровень повторного использования кода, поскольку обязательства модуля четко документированы. Вообще, контракт модуля можно рассматривать также как способ документации программного обеспечения.
Условия контракта никогда не должны нарушаться во время выполнения программы без ошибок. Поэтому контракты обычно проверяются только в режиме отладки во время разработки программного обеспечения. Позже при выпуске проверки контрактов отключаются для максимальной производительности.
Во многих языках программирования контракты реализуются с помощью assert . Утверждения по умолчанию компилируются в режиме выпуска в C / C ++ и аналогичным образом деактивируются в C # и Java.
Запуск интерпретатора Python с «-O» (для «оптимизировать») в качестве аргумента аналогичным образом приведет к тому, что генератор кода Python не будет генерировать какой-либо байт-код для утверждений.
Это эффективно исключает затраты времени выполнения на утверждения в производственном коде - независимо от количества и вычислительных затрат на утверждения, используемые при разработке, - поскольку никакие такие инструкции не будут включены в производство компилятором.
Дизайн по контракту не заменяет обычные стратегии тестирования, такие как модульное тестирование , интеграционное тестирование и системное тестирование . Скорее, он дополняет внешнее тестирование внутренними самотестированием, которые можно активировать как для изолированных тестов, так и в производственном коде на этапе тестирования.
Преимущество внутренних самотестирования заключается в том, что они могут обнаруживать ошибки до того, как они проявят себя как недействительные результаты, наблюдаемые клиентом. Это приводит к более раннему и более конкретному обнаружению ошибок.
Использование утверждений можно рассматривать как форму тестового оракула , способ тестирования проекта путем реализации контракта.
Языки, изначально поддерживающие средства для контрактного программирования:
Предположим, у нас есть функция divide, которая делит одно число на другое. Для нее установим:
class Calculator
{
// Метод для деления
public function divide(float $numerator, float $denominator): float
{
// Предусловие
assert($denominator !== 0, "Делитель не должен быть равен нулю.");
// Основное тело метода
$result = $numerator / $denominator;
// Постусловие
assert(abs(($result * $denominator) - $numerator) < 0.00001, "Результат не соответствует ожиданиям.");
return $result;
}
}
// Пример использования
$calc = new Calculator();
try {
echo $calc->divide(10, 2); // Вывод: 5
echo $calc->divide(10, 0); // Выдаст ошибку из-за деления на ноль
} catch (AssertionError $e) {
echo "Ошибка контракта: " . $e->getMessage();
}
Пример для инварианта класса
Для класса Calculator можно добавить инвариант, который будет гарантировать, что результат вычислений всегда будет числом, например, свойство, указывающее на последний результат операции. Инвариант для этого свойства будет состоять в том, что результат всегда должен быть числом, а не NaN или null. Это будет гарантировать, что объект класса всегда находится в "корректном" состоянии.
Добавим свойство $lastResult для хранения результата последней операции и реализуем инвариант, который будет проверяться после каждой операции.
interface CalculatorInterface
{
public function add(float $a, float $b): float;
public function subtract(float $a, float $b): float;
public function multiply(float $a, float $b): float;
public function divide(float $a, float $b): float;
}
class Calculator implements CalculatorInterface
{
// Свойство для хранения последнего результата
private float $lastResult = 0.0;
public function add(float $a, float $b): float
{
$this->lastResult = $a + $b;
$this->checkInvariant();
return $this->lastResult;
}
public function subtract(float $a, float $b): float
{
$this->lastResult = $a - $b;
$this->checkInvariant();
return $this->lastResult;
}
public function multiply(float $a, float $b): float
{
$this->lastResult = $a * $b;
$this->checkInvariant();
return $this->lastResult;
}
public function divide(float $a, float $b): float
{
if ($b === 0) {
throw new InvalidArgumentException("Делитель не должен быть равен нулю.");
}
$this->lastResult = $a / $b;
$this->checkInvariant();
return $this->lastResult;
}
// Проверка инварианта
private function checkInvariant(): void
{
// Инвариант: $lastResult всегда должен быть числом
assert(is_float($this->lastResult), "Результат последней операции должен быть числом.");
}
public function getLastResult(): float
{
return $this->lastResult;
}
}
// Пример использования
$calculator = new Calculator();
try {
echo "Сложение: " . $calculator->add(5, 3) . PHP_EOL;
echo "Вычитание: " . $calculator->subtract(5, 3) . PHP_EOL;
echo "Умножение: " . $calculator->multiply(5, 3) . PHP_EOL;
echo "Деление: " . $calculator->divide(5, 2) . PHP_EOL;
echo "Последний результат: " . $calculator->getLastResult() . PHP_EOL;
} catch (AssertionError $e) {
echo "Ошибка инварианта: " . $e->getMessage();
}
Свойство $lastResult: хранит результат последней операции, и инвариант требует, чтобы оно всегда оставалось числом.
Метод checkInvariant(): проверяет, что $lastResult является числом. Этот метод вызывается после каждой операции для гарантии выполнения инварианта.
Исключение: если инвариант нарушен, выбрасывается AssertionError, указывающий на проблему в работе класса.
Такой инвариант помогает убедиться, что объект класса Calculator всегда находится в "валидном" состоянии, независимо от того, какая операция была вызвана.
Таким образом, контрактное программирование в PHP с использованием assert помогает контролировать выполнение условий и обеспечивать более надежное выполнение кода.
Пример на языке D
double divide(double dividend, double divisor)
in{
assert(divisor != 0);
}
out (result){
assert(result < 10);
}
body{
return dividend/divisor;
}
Эта функция сначала проверит, равен ли второй аргумент нулю, и если да, то выдаст исключение; в противном случае он разделит первый аргумент на второй. Затем она проверит, меньше ли результат 10. Если он меньше 10, функция вернет значение. В противном случае будет выдано исключение.
Модульный тест также можно считать частным случаем управления выходом .
Комментарии
Оставить комментарий
Разработка программного обеспечения и информационных систем
Термины: Разработка программного обеспечения и информационных систем