PARTE 1 ¡Aloha! En el artículo anterior creamos un sencillo bot que nos daba la bienvenida a cualquier evento. Ya hemos escrito miles de líneas de código y es hora de agregar funciones más complejas a nuestro bot. Hoy intentaremos escribir un bot simple para que en nuestro tiempo libre podamos perfeccionar nuestros conocimientos de Java Core antes de las entrevistas (sorprendentemente, no he encontrado ni un solo bot que funcione de este tipo). Para ello haremos lo siguiente:
- conectar una base de datos externa de Postgres a Heroku;
- Escribamos nuestros primeros scripts para inicializar y poblar la base de datos;
- conectemos Spring Boot Data JPA para trabajar con la base de datos;
- Implementamos varios escenarios de comportamiento de bot.
- registrarse en Heroku ;
- Vaya a nuestro panel -> Nuevo -> Crear nueva aplicación y cree una nueva aplicación;
- Entramos en la aplicación recién creada, nos intimidan los muchos botones, pero nos concentramos en el panel "Complementos instalados"; al lado hay un botón Configurar complementos, hacemos clic en él;
- Ingrese "Heroku Postgres" en la búsqueda, seleccione el plan "Hobby Dev - Gratis" -> Enviar formulario de pedido;
- Abra la base de datos recién obtenida -> Configuración -> Ver credenciales. Esta pestaña contendrá nuestras claves para acceder a la base de datos. Recordamos su ubicación; los necesitaremos para conectar la base de datos, como DataSource en IDEA.
- Lombok es una biblioteca gracias a la cual reduciremos significativamente la cantidad de código diferente. Con él podemos crear automáticamente constructores, definidores, captadores y mucho más.
- Spring Data JPA es un marco para trabajar con bases de datos (aunque suena demasiado simple). La descripción de las capacidades de Spring Data JPA equivaldría a una serie de artículos, y la dependencia que especificamos también implica Hibernate y mucho más, así que saltemos los detalles e intentemos escribir algo usando Spring JPA hoy.
- PostgreSQL: extraemos la biblioteca para obtener un controlador que funcione con nuestra base de datos.
DROP TABLE IF EXISTS java_quiz;
DROP TABLE IF EXISTS users;
CREATE SEQUENCE global_seq START WITH 100000;
CREATE TABLE users
(
id INTEGER PRIMARY KEY DEFAULT nextval('global_seq'),
chat_id INTEGER UNIQUE NOT NULL,
name VARCHAR NOT NULL,
score INTEGER DEFAULT 0 NOT NULL,
high_score INTEGER DEFAULT 0 NOT NULL,
bot_state VARCHAR NOT NULL
);
CREATE TABLE java_quiz
(
id INTEGER PRIMARY KEY DEFAULT nextval('global_seq'),
question VARCHAR NOT NULL,
answer_correct VARCHAR NOT NULL,
option1 VARCHAR NOT NULL,
option2 VARCHAR NOT NULL,
option3 VARCHAR NOT NULL
);
¿Qué hace nuestro guión? Las dos primeras líneas borran las tablas, si están presentes, para recrearlas. La tercera línea crea una secuencia que se utilizará para crear entradas de identificación únicas en nuestra base de datos. A continuación creamos dos tablas: para usuarios y para preguntas. El usuario tendrá una identificación única, identificación de chat de Telegram, nombre, cantidad de puntos (actual y máximo), así como el estado actual del bot. Las preguntas también tendrán una identificación única, así como campos responsables de la pregunta y opciones de respuesta. Podemos ejecutar el script resultante haciendo clic derecho sobre él y seleccionando "Ejecutar script SQL". Se debe prestar especial atención al elemento "Interfaz Cmd-Line": aquí necesitaremos PostgreSQL recién instalado. Al configurar este campo, seleccione "Nueva interfaz Cmd-Line" y especifique la ruta a psql.exe. Como resultado, la configuración debería verse así: Ejecutamos el script y si no nos hemos equivocado en ningún lado, el resultado de nuestro trabajo será el siguiente: <h3>Crear un modelo</h3>Ahora es el momento para volver a escribir código Java. Para abreviar el artículo, omitiré la descripción de las anotaciones utilizadas para escribir las clases para que puedas familiarizarte con ellas. Creemos un paquete modelo en el que tendremos tres clases:
- AbstractBaseEntity es una clase que describe cualquier objeto que pueda tener una identificación (esta clase es una gran simplificación de lo que podrías ver en una pasantía):
package com.whiskels.telegram.model; import lombok.Getter; import lombok.Setter; import javax.persistence.*; // Аннотация, которая говорит нам, что это суперкласс для всех Entity // https://vladmihalcea.com/how-to-inherit-properties-from-a-base-class-entity-using-mappedsuperclass-with-jpa-and-hibernate/ @MappedSuperclass // http://stackoverflow.com/questions/594597/hibernate-annotations-which-is-better-field-or-property-access @Access(AccessType.FIELD) // Аннотации Lombok для автогенерации сеттеров и геттеров на все поля @Getter @Setter public abstract class AbstractBaseEntity { // Аннотации, описывающие механизм генерации id - разберитесь в documentoации каждой! @Id @SequenceGenerator(name = "global_seq", sequenceName = "global_seq", allocationSize = 1, initialValue = START_SEQ) @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "global_seq") // See https://hibernate.atlassian.net/browse/HHH-3718 and https://hibernate.atlassian.net/browse/HHH-12034 // Proxy initialization when accessing its identifier managed now by JPA_PROXY_COMPLIANCE setting protected Integer id; protected AbstractBaseEntity() { } }
- Usuario :
package com.whiskels.telegram.model; import com.whiskels.telegram.bot.State; import lombok.AllArgsConstructor; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; import org.hibernate.annotations.BatchSize; import javax.persistence.*; import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotNull; import java.util.Set; import static javax.persistence.FetchType.EAGER; @Entity @Table(name = "users", uniqueConstraints = {@UniqueConstraint(columnNames = "chat_id", name = "users_unique_chatid_idx")}) @Getter @Setter @NoArgsConstructor @AllArgsConstructor public class User extends AbstractBaseEntity { @Column(name = "chat_id", unique = true, nullable = false) @NotNull private Integer chatId; @Column(name = "name", unique = true, nullable = false) @NotBlank private String name; @Column(name = "score", nullable = false) @NotNull private Integer score; @Column(name = "high_score", nullable = false) @NotNull private Integer highScore; @Column(name = "bot_state", nullable = false) @NotBlank private State botState; // Конструктор нужен для создания нового пользователя (а может и нет? :)) public User(int chatId) { this.chatId = chatId; this.name = String.valueOf(chatId); this.score = 0; this.highScore = 0; this.botState = State.START; } }
- Clase de preguntas :
package com.whiskels.telegram.model; import lombok.AllArgsConstructor; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.Table; import javax.validation.constraints.NotBlank; @Entity @Table(name = "java_quiz") @Getter @Setter @NoArgsConstructor @AllArgsConstructor public class Question extends AbstractBaseEntity { @Column(name = "question", nullable = false) @NotBlank private String question; @Column(name = "answer_correct", nullable = false) @NotBlank private String correctAnswer; @Column(name = "option2", nullable = false) @NotBlank private String optionOne; @Column(name = "option1", nullable = false) @NotBlank private String optionTwo; @Column(name = "option3", nullable = false) @NotBlank private String optionThree; @Override public String toString() { return "Question{" + "question='" + question + '\'' + ", correctAnswer='" + correctAnswer + '\'' + ", optionOne='" + optionOne + '\'' + ", optionTwo='" + optionTwo + '\'' + ", optionThree='" + optionThree + '\'' + '}'; } }
- JpaUserRepositorio:
package com.whiskels.telegram.repository; import com.whiskels.telegram.model.User; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; import org.springframework.transaction.annotation.Transactional; import java.util.Optional; @Repository @Transactional(readOnly = true) public interface JpaUserRepository extends JpaRepository<user, integer=""> { // По названию метода Spring сам поймет, что мы хотим получить пользователя по переданному chatId Optional<user> getByChatId(int chatId); } </user></user,>
- Repositorio de preguntas Jpa:
package com.whiskels.telegram.repository; import com.whiskels.telegram.model.Question; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.data.jpa.repository.Query; @Repository @Transactional(readOnly = true) public interface JpaQuestionRepository extends JpaRepository<question, integer=""> { // А здесь мы написали SQL Query, которая будет выбирать 1 случайный вопрос из таблицы вопросов @Query(nativeQuery = true, value = "SELECT * FROM java_quiz ORDER BY random() LIMIT 1") Question getRandomQuestion(); } </question,>
package com.whiskels.telegram.bot;
public enum State {
NONE,
START,
ENTER_NAME,
PLAYING_QUIZ,
}
A continuación, crearemos un paquete bot/handler en el que declararemos la interfaz del controlador:
package com.whiskels.telegram.bot.handler;
import com.whiskels.telegram.bot.State;
import com.whiskels.telegram.model.User;
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod;
import java.io.Serializable;
import java.util.List;
public interface Handler {
// основной метод, который будет обрабатывать действия пользователя
List<partialbotapimethod<? extends="" serializable="">> handle(User user, String message);
// метод, который позволяет узнать, можем ли мы обработать текущий State у пользователя
State operatedBotState();
// метод, который позволяет узнать, Cómoие команды CallBackQuery мы можем обработать в этом классе
List<string> operatedCallBackQuery();
}
</string></partialbotapimethod<?>
Crearemos los controladores un poco más tarde, pero por ahora deleguemos el procesamiento de eventos a la nueva clase UpdateReceiver , que crearemos en la raíz del paquete del bot: ¡ ATENCIÓN! Aquí y más allá habrá métodos que se muestran como Lista> handle(args); en realidad se ven así, pero el formateador de código los rompió:
package com.whiskels.telegram.bot;
import com.whiskels.telegram.bot.handler.Handler;
import com.whiskels.telegram.model.User;
import com.whiskels.telegram.repository.JpaUserRepository;
import org.springframework.stereotype.Component;
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod;
import org.telegram.telegrambots.meta.api.objects.CallbackQuery;
import org.telegram.telegrambots.meta.api.objects.Message;
import org.telegram.telegrambots.meta.api.objects.Update;
import java.io.Serializable;
import java.util.Collections;
import java.util.List;
@Component
public class UpdateReceiver {
// Храним доступные хендлеры в списке (подсмотрел у Miroha)
private final List<handler> handlers;
// Имеем доступ в базу пользователей
private final JpaUserRepository userRepository;
public UpdateReceiver(List<handler> handlers, JpaUserRepository userRepository) {
this.handlers = handlers;
this.userRepository = userRepository;
}
// Обрабатываем полученный Update
public List<partialbotapimethod<? extends="" serializable="">> handle(Update update) {
// try-catch, чтобы при несуществующей команде просто возвращать пустой список
try {
// Проверяем, если Update - сообщение с текстом
if (isMessageWithText(update)) {
// Получаем Message из Update
final Message message = update.getMessage();
// Получаем айди чата с пользователем
final int chatId = message.getFrom().getId();
// Просим у репозитория пользователя. Если такого пользователя нет - создаем нового и возвращаем его.
// Как раз на случай нового пользователя мы и сделали конструктор с одним параметром в классе User
final User user = userRepository.getByChatId(chatId)
.orElseGet(() -> userRepository.save(new User(chatId)));
// Ищем нужный обработчик и возвращаем результат его работы
return getHandlerByState(user.getBotState()).handle(user, message.getText());
} else if (update.hasCallbackQuery()) {
final CallbackQuery callbackQuery = update.getCallbackQuery();
final int chatId = callbackQuery.getFrom().getId();
final User user = userRepository.getByChatId(chatId)
.orElseGet(() -> userRepository.save(new User(chatId)));
return getHandlerByCallBackQuery(callbackQuery.getData()).handle(user, callbackQuery.getData());
}
throw new UnsupportedOperationException();
} catch (UnsupportedOperationException e) {
return Collections.emptyList();
}
}
private Handler getHandlerByState(State state) {
return handlers.stream()
.filter(h -> h.operatedBotState() != null)
.filter(h -> h.operatedBotState().equals(state))
.findAny()
.orElseThrow(UnsupportedOperationException::new);
}
private Handler getHandlerByCallBackQuery(String query) {
return handlers.stream()
.filter(h -> h.operatedCallBackQuery().stream()
.anyMatch(query::startsWith))
.findAny()
.orElseThrow(UnsupportedOperationException::new);
}
private boolean isMessageWithText(Update update) {
return !update.hasCallbackQuery() && update.hasMessage() && update.getMessage().hasText();
}
}
</partialbotapimethod<?></handler></handler>
Y le delegamos el procesamiento en la clase Bot:
package com.whiskels.telegram.bot;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.telegram.telegrambots.bots.TelegramLongPollingBot;
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod;
import org.telegram.telegrambots.meta.api.methods.send.SendMessage;
import org.telegram.telegrambots.meta.api.objects.Update;
import org.telegram.telegrambots.meta.exceptions.TelegramApiException;
import java.io.Serializable;
import java.util.List;
@Slf4j
@Component
public class Bot extends TelegramLongPollingBot {
@Value("${bot.name}")
@Getter
private String botUsername;
@Value("${bot.token}")
@Getter
private String botToken;
private final UpdateReceiver updateReceiver;
public Bot(UpdateReceiver updateReceiver) {
this.updateReceiver = updateReceiver;
}
@Override
public void onUpdateReceived(Update update) {
List<partialbotapimethod<? extends="" serializable="">> messagesToSend = updateReceiver.handle(update);
if (messagesToSend != null && !messagesToSend.isEmpty()) {
messagesToSend.forEach(response -> {
if (response instanceof SendMessage) {
executeWithExceptionCheck((SendMessage) response);
}
});
}
}
public void executeWithExceptionCheck(SendMessage sendMessage) {
try {
execute(sendMessage);
} catch (TelegramApiException e) {
log.error("oops");
}
}
}
</partialbotapimethod<?>
Ahora nuestro bot delega el procesamiento de eventos a la clase UpdateReceiver , pero aún no tenemos ningún controlador. ¡Vamos a crearlos! ¡DESCARGO DE RESPONSABILIDAD! Realmente quería compartir las posibilidades de escribir un bot de este tipo, por lo que el código adicional (como en principio el código UpdateReceiver) se puede refactorizar muy bien utilizando varios patrones. Pero estamos aprendiendo y nuestro objetivo es un bot mínimamente viable, así que como otra tarea, puedes refactorizar todo lo que viste :) Crea un paquete de utilidades y en él, la clase TelegramUtil :
package com.whiskels.telegram.util;
import com.whiskels.telegram.model.User;
import org.telegram.telegrambots.meta.api.methods.send.SendMessage;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.InlineKeyboardButton;
public class TelegramUtil {
public static SendMessage createMessageTemplate(User user) {
return createMessageTemplate(String.valueOf(user.getChatId()));
}
// Создаем шаблон SendMessage с включенным Markdown
public static SendMessage createMessageTemplate(String chatId) {
return new SendMessage()
.setChatId(chatId)
.enableMarkdown(true);
}
// Создаем кнопку
public static InlineKeyboardButton createInlineKeyboardButton(String text, String command) {
return new InlineKeyboardButton()
.setText(text)
.setCallbackData(command);
}
}
Escribiremos cuatro controladores: HelpHandler, QuizHandler, RegistrationHandler, StartHandler. Controlador de inicio:
package com.whiskels.telegram.bot.handler;
import com.whiskels.telegram.bot.State;
import com.whiskels.telegram.model.User;
import com.whiskels.telegram.repository.JpaUserRepository;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod;
import org.telegram.telegrambots.meta.api.methods.send.SendMessage;
import java.io.Serializable;
import java.util.Collections;
import java.util.List;
import static com.whiskels.telegram.util.TelegramUtil.createMessageTemplate;
@Component
public class StartHandler implements Handler {
@Value("${bot.name}")
private String botUsername;
private final JpaUserRepository userRepository;
public StartHandler(JpaUserRepository userRepository) {
this.userRepository = userRepository;
}
@Override
public List<partialbotapimethod<? extends="" serializable="">> handle(User user, String message) {
// Приветствуем пользователя
SendMessage welcomeMessage = createMessageTemplate(user)
.setText(String.format(
"Hola! I'm *%s*%nI am here to help you learn Java", botUsername
));
// Просим назваться
SendMessage registrationMessage = createMessageTemplate(user)
.setText("In order to start our journey tell me your name");
// Меняем пользователю статус на - "ожидание ввода имени"
user.setBotState(State.ENTER_NAME);
userRepository.save(user);
return List.of(welcomeMessage, registrationMessage);
}
@Override
public State operatedBotState() {
return State.START;
}
@Override
public List<string> operatedCallBackQuery() {
return Collections.emptyList();
}
}
</string></partialbotapimethod<?>
Controlador de registro:
package com.whiskels.telegram.bot.handler;
import com.whiskels.telegram.bot.State;
import com.whiskels.telegram.model.User;
import com.whiskels.telegram.repository.JpaUserRepository;
import org.springframework.stereotype.Component;
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.InlineKeyboardMarkup;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.InlineKeyboardButton;
import java.io.Serializable;
import java.util.List;
import static com.whiskels.telegram.bot.handler.QuizHandler.QUIZ_START;
import static com.whiskels.telegram.util.TelegramUtil.createInlineKeyboardButton;
import static com.whiskels.telegram.util.TelegramUtil.createMessageTemplate;
@Component
public class RegistrationHandler implements Handler {
//Храним поддерживаемые CallBackQuery в виде констант
public static final String NAME_ACCEPT = "/enter_name_accept";
public static final String NAME_CHANGE = "/enter_name";
public static final String NAME_CHANGE_CANCEL = "/enter_name_cancel";
private final JpaUserRepository userRepository;
public RegistrationHandler(JpaUserRepository userRepository) {
this.userRepository = userRepository;
}
@Override
public List<partialbotapimethod<? extends="" serializable="">> handle(User user, String message) {
// Проверяем тип полученного события
if (message.equalsIgnoreCase(NAME_ACCEPT) || message.equalsIgnoreCase(NAME_CHANGE_CANCEL)) {
return accept(user);
} else if (message.equalsIgnoreCase(NAME_CHANGE)) {
return changeName(user);
}
return checkName(user, message);
}
private List<partialbotapimethod<? extends="" serializable="">> accept(User user) {
// Если пользователь принял Nombre - меняем статус и сохраняем
user.setBotState(State.NONE);
userRepository.save(user);
// Создаем кнопку для начала игры
InlineKeyboardMarkup inlineKeyboardMarkup = new InlineKeyboardMarkup();
List<inlinekeyboardbutton> inlineKeyboardButtonsRowOne = List.of(
createInlineKeyboardButton("Start quiz", QUIZ_START));
inlineKeyboardMarkup.setKeyboard(List.of(inlineKeyboardButtonsRowOne));
return List.of(createMessageTemplate(user).setText(String.format(
"Your name is saved as: %s", user.getName()))
.setReplyMarkup(inlineKeyboardMarkup));
}
private List<partialbotapimethod<? extends="" serializable="">> checkName(User user, String message) {
// При проверке имени мы превентивно сохраняем пользователю новое Nombre в базе
// идея для рефакторинга - добавить временное хранение имени
user.setName(message);
userRepository.save(user);
// Haciendo кнопку для применения изменений
InlineKeyboardMarkup inlineKeyboardMarkup = new InlineKeyboardMarkup();
List<inlinekeyboardbutton> inlineKeyboardButtonsRowOne = List.of(
createInlineKeyboardButton("Accept", NAME_ACCEPT));
inlineKeyboardMarkup.setKeyboard(List.of(inlineKeyboardButtonsRowOne));
return List.of(createMessageTemplate(user)
.setText(String.format("You have entered: %s%nIf this is correct - press the button", user.getName()))
.setReplyMarkup(inlineKeyboardMarkup));
}
private List<partialbotapimethod<? extends="" serializable="">> changeName(User user) {
// При pedidoе изменения имени мы меняем State
user.setBotState(State.ENTER_NAME);
userRepository.save(user);
// Создаем кнопку для отмены операции
InlineKeyboardMarkup inlineKeyboardMarkup = new InlineKeyboardMarkup();
List<inlinekeyboardbutton> inlineKeyboardButtonsRowOne = List.of(
createInlineKeyboardButton("Cancel", NAME_CHANGE_CANCEL));
inlineKeyboardMarkup.setKeyboard(List.of(inlineKeyboardButtonsRowOne));
return List.of(createMessageTemplate(user).setText(String.format(
"Your current name is: %s%nEnter new name or press the button to continue", user.getName()))
.setReplyMarkup(inlineKeyboardMarkup));
}
@Override
public State operatedBotState() {
return State.ENTER_NAME;
}
@Override
public List<string> operatedCallBackQuery() {
return List.of(NAME_ACCEPT, NAME_CHANGE, NAME_CHANGE_CANCEL);
}
}
</string></inlinekeyboardbutton></partialbotapimethod<?></inlinekeyboardbutton></partialbotapimethod<?></inlinekeyboardbutton></partialbotapimethod<?></partialbotapimethod<?>
Controlador de ayuda:
package com.whiskels.telegram.bot.handler;
import com.whiskels.telegram.bot.State;
import com.whiskels.telegram.model.User;
import org.springframework.stereotype.Component;
import org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod;
import org.telegram.telegrambots.meta.api.methods.send.SendMessage;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.InlineKeyboardMarkup;
import org.telegram.telegrambots.meta.api.objects.replykeyboard.buttons.InlineKeyboardButton;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import static com.whiskels.telegram.bot.handler.RegistrationHandler.NAME_CHANGE;
import static com.whiskels.telegram.util.TelegramUtil.createInlineKeyboardButton;
import static com.whiskels.telegram.util.TelegramUtil.createMessageTemplate;
@Component
public class HelpHandler implements Handler {
@Override
public List<partialbotapimethod<? extends="" serializable="">> handle(User user, String message) {
// Создаем кнопку для смены имени
InlineKeyboardMarkup inlineKeyboardMarkup = new InlineKeyboardMarkup();
List<inlinekeyboardbutton> inlineKeyboardButtonsRowOne = List.of(
createInlineKeyboardButton("Change name", NAME_CHANGE));
inlineKeyboardMarkup.setKeyboard(List.of(inlineKeyboardButtonsRowOne));
return List.of(createMessageTemplate(user).setText(String.format("" +
"You've asked for help %s? Here it comes!", user.getName()))
.setReplyMarkup(inlineKeyboardMarkup));
}
@Override
public State operatedBotState() {
return State.NONE;
}
@Override
public List<string> operatedCallBackQuery() {
return Collections.emptyList();
}
}
</string></inlinekeyboardbutton></partialbotapimethod<?>
QuizHandler (el peor
GO TO FULL VERSION