Vk-io: आर्किटेक्चर: वीके-आईओ पर बॉट को व्यवस्थित करने का 'आधिकारिक' सबसे अच्छा तरीका क्या है?

मैं यह नहीं कहूंगा कि "आधिकारिक" दृष्टिकोण, मैं केवल अपनी व्यक्तिगत प्राथमिकताएं और थोड़ा सा व्यावहारिक हिस्सा साझा करूंगा।

सामान्य डिजाइन

मैं वितरित मॉड्यूल को व्यवस्थित करने के लिए मोनोरेपो दृष्टिकोण का उपयोग करना पसंद करता हूं (पुस्तकालय वास्तव में इसका उपयोग करता है)। आप सेवाओं के लिए तैयार टेम्पलेट ले सकते हैं, और अमूर्त का उपयोग करके पुस्तकालय से बॉट कार्यान्वयन को अलग कर सकते हैं (क्योंकि किसी भी ब्रेकिंग परिवर्तन को इसे अनुकूलित करने के लिए बहुत अधिक ध्यान देने की आवश्यकता होगी)। विकास और उत्पादन में समान परिस्थितियों के लिए वर्चुअल मशीनों का उपयोग करना भी एक अच्छा विचार है, उदाहरण के लिए डॉकर यहां मदद करेगा।

आर्किटेक्चर

बॉट निर्भरता स्पष्ट होनी चाहिए, अर्थात। एक आयात के साथ "फीचर्स" नहीं जोड़ना, अन्यथा एक वास्तविक डिबगिंग दुःस्वप्न यहां शुरू होगा। सार कोड:

// commands/random.ts
import { Command } from '@my-project/core';
import { getRandomIntegerInRange } from '@my-project/utils';

export const randomCommand = new Command({
    slug: 'random',

    aliases: [
        'рандом',
        'random'
    ],

    description = 'рандмоное число в промежутке';

    arguments: [
        {
            type: 'integer',
            key: 'min',
            label: 'минк/макс',
            default: null
        },
        {
            type: 'integer',
            key: 'max',
            label: 'минк/макс',
            default: null
        }
    ],

    handler(context) {
        // Работаем с аргументами, а не текстом
        let { min = null, max = null } = context.commander.params;

        if (min === null && max === null) {
            min = 0;
            max = 100;
        } else if (max === null) {
            max = min;
            min = 0;
        }

        const result = getRandomIntegerInRange(min, max);

        return context.answer({
            text: `число в промежутке ${min} - ${max}: ${result}`
        });
    }
});

// commands/index.ts
export * from './random';

// bot.ts
import {
    Bot,

    SessionManager,
    RedisSessionStorage,

    RateLimitManager,

    CommanderManager
} from '@my-project/core';

import * as commands from './commands';

const sessionManager = new SessionManager({
    storage: new RedisSessionStorage({})
});

const rateLimitManager = new RateLimitManager({
    maxPerSecond: 1
});

const commanderManager = new CommanderManager();

for (const command of Object.values(commands)) {
    commanderManager.add(command);
}

const bot = new Bot({
    // ...options
});

// Это может быть кастомная цепочка middleware в боте
bot.incoming.on('message', sessionManager.middleware);
bot.incoming.on('message', rateLimitManager.middleware);
bot.incoming.on('message', commanderManager.middleware);

bot.start()
    .then(() => {
        console.log('Bot started', error);
    })
    .catch((error: Error) => {
        console.error('Error starting bot', error);

        process.exit(1);
    });

उपरोक्त कोड से महत्वपूर्ण बातें:

1. मूल पैकेज @my-project/core लागू किया, जिसमें बॉट के लिए आवश्यक चीजें शामिल हैं।
2. कमांड पैरामीटर का उपयोग करते हैं, इस प्रकार Dispatcher को साकार करते हैं। यह क्यों जरूरी है? सब कुछ बहुत सरल है - आप निर्दिष्ट मापदंडों के साथ कहीं से भी कमांड को कॉल कर सकते हैं। पाठ से, हम किसी भी सुविधाजनक तरीके से कमांड में वर्णित तर्कों को पार्स करते हैं, और कीबोर्ड में बटन बस पहले से ही उनके साथ सेट होते हैं और हमें जिस कमांड की आवश्यकता होती है, उसे संबोधित किया जाता है। इस प्रकार, हमने तर्क के दोहराव से बचा और तर्कों के सत्यापन को व्यवस्थित किया। उदाहरण के लिए एक कमांड को दूसरे से कॉल करना:

export const dndCommand = new Command({
    // ...
    handler(context) {
        return context.commander.enter('random', {
            params: {
                min: 1,
                max: 20
            }
        });
    }
});

1. उपयोग किए गए प्रत्येक प्रबंधक मॉड्यूल की अपनी जिम्मेदारी का क्षेत्र होता है और जो उपयोग किया जाता है और उपलब्ध होता है उसकी स्पष्ट समझ देता है।

निष्कर्ष

यह वह तरीका है जिसका मैंने अपने बॉट्स में उपयोग किया था, और यह सरल से जटिल बॉट्स को लागू करने के लिए काफी सुविधाजनक निकला। सबसे अच्छा, पैकेज @my-project/core केवल एक पुस्तकालय का एक उपनाम होना चाहिए जो पहले से ही सब कुछ लागू और परीक्षण कर चुका है, और फ़ाइल इस तरह दिखती है:

export { Bot, Command } from 'super-bot-library';

export { ViewerManager } from './middlewares';

पुस्तकालय में परिवर्तन के मामलों में, तब किसी एक इंटरफेस को बदलना संभव होगा। लेकिन केवल परियोजना के लिए सभी तर्क रखने से कोई मना नहीं करता है।

हुक पर बॉट तर्क का एक और दिलचस्प कार्यान्वयन है, जिसका उपयोग उदाहरण के लिए React या Vue में किया जाता है, आप इस कोड का उपयोग करके इसे लाइव पोक कर सकते हैं।

बहुत अच्छे और विस्तृत उत्तर के लिए धन्यवाद। और मैं आपसे इस मुद्दे को खुला छोड़ने के लिए कहना चाहूंगा ताकि अन्य लोग भी इसे पढ़ सकें