【架构师助手】—— 代码全自动生成工具

1. Введение

Данный инструмент предназначен для использования архитекторами программного обеспечения, опытными разработчиками и менеджерами проектов.

Десятилетний опыт разработки и оптимизации позволил создать инструмент, который повышает эффективность разработки, улучшает качество кода и освобождает разработчиков от рутинных задач.

Это инструмент для автоматического создания кода на основе Springboot для бизнес-систем (фронтенд/бэкенд). Вы можете адаптировать его под любую структуру и язык программирования.

Инструмент представляет собой автоматизированную фабрику по созданию и обработке информационных систем, которая позволяет вам ввести данные бизнес-модели (data.xml) и получить готовую к использованию систему на базе Springboot в течение нескольких секунд.

2. Архитектура программного обеспечения

Архитектура инструмента генерации кода основана на Ant и шаблонах Freemarker.

Созданная система приложений (maven web проект) использует Springboot, Mybatis, Shiro/Security, Thymeleaf и MySQL/Oracle/H2.

Принцип работы:

• Инструмент обрабатывает файл data.xml с данными модели и автоматически генерирует необходимый код.
• От вас требуется только отредактировать файл data.xml в соответствии с вашими бизнес-требованиями.

Выбор data.xml для описания модели данных обусловлен возможностью детализации различных аспектов модели, таких как отношения «многие ко многим» и допустимость пустых значений, которые могут быть потеряны при использовании базы данных в качестве входных данных.

3. Основные функции

Система, созданная с помощью 【架构师助手】, реализует следующие основные функции:

• Вход в систему и регистрация: имя пользователя, пароль, проверка подлинности.
• Единая аутентификация пользователей: возможность независимой или единой аутентификации пользователей, а также единого входа.
• Управление правами и контроль доступа: реализация авторизации на основе ролей и прав пользователей для различных бизнес-объектов, обеспечивая полноценное управление правами и доступом в системе.
• Связывание бизнес-объектов: автоматическое определение связей между бизнес-объектами и их реализация, включая просмотр, добавление, изменение, удаление и запрос данных.
• Экспорт данных: возможность экспорта данных в таблицы Excel.
• Автоматическое ведение журнала: запись операций над данными (добавление, изменение, удаление) в журнале данных.
• Загрузка и скачивание файлов.
• Мониторинг производительности базы данных.

4. Особенности

• Быстрый результат: ввод данных бизнес-модели через data.xml позволяет получить готовую систему с базовыми функциями всего за несколько секунд.
• Поддержка баз данных: поддержка MySQL, Oracle и H2.
• Адаптация элементов управления: выбор подходящих элементов управления в зависимости от типа данных (дата, время, словарь, внешний ключ и т. д.).
• Полное покрытие тестовых данных: количество генерируемых тестовых данных можно настроить, и инструмент автоматически создаёт необходимые тестовые данные в соответствии с типом данных.
• Универсальность шаблонов: основа инструмента — универсальные шаблоны, позволяющие создавать системы на разных языках, с бэкендом на Java или Python и фронтендом HTML и JavaScript.
• Дизайн и методология: autosoftline предлагает не просто инструмент, но и метод проектирования.
• Алгоритм обработки отношений: специальный алгоритм автоматически распознаёт и обрабатывает сложные связи между бизнес-объектами.
• Качество кода: сгенерированный код основан на зрелых и стабильных фреймворках, обеспечивая чёткую модульную и многоуровневую структуру.

5. Среда выполнения инструмента

Для работы инструмента требуется следующее окружение:

• JDK 1.8.
• Ant 1.6.
• Maven 3.3.

Основанный на шаблонах Freemarker, инструмент использует Ant и Maven. Сначала Ant преобразует шаблоны в проект структуры Maven Web, после чего Maven управляет этим проектом. Поэтому необходимо установить и настроить среды выполнения Ant и Maven.

Установка и настройка JDK 1.8 и Maven 3.3: если вы не знаете, как это сделать, возможно, вам стоит улучшить свои навыки, прежде чем использовать этот инструмент.

Настройка среды выполнения Ant: достаточно скачать и распаковать пакет Ant в определённую папку, без необходимости установки. Затем добавьте каталог bin Ant в переменную среды path, чтобы иметь возможность выполнять команду ant из любого каталога в командной строке DOS. Например, если вы скачали и распаковали Ant в C:\ant162, добавьте C:\ant162\bin в path. Чтобы проверить успешность настройки, введите ant –version в любом каталоге командной строки DOS. Если отображается версия Ant, настройка прошла успешно.

Проблемы с нехваткой памяти при выполнении Ant можно решить, добавив переменные среды ANT_OPTS: ANT_OPTS -Xms1024m -Xmx1024m -XX:PermSize=1024M -XX:MaxNewSize=256m -XX:MaxPermSize=1024m

6. Как использовать инструмент

• Определите свою модель данных: создайте собственную модель данных, используя data.xml, вместо того чтобы основываться на таблицах базы данных. Data.xml предоставляет преимущества в описании деталей отношений между объектами и таблицами, которые теряются при использовании таблиц базы данных. С помощью data.xml можно генерировать SQL-скрипты для разных баз данных, объекты модели/сущности, Dao/Mapper, Controller, Service, HTML-страницы для фронтенда и другие элементы.

• Запустите инструмент: запустите run.bat из командной строки CMD, чтобы сгенерировать весь необходимый код и автоматически скомпилировать и запустить веб-приложение на базе Springboot.

• Доступ к приложению: перейдите по адресу http://localhost:8080.