Программная археология
Программная археология — дисциплина, изучающая слабо документированное или недокументированное унаследованное программное обеспечение, в целях его сопровождения[1][2]. Программная археология включает в себя обратную разработку приложений, использование специальных инструментальных средств и технологических процессов для извлечения и понимания структуры кода, восстановления замысла его разработчиков[1][3]. Программная археология помогает обнаружить проблемы, связанные с неудачной архитектурой приложения и отмершим (неиспользуемым) кодом[4]. Термин используется уже несколько десятилетий[5] и отражает следующую метафору: разработчик, читающий код унаследованного программного обеспечения, ощущает себя так же, как и археолог, исследующий памятники древней цивилизации[6].
Инструменты и методы
В 2001 году на конференции OOPSLA секция программной археологии определила следующие инструменты и методы программной археологии, некоторые из которых относятся к объектно-ориентированному программированию[6]:
- Скриптовые языки для создания статических отчетов и фильтрации отладочного вывода
- Изучение существующей сопровождающей документации в формате HTML, PDF, CHM, MSHC или Wiki
- Создание сопровождающей документации на API (Javadoc, doxygen), добавление документирующих комментариев в кодовую базу приложения
- Сигнатурный анализ , статистический анализ, инструменты для визуализации ПО
- Инструменты обратной разработки
- Отслеживание системных вызовов (truss, strace)
- Инструменты для поиска ключевых слов в файлах
- Использование интегрированной среды разработки (IDE) для просмотра, поиска и редактирования файлов кода приложения
- Платформы для модульного тестирования (JUnit, CppUnit)
- Отладчики и профилировщики
В целях систематической трассировки вызовов функций без широкомасштабного редактирования кодовой базы исследуемого приложения можно успешно применять аспектно-ориентированное программирование (например, AspectJ[6] для Java, MrAdvice для C# .NET), разработав аспектные классы для получения средствами рефлексии информации о состоянии стека вызовов, отфильтровывания из него нужной информации и записи ее в журнальный файл или окно протокола работы (т.н. лога) приложения.
При сопровождении экспертной системы важным источником информации о логике ее работы являются сообщения подсистемы объяснений[7].
Энди Хант и Дейв Томас указывают на важность использования системы контроля версий, контейнера управления зависимостями, инструментов индексирования текста (GLIMPSE, SWISH-E) и «[составления] карты исследования»[6].
Подобно настоящей археологии, программная археология предполагает исследовательскую работу для понимания мыслительных процессов предшественников[6]. На секции OOPSLA Уорд Каннингем предложил так называемый «синоптический сигнатурный анализ», который дает в первом приближении понимание «духа» программы путём показа разработчику только лишь пунктуации кода (двоеточия, операторные скобки)[8]. Также Каннингем предложил рассматривать программы, напечатанные минимально возможным шрифтом, для понимания общей структуры программы[9].
Методы сетевого и временно́го анализа, расширение Git Archaeology для Microsoft Visual Studio могут помочь обнаружить шаблоны совместной деятельности разработчиков унаследованного ПО, которые, в свою очередь, могут пролить свет на силы и слабости получившегося в итоге кода[10].
Майкл Розлог из Embarcadero Technologies описал программную археологию как процесс из шести шагов, который позволяет разработчикам ответить на такие вопросы: «Что досталось мне в наследство?» и «В каких местах этот код ужасен?»[11] Эти шаги, как и обнаруженные секцией OOPSLA, включая визуализацию кода для понимания архитектуры приложения, используют метрики программного обеспечения для поиска нарушений принципов проектирования и стиля программирования, модульное тестирование и профилирование для поиска дефектов ПО (т.н. багов) и узких мест в производительности, а также сбор информации о структуре приложения, восстановленной в процессе программно-археологических раскопок[11]. Программная археология может также быть услугой, предоставляемой штатным разрабочикам внешними консультантами[12].
Митч Розенберг (InfoVentions.net) утверждает, что «первый закон программной археологии» звучит так:
Оно здесь находится не просто так, и причина может быть одна из трёх:
- Оно должно было быть здесь, но уже не должно.
- Ему не нужно было быть здесь, а программист, написавший это, не ведал, что творил.
- Оно всё еще должно быть здесь, и это Вы не ведаете, что творите.
Следствие этого «закона»: пока причина неизвестна, не следует изменять код (или данные)[13]
.
См. также
Примечания
- ↑ 1,0 1,1 Gregorio Robles, Jesus M. Gonzalez-Barahona, and Israel Herraiz, «An Empirical Approach to Software Archaeology Архивная копия от 20 января 2020 на Wayback Machine, „ Poster Proceedings of the International Conference on Software Maintenance, 2005.
- ↑ “Agile Legacy System Analysis and Integration Modeling Архивная копия от 23 марта 2021 на Wayback Machine» by Scott W. Ambler at agilemodeling.com, accessed 20 August 2010: "Without accurate documentation, or access to knowledgeable people, your last resort may be to analyze the source code for the legacy system.
- ↑ Richard Hopkins and Kevin Jenkins, Eating the IT Elephant: Moving from greenfield development to brownfield Архивная копия от 23 марта 2015 на Wayback Machine, Addison-Wesley, 2008, ISBN 0-13-713012-0, p. 93.
- ↑ Diomidis Spinellis and Georgios Gousios, Beautiful Architecture Архивная копия от 22 марта 2015 на Wayback Machine, O’Reilly, 2009, ISBN 0-596-51798-X, p. 29.
- ↑ An early discussion is Judith E. Grass, "Object-Oriented Design Archaeology with CIA++, " Computing Systems, Vol. 5, No. 1, Winter 1992.
- ↑ 6,0 6,1 6,2 6,3 6,4 Andy Hunt and Dave Thomas, «Software Archaeology Архивная копия от 9 ноября 2020 на Wayback Machine», IEEE Software, vol. 19, no. 2, pp. 20-22, Mar.
- ↑ Гаврилова Т. А., Хорошевский В. Ф. Базы знаний интеллектуальных систем. — СПб.: Питер, 2000..
- ↑ Ward Cunningham, «Signature Survey: A Method for Browsing Unfamiliar Code Архивная копия от 22 августа 2010 на Wayback Machine, „ Workshop Position Statement, Software Archeology: Understanding Large Systems, OOPSLA 2001.
- ↑ “Software Archeology Архивная копия от 6 марта 2012 на Wayback Machine» on John D. Cook’s blog The Endeavour, November 10, 2009.
- ↑ Cleidson de Souza, Jon Froehlich, and Paul Dourish, "Seeking the Source: Software Source Code as a Social and Technical Artifact Архивная копия от 23 сентября 2015 на Wayback Machine, " Proceedings of the 2005 International ACM SIGGROUP Conference on Supporting Group Work, pp. 197—206.
- ↑ 11,0 11,1 Michael Rozlog, "Software Archeology: What Is It and Why Should Java Developers Care? Архивная копия от 13 июля 2015 на Wayback Machine, " article on java.sys-con.com, January 28, 2008.
- ↑ Simon Sharwood, Raiders of the Lost Code Архивная копия от 14 марта 2012 на Wayback Machine, ZDNet, November 3, 2004.
- ↑ For example, the 32nd ACM/IEEE International Conference on Software Engineering in Cape Town, South Africa in May 2010