ЭФФЕКТИВНОЕ ОО-ПРОЕКТИРОВАНИЕ И СТРУКТУРНОЕ КАЧЕСТВО ПРИЛОЖЕНИЙ Алексей ПЕТРОВ О ЧЕМ ПОЙДЕТ РЕЧЬ? 1 2 Что такое «структурное качество» приложений? Как соотносятся шаблоны ОО-проектирования и показатели качества? Что такое «анти-шаблоны»? 3 4 Какую помощь в обеспечении структурного качества могут оказать современные языки? Какие мероприятия могут помочь в обеспечении структурного качества? Реально ли повысить структурное качество уже написанных приложений? НЕФОРМАЛЬНОЕ ВВЕДЕНИЕ Качество — это… 1 … «степень соответствия присущих характеристик <…> изделия или продукта потребностям, ожиданиям» (ГОСТ Р ИСО 9000). Различают качество программного обеспечения (ПО) и исходного кода. Основная задача 2 … планировать и осуществлять мероприятия по анализу и повышению структурного качества исходного программного кода как артефакта в процессах разработки ПО Актуальность 3 Итеративные методы разработки; распространение методов обеспечения и контроля качества на все этапы разработки ПО; распространение методов ОО-анализа, проектирования и разработки; применение UML и CASE-средств. Первые результаты 4 Повышение качества управления рисками и затратами на всех этапах жизненного цикла ПО МОДЕЛИ КАЧЕСТВА ПО 20 стр. Метрики точка зрения разработчика модели точка зрения пользователя Критерии атрибуты Факторы Модели качества ПО — это упорядоченные системы атрибутов, значимых для заинтересованных сторон проекта разработки ПО Общий принцип — числовое выражение фактора: линейная комбинация взвешенных влияющих метрик Дж. МакКол Б. Боэм ISO 9126 𝒇𝒊 = 𝒘𝒊𝒋 𝒎𝒋 𝒋 4,8 ВОПРОС #1 Что такое «качественное ПО»? 1 2 Что такое «качественное ПО»? – Ответьте, используя не более шести слов. Какие характеристики ПО, на ваш взгляд, можно назвать структурными? – Ответьте, используя не более шести слов. 20 стр. МОДЕЛЬ КАЧЕСТВА ISO / IEC 9126 ISO 25000:2005 6 целей 21 ожидание от ПО 1991 2001 SQuaRE — Software product Quality Requirements and ❶Надежность Evaluation атрибут близость к достижению цели ISO / IEC 9126 5 структурных характеристик ПО прочность, устойчивость; степень риска, сопряженного с использованием системы ❷Эффективность производительность операций; управление ресурсами; правила кодирования кодирования; ❸Безопасность правила обработка ошибок и исключений ❹Удобство сопровождения документация в коде; удобство чтения кода; отсутствие «грязных» техник; переносимость кода ❺Размер кода оценка трудозатрат в ретроспективе и перспективе МЕТРИКИ КАЧЕСТВА В МОДЕЛИ ISO / IEC 9126 ISO 9126-2, ISO 9126-3 6 целей ожидание от ПО 1991 2001 21 атрибут SQuaRE — Software product QualityПолнота Requirements and и корректность Evaluation реализации функций близость к достижению цели Метрики качества Отношение числа найденных дефектов к прогнозному Отношение числа проведенных тестов к общему их числу … ISO / IEC 9126 В трактовке ISO 9126, качество ПО можно повысить, не внося в него изменений ЛАНДШАФТ МЕТОДОВ ОЦЕНКИ КАЧЕСТВА ПО статические 1 Необходим «запуск» объекта исследования? документация 2 По анализируемым артефактам По способу изучения инструментальный анализ 3 динамические объектный код исходный программный код формальные модели целенаправленная инспекция (desk-checking) рефакторинг ВОПРОС #2 Ограничения статического анализа Возможно ли путем статического анализа установить степень реализации следующих атрибутов качества ПО? Ответьте «да» или «нет» – Защищенность ________________________ – Понятность ________________________ – Правильность, точность ________________________ – Привлекательность ________________________ – Работоспособность ________________________ – Удобство анализа ________________________ – Удобство обучения ________________________ 20 стр. СТАТИЧЕСКИЙ АНАЛИЗ И СТРУКТУРНЫЕ ПОКАЗАТЕЛИ КАЧЕСТВА 1 Статический анализ: удобство чтения низкая сложность корректность обработки исключений отсутствие предупреждений при компиляции легкость отладки, тестирования, исправления ошибок, поддержки и внесения изменений полнота 2 Нефункциональные требования: краткость надежность понятность структурированность удобство сопровождения компонентная структура 3 Оценка качества: платформа архитектура исходный код схема БД МЕТРИКИ В АРТЕФАКТАХ Архитектура 1 Соблюдение стандартов разработки архитектуры; реализация шаблонов проектирования разного уровня; показатели связности и повторного использования компонентов Транзакции и алгоритмы 2 Сложность транзакций и алгоритмов; сложность приемов программирования и отсутствие «грязных» техник Исходный код 3 Соблюдение правил оформления кода; обработка ошибок и исключений; соответствие выбранной парадигме Техническая документация 4 Удобство чтения и структурированность; объем документации БОРЬБА СО СЛОЖНОСТЬЮ: РАУНД 1 20 стр. Сложность — это… 1 …атрибут качества, опосредованно оцениваемый через количество, размер и связность единиц трансляции, соблюдение правил и соглашений о проектировании, моделировании, кодировании продукта Снижению сложности способствуют… 2 …предварительное проектирование архитектуры в соответствии с заданными критериями качества с учетом ее реализуемости на выбранном языке использование шаблонов 3 «Несложный» код: лаконичность модульность соблюдение правил слабая связанность оформления кода систематическая обработка ошибок 4 «Несложный» код обеспечивает… …снижение совокупной стоимости владения ПО БОРЬБА СО СЛОЖНОСТЬЮ: РАУНД 2 Самодокументируемость кода 1 Обеспечивает понятность кода без обращения к документации; способствует соответствию исходного кода «внутренней программной документации» Композиция объектов компонентная разработка 2 Не порождает сильной связи суперклассов с подклассами; не вызывает проблемы «хрупких» базовых классов (fragile base class) Принцип «корректность по построению» 3 4 Подразумевает применение методов проектирования, автоматически гарантирующих корректность получаемого продукта Контрактное программирование ВОПРОС #3 «Контракты» в коде и качество ПО 20 стр. Что вы знаете о контрактном программировании? 1 – 2 Какие структурные показатели качества улучшает применение «контрактов» в исходном коде? – Предложите свое определение контрактного программирования, содержащее не более пяти слов. Ответьте, используя не более четырех слов. ЗНАКОМЬТЕСЬ: ПРАКТИЧЕСКИЕ ПРИМЕРЫ Стандарты и стили кода 1 Открытые: Google C++ Style Guide, Code Conventions for the Java Programming Language; частные: корпоративные, командные и т.д. Шаблоны проектирования 2 3 Фундаментальные (базовые); GoF, Gang of Four (Э. Гамма и др.); GRASP (К. Ларман); PoEAA (М. Фаулер) Автоматическая генерация, рефакторинг, комментирование и документирование кода CASE- и ALM-средства (в составе Microsoft Visual Studio, Eclipse IDE, IntelliJ IDEA и т.д.); Doxygen, javadoc и т.д. ФУНДАМЕНТАЛЬНЫЕ ШАБЛОНЫ ООПРОЕКТИРОВАНИЯ. ШАБЛОНЫ GOF И GRASP Цель ОО-проектирования 1 Разработка архитектуры согласно выбранным критериям качества и с учетом ее реализуемости на выбранном языке Типичные компромиссы 2 Соответствие дизайна задаче общность дизайна; доступность элементов системы безопасность; удобство вызова возможность тонкой настройки Шаблоны (паттерны) проектирования —это… 3 …типовые архитектурные решения задач, в том числе: фундаментальные шаблоны: наследование, делегирование и др.; шаблоны «банды четырех» (GoF): стратегия, адаптер и др.; шаблоны GRASP, PoEAA и др. ПРИМЕР #1: ШАБЛОНЫ ОО-ПРОЕКТИРОВАНИЯ (UML) Делегирование Адаптер объекта ПРИМЕР #2: ШАБЛОНЫ ОО-ПРОЕКТИРОВАНИЯ (JAVA) public class Singleton { private static final Singleton instance = new Singleton(); private Singleton() { // … } public static Singleton getInstance() { return instance; } } ВОПРОС #4 Проблемы архитектуры и качество ПО Какие показатели качества ПО страдают от наличия следующих проблем в архитектуре системы? Ответьте полно, насколько это возможно. Время на ответ — 3 минуты. – Наличие «божественных» классов или объектов _______________________________________________ – Сильная связанность классов или объектов _______________________________________________ – Невозможность замены способа выполнения операции (запроса) _______________________________________________ 20 стр. КАК СООТНОСЯТСЯ ШАБЛОНЫ ПРОЕКТИРОВАНИЯ И КАЧЕСТВО ПРИЛОЖЕНИЙ? (1 / 3) Проблема Чрезмерное количество используемых классов, объектов или глобальных переменных системы 20 стр. Пример шаблона Наследование, прототип, одиночка, посредник, приспособленец «Хрупкие» базовые классы Композиция «Божественные» объекты Декоратор, состояние, стратегия Слабая инкапсуляция (локализация) имен или зависимость от имен Абстрактная фабрика, прототип, фабричный метод, фасад, шаблонный метод Слабая инкапсуляция (локализация) кода или структур данных Итератор, мост, наблюдатель (менеджер), состояние, стратегия, строитель, фасад, шаблонный метод Каждый шаблон (справа) призван решать проблемы в архитектуре системы, последовательно устраняя важнейшие причины перепроектирования (слева) КАК СООТНОСЯТСЯ ШАБЛОНЫ ПРОЕКТИРОВАНИЯ И КАЧЕСТВО ПРИЛОЖЕНИЙ? (2 / 3) Проблема 20 стр. Пример шаблона Дублирование кода Наследование, композиция, мост, шаблонный метод Невозможность замены способа выполнения запроса, сложность сочетания поведений или динамического конфигурирования системы Декоратор, делегирование (композиция), наблюдатель, посредник, прототип, состояние, стратегия Потребность в универсальном или альтернативном способе доступа (системе запросов), абстрактном типе данных (ADT) Адаптер, интерфейс, итератор, компоновщик, наблюдатель, посетитель Потребность в глобальной точке доступа Потребность в константном объекте Зависимость системы от программной или аппаратной платформы Зависимость клиента от алгоритмов, представления или реализации объекта Одиночка Неизменяемый объект Абстрактная фабрика, мост Итератор, мост КАК СООТНОСЯТСЯ ШАБЛОНЫ ПРОЕКТИРОВАНИЯ И КАЧЕСТВО ПРИЛОЖЕНИЙ? (3 / 3) Проблема Пример шаблона Сильная связанность классов или объектов Команда, мост, посредник, фасад Чрезмерное использование наследования Заместитель, отложенная инициализация Необходимость широковещательных коммуникаций Наблюдатель Сложность архитектуры и компрометация уровней многоуровневой системы стр. Декоратор, композиция Недостаточная скорость выполнения инициализирующих операций Недостаточная расширяемость, переносимость и безопасность 20 Заместитель, команда, мост, фасад Наблюдатель, фасад ЧТО ТАКОЕ «АНТИ-ШАБЛОНЫ»…? Загадочный код (Cryptic code) умышленное или неумышленное несоблюдение принципа самодокументируемости исходного кода Божественный объект (God object) монолитный артефакт большого размера в исходном коде Магические числа (Magic numbers) константы с трудно постижимой семантикой Жесткий код (Hard code) имена, адреса и пр. числовые и символьные литералы, наличие которых затрудняет (делает невозможным) конфигурирование системы … И ЧТО ТАКОЕ «ГРЯЗНЫЕ ТЕХНИКИ»? «Мертвый» или пустой код кодовые фрагменты, которые не используются в текущей сборке (версии) приложения, устарели или сделаны «про запас» Архитектурно необоснованные заглушки методы или функции, не выполняющие роль пустых неабстрактных методов, шаблонных методов (GoF) или операций-«зацепок» (hook operations) Код с непредсказуемым поведением обращение к неинициализированным переменным, «трюки» в управлении памятью, неконтролируемое переполнение буферов и т.д. ВОПРОС #5 Языки ООП и качество исходного кода – 1 Какие «внеязыковые» возможности современных сред разработки могут помочь в обеспечении структурного качества исходного кода? 2 Какие возможности языков ОО-программирования вносят свой вклад в обеспечение структурного качества кода? Ответьте полно, насколько это возможно. Время на ответ — 2 минуты. 20 стр. КАКУЮ ПОМОЩЬ МОГУТ ОКАЗАТЬ СОВРЕМЕННЫЕ ЯЗЫКИ ПРОГРАММИРОВАНИЯ? (1 / 2) Исполнение управляемого кода в защищенной программной среде Строгая типизация Запрет автоматического приведения (преобразования) типов Средства динамической идентификации типов времени выполнения (RTTI) Отладочные утверждения (assertions) времени компиляции (исполнения) Автоматическая сборка мусора стр. C++ Java быстро, небезопасно медленно, безопасно «Родные» методы (выполняют код вне защищенной среды, имеют доступ ко всем системным ресурсам) 20 — быстро, небезоп., непереносимо част., особ. в C++11 dynamic_cast, typeid instanceof эмулируется КАКУЮ ПОМОЩЬ МОГУТ ОКАЗАТЬ СОВРЕМЕННЫЕ ЯЗЫКИ ПРОГРАММИРОВАНИЯ? (2 / 2) Обобщенное программирование с поддержкой безопасности типов данных Элементы рефлексии в исходном коде Расширенная поддержка ОО-парадигмы (абстрактные классы, «листовые» классы / методы, «удаленные» методы) Обработка исключительных ситуаций. Стандартные и пользовательские классыисключения Спецификация типов исключений, возбуждаемых методами классов Алгоритмы и структуры данных в составе стандартных библиотек 20 стр. C++ Java шаблоны обобщения характеристики типов особ. в C++11 аннотации на усмотрение разработчика существуют непроверяемые ЭЛЕМЕНТЫ РЕФЛЕКСИИ В ИСХОДНОМ КОДЕ Предотвращают… 1 …некорректное использование библиотек, ошибки при выборе (типов) фактических параметров, непреднамеренные ошибки в сигнатурах методов (архитектуре классов) и пр. Выделяют и принуждают… 2 … к отказу от использования устаревающих элементов архитектуры Сопровождают… 3 … намеренно сохраненные в итоговой сборке кода предупреждения при компиляции Упрощают… 4 … работу с атомарными характеристиками типов и позволяют предельно оптимизировать специализированные версии универсальных функций и методов АЛГОРИТМЫ И КОНТЕЙНЕРЫ В СОСТАВЕ СТАНДАРТНЫХ БИБЛИОТЕК Позволяют… 1 работать с эффективным готовым исходным кодом; ускорить процессы разработки; снизить издержки на сопровождение продукта Предоставляют… 2 строгие гарантии вычислительной сложности операций (напр., поиск элемента списка требует линейного времени) 𝑂 𝑁 широкие возможности повторного использования кода; расширяемые, удобные, взаимозаменяемые программные модули с унифицированными интерфейсами Обеспечивают… 3 вариативность решения задачи с учетом предпочтений разработчика; структурную несовместимость контейнеров и алгоритмов, неэффективных при совместной работе ПРИМЕР #3: СТАНДАРТНЫЕ АЛГОРИТМЫ СОРТИРОВКИ (STD. TEMPLATE LIBRARY, C++) std::sort (вариант quicksort) 1 нестабильная сортировка на месте; среднее время — 𝑶 𝑵 log 𝑵 ; наибольшее время — 𝑶 𝑵𝟐 std::partial_sort (вариант heapsort) 2 нестабильная сортировка на месте; допускает получение отсортированного поддиапазона длины 𝒌 < 𝑵; наибольшее время — 𝑶 𝑵 log 𝑵 или 𝑶 𝑵 log 𝒌 std::stable_sort (вариант mergesort) 3 стабильная сортировка на месте; адаптируется к ограничениям памяти (оптимальный объем памяти — под 𝑵 𝟐 элементов); наибольшее время — от 𝑶 𝑵 log 𝑵 до 𝑶 𝑵 log 𝑵 𝟐 КАКИЕ ОРГАНИЗАЦИОННЫЕ МЕРОПРИЯТИЯ МОГУТ ПОМОЧЬ В ОБЕСПЕЧЕНИИ КАЧЕСТВА? Выбор и внедрение модели качества ПО 1 Выбор модели и атрибутов качества, определение метрик качества и их сравнительной значимости («весов»); принятие модели качества в «обязывающей» форме; утверждение и внедрение регламента регулярной оценки качества Программа повышения квалификации 2 3 (Принятая) модель и атрибуты структурного качества ПО; расширенные возможности языков моделирования (UML), запросов к БД (SQL) и языков программирования; поддержка качественного проектирования и разработки CASE-средствами, языками и инструментами Соглашения о проектировании, моделировании, кодировании Активное применение языков моделирования и CASEтехнологий; автоматическая генерация исходного кода и технической документации по нему Аудит наличной архитектуры и кодовой базы 4 Разработка и реализация плана рефакторинга архитектуры системы и ее исходного программного кода РЕАЛЬНО ЛИ ПОВЫСИТЬ СТРУКТУРНОЕ КАЧЕСТВО УЖЕ НАПИСАННЫХ ПРИЛОЖЕНИЙ? ❶ Провести комплекс организационных мероприятий Да! ❷ Запустить систематический рефакторинг архитектуры и исходного кода ❸ Провести дополнительное тестирование приложения ❹ На регулярной основе пересматривать и ужесточать требования действующей модели качества приложения ❺ Держаться курса, чего бы это ни стоило! СПАСИБО! ВОПРОСЫ? Алексей ПЕТРОВ education@luxoft.com