Vk-io: Arsitektur: Apa cara terbaik `resmi` untuk mengatur bot di VK-IO

Saya tidak akan mengatakan bahwa pendekatan "resmi", saya hanya akan membagikan preferensi pribadi saya dan sedikit bagian praktisnya.

Desain umum

Saya lebih suka menggunakan pendekatan monorepo untuk mengatur modul terdistribusi (perpustakaan benar-benar menggunakannya). Anda dapat mengambil template siap pakai untuk layanan, dan memisahkan implementasi bot dari perpustakaan menggunakan abstraksi (karena setiap perubahan yang melanggar akan membutuhkan banyak perhatian untuk menyesuaikannya). Ada baiknya juga menggunakan mesin virtual untuk kondisi yang identik dalam pengembangan dan produksi, misalnya Docker akan membantu di sini.

Arsitektur

Ketergantungan bot harus eksplisit, mis. tidak menambahkan "fitur" dengan satu impor, jika tidak, mimpi buruk debugging nyata akan dimulai di sini. Kode abstrak:

// 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);
    });

Hal-hal penting dari kode di atas:

1. Menerapkan paket dasar @my-project/core , yang berisi hal-hal yang diperlukan untuk bot.
2. Perintah menggunakan parameter, sehingga mewujudkan Dispatcher . Mengapa ini perlu? Semuanya sangat sederhana - Anda dapat memanggil perintah dari mana saja dengan parameter yang ditentukan. Dari teks, kami menguraikan argumen yang dijelaskan dalam perintah dengan cara apa pun yang nyaman, dan tombol-tombol di keyboard sudah diatur dengan mereka dan dialamatkan ke perintah yang kami butuhkan. Jadi, kami menghindari duplikasi logika dan mengatur validasi argumen. Misalnya memanggil satu perintah dari yang lain:

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

1. Setiap modul manajer yang telah digunakan memiliki area tanggung jawab masing-masing dan memberikan pemahaman yang jelas tentang apa yang digunakan dan tersedia.

Kesimpulan

Ini adalah pendekatan yang saya gunakan di bot saya, dan ternyata cukup nyaman untuk diterapkan dari bot yang sederhana hingga yang rumit. Paling-paling, paket @my-project/core seharusnya hanya menjadi alias perpustakaan yang telah menerapkan dan menguji semuanya, dan file terlihat seperti ini:

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

export { ViewerManager } from './middlewares';

Dalam kasus perubahan di perpustakaan, maka dimungkinkan untuk mengganti salah satu antarmuka. Tapi tidak ada yang melarang menyimpan semua logika hanya untuk proyek.

Ada implementasi lain yang menarik dari logika bot pada kait, yang digunakan misalnya dalam React atau Vue , Anda dapat menyodoknya langsung menggunakan kode ini .

Terima kasih atas jawaban yang sangat baik dan terperinci. Dan saya ingin meminta Anda untuk membiarkan masalah ini terbuka sehingga orang lain dapat membacanya juga