Проектная документация

Структура проекта

• moose: родительский проект, в котором задаются зависимости версий и т. д.

• moose-common: общий модуль, где хранятся объекты передачи данных (DTO), исключения, константы и перечисления.

• moose-util: модуль с утилитами, здесь находятся общие инструменты для всего проекта.

  Проект использует инструменты hutool.

• moose-security: модуль безопасности, интегрированный с spring-security.

• moose-message: модуль сообщений, который включает конфигурации Kafka и WebSocket.

• moose-bussiness: бизнес-модуль, в нём есть генератор, который может автоматически создавать entity, mapper, service и controller на основе таблиц базы данных. Поддерживает операции CRUD для одной таблицы.

Общая архитектура: springboot, mybatis-plus, spring-security, spring-session-redis, spring-cache, Kafka, WebSocket — всё интегрировано. Проект поддерживает несколько источников данных.

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

Адрес документации Swagger: [http://localhost:10086/moose/swagger-ui.html].

Документация Hutool: [https://www.hutool.cn/docs/#/].

Документация MyBatis: [https://www.kancloud.cn/digest/andyalien-mybatis/190185].

Документация MyBatis Plus: [http://mp.baomidou.com/guide/].

Документация EasyPoi: [http://easypoi.mydoc.io/].

Конфигурация нескольких источников данных: [https://gitee.com/baomidou/dynamic-datasource-spring-boot-starter].

Описание базы данных

• В файле init.sql есть инструкции по созданию базовых пользовательских прав и тестовых данных.
• Три поля в таблице: is_deleted (логическое удаление, 0 — не удалено, 1 — удалено), create_time (дата и время создания), update_time (время последнего обновления). Эти три поля автоматически заполняются при добавлении новых записей, дополнительная обработка не требуется.

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

Измените файл конфигурации, указав основные параметры подключения к базе данных и адрес Redis. Адрес Kafka можно не указывать, если он не нужен, это не повлияет на работу проекта.

Запустите скрипт init.sql.

Доступ к странице входа: http://localhost:10086/moose/login.

Есть три пользователя: admin/admin, cat/tomcat, moose/moose. У них разные права доступа. Помимо стандартного входа по имени пользователя и паролю, в moose-security реализована аутентификация по SMS (отправка SMS пока не подключена).