Skip to content

Instantly share code, notes, and snippets.

@marensovich

marensovich/Button.java

Last active December 6, 2025 09:35
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save marensovich/5930a130fb814607c2bc560a82b54023 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save marensovich/5930a130fb814607c2bc560a82b54023 to your computer and use it in GitHub Desktop.
Download ZIP
Утилита для создания клавиатур посредством конструктора для Telegram ботов. Рекомендуется использовать с менеджером кнопок и интерфейсом для их создания. Поддерживает указание как текста для кнопки, так и ссылку на класс, наследующийся от интерфейса. Создан под версию библиотеки telegrambots:6.9.7.1
Raw
Button.java
package me.marensovich.kworkparserbot.bot.manager.button.interfaces;
import org.telegram.telegrambots.meta.api.objects.Update;
/**
* Интерфейс кнопки бота.
* <p>
* Определяет методы для работы с кнопкой:
* получения текста кнопки и обработки нажатия.
*
* @author marensovich
* @version 0.0.1
* @since 0.0.1
*/
public interface Button {
/**
* Получить текст кнопки.
*
* @return текст, который отображается на кнопке
* @author marensovich
* @since 0.0.1
*/
String getButtonText();
/**
* Обработать нажатие на кнопку.
*
* @param update объект Update из Telegram, содержащий информацию о событии
* @author marensovich
* @since 0.0.1
*/
void handle(Update update);
}
Raw
ButtonManager.java
package me.marensovich.kworkparserbot.bot.manager.button;
import lombok.extern.slf4j.Slf4j;
import me.marensovich.kworkparserbot.bot.manager.button.interfaces.Button;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.telegram.telegrambots.meta.api.objects.Update;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Менеджер кнопок.
* <p>
* Управляет всеми кнопками бота, их регистрацией, поиском по тексту,
* а также хранит активные кнопки, закрепленные за пользователями.
*
* @author marensovich
* @version 0.0.1
* @since 0.0.1
*/
@Service
@Slf4j
public class ButtonManager {
private final Map<Class<? extends Button>, Button> buttonsByClass = new HashMap<>();
private final Map<String, Button> buttonsByText = new HashMap<>();
private final Map<Long, Button> activeButtons = new HashMap<>();
/**
* Конструктор менеджера.
*
* @param buttonList список всех кнопок для регистрации
* @author marensovich
* @since 0.0.1
*/
@Autowired
public ButtonManager(List<Button> buttonList) {
for (Button button : buttonList) {
buttonsByClass.put(button.getClass(), button);
buttonsByText.put(button.getButtonText(), button);
}
}
/**
* Получить кнопку по классу.
*
* @param clazz класс кнопки
* @return кнопка, если зарегистрирована, иначе null
* @author marensovich
* @since 0.0.1
*/
public Button getByClass(Class<? extends Button> clazz) {
return buttonsByClass.get(clazz);
}
/**
* Найти кнопку по тексту.
*
* @param text текст кнопки
* @return кнопка, если найдена, иначе null
* @author marensovich
* @since 0.0.1
*/
public Button findByText(String text) {
return buttonsByText.get(text);
}
/**
* Обработать нажатие кнопки.
*
* @param update объект Update из Telegram
* @author marensovich
* @since 0.0.1
*/
public void handle(Update update) {
if (!update.hasMessage() || !update.getMessage().hasText()) return;
String text = update.getMessage().getText();
Button button = findByText(text);
if (button != null) button.handle(update);
}
/**
* Установить активную кнопку для пользователя.
*
* @param userId id пользователя
* @param button кнопка, которая становится активной
* @author marensovich
* @since 0.0.1
*/
public void setActiveCommand(Long userId, Button button) {
log.debug("Активная кнопка " + button.getButtonText() + " закреплена за пользователем " + userId);
activeButtons.put(userId, button);
}
/**
* Снять активную кнопку у пользователя.
*
* @param userId id пользователя
* @author marensovich
* @since 0.0.1
*/
public void unsetActiveCommand(Long userId) {
log.debug("Активная кнопка пользователя " + userId + " была очищена");
activeButtons.remove(userId);
}
/**
* Проверить, есть ли у пользователя активная кнопка.
*
* @param userId id пользователя
* @return true, если кнопка есть, иначе false
* @author marensovich
* @since 0.0.1
*/
public boolean hasActiveCommand(Long userId) {
return activeButtons.containsKey(userId);
}
/**
* Получить активную кнопку пользователя.
*
* @param userId id пользователя
* @return активная кнопка, или null если её нет
* @author marensovich
* @since 0.0.1
*/
public Button getActiveCommand(Long userId) {
return activeButtons.get(userId);
}
}
Raw
KeyboardFactory.java
package me.marensovich.kworkparserbot.utils;
import me.marensovich.kworkparserbot.bot.manager.button.ButtonManager;
import me.marensovich.kworkparserbot.bot.manager.button.interfaces.Button;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.InlineKeyboardMarkup;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.ReplyKeyboardMarkup;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.*;
import org.telegram.telegrambots.meta.api.objects.webapp.WebAppInfo;
import java.util.ArrayList;
import java.util.List;
/**
* Фабрика для создания различных типов клавиатур (Reply и Inline)
* для Telegram-бота. Используется для удобного построения
* интерфейсов взаимодействия с пользователем.
*
* <p>Поддерживает работу как с текстовыми кнопками, так и
* с кнопками, связанными с классами, реализующими интерфейс {@link Button}.
*
* @author marensovich
* @version 0.0.2
* @since 0.0.1
*/
@Component
public class KeyboardFactory {
@Lazy
private final ButtonManager buttonManager;
/**
* Конструктор фабрики клавиатур.
*
* @param buttonManager менеджер кнопок, предоставляющий информацию о зарегистрированных кнопках и их текстах
* @author marensovich
* @since 0.0.1
*/
public KeyboardFactory(@Lazy ButtonManager buttonManager) {
this.buttonManager = buttonManager;
}
/**
* Создаёт универсальный билдер клавиатур.
* <p>Билдер позволяет создавать как обычные (Reply),
* так и встроенные (Inline) клавиатуры.
*
* @return экземпляр {@link UniversalKeyboardBuilder}
* @author marensovich
* @since 0.0.1
*/
public UniversalKeyboardBuilder create() {
return new UniversalKeyboardBuilder(buttonManager);
}
/**
* Вложенный класс, реализующий шаблон проектирования "Билдер"
* для создания клавиатур Telegram (Reply и Inline).
* <p>Не требует экземпляра внешнего класса {@link KeyboardFactory}.
*
* @author marensovich
* @version 0.0.2
* @since 0.0.1
*/
public static class UniversalKeyboardBuilder {
private final ButtonManager buttonManager;
// --- Reply-кнопки ---
private final List<KeyboardRow> rows = new ArrayList<>();
// --- Inline-кнопки ---
private final List<List<InlineKeyboardButton>> inlineRows = new ArrayList<>();
private KeyboardRow currentRow = new KeyboardRow();
private List<InlineKeyboardButton> currentInlineRow = new ArrayList<>();
/**
* Конструктор билдера клавиатур.
*
* @param buttonManager менеджер кнопок, предоставляющий тексты кнопок и их callback-данные
* @author marensovich
* @since 0.0.1
*/
public UniversalKeyboardBuilder(@Lazy ButtonManager buttonManager) {
this.buttonManager = buttonManager;
}
/**
* Добавляет кнопку в текущий ряд, используя зарегистрированный класс кнопки.
*
* @param buttonClass класс кнопки, реализующий интерфейс {@link Button}
* @return текущий экземпляр билдера
* @author marensovich
* @since 0.0.1
*/
public UniversalKeyboardBuilder addButton(Class<? extends Button> buttonClass) {
Button button = buttonManager.getByClass(buttonClass);
if (button != null) {
currentRow.add(new KeyboardButton(button.getButtonText()));
}
return this;
}
/**
* Добавляет обычную текстовую кнопку в текущий ряд.
*
* @param text текст кнопки
* @return текущий экземпляр билдера
* @author marensovich
* @since 0.0.1
*/
public UniversalKeyboardBuilder addButton(String text) {
currentRow.add(new KeyboardButton(text));
return this;
}
/**
* Добавляет кнопку, которая при нажатии запрашивает контакт у пользователя.
* Текст кнопки передаётся напрямую.
*
* @param text текст кнопки (например: "Отправить контакт")
* @return текущий экземпляр билдера
* @author marensovich
* @since 0.0.2
*/
public UniversalKeyboardBuilder addContactButton(String text) {
KeyboardButton contactButton = new KeyboardButton(text);
contactButton.setRequestContact(true);
currentRow.add(contactButton);
return this;
}
/**
* Добавляет кнопку, которая при нажатии запрашивает контакт у пользователя.
* Текст кнопки берётся из зарегистрированного класса, реализующего {@link Button}.
*
* @param buttonClass класс кнопки, реализующий интерфейс {@link Button}
* @return текущий экземпляр билдера
* @author marensovich
* @since 0.0.2
*/
public UniversalKeyboardBuilder addContactButton(Class<? extends Button> buttonClass) {
Button button = buttonManager.getByClass(buttonClass);
if (button != null) {
KeyboardButton contactButton = new KeyboardButton(button.getButtonText());
contactButton.setRequestContact(true);
currentRow.add(contactButton);
}
return this;
}
/**
* Добавляет кнопку, запрашивающую местоположение пользователя.
*
* @param text текст кнопки
* @return the universal keyboard builder
*/
public UniversalKeyboardBuilder addLocationButton(String text) {
KeyboardButton button = new KeyboardButton(text);
button.setRequestLocation(true);
currentRow.add(button);
return this;
}
/**
* Добавляет кнопку, которая предлагает пользователю выбрать конкретного пользователя Telegram.
*
* @param text текст кнопки
* @param requestId уникальный ID запроса (любое число, например 1)
* @param userIsBot если true — выбирает только ботов
* @param userIsPremium если true — выбирает только Premium-пользователей
* @return the universal keyboard builder
*/
public UniversalKeyboardBuilder addRequestUserButton(String text, int requestId, boolean userIsBot, boolean userIsPremium) {
KeyboardButton button = new KeyboardButton(text);
KeyboardButtonRequestUser request = new KeyboardButtonRequestUser();
request.setRequestId(String.valueOf(requestId));
request.setUserIsBot(userIsBot);
request.setUserIsPremium(userIsPremium);
button.setRequestUser(request);
currentRow.add(button);
return this;
}
/**
* Добавляет кнопку, которая предлагает выбрать несколько пользователей (Bot API 7.0+).
*
* @param text текст кнопки
* @param requestId уникальный ID запроса
* @param allowBots разрешить ли выбор ботов
* @param allowPremium разрешить ли выбор Premium-пользователей
* @param maxUsers максимальное количество пользователей, которых можно выбрать
* @return the universal keyboard builder
*/
public UniversalKeyboardBuilder addRequestUsersButton(String text,
int requestId,
boolean allowBots,
boolean allowPremium,
int maxUsers) {
KeyboardButton button = new KeyboardButton(text);
KeyboardButtonRequestUsers request = new KeyboardButtonRequestUsers();
request.setRequestId(String.valueOf(requestId));
request.setUserIsBot(allowBots);
request.setUserIsPremium(allowPremium);
request.setMaxQuantity(maxUsers);
button.setRequestUsers(request);
currentRow.add(button);
return this;
}
/**
* Добавляет кнопку, которая предлагает пользователю выбрать чат (группу, супергруппу или канал).
*
* @param text текст кнопки
* @param requestId уникальный ID запроса
* @param chatIsChannel true — запросить только каналы, false — обычные чаты
* @param botIsMember true — бот должен быть участником чата
* @param hasUsername true — чат должен иметь username
* @param chatIsForum true — чат должен быть форумом
* @return the universal keyboard builder
*/
public UniversalKeyboardBuilder addRequestChatButton(String text,
int requestId,
boolean chatIsChannel,
boolean botIsMember,
boolean hasUsername,
boolean chatIsForum
) {
KeyboardButton button = new KeyboardButton(text);
KeyboardButtonRequestChat request = new KeyboardButtonRequestChat();
request.setRequestId(String.valueOf(requestId));
request.setChatIsChannel(chatIsChannel);
request.setBotIsMember(botIsMember);
request.setChatHasUsername(hasUsername);
request.setChatIsForum(chatIsForum);
button.setRequestChat(request);
currentRow.add(button);
return this;
}
/**
* Добавляет кнопку, которая предлагает создать опрос.
*
* @param text текст кнопки
* @param pollType тип опроса: "quiz" или "regular" (null = любой)
* @return the universal keyboard builder
*/
public UniversalKeyboardBuilder addPollButton(String text, String pollType) {
KeyboardButton button = new KeyboardButton(text);
KeyboardButtonPollType poll = new KeyboardButtonPollType();
poll.setType(pollType);
button.setRequestPoll(poll);
currentRow.add(button);
return this;
}
/**
* Добавляет кнопку, открывающую WebApp.
*
* @param text текст кнопки
* @param url URL веб-приложения
* @return the universal keyboard builder
*/
public UniversalKeyboardBuilder addWebAppButton(String text, String url) {
KeyboardButton button = new KeyboardButton(text);
button.setWebApp(new WebAppInfo(url));
currentRow.add(button);
return this;
}
/**
* Завершает текущий ряд кнопок и создаёт новый.
*
* @return текущий экземпляр билдера
* @author marensovich
* @since 0.0.1
*/
public UniversalKeyboardBuilder nextRow() {
rows.add(currentRow);
currentRow = new KeyboardRow();
return this;
}
/**
* Завершает построение Reply-клавиатуры и возвращает готовую разметку.
*
* @return объект {@link ReplyKeyboardMarkup} для отправки в Telegram API
* @author marensovich
* @since 0.0.1
*/
public ReplyKeyboardMarkup buildReplyKeyboard() {
if (!currentRow.isEmpty()) rows.add(currentRow);
ReplyKeyboardMarkup markup = new ReplyKeyboardMarkup();
markup.setResizeKeyboard(true);
markup.setOneTimeKeyboard(true);
markup.setKeyboard(rows);
return markup;
}
/**
* Добавляет Inline-кнопку, связанную с классом {@link Button}.
*
* @param buttonClass класс кнопки, реализующий интерфейс {@link Button}
* @return текущий экземпляр билдера
* @author marensovich
* @since 0.0.1
*/
public UniversalKeyboardBuilder addInlineButton(Class<? extends Button> buttonClass) {
Button button = buttonManager.getByClass(buttonClass);
if (button != null) {
InlineKeyboardButton inlineButton = new InlineKeyboardButton();
inlineButton.setText(button.getButtonText());
inlineButton.setCallbackData(button.getButtonText());
currentInlineRow.add(inlineButton);
}
return this;
}
/**
* Добавляет Inline-кнопку с заданным текстом и callback-данными.
*
* @param text текст кнопки
* @param callbackData данные, передаваемые при нажатии кнопки
* @return текущий экземпляр билдера
* @author marensovich
* @since 0.0.1
*/
public UniversalKeyboardBuilder addInlineButton(String text, String callbackData) {
InlineKeyboardButton inlineButton = new InlineKeyboardButton();
inlineButton.setText(text);
inlineButton.setCallbackData(callbackData);
currentInlineRow.add(inlineButton);
return this;
}
/**
* Завершает текущий ряд Inline-кнопок и создаёт новый.
*
* @return текущий экземпляр билдера
* @author marensovich
* @since 0.0.1
*/
public UniversalKeyboardBuilder nextInlineRow() {
inlineRows.add(currentInlineRow);
currentInlineRow = new ArrayList<>();
return this;
}
/**
* Завершает построение Inline-клавиатуры и возвращает готовую разметку.
*
* @return объект {@link InlineKeyboardMarkup} для отправки в Telegram API
* @author marensovich
* @since 0.0.1
*/
public InlineKeyboardMarkup buildInlineKeyboard() {
if (!currentInlineRow.isEmpty()) inlineRows.add(currentInlineRow);
InlineKeyboardMarkup markup = new InlineKeyboardMarkup();
markup.setKeyboard(inlineRows);
return markup;
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment