Файл: Руководство по стилю программирования и конструированию по.pdf
ВУЗ: Не указан
Категория: Не указан
Дисциплина: Не указана
Добавлен: 30.11.2023
Просмотров: 780
Скачиваний: 2
ВНИМАНИЕ! Если данный файл нарушает Ваши авторские права, то обязательно сообщите нам.
СОДЕРЖАНИЕ
ГЛАВА 34 Основы мастерства
825
Соглашения могут компенсировать недостатки языков. Если язык не поддержи- вает именованные константы (к таким языкам относятся Python, Perl, языки обо- лочек UNIX и т. д.), конвенция позволяет провести различие между переменны- ми, допускающими и чтение, и запись, и переменными, служащими для эмуляции констант, предназначенных только для чтения. В качестве других примеров ком- пенсирования недостатков языка при помощи соглашений можно назвать согла- шения дисциплинированного использования глобальных данных и указателей.
В крупных проектах программисты иногда злоупотребляют конвенциями. Они создают так много стандартов и правил, что их запоминание само по себе стано- вится полноценной работой. Но в небольших проектах программисты из-за пло- хого понимания достоинств разумных соглашений обычно впадают в другую крайность. Поймите подлинную ценность соглашений и извлекайте из них выго- ду; используйте их для структурирования тех областей, которые страдают от не- достатка структуры.
34.6. Программируйте в терминах
проблемной области
Другим специфическим методом борьбы со сложностью является работа на мак- симально высоком уровне абстракции. Один способ достижения этой цели за- ключается в работе в терминах проблемы программирования, а не ее компьютер- ного решения.
Высокоуровневый код не должен включать подробных сведений о файлах, сте- ках, очередях, массивах, символах и подобных объектах, имеющих имена вроде
i, j и k. Высокоуровневый код должен описывать решаемую проблему. Он должен быть наполнен описательными именами классов и вызовами методов, ясно харак- теризующими выполняемые действия, а не подробными сведениями о том, что файл открывается в режиме «только для чтения». Высокоуровневый код не должен быть загроможден комментариями, гласящими, что «здесь переменная
i представляет индекс записи из файла о сотрудниках, а чуть позже она используется для индек- сации файла счетов клиентов».
Это неуклюжая методика программирования. На самом высоком уровне программы не нужно знать, что данные о сотрудниках представлены в виде записей или хра- нятся в файле. Информацию, относящуюся к этому уровню детальности, надо скрыть. На самом высоком уровне вы не должны иметь понятия о том, как хра- нятся данные. Вы не должны читать комментарии, объясняющие роль перемен- ной
i и то, что она используется с двойной целью. Вместо этого вы должны ви- деть две переменные с выразительными именами, такими как
employeeIndex и
clientIndex.
Разделение программы на уровни абстракции
Очевидно, что на некотором уровне надо работать и в терминах реализации, но вы можете изолировать эти части программы от частей, разработанных в терми- нах проблемной области. Проектируя программу, обдумайте уровни абстракции
(рис. 34-1).
826
ЧАСТЬ VII Мастерство программирования
Рис. 34-1. Программа может быть разделена на несколько уровней абстракции.
Удачное проектирование позволяет программистам проводить значительную
часть времени, сосредоточившись только на верхних уровнях, игнорируя
более низкие уровни
Уровень 0: возможности операционной системы и машинные команды
Если вы программируете на высокоуровневом языке, можете не беспокоиться о самом низком уровне: язык позаботится об этом автоматически. Если же вы ис- пользуете низкоуровневый язык, попробуйте создать ради своего удобства более высокие уровни, хотя многие программисты этого не делают.
Уровень 1: структуры и средства языка программирования
Структуры языка программирования — это элементарные типы данных, управля- ющие структуры и т. д. Кроме того, большинство популярных языков снабжено дополнительными библиотеками, предоставляют доступ к вызовам ОС и т. д. Вы используете эти структуры и средства естественным образом, так как программи- ровать без них невозможно. Многие программисты никогда не поднимаются выше этого уровня абстракции, чем значительно осложняют себе жизнь.
Уровень 2: низкоуровневые структуры реализации
Низкоуровневые структуры реализации относятся к чуть более высокому уровню,
чем структуры, предоставляемые самим языком. В большинстве своем это опера- ции и типы данных, которые вы изучали в вузе: стеки, очереди, связные списки,
деревья, индексированные файлы, последовательные файлы, алгоритмы сортиров- ки, поиска и т. д. Если вы будете писать программу полностью на этом уровне, вам придется работать со слишком большим числом деталей, чтобы победить в битве со сложностью.
Уровень 3: низкоуровневые элементы проблемной области
На этом уровне вы имеете дело с примитивами, нужными для работы в терминах проблемной области. Это клей, скрепляющий нижележащие структуры компью- терных наук и высокоуровневый код проблемной области. Чтобы писать код на этом уровне, вы должны определить словарь проблемной области и создать стро- ительные блоки, годные для решения поставленной задачи. Во многих приложе- ниях этим уровнем является уровень бизнес-объектов или уровень сервисов.
ГЛАВА 34 Основы мастерства
827
В качестве элементов словаря и строительных блоков данного уровня выступают классы. Возможно, эти классы слишком примитивны, чтобы их можно было за- действовать для решения проблемы непосредственно на этом уровне, однако они формируют каркас, на основе которого можно решить проблему, используя классы более высокого уровня.
Уровень 4: высокоуровневые элементы проблемной области
Этот уровень формирует абстракцию, позволяющую работать с проблемой в ее собственных терминах. Код, написанный на этом уровне, должен быть частично понятен даже людям, далеким от программирования — возможно, и вашим заказ- чикам. Он будет слабо зависеть от специфических аспектов языка программиро- вания, потому что вы будете использовать для работы над проблемой собствен- ный набор средств. Так что на этом уровне ваш код больше зависит от средств,
созданных вами на уровне 3, чем от возможностей языка.
Детали реализации уже должны быть скрыты на два уровня ниже — на уровне структур компьютерных наук, чтобы изменения оборудования или ОС совсем не влияли на этот уровень. Выразите в программе на этом уровне пользовательское представление о мире, потому что когда программа изменяется, она изменяется в терминах пользователя. Изменения проблемной области будут сильно влиять на этот уровень, но вы сможете легко адаптировать к ним программу, создавая но- вую версию на основе строительных блоков предыдущего уровня.
Многие программисты находят полезным дополнение этих концептуальных уров- ней другими, перпендикулярными «уровнями». Например, типичная трехуровневая архитектура пересекает описанные выше уровни, предоставляя дополнительные средства интеллектуального управления аспектами проектирования и кодом.
Низкоуровневые методики работы в проблемной области
Даже не выработав полного архитектурного подхода к словарю проблемной об- ласти, вы можете использовать многие методики этой книги для работы в тер- минах проблемы реального мира, а не ее компьютерного решения.
쐽
Используйте классы для реализации структур, значимых в проблемной области.
쐽
Скрывайте информацию о низкоуровневых типах данных и деталях их реа- лизации.
쐽
Используйте именованные константы для документирования смысла строк и численных литералов.
쐽
Присваивайте промежуточным переменным промежуточные результаты вычис- лений с целью документирования этих результатов.
쐽
Используйте булевы функции для пояснения сложных булевых тестов.
34.7. Опасайтесь падающих камней
Программирование не является ни полностью искусством, ни полностью наукой.
В своей обычной форме оно представляет собой «мастерство», занимающее про- межуточное место между искусством и наукой. В лучшем случае это инженерная дисциплина, основанная на синергической интеграции науки и искусства
828
ЧАСТЬ VII Мастерство программирования
(McConnell, 2004). Чем бы программирование ни было — искусством, ремеслом или инженерной дисциплиной, создание работающей программы требует изрядной доли рассудительности. А для этого нужно обращать внимание на широкий диа- пазон предупреждающих знаков — тонких намеков на проблемы в вашей програм- ме. Предупреждающие знаки в программировании указывают на возможные про- блемы, но обычно они не настолько очевидны, как дорожный знак, предупреж- дающий о камнепадах.
Слова «Это по-настоящему хитрый код» обычно предупреждают о том, что код плох.
«Хитрый» код — это другое название «плохого» кода. Если код кажется вам хит- роумным, подумайте, не переписать ли его, чтобы он таким не был.
Класс, число ошибок в котором превышает средний уровень, — тоже предупреж- дающий знак. Несколько классов, подверженных ошибкам, обычно оказываются самой дорогой частью программы. Если число ошибок в каком-то классе превы- шает средний уровень, такая ситуация, вероятно, сохранится и в будущем. Поду- майте о том, чтобы переписать его.
Если бы программирование было наукой, с каждым предупреждающим знаком был бы связан конкретный, хорошо определенный способ исправления проблемы. Но так как программирование еще и мастерство, предупреждающие знаки просто указывают на проблемы, которые вы должны рассмотреть. Переписывать хитро- умный код или улучшать класс, подверженный ошибкам, нужно не всегда.
Как аномальное число дефектов в классе предупреждает о низком качестве клас- са, так и аномальное число дефектов в программе свидетельствует о неэффектив- ности процесса разработки. Хороший процесс не привел бы к получению дефек- тного кода. Он включил бы проверку архитектуры, за которой последовали бы обзоры архитектуры, проектирование с обзорами проекта и кодирование с об- зорами кода. Ко времени тестирования кода большинство ошибок было бы устранено. Для достижения высочайшей производительности труда нужно рабо- тать не просто усердно, но и разумно. Большой объем отладки предупреждает о том, что программисты не работают разумно. Написать большой фрагмент кода за день и потратить две недели на его отладку — это и есть неразумная работа.
Метрики проектирования также могут быть предупреждающими знаками. Боль- шинство таких метрик — это эвристические правила, характеризующие качество проектирования. Если класс содержит более семи членов, это не всегда означает,
что он плохо спроектирован, но предупреждает о том, что класс сложен. Более
10 точек принятия решения в методе, более трех уровней логической вложенно- сти, необычно большое число переменных, высокая степень сопряжения одного класса с другими или низкий уровень внутреннего сопряжения класса или мето- да — все это предупреждающие знаки. Они не всегда означают, что класс спроек- тирован плохо, но наличие любого из них должно заставлять вас взглянуть на класс скептически.
Любой предупреждающий знак должен заставить вас сомневаться в качестве програм- мы. Как говорит Чарльз Саундерс Пирс (Charles Saunders Peirce), «сомнение — это неловкое и неприятное состояние, от которого мы стараемся освободиться, перей- дя в состояние убежденности». Рассматривайте предупреждающие знаки как «при- чины сомнения», побуждающие искать более приятное состояние убежденности.
1 ... 94 95 96 97 98 99 100 101 ... 104