Расширенные темы
В этом разделе собраны продвинутые темы фреймворка ErisPulse — контроль доступа, грейд-деплой, многошаговые взаимодействия, хранилища и другие глубокие возможности. Каждая статья решает конкретную задачу.
Note
Все документы в этом разделе — документация по запросу. Прочитайте сначала пять основных статей на главной странице, а затем обращайтесь к ним по мере возникновения конкретных задач. В начале каждой статьи указано, когда её стоит читать.
Четыре обязательных статьи уровня L2
Четыре статьи, которые невозможно обойти при написании модулей для продакшена. Рекомендуется прочитать их перед созданием сложных модулей (согласовано с документацией на главной странице):
- Области видимости (scope) — трёхмерный контроль доступа: доступность модуля / допуск событий / ограничение исходящих действий (включая тонкие правила на уровне методов и наследование правил merge)
- Система владельцев (owner) — принадлежность ресурсов и автоматическая очистка: контекст владельца, карта принадлежности ресурсов, последовательность очистки, границы горячей перезагрузки и проектирования
- Управление жизненным циклом — система событий жизненного цикла: что делать при загрузке, выгрузке, перезагрузке и отключении модуля / адаптера
- Система интерактивных сессий — wait_reply / таймер сессии / ожидание нескольких потоков / взаимоисключающий токен сессии / почтовый ящик / транзакции сообщений / трассировка цепочки
Группировка по сценариям
Группировка согласована с разделом «Глубокое понимание принципов» на главной странице. Первая статья каждой группы отмечена, что может пойти не так, если не знать.
Запуск приложения — если не понимать цепочку запуска (Finder / Loader / Manager / Router), при сбое загрузки модуля можно только смотреть на логи
- Процесс запуска и ручное управление — разбор цепочки запуска (Finder/Loader/Manager/Router) и ручной полный запуск
- Ленивая загрузка — принцип работы системы ленивой загрузки, конфигурация и событийная активация (activate_on)
Коммуникация и подключение — если не знать о белом списке сервисных контрактов (meta.services), то межмодульные вызовы module.call будут отвергаться с ошибкой ServiceNotProvidedError без объяснения причины
- Взаимодействие между модулями — RPC-протокол (module.call), сервисные контракты и каталог, направленные события, воспроизведение при холодном запуске,幂等ичность и удаление дубликатов событий
- Пул подключений и трансляция — регистрационная таблица подключений: трансляция, подписка по группам, передача и повторное использование между модулями, просмотр пула подключений
- Менеджер маршрутизации — управление маршрутизацией HTTP и WebSocket (включая регистрацию с одним параметром, соглашение о возврате кортежа)
Хранилища данных — если не знать семантику периода охлаждения при сбое подключения, при колебаниях базы данных можно ошибочно решить, что «фреймворк упал» (на самом деле это просто быстрый отказ и автоматическое повторное подключение после охлаждения)
- Хранилища данных — выбор, настройка и переключение асинхронных хранилищ sqlite / mysql / postgres
- SQL-конструктор запросов — универсальный конструктор SQL-запросов с цепочечным API и абстракция над хранилищами
- Сетевой клиент — единый клиент для HTTP-запросов
Сообщения и диалоги — если не знать о взаимоисключающем токене сессии, два модуля, ожидающие ответа одного и того же пользователя, будут мешать друг другу
- Многошаговый диалог (Conversation) — методы взаимодействия контекста многошагового диалога
- Почтовый ящик сессии — автоматическая запись сообщений: настройки хранения, API для перезаписи в режиме выполнения, риски и аудит
- Подробности MessageBuilder — двойное использование конструктора сообщений OneBot12
- Многоязычность (i18n) — поддержка нескольких языков, регистрация переводов и определение языка
Грейд-деплой и теневые модули — если не знать о пяти уровнях изоляции, можно преждевременно перевести теневую версию в продакшн, и исходящие сообщения теневого модуля могут попасть к реальным пользователям
- Теневые модули и грейд-деплой — независимая параллельная работа новой версии модуля с отдельным владельцем: перехват и учёт исходящих сообщений, сравнение поведения, продвижение (promote) и откат при сбое
Производительность и мониторинг — если проблемы возникают, а вы просто перезапускаете, это всё равно что лететь вслепую
- Производительность и оптимизация — измеренные базовые цифры (включая сравнение с NoneBot2), методы самостоятельной проверки и сравнения, ключевые моменты оптимизации, диагностика памяти
- Инструменты runtime —
ErisPulse.runtime— быстрый справочник по агрегированному экспорту: принадлежность, фоновые задачи, контекст событий, снимок памяти, парсинг dict, диагностика ошибок
Исключения и справочные материалы
- Система исключений и руководство по обработке — все типы исключений фреймворка, места их возникновения и рекомендации по обработке
- Типы сессий — определение типов сессий, сопоставление и регистрация пользовательских типов
Note
Документация по модулям сторонних экосистем, таким как Dashboard и Takumi, была перемещена в каталог Экосистема модулей.
Для кого предназначены эти документы
Документы подходят следующим разработчикам:
- Разработчикам, уже знакомым с основными функциями ErisPulse
- Разработчикам, желающим глубже понять внутренние механизмы фреймворка
- Разработчикам, желающим оптимизировать производительность или реализовать сложные функции
Предварительные знания
Перед чтением документов этого раздела рекомендуется ознакомиться с: