Botx-api-framework

Описание

Фреймворк для разработки ботов под eXpress

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

Добавьте в Cargo.toml

botx-api-framework = { version = "*", features = ["anthill-di"] }

Доступны следующие features: actix-web - включение интеграции с actix-web (default)

Фреймворк не привязан к конкретному web фреймворку, но имеет готовую интеграцию с actix-web

Минимально для работы фреймворка нужно создать объект BotXApiFrameworkContext. Есть несколько способов:

• Через конструктор new - автоматически создастся контекст зависимостей и возьмутся настройки по умолчанию
• Через конструктор from_di_container - контекст зависимостей берется из аргументов, настройки берутся из зависимостей а при отсутствии берутся дефолтные
• Через регистрацию в anthill_di - контекстом зависимостей берется текущий контекст, настройки берутся из зависимостей а при отсутствии берутся дефолтные

// Пример создания контекста фреймворка из контекста anthill_di

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let ioc_ctx = DependencyContext::new_root();

    ioc_ctx.register_botx_api_framework_context().await?;
    // Если не использовать метод расширения
    // ioc_ctx.register_type::<BotXApiFrameworkContext>(LifeCycle::Transient).await?;

    let context = ioc_ctx.resolve::<BotXApiFrameworkContext>().await?;
} 

После создания объекта фреймворка можно обрабатывать команды методами:

• process_command - обработка событий бота
• process_notification_result - обработка асинхронного результата
• process_status_result - обработка состояния бота

Интеграция с web actix добавляет методы расширения для actix_web::app::App:

• add_botx_api_handlers - добавляет обработку api (/command, /notification/callback, /status)
• add_smartapp_static_files - добавляет обработку запроса статики по api /smartapp_files/static/{path*}

Зарегистрированные api при запросе достают контекст фреймворка из зависимостей и передают ему управление

Для добавления обработчиков необходимо регистрировать соответствующий trait и зарегистрировать в контексте зависимостей
Для удобства регистрации обработчиков добавлены методы расширения

Сопоставление trait-ов и методов расширения

Для обработки кнопок TData и TMetadata обработчика должны примерять макрос button_data:

#[button_data]
pub struct ButtonData {
    pub message: String,
}

Макрос button_data добавляет в Data и MetaData поле type_id в котором должен храниться тип объекта. По type_id происходит сопоставление кнопок и обработчиков. Объект в поле type_id имеет реализацию Default, по этому создание объектов data и metadata выполняется способом ниже:

let data = ButtonData { type_id: Default::default(), message: "test message".to_string() }

Сопоставление команд идет по указанному регулярному выражению
Сопоставление событий smartapp и внутренней бот нотификации происходит при помощи десериализации - если сообщение можно разобрать в объекты указанные в обработчике, значит этому обработчику будет передано событие

Для работы с api eXpress этот crate реэкспортирует crate botx-api. Используйте метод расширение для регистрации контекста api в контексте зависимостей, после чего его можно будет получить в каждом обработчике и выполнять запросы в eXpress

Базовая настройка приложения может выглядеть следующим образом

use actix_web::{
    middleware::Logger,
    web::{self, Data},
    App, HttpServer,
};

use anthill_di::DependencyContext;
use botx_api::extensions::botx_api_context::IBotXApiContextExt;
use botx_api_framework::extensions::{anthill_di::IAnthillDiExt, actix::IActixHandlersExt};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let ioc_ctx = DependencyContext::new_root();

    ioc_ctx.register_botx_api_context().await?;
    ioc_ctx.register_botx_api_framework_context().await?;

    HttpServer::new(move || {
        App::new()
            .wrap(Logger::default())
            .app_data(Data::new(ioc_ctx.clone()))
            .add_botx_api_handlers()
    })
    .bind(("127.0.0.1", "7856"))?
    .run()
    .await?;

    Ok(())
}

Вклад

Откройте issue с вопросом или предложением

Лицензия

MIT, можно использовать в любых целях

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