Разработка Telegram-бота на JAVA для генерации и считывания QR-кодов
Разработка Telegram-бота для работы с QR-кодами
Разработка Telegram-бота на JAVA для генерации и считывания QR-кодов
Введение
С недавнего времени QR-коды всерьез, и похоже, надолго вошли в нашу жизнь. QR-код – это простой по своей сути, но при этом чрезвычайно полезный в прикладном плане механизм графического кодирования информации. Мать-прародительница (компания DENSO) внедрила использование QR-кодов с целью оптимизации временных издержек в производственных процессах. К сожалению, на сегодняшний день с введением ограничений со стороны властей на посещение общественных заведений, понятие «QR-код» приобрело негативный окрас, заставляя многих вздрагивать при его упоминании, от чего даже становится немного грустно, ведь не для ограничений были созданы эти черно-белые квадраты.
О QR-кодах я не так давно писал в своей первой публикации Почему введение проверки QR-кодов не имеет смысла в общественном транспорте и торговых центрах?, не смотря на сравнительно небольшой объем технических подробностей, данный материал получил множество положительных откликов, что на время позволило мне войти в первую сотню авторов. Не скрою, это было неожиданным и приятным сюрпризом, большое спасибо всем тем, кто плюсовал в карму, конструктивно критиковал и дискутировал в комментариях.
Во время подготовки первой статьи я отметил для себя, что инструментария работы с QR-кодами может не быть под рукой, либо его функционала будет недостаточно для покрытия текущих потребностей. Например, приложение для считывания QR-кодов не установлено в телефоне, либо возникает необходимость отсканировать QR-код с электронного изображения. Ну и самое интересное, если есть возможность считать код, то должен быть инструмент для того, чтобы его сгенерировать. Так возникла идея разработки Telegram-бота, функционал которого позволяет сканировать и генерировать QR-коды.
Плюсы использования Telegram-бота в сравнении с традиционными приложениями-сканерами это: отсутствие необходимости ставить дополнительный софт (при наличии телеги, естественно), возможность чтения цифровых изображений без использования камеры (например, из галереи или с web-сайта) и кроссплатформенность.
Нельзя забывать и о минусах, для пользователя отправка личных данных в сеть может быть чревата их компрометацией, кроме того, работа бота зависит от наличия сети и доступности сервера, на котором запущено приложение.
Логика работы бота проста – отправляешь боту QR-код, в ответе получаешь расшифрованную информацию, отправляешь текст – в ответе получаешь QR-код. Просто? Да! Удобно? Несомненно!
Целевая аудитория
Материал статьи сравнительно несложен, не думаю, что он подойдет для людей, делающих свои первые шаги в программировании, но если опыт разработки на объектно-ориентированных языках имеется, то проблем, препятствующих восприятию, возникнуть не должно.
Если вы еще не разработали своего первого Telegram-бота, либо вам хочется понять, как работают механизмы отправки/приема файлов или же познакомиться с работой одной из самых популярных библиотек для работы с QR-кодами в JAVA – ZXING, то этот пост для вас.
Получение имени и токена бота
Не думаю, что стоит подробно описывать процесс регистрации бота и получения токена, ибо на эту тему было написано множество статей, но если есть вопросы о том, кто такой @BotFather и что с ним делать, то можно почитать материал Всё, о чём должен знать разработчик Telegram-ботов или оставить вопрос в комментариях.
Итак, у нас имеется имя бота (в моем случае – @QRVisorBot) и токен, по понятным причинам значение токена не выкладываю, т.к. это конфиденциальная информация, важно понимать, что лица, имеющие доступ к токену, имеют максимальные полномочия на управление ботом, так что держите токен при себе, если не хотите, чтобы доступ к управлению вашим ботом получили третьи лица.
Создание проекта
Создаем JAVA-проект, лично я работаю в IDE JETBRAINS IDEA, для сборки использую сборщик проектов MAVEN, поэтому буду указывать список зависимостей для данного сборщика.
Настройки бота
Дабы не хардкодить настроечную информацию, выносим ее в файл настроек, для этого в папке ресурсов (resources) создаем текстовый файл с именем «config.properties», в котором прописываем полученные имя и токен чат-бота:
token = 0000000000:XXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
username = QRVisor
, где:
token – значение токена;
username – имя бота.
Чтобы настройки были доступны в рантайме, я создал класс BotSettings (код ниже), который считывает значения настроек из файла config.properties. Здесь и далее я использую плагин LOMBOK, он служит для уменьшения количества типового кода, не думаю, что программируя на JAVA вы могли пройти мимо него, но если так, то настоятельно рекомендую ознакомиться с его функционалом. Также стоит обозначить, что в классе BotSettings используется порождающий шаблон проектирования СИНГЛТОН, служит он для того, чтобы не было возможности создать несколько экземпляров класса в одном потоке.
Основная логика чат-бота
Основная логика бота размещена в классе BotProcessor (код ниже). Несмотря на то, что бот имеет достаточно простой алгоритм работы, пара команд ему все-таки потребуется. Для возможности работы с командами необходимо основной класс бота унаследовать от TelegramLongPollingCommandBot. TelegramLongPollingCommandBot – содержит методы обработки команд.
Переопределяемые методы базового класса (TelegramLongPollingCommandBot):
getBotUsername – возвращает имя пользователя, на которого зарегистрирован бот;
getBotToken – возвращает токен;
onRegister – действие после регистрации бота (в нашем случае просто вызываем метод класса-родителя);
processNonCommandUpdate – обрабатывает сообщение, которое не является зарегистрированной командой;
processInvalidCommandUpdate – действие при отправке боту некорректной команды.
Методы обработки сообщений:
getMessageType – определяет тип сообщения (типы сообщений бота перечислены в MessageType).
sendMessage – отправляет сообщение в заданный чат.
sendImage – отправляет изображение в заданный чат.
sendQRImage – отправляет QR-код в заданный чат (отличается от sendImage тем, что отправленное изображение QR-кода необходимо удалить).
processImage – обрабатывает полученное от пользователя изображение. TELEGRAM API хранит несколько размеров изображений, получить которые можно с помощью метода getPhoto, каждый файл имеет собственный идентификатор, список сохраняем в коллекцию photoSizes, наибольший размер изображения соответствует максимальному индексу коллекции (нам нужен именно он). Ссылку для скачивания файла получаем с помощью метода getFileUrl (описан ниже).
setRegisteredCommands – регистрирует команды бота. Для того, чтобы чат-бот мог распознавать команды, их необходимо зарегистрировать. Но как? О том, как создавать команды описано в секции «Команды».
getFileRequest – метод запрашивает информацию о файле хранилища, возвращает информацию о файле в формате JSON, ссылка на файл хранилища имеет вид: https://api.telegram.org/bot<token>/getFile?file_id=<file_id>, где: token – токен бота, file_id – идентификатор файла.
getFileUrl – возвращает ссылку на файл хранилища, для этого сначала запрашиваем информацию о файле (метод getFileRequest), откуда получаем путь к файлу в хранилище (поле «file_path»). Ссылка на файл имеет вид: https://api.telegram.org/file/bot<token>/<path>, где token – токен бота, path – путь к файлу в хранилище.
registerBot – подключает бот к Telegram API.
Зависимости:
Команды
Команды должны имплементировать интерфейс IBotCommand, в моей реализации интерфейс имплементируется абстрактным классом Command, от которого наследуются классы, содержащие реализацию команд (классы CommandStart и CommandHelp).
В боте имеются команды /START и /HELP, по наименованию команд несложно догадаться, что они выполняются при запуске бота и при запросе справки, соответственно. Логика команд содержится в классах CommandStart и CommandHelp (код ниже).
С реализацией команд все понятно, но как быть в случае, если пользователь отправит боту незарегистрированную команду? Для обработки подобных ситуаций необходимо переопределить метод processInvalidCommandUpdate.
Запуск приложения
Основную логику приложения разработали, но как его запустить? Для запуска используем класс Main (код ниже), в основном методе main создаем инстанс разработанного нами Telegram-бота. Запускаем… Работает!
Работа с QR-кодами (ZXing)
Для работы с QR-кодами я использовал open-source библиотеку ZXing (zebra crossing), назначение которой – работа с штрих- и QR-кодами.
Для обработки QR-кодов я разработал класс QRTools (код ниже).
Методы:
getBitmapFromUrl – возвращает изображение по url-адресу, как мы помним, изображения хранятся в хранилище telegram, данный метод возвращает объект BinaryBitmap библиотеки Zxing
decodeBitmap – декодирует изображение в текст
encodeText – кодирует текст в QR-код, полученному изображение сохраняется в файл с уникальным именем, метод возвращает путь к файлу.
getTextFromQR – возвращает текст, который содержит QR-код.
Зависимости:
Обработка ошибок
Не могу не написать про необходимость обработки исключений. Вы можете со мной поспорить, но на мой взгляд, стабильность работы приложения и информативность сообщений о возникающих в ходе выполнения ошибок, даже важнее оптимальности и скорости работы алгоритмов, заложенных в программу. Для проброса ошибок, которые адресованы пользователю, создан класс UserException, данное исключение служит для того, чтобы пользователь получал лишь информацию об успешности выполнения его запросов, более подробная (системная информация) должна попадать в лог.
Логгирование
Для логгирования я воспользовался библиотекой SLF4J. Бот не собирает информацию о личных данных, отправляемых пользователем, механизм протоколирования используется лишь для отладки.
Зависимости:
Ресурсы
Найти бот в Telegram можно по имени: @QRVisorBot
Заключение
Друзья, я рассмотрел создание сравнительно простого, но имеющего практическое применение бота, буду чрезвычайно рад если и бот, и данный материал будут вам полезны. Если я что-то упустил, или вы обнаружите неточность, пишите мне, постараюсь ответить на все вопросы.
Есть идея для написания следующей статьи, хотел бы поделиться своими изысканиями на тему работы с API Tinkoff-Инвестиции, в планах написать пример торгового робота. Но это если вам, что называется, зайдет данный материал.
Желаю читателям здоровья и терпения, надеюсь, что в скором времени с нас снимут ограничения на посещение общественных мест по QR-кодам.
Генератор QR-кода для Telegram аккаунта
Чтобы создать QR-код для перехода на канал, публичный чат, бота в Telegram или к переписке с конкретным пользователем в Telegram, укажите имя пользователя (@username) или канала или чата или бота.
Узнать имя пользователя можно в профиле пользователя.
Если у вас ещё не установлен @username в Telegram, вы можете установить его в настройках своего профиля в приложении.
Если вы создаёте QR код не для канала, а для связи непосредственно с вами, вы можете указать номер телефона. Номер телефона нужно указывать в международном формате — начиная с символа «+», без тире и скобок.
*Если вы указываете номер телефона, не забудьте проверить свои настройки приватности в приложении. Номер телефона должен быть открыт для всех. Если вы его скрываете или он доступен только вашим добавленным контактам, ссылка с номером не будет работать или будет работать только у ваших контактов, в этом случае лучше использовать имя пользователя (@username).
При использовании номера телефона, при переходе по ссылке, пользователи которые давно не обновляли своё приложение, могут видеть сообщение об ошибке «Истёк срок действия ссылки». Решение проблемы — обновить приложение. Ссылка с @username будет работать у всех.
Вы можете выбрать цвет QR-кода. Нажимайте на ссылки, чтобы выбрать чёрный или фирменный цвет — как цвет логотипа Telegram. Или выберите любой цвет из палитры. Если вы используете нестандартные соотношения цветов, стоит подбирать сочетания цветов так, чтобы сохранялся хороший контраст между фоном и самим кодом. При плохом контрасте цветов, могут возникать трудности при сканировании.
Вы можете вставить логотип Telegram в центр QR-кода, выберите цвет логотипа: чёрный или оригинальный цвет логотипа Telegram, если логотип не нужен, выберите пункт «Нет» в настройке логотипа.
Сканировать такой код можно при помощи любого приложения с универсальным куар-сканером для мобильных устройств, при помощи сканера в мобильном браузере.
Вы также можете воспользоваться формами для создания QR-кода на другие случаи или общим, универсальным генератором QR кода
Как сделать qr code telegram
Содержание:
- Как создать QR-код для своего аккаунта в Telegram
- Как создать QR-код для своего аккаунта во «ВКонтакте»
- Как прочитать QR-коды приложений с телефона
Как создать QR-код для своего аккаунта в Telegram
Возможность создавать собственные куар-коды для пользователей Telegram добавил в мобильное приложение в конце 2021 года.
Зайдите в «Настройки». Проверьте, выбрано ли у вас имя пользователя. Если нет — задайте его.
После этого в левом верхнем углу появится значок QR-кода.
Перейдите в раздел и выберите дизайн картинки.
QR-кодом можно поделиться в соцсетях, мессенджерах или сразу отправить его в сторис Instagram (если приложение доступно на вашем устройстве).
Аналогичные куар-коды можно создать для групп, каналов и ботов: для этого нужно перейти в настройки группы / канала / бота.
Как создать QR-код для своего аккаунта во «ВКонтакте»
В приложении перейдите на свой профиль в социальной сети. Кнопка с QR-кодом будет доступна вверху страницы.
Вы можете создать оригинальный дизайн кода, поделиться им с друзьями или сохранить на устройство.
Создать QR-код для перехода на профиль ВК также можно с десктопной версии: откройте свою страничку и перейдите в раздел «Ссылка на профиль». Здесь можно будет создать QR-код в простом дизайне или скопировать ссылку на профиль.
Как прочитать QR-коды приложений с телефона
В том же разделе «ВКонтакте», где вы создавали QR-код, доступен сканер, который распознает коды других людей. Чтобы им воспользоваться, нужно навести камеру на код или предварительно сохранить изображение с кодом в галерее на смартфоне, а затем открыть его в сканере. Сервис распознает коды не только от «ВКонтакте», но и от других соцсетей.
Если вы не пользуетесь «ВКонтакте», распознавание кодов обычно заложено в функции встроенной камеры смартфона — достаточно навести камеру на код, чтобы появилось предложение перейти по ссылке.
Еще один способ — скачать специализированную программу для чтения QR-кодов, например, Google Lens. В опциях таких программ также часто есть сканирование кода с сохраненного на устройстве файла.
Фото в тексте: RB.ru. Обложка: Unsplash.
Подписывайтесь на наш Telegram-канал, чтобы быть в курсе последних новостей и событий!
QR код в Телеграмм для канала
Лента
Qr код телеграмм используются для многих целей. К примеру, с их помощью можно совершить вход в свой профиль на ПК, если до этого вы пользовались версией мессенджера для телефона, или можно сгенерировать qr ссылку-приглашение на канал. Рассказываем, как сделать qr код для Telegram.
Где находится qr код в мессенджере Телеграм
На свой собственный профиль в телеграм делать qr-code специально нет необходимости, так как мессенджер сам создает его в приложении.
Чтобы найти его на Андроиде:
- откройте боковое меню телеграмма, нажав на три горизонтальные полосы;
- тапните на фотографию своего профиля в верхнем левом углу экрана;
- а затем — на значок куар кода (иконка с квадратиками и точками).
На Айфоне QR код можно открыть при помощи настроек, слева от фотографии вашего профиля.
QR code, который создает Telegram, позволяет вам выбрать фон и цвет для создания картинки с кодом, а также поделиться ей через соцсети, сообщения и так далее.
Как сделать qr код на Телеграмм канал
Внутри самого мессенджера Telegram уже есть автоматические QR коды не только для ссылок на аккаунты, но и для каналов и ботов. Функция это очень удобна как для владельцев каналов, так и для обычных пользователей, так как её нередко используют в качестве приглашения в сообщество. Найти кьюар ссылку на канал можно в разделе с его описанием.
- Откройте канал и кликните вверху на название;
- В графе «Информация» будет ссылка-приглашение в виде qr кода.
- Выберите фон и нажмите «поделиться»
Также можно создать куар код на какой-то конкретный пост на канале. Для этого необходимо скачать специальную программу, которая может генерировать подобные шифры. Куар шифр для поста на канале может оказаться очень полезным и эффективным средством развития своего сообщества, а приложений и программ, генерирующих подобные коды, на просторах интернета можно найти целое множество. И что немаловажно – все они бесплатны. Инструкция проста: сначала нужно скачать 2 приложения — сам Messenger и генератор QR шифров.
Чтобы сделать куар код публикацию канала, выполните следующие действия:
- Откройте Messenger и зайдите на канал;
- Найдите нужный пост и кликните рядом с ним;
- Кликните на «Копировать ссылку»;
- Запустите приложение или программу для генерирования куар кодов;
- Вставьте скопированную ссылку и сгенерируйте код;
- Теперь вы можете отправить готовый QR code на пост любому пользователю.
Этот же способ подходит и для создания кьюар шифра для группового чата, только нужно скопировать ссылку на приглашение в группу.
Как в Телеграм сканировать qr код
К сожалению, в телеграм нет встроенного сканера для QR кодов. Следовательно, с помощью самого приложения мессенджера не получается отсканировать куар шифр-приглашение на канал. Для этого придется воспользоваться сторонними ресурсами.
В новых моделях телефонов функция сканирования QR шифров чаще всего заложена в саму камеру смартфона. Значит, чтобы распознать QR код, необходимо просто запустить приложение камеры на телефоне, навести её на изображение кода (или вставить картинку кода из галереи), дождаться, когда появятся предложение перехода по ссылке и перейти по ней.
Если в вашей камере нет такой встроенной функции, вы можете скачать специальную программу для распознавания QR шифров. Принцип работы таких программ схож с описанным ранее.
Вход в Телеграмм веб по QR коду
Для начала, нужно отметить: чтобы пройти авторизацию через веб-версию телеграмма QR code не обязателен. Правда, для этого на каком-то из устройств (на компьютере или телефоне) должна быть запущена сессия. Чтобы войти в Telegram с помощью сайта, введите номер своего мобильного и наберите полученную цифровую комбинацию.
Тем не менее авторизация в веб-версии Телеграмма при помощи QR шифра позволяет войти в свой личный кабинет максимально быстро, потому что в этом случае нет нужды в вводе своего телефонного номера или проверочного кода от мессенджера. Нужно просто отсканировать QR code с помощью приложения Telegram.
Главным условием, позволяющим авторизоваться в Телеграмме онлайн, является наличие скачанного приложения на телефоне и компьютере.