Ключевые моменты

Интерфейс класса должен формировать согласованную абстракцию. Многие проблемы объясняются нарушением одного этого принципа.

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

Включение обычно предпочтительнее, чем наследование, если только вы не моделируете отношение «является».

Наследование - полезный инструмент, но оно повышает сложность, что противоречит Главному Техническому Императиву Разработки ПО, которым является управление сложностью.

Классы - главное средство управления сложностью. Уделите их проектированию столько времени, сколько нужно для достижения этой цели.

ГЛАВА

Высококачественные

методы

Содержание

7.1. Разумные причины создания методов ШтсШШйТГЬ

7.2. Проектирование на уровне методов

7.3. Удачные имена методов

7.4. Насколько объемным может быть метод?

7.5. Советы по использованию параметров методов

7.6. Отдельные соображения по использованию функций

7.7. Методы-макросы и встраиваемые методы

Связанные темы

Этапы конструирования методов: раздел 9.3

Классы: глава 6

Общие методики проектирования: глава 5

Архитектура ПО: раздел 3.5

В главе 6 мы подробно рассмотрели создание классов. В этой главе мы обратим внимание на методы и характеристики, отличающие хорошие методы от плохих. Если вам хотелось бы сначала разобраться в вопросах, влияющих на проектирование методов, прочитайте главу 5 и потом вернитесь к этой главе. Некоторые важные атрибуты высококачественных методов обсуждаются также в главе 8. Если вас больше интересуют этапы создания методов и классов, см. главу 9.

Прежде чем перейти к деталям, определим два базовых термина. Что такое «метод»? Метод - это отдельная функция или процедура, выполняющая одну задачу. В различных языках методы могут называться по-разному, но их суть от этого не меняется. Иногда макросы С и С++ также полезно рассматривать как методы. Многие советы по созданию высококачественных методов относятся и к макросам.

Что такое высококачественный метод? На этот вопрос ответить сложнее. Возможно, лучше всего просто показать, что не является высококачественным методом. Вот пример низкокачественного метода:

Пример низкокачественного метода (С++)

void HanclleStuff( CORP DATA & inputRec, int crntQtr, EMP DATA empRec, double & estimRevenue, double ytdRevenue, int screenX, int screenY, COLOR TYPE & newColor, COLOR TYPE & prevColor, StatusType & status, int expenseType )

int i;

for ( i = 0; i < 100; i++ ) { inputRec.revenue[i] = 0;

inputRec.expense[i] = corpExpense[ crntQtr ][ i ]; }

UpdateCorpDatabase( empRec );

estimRevenue = ytdRevenue * 4.0 / (double) crntQtr;

newColor = prevColor;

status = SUCCESS;

if ( expenseType == 1 ) {

for ( i = 0; i < 12; i++ )

profit[i] = revenue[i] - expense.type1[i];

else if ( expenseType == 2 ) {

profit[i] = revenue[i] - expense.type2[i];

else if ( expenseType 3 )

profit[i] = revenue[i] - expense.type3[i];

Что тут не так? Подскажу: вы должны найти минимум 10 недостатков. Составив свой список, сравните его с моим.

Неудачное имя: HandleStuffQ ничего не говорит о роли метода.

Метод недокументирован (вопрос документирования не ограничивается отдельными методами и обсуждается в главе 32).

Метод плохо форматирован. Физическая организация кода почти не дает представления о его логической организации. Стратегии форматирования используются непоследовательно: сравните стили операторов if с условиями expenseType == 2 и expenseType == 3 (о форматировании см. главу 31).

Входная переменная inputRec внутри метода изменяется. Если это входная переменная, изменять ее нежелательно (в случае С++ ее следовало бы объявить как const). Если изменение значения предусмотрено, переменную не стоило называть inputRec.

Метод читает и изменяет глобальные переменные: читает corpExpense и изменяет profit. Взаимодействие этого метода с другими следовало бы сделать более непосредственным, без использования глобальных переменных.

Цель метода размыта. Он инициализирует ряд переменных, записывает данные в БД, выполняет вычисления - все эти действия не кажутся связанными между собой. Метод должен иметь одну четко определенную цель.