Youran: платформа автоматизации кода

Введение

Это автоматизированная веб-платформа, которая включает функции проектирования системы и генерации кода. Её использование может значительно повысить эффективность разработки программистов.

Платформа предлагает следующие функции:

1. Генерация кода на основе git с возможностью инкрементального обновления. Поддерживается прямое сохранение кода в удалённый репозиторий git, а также возможность повторного создания после изменения метаданных.
2. Пользовательские шаблоны: если предустановленные шаблоны не соответствуют требованиям, можно разработать собственные шаблоны на основе технических фреймворков команды.
3. Пользовательские диаграммы: можно настраивать существующие таблицы и агрегированные таблицы, а также использовать Echarts для создания диаграмм. Несколько диаграмм могут быть объединены в одну панель.
4. Обратное проектирование: если приложение уже имеет структуру таблиц, функция обратного проектирования позволяет импортировать операторы создания таблиц в проект, автоматически создавая сущности и поля.
5. Много-ко-многим отношения: поддерживается создание связей между двумя сущностями, что приводит к созданию соединительной таблицы в MySQL. Можно настроить, будет ли каждая сущность содержать ссылку на другую. Если одна из сущностей содержит ссылку, она автоматически получает функцию поддержания связи.
6. Внешние ключи: при добавлении поля можно указать, является ли оно внешним ключом, который должен быть связан с первичным ключом другой сущности, обеспечивая возможность создания отношений «один-к-одному» или «один-ко-многим».
7. Каскадное расширение: внешние ключи и много-ко-многим сущности могут иметь каскадные поля, которые могут использоваться как условия поиска связанных сущностей или как результаты поиска.
8. Диаграмма ER сущностей: на странице списка сущностей можно выбрать несколько связанных сущностей и нажать кнопку «Просмотр ER диаграммы», чтобы создать диаграмму отношений сущностей.
9. Предварительный просмотр кода: код можно просматривать онлайн без необходимости загрузки, включая предварительный просмотр изменений после обновления метаданных.
10. Возможность генерации функций импорта и экспорта в Excel (на основе easyexcel), с опцией использования плагина lombok.
11. Функция совместного использования проектов (опциональная): требуется интеграция с единой системой аутентификации компании для совместного доступа к проектам среди членов группы. По умолчанию эта функция отключена.

Страница скриншотов

• Управление проектами
  • Изображение: страница управления проектами.
• Инкрементальный предварительный просмотр
  • Изображение: предварительный просмотр инкрементных изменений.
• Управление полями
  • Изображение: управление полями сущностей.
• Диаграмма ER
  • Изображение: диаграмма отношений сущностей (ER).
• Предварительный просмотр кода
  • Изображение: предварительный просмотр сгенерированного кода.
• Список шаблонов
  • Изображение: список доступных шаблонов.
• Пользовательские диаграммы
  • Изображение: пользовательские диаграммы.

Шаги установки

Шаг 1: среда и конфигурация

1. Установите необходимые зависимости: MySQL и JDK 8.
2. Скачайте zip-файл установки и распакуйте его.
3. Подготовьте базу данных MySQL, используя предварительно созданный скрипт инициализации (/schema/init.sql).
4. Настройте параметры базы данных в файле конфигурации (/conf/application-local.yml).

Шаг 2: запуск

Запустите систему с помощью скрипта запуска (/bin/startup.cmd). Система доступна по адресу:

• http://localhost:8088

При первом доступе к системе необходимо импортировать предустановленные шаблоны кода:

• Java-шаблоны: доступны по ссылкам:
  • Исходный код: https://github.com/cai3178940/youran-template-01.
  • Zip-архив: https://github.com/cai3178940/youran-template-01/releases.
• Vue-шаблоны: доступны по ссылкам:
  • Исходный код: https://github.com/cai3178940/youran-template-02.
  • Zip-архив: https://github.com/cai3178940/youran-template-02/releases.

Использование

Рекомендуется использовать следующую процедуру:

1. Создайте пустой репозиторий на GitLab или GitHub.
2. В платформе Youran создайте проект и укажите адрес репозитория.
3. Создайте сущности (обязательно).
4. Создайте поля для сущностей (обязательно).
5. При необходимости добавьте другие метаданные.
6. Выполните команду «Отправить Git».

Альтернативный подход (не рекомендуется):

1. Заранее спроектируйте структуру таблиц.
2. В Youran создайте проект и используйте оператор создания таблицы для выполнения обратного проектирования.
3. Настройте свойства полей, так как обратное проектирование может предоставить ограниченное количество информации о свойствах.
4. Сгенерируйте код.

Пример начала работы

Пример проекта доступен по ссылке:

https://github.com/cai3178940/youran/releases/tag/example. Для предварительного просмотра сгенерированного кода выполните следующие шаги:

1. Управление проектами -> Импорт метаданных.
2. Управление проектами -> Действия -> Редактировать -> Выберите шаблон кода.
3. Управление проектами -> Используйте шаблон -> Предварительный просмотр кода.

Термины

1. Проект: независимый набор приложений, позволяющий создавать комплексные JavaWeb-системы.
2. Сущность: соответствует таблице бизнес-данных в базе данных и функциям CRUD, связанным с ней. Сущности могут иметь отношения «один ко многим» и «многие ко многим».
3. Поле: атрибут сущности, соответствующий полю таблицы базы данных и полю класса Java. Поля имеют множество настраиваемых свойств.
4. Перечисление: рекомендуется создавать перечисления для константных данных, которые редко изменяются. Это приведёт к генерации соответствующего enum-класса в коде Java.
5. Индекс: индекс в таблицах бизнес-данных MySQL.
6. Отношения «многие ко многим»: связь между двумя сущностями, приводящая к созданию соединительной таблицы.

Журнал изменений

Изменения доступны в файле ChangeLog (/doc/ChangeLog.md).

Демонстрация результатов

Изображение: демонстрация сгенерированных результатов.

Для доступа к исходному коду посетите GitHub по адресу: https://github.com/cai3178940/youran.