Маршрутизатор (router)
Клас Router (довідка API) надає спосіб структурувати вашого бота шляхом маршрутизації обʼєктів контексту до різних частин вашого коду. Це більш досконала версія bot у Composer (довідка grammY API).
Приклад
Ось приклад використання маршрутизатора, який говорить сам за себе.
ts
const router = new Router((ctx) => {
// Визначаємо маршрут.
return "ключ";
});
router.route("ключ", async (ctx) => {/* ... */});
router.route("інший ключ", async (ctx) => {/* ... */});
router.otherwise((ctx) => {/* ... */}); // викликається, якщо жоден маршрут не збігається
bot.use(router);1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
Інтеграція з проміжними обробниками
Звісно, плагін маршрутизатора легко інтегрується з деревами проміжних обробників, які надає grammY. Наприклад, ви можете додатково фільтрувати оновлення після їх маршрутизації.
ts
router.route("ключ").on("message:text", async (ctx) => {/* ... */});
const other = router.otherwise();
other.on(":text", async (ctx) => {/* ... */});
other.use((ctx) => {/* ... */});1
2
3
4
5
2
3
4
5
Ви також можете переглянути цей розділ про комбінування обробників.
Комбінування маршрутизаторів із сесіями
Маршрутизатори добре працюють разом із сесіями. Наприклад, поєднання цих двох концепцій дозволяє створювати форми у вигляді інтерфейсу чата.
Зауважте, що набагато кращим рішенням є використання плагіна розмов. Решта цієї сторінки застаріла з моменту створення того плагіна. Ми збережемо цю сторінку як довідник для тих, хто використовував маршрутизатор для створення форм.
Припустимо, ви хочете створити бота, який повідомляє користувачам, скільки днів залишилося до їхнього дня народження. Щоб обчислити кількість днів, бот повинен знати дату дня народження, а саме місяць і день, наприклад, місяць — червень, день місяця — 15-й.
Тому бот повинен задати два питання:
- Якого місяця народився користувач?
- Якого дня народився користувач?
Тільки якщо обидва значення відомі, бот може сказати користувачу, скільки днів залишилося до його дня народження.
Ось як можна реалізувати такого бота:
ts
import { Bot, Context, Keyboard, session, SessionFlavor } from "grammy";
import { Router } from "@grammyjs/router";
interface SessionData {
// "порожній", "день" та "місяць" відповідно
step: "idle" | "day" | "month"; // крок форми, на якому ми знаходимося
dayOfMonth?: number; // день місяця
month?: number; // місяць народження
}
type MyContext = Context & SessionFlavor<SessionData>;
const bot = new Bot<MyContext>("");
// Використовуємо сесії.
bot.use(session({ initial: (): SessionData => ({ step: "idle" }) }));
// Визначаємо деякі команди.
bot.command("start", async (ctx) => {
await ctx.reply(`Ласкаво просимо!
Я можу сказати вам, через скільки днів у вас день народження!
Надішліть /birthday, щоб почати`);
});
bot.command("birthday", async (ctx) => {
const day = ctx.session.dayOfMonth;
const month = ctx.session.month;
if (day !== undefined && month !== undefined) {
// Відповідаємо користувачу, якщо інформація вже надана
await ctx.reply(`Ваш день народження через ${getDays(month, day)} днів!`);
} else {
// Починаємо опитування, якщо деякої інформації не вистачає
ctx.session.step = "day";
await ctx.reply(
"Будь ласка, надішліть мені день \
вашого народження у числовому форматі!",
);
}
});
// Використовуємо маршрутизатор.
const router = new Router<MyContext>((ctx) => ctx.session.step);
// Визначаємо крок, який обробляє день.
const day = router.route("day");
day.on("message:text", async (ctx) => {
const day = parseInt(ctx.msg.text, 10);
if (isNaN(day) || day < 1 || 31 < day) {
await ctx.reply("Цей день недійсний, спробуйте ще раз!");
return;
}
ctx.session.dayOfMonth = day;
// Попередньо змінюємо крок форми
ctx.session.step = "month";
await ctx.reply("Готово! А тепер скажіть, якого місяця ви народилися!", {
reply_markup: {
one_time_keyboard: true,
keyboard: new Keyboard()
.text("Січень").text("Лютий").text("Березень").row()
.text("Квітень").text("Травень").text("Червень").row()
.text("Липень").text("Серпень").text("Вересень").row()
.text("Жовтень").text("Листопад").text("Грудень").build(),
},
});
});
day.use((ctx) =>
ctx.reply(
"Будь ласка, надішліть мені день у вигляді текстового повідомлення!",
)
);
// Визначаємо крок, який обробляє місяць.
const month = router.route("month");
month.on("message:text", async (ctx) => {
// Наступна умова виконається, лише якщо дані сесії пошкоджено.
const day = ctx.session.dayOfMonth;
if (day === undefined) {
await ctx.reply("Спочатку мені потрібно дізнатися день вашого народження!");
ctx.session.step = "day";
return;
}
const month = Object.keys(months).indexOf(ctx.msg.text);
if (month === -1) {
await ctx.reply(
"Цей місяць недійсний, \
будь ласка, скористайтеся однією з кнопок!",
);
return;
}
ctx.session.month = month;
const diff = getDays(month, day);
await ctx.reply(
`Ваш день народження ${day}-го ${Object.values(months)[month]}.
Це за ${diff} днів!`,
{ reply_markup: { remove_keyboard: true } },
);
ctx.session.step = "idle";
});
month.use((ctx) => ctx.reply("Будь ласка, натисніть одну з кнопок!"));
// Визначаємо крок, який обробляє всі інші випадки.
router.otherwise(async (ctx) => { // idle
await ctx.reply(
"Надішліть /birthday, щоб дізнатися, як довго вам доведеться чекати свого дня народження.",
);
});
bot.use(router); // реєструємо маршрутизатор
bot.start();
// Утиліти для перетворення дат
const months = {
"Січень": "січня",
"Лютий": "лютого",
"Березень": "березня",
"Квітень": "квітня",
"Травень": "травня",
"Червень": "червня",
"Липень": "липня",
"Серпень": "серпня",
"Вересень": "вересня",
"Жовтень": "жовтня",
"Листопад": "листопада",
"Грудень": "грудня",
};
function getDays(month: number, day: number) {
const bday = new Date();
const now = Date.now();
bday.setMonth(month);
bday.setDate(day);
if (bday.getTime() < now) bday.setFullYear(bday.getFullYear() + 1);
const diff = (bday.getTime() - now) / (1000 * 60 * 60 * 24);
return diff;
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
js
const { Bot, Context, Keyboard, session, SessionFlavor } = require("grammy");
const { Router } = require("@grammyjs/router");
const bot = new Bot("");
// Використовуємо сесії.
bot.use(session({ initial: () => ({ step: "idle" }) }));
// Визначаємо деякі команди.
bot.command("start", async (ctx) => {
await ctx.reply(`Ласкаво просимо!
Я можу сказати вам, через скільки днів у вас день народження!
Надішліть /birthday, щоб почати`);
});
bot.command("birthday", async (ctx) => {
const day = ctx.session.dayOfMonth;
const month = ctx.session.month;
if (day !== undefined && month !== undefined) {
// Відповідаємо користувачеві, якщо інформація вже надана
await ctx.reply(`Ваш день народження через ${getDays(month, day)} днів!`);
} else {
// Починаємо опитування, якщо деякої інформації не вистачає
ctx.session.step = "day";
await ctx.reply(
"Будь ласка, надішліть мені день \
вашого народження у вигляді числа!",
);
}
});
// Використовуємо маршрутизатор.
const router = new Router((ctx) => ctx.session.step);
// Визначаємо крок, який обробляє день.
const day = router.route("day");
day.on("message:text", async (ctx) => {
const day = parseInt(ctx.msg.text, 10);
if (isNaN(day) || day < 1 || 31 < day) {
await ctx.reply("Цей день недійсний, спробуйте ще раз!");
return;
}
ctx.session.dayOfMonth = day;
// Попередньо змінюємо крок форми
ctx.session.step = "month";
await ctx.reply("Готово! А тепер скажіть, якого місяця ви народилися!", {
reply_markup: {
one_time_keyboard: true,
keyboard: new Keyboard()
.text("Січень").text("Лютий").text("Березень").row()
.text("Квітень").text("Травень").text("Червень").row()
.text("Липень").text("Серпень").text("Вересень").row()
.text("Жовтень").text("Листопад").text("Грудень").build(),
},
});
});
day.use((ctx) =>
ctx.reply(
"Будь ласка, надішліть мені день у вигляді текстового повідомлення!",
)
);
// Визначаємо крок, який обробляє місяць.
const month = router.route("month");
month.on("message:text", async (ctx) => {
// Наступна умова виконається, лише якщо дані сесії пошкоджено.
const day = ctx.session.dayOfMonth;
if (day === undefined) {
await ctx.reply("Спочатку мені потрібно дізнатися день вашого народження!");
ctx.session.step = "day";
return;
}
const month = Object.keys(months).indexOf(ctx.msg.text);
if (month === -1) {
await ctx.reply(
"Цей місяць недійсний, \
будь ласка, скористайтеся однією з кнопок!",
);
return;
}
ctx.session.month = month;
const diff = getDays(month, day);
await ctx.reply(
`Ваш день народження ${day}-го ${Object.values(months)[month]}.
Це за ${diff} днів!`,
{ reply_markup: { remove_keyboard: true } },
);
ctx.session.step = "idle";
});
month.use((ctx) => ctx.reply("Будь ласка, натисніть одну з кнопок!"));
// Визначаємо крок, який обробляє всі інші випадки.
router.otherwise(async (ctx) => { // idle
await ctx.reply(
"Надішліть /birthday, щоб дізнатися, як довго вам доведеться чекати свого дня народження.",
);
});
bot.use(router); // реєструємо маршрутизатор
bot.start();
// Утиліти для перетворення дат
const months = {
"Січень": "січня",
"Лютий": "лютого",
"Березень": "березня",
"Квітень": "квітня",
"Травень": "травня",
"Червень": "червня",
"Липень": "липня",
"Серпень": "серпня",
"Вересень": "вересня",
"Жовтень": "жовтня",
"Листопад": "листопада",
"Грудень": "грудня",
};
function getDays(month: number, day: number) {
const bday = new Date();
const now = Date.now();
bday.setMonth(month);
bday.setDate(day);
if (bday.getTime() < now) bday.setFullYear(bday.getFullYear() + 1);
const diff = (bday.getTime() - now) / (1000 * 60 * 60 * 24);
return diff;
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
ts
import {
Bot,
Context,
Keyboard,
session,
SessionFlavor,
} from "https://deno.land/x/grammy@v1.27.0/mod.ts";
import { Router } from "https://deno.land/x/grammy_router@v2.0.0/router.ts";
interface SessionData {
// "порожній", "день" та "місяць" відповідно
step: "idle" | "day" | "month"; // крок форми, на якому ми знаходимося
dayOfMonth?: number; // день місяця
month?: number; // місяць народження
}
type MyContext = Context & SessionFlavor<SessionData>;
const bot = new Bot<MyContext>("");
// Використовуємо сесії.
bot.use(session({ initial: (): SessionData => ({ step: "idle" }) }));
// Визначаємо деякі команди.
bot.command("start", async (ctx) => {
await ctx.reply(`Ласкаво просимо!
Я можу сказати вам, через скільки днів у вас день народження!
Надішліть /birthday, щоб почати`);
});
bot.command("birthday", async (ctx) => {
const day = ctx.session.dayOfMonth;
const month = ctx.session.month;
if (day !== undefined && month !== undefined) {
// Відповідаємо користувачеві, якщо інформація вже надана
await ctx.reply(`Ваш день народження через ${getDays(month, day)} днів!`);
} else {
// Починаємо опитування, якщо деякої інформації не вистачає
ctx.session.step = "day";
await ctx.reply(
"Будь ласка, надішліть мені день \
вашого народження у вигляді числа!",
);
}
});
// Використовуємо маршрутизатор.
const router = new Router<MyContext>((ctx) => ctx.session.step);
// Визначаємо крок, який обробляє день.
const day = router.route("day");
day.on("message:text", async (ctx) => {
const day = parseInt(ctx.msg.text, 10);
if (isNaN(day) || day < 1 || 31 < day) {
await ctx.reply("Цей день недійсний, спробуйте ще раз!");
return;
}
ctx.session.dayOfMonth = day;
// Попередньо змінюємо крок форми
ctx.session.step = "month";
await ctx.reply("Готово! А тепер скажіть, якого місяця ви народилися!", {
reply_markup: {
one_time_keyboard: true,
keyboard: new Keyboard()
.text("Січень").text("Лютий").text("Березень").row()
.text("Квітень").text("Травень").text("Червень").row()
.text("Липень").text("Серпень").text("Вересень").row()
.text("Жовтень").text("Листопад").text("Грудень").build(),
},
});
});
day.use((ctx) =>
ctx.reply(
"Будь ласка, надішліть мені день у вигляді текстового повідомлення!",
)
);
// Визначаємо крок, який обробляє місяць.
const month = router.route("month");
month.on("message:text", async (ctx) => {
// Наступна умова виконається, лише якщо дані сесії пошкоджено.
const day = ctx.session.dayOfMonth;
if (day === undefined) {
await ctx.reply("Спочатку мені потрібно дізнатися день вашого народження!");
ctx.session.step = "day";
return;
}
const month = Object.keys(months).indexOf(ctx.msg.text);
if (month === -1) {
await ctx.reply(
"Цей місяць недійсний, \
будь ласка, скористайтеся однією з кнопок!",
);
return;
}
ctx.session.month = month;
const diff = getDays(month, day);
await ctx.reply(
`Ваш день народження ${day}-го ${Object.values(months)[month]}.
Це за ${diff} днів!`,
{ reply_markup: { remove_keyboard: true } },
);
ctx.session.step = "idle";
});
month.use((ctx) => ctx.reply("Будь ласка, натисніть одну з кнопок!"));
// Визначаємо крок, який обробляє всі інші випадки.
router.otherwise(async (ctx) => { // idle
await ctx.reply(
"Надішліть /birthday, щоб дізнатися, як довго вам доведеться чекати свого дня народження.",
);
});
bot.use(router); // реєструємо маршрутизатор
bot.start();
// Утиліти для перетворення дат
const months = {
"Січень": "січня",
"Лютий": "лютого",
"Березень": "березня",
"Квітень": "квітня",
"Травень": "травня",
"Червень": "червня",
"Липень": "липня",
"Серпень": "серпня",
"Вересень": "вересня",
"Жовтень": "жовтня",
"Листопад": "листопада",
"Грудень": "грудня",
};
function getDays(month: number, day: number) {
const bday = new Date();
const now = Date.now();
bday.setMonth(month);
bday.setDate(day);
if (bday.getTime() < now) bday.setFullYear(bday.getFullYear() + 1);
const diff = (bday.getTime() - now) / (1000 * 60 * 60 * 24);
return diff;
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
Зверніть увагу, що сесія має властивість step, яка зберігає крок форми, тобто яке значення наразі заповнюється. Маршрутизатор використовується для переходу між різними проміжними обробниками, які заповнюють поля month і day у сесії. Якщо обидва значення відомі, бот обчислює кількість днів, що залишилися, і надсилає її назад користувачеві.
Загальні відомості про плагін
- Назва:
router - Довідка API