Zásuvný modul do programu SonarQube umožňující detekci návrhových vzorů ve zdrojovém kódu

Jakub Osmančík

Diplomová práce

SonarQube Plugin for Design Pattern Detection in Source Code

Anotace:

Návrhové vzory jsou všeobecně uznávány jako ověřená řešení běžných problémů při návrhu softwaru. Automatická detekce přítomnosti návrhových vzorů ve zdrojovém kódu však zůstává výzvou. Tato práce představuje komplexní přístup k detekci návrhových vzorů v kódu jazyka Java, pomocí detekce příznaků a integrace do stávajících nástrojů na statickou analýzu kódu. Navrhované řešení zahrnuje dva hlavní kroky. Za prvé, úvodní analýza zkoumá jednotlivé objekty a hledá atributy, metody a vztahy, které jsou charakteristické pro části jednotlivých návrhových vzorů. Tento úvodní průchod přiřadí každé potenciální instanci vzoru skóre pravděpodobnosti. Ve druhém kroku se dále analyzují vztahy mezi třídami, aby se potvrdila přítomnost struktur návrhových vzorů. Tento přístup byl vyhodnocen na různých testovacích případech, od učebnicových implementací návrhových vzorů až po reálné projekty s otevřeným zdrojovým kódem. Výsledky prokazují schopnost identifikovat struktury návrhových vzorů v kódu. Přínosem této práce je řešení pro detekci návrhových vzorů a poznatky o praktických problémech spojených s jejich detekcí. Získané poznatky mohou být podkladem pro vývoj robustnějších nástrojů pro detekci návrhových vzorů, které podpoří činnosti spojené s porozuměním softwaru, refaktoringem a zajištěním kvality.

Abstract:

Design patterns are widely recognized as proven solutions to common problems in software design. However, the automatic detection of design patterns in source code remains a challenge. This work presents a comprehensive approach to detecting design patterns in Java code using a combination of attribute detection and integration into existing static code analysis tools. The proposed solution involves two main steps. Firstly, an initial analysis examines individual objects and searches for attributes, methods, and relationships characteristic of specific design patterns. This initial pass assigns a probability score to each potential pattern instance. In the second step, relationships between classes are further analyzed to confirm the presence of design pattern structures. This approach was evaluated on various test cases, from textbook implementations of design patterns to real-world projects with open-source code. The results demonstrate the ability to identify design pattern structures in code. The benefits of this work include solution for design pattern detection and insights into practical issues associated with their detection. The acquired knowledge can serve as a foundation for developing more robust tools for design pattern detection, supporting activities related to software understanding, refactoring, and quality assurance.

Klíčová slova

Automatizovaná Detekce návrhových vzorů, Statická analýza kódu, Analýza Java kódu, Návrh softwaru, Porozumění softwaru, Zajištění kvality softwaru, Taxonomie návrhových vzorů, Heuristika návrhových vzorů, Strukturální analýza návrhových vzorů, Problémy s implementací návrhových vzorů, Nástroje softwarového inženýrství, Údržba a vývoj softwaru.

Keywords

Automated design pattern detection, Static code analysis, Java code analysis, Software design, Software comprehension, Software quality assurance, Design pattern taxonomy, Design pattern heuristics, Structural analysis of design patterns, Design pattern implementation challenges, Software engineering tools, Software maintenance and evolution

Jazyk práce: čeština

Datum vytvoření / odevzdání či podání práce: 15. 7. 2024

Obhajoba závěrečné práce

• Obhajoba proběhla 6. 8. 2024
• Vedoucí: David Ježek
• Oponent: Svatopluk Štolfa, Svatopluk Štolfa

VŠB – Technická univerzita Ostrava

Fakulta elektrotechniky a informatiky

Magisterský studijní program:
Informatika