DBTree: WEB-версия облегчённого инструмента для просмотра и управления структурой таблиц в базах данных

DBTree — это WEB-инструмент для просмотра структуры таблиц баз данных и управления ими. Он отличается от phpMyAdmin тем, что фокусируется на удобстве просмотра информации о структуре таблиц и ведении комментариев. DBTree использует древовидную структуру для отображения структуры таблиц, позволяя классифицировать таблицы и обновлять комментарии онлайн. Также инструмент может частично заменить функцию генерации кода mybatis generator.

Возможности:

• Одно нажатие для создания и загрузки ресурсов mybatis;
• Классификация таблиц по каталогам;
• Отображение структуры таблиц;
• Возможность отобразить только одну таблицу из нескольких;
• Изменение комментариев к таблицам и полям;
• Поддержка MySQL и SQL Server;
• Экспорт структуры таблиц в формат Markdown;
• Веб-интерфейс для удобства совместного использования.

Скриншоты функций:

• Древовидное отображение структуры таблиц с возможностью редактирования комментариев;
• Выбор каталога, выделение таблиц и генерация ресурсов mybatis.
• Добавление категорий в каталоги и архивирование таблиц.

Демонстрация функций: Демонстрация работы инструмента.

Причины создания этого инструмента: В процессе разработки взаимодействие с базой данных является важным аспектом коммуникации между разработчиками. Автор отмечает, что такие инструменты, как MSS Management Studio и phpMyAdmin, а также аналогичные программы для проектирования баз данных, не всегда удобны для обмена информацией о таблицах и комментариях. Особенно это заметно при работе с большим количеством таблиц. Поэтому был создан этот веб-инструмент, который призван облегчить работу с базами данных.

Также автор выделяет функцию, которая позволяет выбрать таблицу и одним нажатием кнопки создать и загрузить ресурсы mybatis, что упрощает процесс настройки генератора mybatis.

Конфигурация и модификация:

• Конфигурация сервера: dbtree-backend/src/main/resources/dbconfig/db-server.json содержит информацию о конфигурации сервера. В этом файле указаны параметры подключения к базе данных (тип базы данных, хост, порт, имя пользователя и пароль).

• Конфигурация базы данных: Файл dbtree-backend/src/main/resources/dbconfig/db-config.json определяет конфигурацию каждой базы данных. Здесь указываются параметры каждой базы данных, включая её имя, сервер и правила разделения таблиц. Пример показывает, что все таблицы, начинающиеся с «rule_», будут заменены на «rule».

• Папка mybatis.base: Здесь хранятся файлы, созданные генератором mybatis.

• Соединители MySQL и SQLServer: Файлы соединителей MySQL и SQLServer используются для настройки генератора mybatis. Они должны быть доступны на сервере.

Создание структуры таблиц: Примеры создания таблиц MySQL можно найти в каталоге dbtree-backend/doc/schema.

Подключение к базе данных: Необходимо настроить параметры соединения с базой данных в конфигурационных файлах. Рекомендуется использовать шифрование паролей с помощью druid.

Разработка и отладка: Для разработки и отладки проекта требуется JDK 1.8 или выше и среда разработки Node.js. Проект можно запустить, открыв его в браузере по адресу http://localhost:8080. Для лучшей разработки рекомендуется использовать VS Code для работы с проектом dbtree-vue.

Развёртывание: Проект построен на основе Springboot2.x, Vue-Element-Template и mybatis. Инструмент можно развернуть, запустив файл jar после сборки проекта.

Планы на будущее: Автор планирует добавить следующие функции:

• Страница конфигурации сервера и базы данных для динамического добавления баз данных без необходимости переразвёртывания проекта;
• Ссылки на таблицы в списке таблиц для перехода на страницу с подробной информацией о таблице;
• Функцию изменения комментариев к таблицам на странице с подробной информацией;
• Расширение дерева базы данных до двух уровней для решения проблемы поиска только первого уровня данных.

Основные технологии:

• Элементный компонент дерева;
• Генератор mybatis core;
• Springboot 2.x;
• Vue 2.x.

Благодарности: Автор выражает благодарность за использование шаблонов и компонентов Vue-admin-template и Element tree.