АННОТАЦИЯ 3
Перечень условных обозначений и терминов 4
Введение 5
1 Анализ существующего процесса 6
1.1 Модель предметной области 6
1.2 Процесс работы с документацией AS IS 7
1.3 Анализ недостатков процесса AS IS 8
2 Анализ существующих решений 9
3 Формализация ожиданий от системы 11
3.1 Процесс работы с документацией TO BE 11
3.2 Необходимость консольного приложения 11
3.3 Ролевая модель 12
3.3.1 Функциональность для пользователя 12
3.3.2 Функциональность для администратора 13
3.4 Формат ER-диаграмм 14
4 Проектирование системы 16
4.1 Выбор инструмента для создания диаграмм 16
4.2 Модель первичного проектирования 16
4.3 Детализированная функциональность для пользователя 19
4.4 Верхнеуровневый процесс генерации диаграмм 20
4.5 Компоненты системы 20
5 Обзор используемых технологий 22
5.1 Java 21 22
5.2 Spring Framework и Spring Boot 22
5.3 Spring Web MVC 22
5.4 Thymeleaf 22
5.5 Spring Data JPA и Hibernate 23
5.6 Flyway 23
5.7 PostgreSQL 23
5.8 MinIO 23
5.9 Gradle 23
5.10 Генератор диаграмм на основе PlantUML-кода 23
6 Реализация системы 24
6.1 Способ получения схемы 24
6.2 Реализованные компоненты системы 24
6.3 Структура пакетов компонента core 25
6.4 Работа с ошибками в компоненте core 26
6.5 Авторизация пользователей 28
6.6 Авторизация интеграционных запросов 30
6.7 Шифрование паролей серверных баз данных 32
6.8 Структура схемы 34
6.9 Процесс получения схемы 35
6.10 Стилизация диаграмм 37
6.11 Создание версии через веб-приложение 40
6.12 Создание версии через консольное приложение 45
6.13 Создание и обновление ветки 46
Заключение 51
Список использованных источников и литературы 52
Приложение A. Реализованный веб-интерфейс 53
В современном мире базы данных являются неотъемлемой частью большинства информационных систем.
Документация схем баз данных может быть полезна при разработке новой функциональности, сопровождении проектов, а также при изучении предметной области.
Одним из наиболее распространенных способов визуализации структур баз данных являются ER-диаграммы, позволяющие наглядно представить основные элементы схемы и их взаимосвязи.
Однако процесс их актуализации, как и любой документации в условиях активной разработки, зачастую связан с рутинными задачами, подверженными риску человеческих ошибок.
В связи с этим существует необходимость в автоматизации процессов документирования схем существующих баз данных, что позволит сократить время на рутинные операции, снизить количество ошибок, а также обеспечить актуальную документацию.
Целью данной выпускной квалификационной работы является разработка системы для автоматизации документирования схем существующих баз данных.
Исходя из поставленной цели были сформулированы задачи:
1) анализ существующих решений;
2) формализация ожиданий от системы;
3) проектирование системы;
4) разработка системы.
В рамках выполнения выпускной квалификационной работы была разработана система для автоматизации документирования существующих схем баз данных. Для достижения этой цели были выполнены все поставленные задачи:
• проанализировать существующие решения;
• формализовать ожидания от системы;
• спроектировать систему;
• разработать систему.
В настоящий момент ведется подготовка технической документации, чтобы опубликовать в открытый доступ исходный код системы с использованием открытой лицензии.
В разделе «ПРИЛОЖЕНИЕ А» приведена часть скриншотов веб-интерфейса разработанной системы.
