boba/discord-bot

Fork 0

loki5512344 64a8928d41 Refactor: remove TTS system, slash commands folder, reorganize stats leaderboard

2026-05-11 14:12:30 +02:00

27 KiB

Raw Blame History

TODO - План реализации функций

Правила разработки

Архитектура и код:

KISS, DRY, SOLID принципы
Файлы максимум 150-200 строк, стараться делать 100 строк
В одной папке не больше 6 файлов
Не создавать новые MD файлы без необходимости
Разделение по доменам, а не по типам артефактов

Принципы структуры:

Пакет = домен/фича, а не тип файла (не "команды/листенеры", а "profile/level/voice")
Каждая фича содержит свои команды, сервисы, репозитории
Единый слой персистентности через repository/
Интеграции в отдельном пакете integration/

Рефакторинг структуры проекта

Целевая оценка: 7/10

Проблемы:

util/ - мусорная корзина (CooldownManager, RateLimiter, NekosLifeApi)
Два механизма персистентности (data/ и database/) без абстракции
command/impl/entertainment/ - 23 файла в одном пакете
exception/ - избыточный пакет для 2 файлов
embed/ - presentation layer оторван от domain
listener/ - смешаны разные ответственности
Техническое разделение вместо доменного
LevelSystem - God Class (5/10):
- Нарушение SRP: хранение + кэширование + формулы + лидерборды + прогресс-бары
- Прямая зависимость от JsonDataStore (нет интерфейса Repository)
- O(n) на каждое сообщение (читает/пишет весь JSON)
- Кэш messageTimestamps не персистентный (теряется при рестарте)
- Рассогласование формул: комментарий говорит 200, код использует 100
- LevelUpResult и LevelProgress - вложенные классы вместо отдельных
- getAllStats() возвращает mutable map (можно сломать консистентность)
UserStats - анемичная модель (6/10):
- Сеттеры позволяют нарушить инварианты (setLevel(999) без XP)
- incrementMessages() скрыто меняет lastMessageTime (side effect)
- Поля lastMessageTime и lastVoiceJoin не используются системой
- Нет equals/hashCode для использования в коллекциях

Целевая структура (по доменам):

src/main/java/creator/loki/
├── App.java                    # Точка входа (временно, потом в bootstrap/)
│
├── core/                       # Ядро системы
│   ├── BotInitializer
│   ├── EventDispatcher
│   ├── registry/               # Регистрация команд
│   │   ├── CommandRegistry
│   │   ├── SlashCommandRegistry
│   │   ├── PrefixCommandRegistrar
│   │   └── SlashCommandRegistrar
│   ├── security/               # Безопасность и ограничения
│   │   ├── RateLimiter         # (из util/)
│   │   └── CooldownManager     # (из util/)
│   └── exception/              # Глобальная обработка ошибок
│       └── CommandExceptionHandler
│
├── command/                    # Базовые интерфейсы команд
│   ├── Command.java
│   ├── CommandContext.java
│   ├── CommandException.java   # (из exception/)
│   ├── SlashCommand.java
│   ├── moderation/             # Модерация (3 файла)
│   │   ├── BanCommand
│   │   ├── KickCommand
│   │   └── ClearCommand
│   ├── entertainment/          # Развлечения
│   │   ├── games/              # Игры (12 файлов)
│   │   └── social/             # Взаимодействия (11 файлов)
│   ├── utility/                # Утилиты (5 файлов)
│   │   ├── HelpCommand
│   │   ├── PingCommand
│   │   ├── InfoCommand
│   │   ├── AvatarCommand
│   │   └── PollCommand
│   └── system/                 # Системные команды
│       └── MetricsCommand      # (из utility/)
│
├── feature/                    # Крупные фичи/домены
│   ├── level/                  # Система уровней
│   │   ├── LevelSystem
│   │   ├── UserStats
│   │   ├── LevelUtils          # (из profile/)
│   │   ├── RankCommand         # (из command/stats/)
│   │   ├── StatsCommand        # (из command/stats/)
│   │   ├── LevelUpNotifier     # (из listener/)
│   │   └── VoiceTracker        # (из listener/)
│   │
│   ├── profile/                # Профили пользователей
│   │   ├── ProfileService
│   │   ├── ProfileGenerator
│   │   ├── ProfileData
│   │   ├── ProfileCommand      # (из command/utility/)
│   │   └── ProfileEmbedFactory # (из embed/)
│   │
│   ├── reputation/             # Система репутации
│   │   ├── ReputationService   # (логика из RepCommand)
│   │   ├── RepCommand          # (из command/stats/)
│   │   ├── MinusRepCommand     # (из command/stats/)
│   │   └── RepTopCommand       # (из command/stats/)
│   │
│   ├── leaderboard/            # Таблица лидеров
│   │   ├── LeaderboardCommand  # (NewLeaderboardCommand)
│   │   ├── LeaderboardService  # (логика из команды)
│   │   ├── LeaderboardFormatter
│   │   ├── LeaderboardButtons
│   │   └── LeaderboardButtonListener
│   │
│   ├── voice/                  # Личные голосовые каналы
│   │   ├── VoiceChannelManager
│   │   ├── VoiceChannelData
│   │   ├── VoicePreset
│   │   ├── VoiceSetupCommand   # (из command/setup/)
│   │   ├── VoiceChannelListener # (из listener/)
│   │   └── VoiceButtonHandler  # (из listener/)
│   │
│   ├── counter/                # Счетчик участников
│   │   ├── CounterManager
│   │   ├── DailyStats
│   │   ├── CounterSetupCommand # (из command/setup/)
│   │   └── MemberCounterListener # (из listener/)
│   │
│   └── role/                   # Кастомные роли
│       ├── CustomRoleManager
│       ├── CreateRoleCommand   # (из command/roles/)
│       ├── DeleteRoleCommand   # (из command/roles/)
│       ├── EditRoleCommand     # (из command/roles/)
│       ├── MyRolesCommand      # (из command/roles/)
│       └── RoleCommandValidator # (из command/roles/)
│
├── event/                      # Обработчики событий Discord
│   ├── ReadyListener           # (из listener/)
│   ├── MessageListener         # (из listener/)
│   ├── SlashCommandListener    # (из listener/)
│   ├── HelpMenuHandler         # (из listener/)
│   └── ModerationLogger        # (из listener/)
│
├── repository/                 # Единый слой данных
│   ├── UserRepository          # Интерфейс
│   ├── GuildConfigRepository   # Интерфейс
│   └── impl/
│       ├── JsonUserRepository  # (из data/)
│       └── SqliteConfigRepository # (из database/)
│
├── database/                   # Инфраструктура БД
│   ├── Database
│   ├── DatabaseSchema
│   └── DatabaseMigration
│
├── integration/                # Внешние API
│   └── nekos/
│       └── NekosLifeApi        # (из util/)
│
├── config/                     # Конфигурация
│   ├── BotConfig
│   └── ConfigLoader
│
├── embed/                      # Общие шаблоны embed
│   ├── EmbedFactory
│   └── EmbedTemplates
│
├── metrics/                    # Метрики
│   └── MetricsCollector
│
└── di/                         # Dependency Injection
    └── BotModule

План действий (приоритеты):

Высокий приоритет (делаем сейчас):

1. Удалить ненужное

Удалить command/slash/ (дубликаты)
Удалить audio/ (TTS не работает)
Удалить TtsCommand.java
Удалить SwapCommand.java
Удалить все импорты AudioManager

2. Реорганизовать util/ (мусорная корзина)

Создать core/security/
Переместить CooldownManager → core/security/
Переместить GlobalRateLimiter → core/security/
Создать integration/nekos/
Переместить NekosLifeApi → integration/nekos/
Удалить пустую папку util/

3. Создать feature/level/ (система уровней)

Создать feature/level/
Создать feature/level/domain/ для доменных объектов
Создать feature/level/service/ для сервисов
Создать feature/level/repository/ для интерфейсов
Рефакторинг LevelSystem (God Class 5/10):
- Вынести LevelUpResult в feature/level/domain/LevelUpResult.java
- Вынести LevelProgress в feature/level/domain/LevelProgress.java
- Создать feature/level/domain/XpFormula.java (инкапсуляция математики)
- Создать feature/level/repository/UserStatsRepository.java (интерфейс)
- Создать feature/level/repository/JsonUserStatsRepository.java (реализация)
- Создать feature/level/service/LeaderboardService.java (топы и агрегации)
- Исправить формулу: 100 vs 200 (рассогласование в коде)
- Убрать messageTimestamps ConcurrentHashMap, использовать UserStats.lastMessageTime
- Рефакторить LevelSystem → feature/level/service/LevelService.java
Рефакторинг UserStats (анемичная модель 6/10):
- Сделать immutable (убрать сеттеры)
- Добавить методы addXP(), recordMessage(), addVoiceTime()
- Добавить getLevel(XpFormula) вместо внешних вычислений
- Добавить equals() и hashCode()
- Переименовать incrementMessages() → recordMessage(long timestamp)
Переместить level/LevelSystem → feature/level/service/LevelService.java
Переместить level/UserStats → feature/level/domain/UserStats.java
Переместить profile/LevelUtils → feature/level/ (если нужен)
Переместить command/impl/stats/RankCommand → feature/level/
Переместить command/impl/stats/StatsCommand → feature/level/
Переместить listener/LevelUpNotifier → feature/level/
Переместить listener/VoiceTracker → feature/level/
Удалить пустую папку level/

4. Создать feature/voice/ (голосовые каналы)

Создать feature/voice/
Переместить voice/* → feature/voice/
Переместить command/impl/setup/VoiceSetupCommand → feature/voice/
Переместить listener/VoiceChannelListener → feature/voice/
Переместить listener/VoiceButtonHandler → feature/voice/
Удалить пустую папку voice/

5. Создать feature/counter/ (счетчик)

Создать feature/counter/
Переместить counter/* → feature/counter/
Переместить command/impl/setup/CounterSetupCommand → feature/counter/
Переместить listener/MemberCounterListener → feature/counter/
Удалить пустую папку counter/

6. Создать feature/role/ (кастомные роли)

Создать feature/role/
Переместить role/CustomRoleManager → feature/role/
Переместить command/impl/roles/* → feature/role/
Удалить пустые папки role/ и command/impl/roles/

Средний приоритет (потом):

7. Создать feature/reputation/

Создать feature/reputation/
Создать ReputationService (вынести логику из команд)
Переместить command/impl/stats/RepCommand → feature/reputation/
Переместить command/impl/stats/MinusRepCommand → feature/reputation/
Переместить command/impl/stats/RepTopCommand → feature/reputation/

8. Создать feature/leaderboard/

Создать feature/leaderboard/
Переместить command/impl/stats/leaderboard/* → feature/leaderboard/
Создать LeaderboardService
Удалить пустую папку command/impl/stats/

9. Реорганизовать profile/

Создать feature/profile/
Переместить profile/* → feature/profile/
Переместить command/impl/utility/ProfileCommand → feature/profile/
Создать ProfileEmbedFactory (вынести из команды)
Удалить пустую папку profile/

10. Реорганизовать event/ (listener)

Создать event/
Переместить listener/ReadyListener → event/
Переместить listener/MessageListener → event/
Переместить listener/SlashCommandListener → event/
Переместить listener/HelpMenuHandler → event/
Переместить listener/ModerationLogger → event/
Удалить пустую папку listener/

11. Реорганизовать core/

Создать core/registry/
Переместить core/CommandRegistry → core/registry/
Переместить core/SlashCommandRegistry → core/registry/
Переместить core/PrefixCommandRegistrar → core/registry/
Переместить core/SlashCommandRegistrar → core/registry/
Создать core/exception/
Переместить exception/CommandExceptionHandler → core/exception/
Переместить exception/CommandException → command/
Удалить пустую папку exception/

12. Реорганизовать command/

Переименовать command/impl/entertainment/interaction/ → command/entertainment/social/
Переместить command/impl/utility/MetricsCommand → command/system/
Переместить command/impl/setup/LogSetupCommand → event/ (или удалить setup/)

Низкий приоритет (опционально):

13. Создать repository/ (единый слой данных)

Создать repository/
Создать интерфейсы UserRepository, GuildConfigRepository
Создать repository/impl/
Рефакторить data/JsonDataStore → repository/impl/
Рефакторить database/ConfigRepository → repository/impl/

14. Обновить документацию

Обновить FEATURES.md (убрать TTS)
Обновить README.md (новая структура)
Добавить ARCHITECTURE.md (описание доменов)

Основные задачи

1. ⚡ Переделать систему опыта (XP System Rework)

Текущая проблема:

Формула: XP = 100 * level^1.5 (слишком сложная)
XP за сообщение: 10 XP
XP за минуту в войсе: 5 XP
Cooldown на сообщения: 60 секунд

Новая система (из FEATURES.md):

✅ Формула прогрессии: XP для следующего уровня = 200 * текущий_уровень
- Пример: уровень 1 → 2 требует 200 XP
- Уровень 5 → 6 требует 1000 XP
- Уровень 10 → 11 требует 2000 XP
✅ Голосовая активность:
- 1 XP каждую минуту нахождения в голосовом канале
- Автоматическое отслеживание через VoiceXpListener
- Уведомление при повышении уровня в войс-канале

Файлы для изменения:

src/main/java/creator/loki/level/LevelSystem.java - изменить формулу
src/main/java/creator/loki/listener/VoiceTracker.java - изменить начисление XP
Добавить уведомления о level up в войсе

Статус: ✅ ГОТОВО

2. 🎤 Система личных голосовых каналов (Voice Management System)

Концепция: Пользователь заходит в специальный канал-триггер → бот автоматически создает личный войс-канал → перемещает пользователя туда → пишет сообщение в чат войса с настройками

Функционал:

2.1 Автоматическое создание каналов

✅ Создать VoiceChannelManager класс
✅ Listener на вход в канал-триггер (например, "➕ Создать канал")
✅ Автоматическое создание канала с именем пользователя
✅ Перемещение пользователя в созданный канал
✅ Выдача прав управления владельцу канала
✅ Автоматическое удаление канала когда он пустой

2.2 Сообщение с настройками в чате войса

При создании канала бот отправляет embed с кнопками:

🔒 Закрыть/Открыть - переключение приватности
👥 Лимит - установить лимит пользователей (0-99)
✏️ Переименовать - изменить название канала
🎨 Битрейт - изменить качество звука
🚫 Удалить - удалить канал

2.3 Система пресетов

✅ Сохранение настроек как пресет
✅ Быстрое применение сохраненных настроек
✅ Хранение в data/voice_presets.json

Структура данных:

{
  "voice_channels": {
    "channel_id": {
      "owner_id": "user_id",
      "created_at": 1234567890,
      "settings": {
        "name": "Канал пользователя",
        "limit": 5,
        "bitrate": 64000,
        "locked": false
      }
    }
  },
  "presets": {
    "user_id": [
      {
        "name": "Gaming",
        "limit": 4,
        "bitrate": 96000
      }
    ]
  }
}

Файлы для создания:

src/main/java/creator/loki/voice/VoiceChannelManager.java
src/main/java/creator/loki/voice/VoiceChannelData.java
src/main/java/creator/loki/voice/VoicePreset.java
src/main/java/creator/loki/listener/VoiceChannelListener.java
src/main/java/creator/loki/command/impl/voice/VoiceSettingsCommand.java (для кнопок)

Статус: ✅ ГОТОВО (базовая реализация, кнопки управления требуют обработчиков)

3. 📊 Счетчик участников (Member Counter)

Функционал:

✅ Обновление названия голосового канала с количеством участников
✅ Формат: 【👥】Участники: 123
✅ Отслеживание дневной статистики:
- Количество присоединившихся за день
- Количество покинувших за день
- Разница за 24 часа
✅ Обновление каждые 5 минут
✅ Сохранение статистики в data/counter_data.json

Структура данных:

{
  "counter_channel_id": "1234567890",
  "daily_stats": {
    "date": "2026-05-11",
    "joined": 15,
    "left": 8,
    "difference": 7
  },
  "history": [
    {
      "date": "2026-05-10",
      "joined": 20,
      "left": 12,
      "difference": 8
    }
  ]
}

Файлы для создания:

src/main/java/creator/loki/listener/MemberCounterListener.java
src/main/java/creator/loki/counter/CounterManager.java
src/main/java/creator/loki/counter/DailyStats.java

Статус: 🔴 Не начато

✅ Что уже сделано

✅ Система опыта переделана

Новая формула: XP для уровня N = 200 * N
1 XP за минуту в войсе
Обновление каждую минуту вместо 5 минут
Метод addVoiceTime теперь возвращает LevelUpResult для уведомлений

✅ Система личных войс-каналов (базовая)

VoiceChannelManager - управление каналами
VoiceChannelListener - автоматическое создание/удаление
VoiceChannelData и VoicePreset - модели данных
Автоматическое создание при входе в триггер-канал
Автоматическое удаление пустых каналов
Панель управления с кнопками (требуется обработчик кнопок)

✅ Счетчик участников

CounterManager - управление счетчиком
MemberCounterListener - отслеживание входов/выходов
DailyStats - дневная статистика
Обновление каждые 5 минут
История за 30 дней

✅ SQLite база данных + автомиграция

Database - менеджер SQLite
DatabaseMigration - автоматическая миграция из JSON
ConfigRepository - работа с конфигурацией
Все таблицы созданы автоматически
Миграция данных при первом запуске

✅ Команды настройки

/voice-setup trigger - установить канал-триггер
/voice-setup category - установить категорию
/voice-setup text-channel - установить текстовый канал
/voice-setup info - показать конфигурацию
/counter-setup channel - установить канал счетчика
/counter-setup format - установить формат
/counter-setup info - показать конфигурацию

🔧 Дополнительные улучшения

4. 🎨 Улучшение уведомлений о level up

✅ Красивые embed сообщения при повышении уровня
✅ Отправка в тот же канал где получен XP
✅ Для войса - отправка в текстовый канал связанный с войсом
✅ Показывать прогресс до следующего уровня

Статус: 🔴 Не начато

5. 🛠️ Команды для настройки систем (Admin Commands)

Voice System Setup:

/voice-setup trigger <channel> - установить канал-триггер
/voice-setup category <category> - установить категорию для личных каналов
/voice-setup text-channel <channel> - установить текстовый канал для уведомлений

Counter Setup:

/counter-setup channel <voice-channel> - установить канал для счетчика
/counter-setup format <format> - изменить формат отображения
/counter stats - показать статистику за период

Статус: 🔴 Не начато

📝 Приоритеты реализации

Высокий приоритет (сделать в первую очередь):

⚡ Переделать систему опыта (простая формула)
🎤 Базовая система личных войс-каналов (создание/удаление)
📊 Счетчик участников

Средний приоритет:

🎤 Настройки войс-каналов через кнопки
🎨 Улучшение уведомлений о level up
🎤 Система пресетов для войс-каналов

Низкий приоритет:

🛠️ Админ команды для настройки

🐛 Известные проблемы (Bugs to Fix)

Критические:

Проверить корректность начисления XP в войсе
Убедиться что VoiceTracker правильно отслеживает время

Некритические:

Удалить неиспользуемый logger в LevelSystem.java
Убрать ненужный @SuppressWarnings в LevelSystem.java

📚 Технические детали

Зависимости:

JDA 5.0.0 (уже есть)
Guice для DI (уже есть)
Gson для JSON (уже есть)

Конфигурация (добавить в config):

voice:
  trigger_channel_id: 1234567890
  category_id: 1234567890
  text_channel_id: 1234567890
  auto_delete_empty: true
  
counter:
  channel_id: 1234567890
  update_interval: 300 # секунды
  format: "【👥】Участники: {count}"

✅ Чеклист перед релизом

Все функции протестированы
Логирование работает корректно
Нет утечек памяти (проверить scheduler'ы)
Graceful shutdown для всех scheduler'ов
Документация обновлена
FEATURES.md актуализирован

Дата создания: 2026-05-11
Версия: 1.0
Автор: Loki Bot Team

27 KiB Raw Blame History Unescape Escape

TODO - План реализации функций

Правила разработки

Архитектура и код:

Принципы структуры:

Рефакторинг структуры проекта

Целевая оценка: 7/10

Целевая структура (по доменам):

План действий (приоритеты):

Высокий приоритет (делаем сейчас):

Средний приоритет (потом):

Низкий приоритет (опционально):

Основные задачи

1. ⚡ Переделать систему опыта (XP System Rework)

2. 🎤 Система личных голосовых каналов (Voice Management System)

2.1 Автоматическое создание каналов

2.2 Сообщение с настройками в чате войса

2.3 Система пресетов

3. 📊 Счетчик участников (Member Counter)

✅ Что уже сделано

✅ Система опыта переделана

✅ Система личных войс-каналов (базовая)

✅ Счетчик участников

✅ SQLite база данных + автомиграция

✅ Команды настройки

🔧 Дополнительные улучшения

4. 🎨 Улучшение уведомлений о level up

5. 🛠️ Команды для настройки систем (Admin Commands)

Voice System Setup:

Counter Setup:

📝 Приоритеты реализации

Высокий приоритет (сделать в первую очередь):

Средний приоритет:

Низкий приоритет:

🐛 Известные проблемы (Bugs to Fix)

Критические:

Некритические:

📚 Технические детали

Зависимости:

Конфигурация (добавить в config):

✅ Чеклист перед релизом

27 KiB

Raw Blame History