हम NodeJS और टाइपस्क्रिप्ट पर फिल्मों की ट्रैकिंग के लिए टेलीग्राम बॉट विकसित कर रहे हैं

आपके साथ ऐसा हुआ है कि आप सिनेमा में आते हैं और फिल्म शुरू होने से पहले ट्रेलर देखते हैं, जबकि उनमें से कुछ आपको काफी मजबूती से जकड़ लेते हैं और आप खुद को इस फिल्म को देखने का वादा करते हैं यदि सिनेमा में नहीं, तो कम से कम बाद में, जब यह डाउनलोड के लिए उपलब्ध हो। ? मैंने सुझाव देने की हिम्मत की कि हाँ। लेकिन अक्सर यह इस तथ्य के साथ समाप्त होता है कि आप सफलतापूर्वक इसके बारे में भूल जाते हैं और, सबसे अच्छी स्थिति में, गलती से इस फिल्म को पहले से जारी फिल्मों की सूची के माध्यम से स्क्रॉल करके पाते हैं।

मुझे अक्सर ऐसी समस्या का सामना करना पड़ा और इसे ईव - टेलीग्राम-बॉट के साथ बनाने का फैसला किया, जो मुझे मेरी पसंदीदा फिल्मों की रिलीज के बारे में नहीं भूलने में मदद करता है। यह क्या है, यह कैसे काम करता है और इसे कैसे विकसित किया गया था, आप कट के नीचे पढ़ सकते हैं!

• प्रस्तावना
• क्यों?
• प्रौद्योगिकी चयन
• Telegraf.js
• परियोजना की संरचना
• इनिशियलाइज़ेशन एंड लॉन्च
• उपयोगकर्ता इनपुट संभालें
• स्थानीयकरण
• निष्कर्ष

प्रस्तावना

यह लेख टेलीग्राम बॉट बनाने पर एक विस्तृत मार्गदर्शिका नहीं है। और यद्यपि लेख के पाठ्यक्रम में मैं अक्सर अपनी परियोजना का उल्लेख करूंगा, इस सामग्री का उद्देश्य सामान्य रूप से विकास के बारे में एक कहानी है, अर्थात् प्रौद्योगिकियों, प्रमुख बिंदुओं और नुकसान की पसंद जो मुझे सामना करना पड़ा।

क्यों?

इसलिए, जैसा कि मैंने ऊपर लिखा था, मैं अक्सर उन फिल्मों को देखना भूल जाता हूं, जिनका ट्रेलर मुझे पसंद आया। मैं लंबे समय से इस समस्या के समाधान के बारे में सोच रहा था। मेरे लिए पहली बात यह थी कि स्मार्टफोन के लिए एक देशी एप्लिकेशन का निर्माण किया गया था, लेकिन तब से मैंने ऐसा पहले कभी नहीं किया है, इसमें बहुत समय लगेगा और इस तथ्य पर नहीं कि अंतिम परिणाम मेरी जरूरतों को पूरा करेगा, साथ ही संभावित उपयोगकर्ताओं की जरूरतों को भी पूरा करेगा।

अगला विचार PWA बनाने का था। प्रौद्योगिकी से परिचित होने के लिए यह काफी दिलचस्प विकल्प है, लेकिन मैंने इसे भविष्य के लिए छोड़ने का फैसला किया। उसी समय, मैं लंबे समय से टेलीग्राम का उपयोग कर रहा हूं और इस सभी समय के दौरान मैंने पर्याप्त संख्या में बॉट जमा किए हैं जो समय-समय पर मेरे जीवन को थोड़ा आसान बनाते हैं। अंततः, सभी पेशेवरों और विपक्षों को तौलना के बाद, मैंने फैसला किया कि यह मंच इस विचार के लिए एकदम सही है।

प्रौद्योगिकी चयन

यदि आप टेलीग्राम बॉट्स के लिए जीथब के माध्यम से जाते हैं, तो आप देख सकते हैं कि उनमें से अधिकांश पायथन में लिखे गए हैं। पायथन वास्तव में इस विचार के लिए एक महान भाषा और महान है, लेकिन मैं इस परियोजना को विशेष रूप से NodeJS + टाइपस्क्रिप्ट पर लागू करना चाहता था। उपयुक्त फ़िल्टर्स को लागू करते हुए, मुझे 2 काफी लोकप्रिय उपकरण मिले: नोड-टेलीग्राम-बॉट-एपी और टेलीग्राफ.जेएस ।

बॉट्स विकसित करने के इस अनुभव से पहले मेरे पास ऐसा नहीं था, इसलिए जब इन दोनों को चुनते हैं तो यह स्पष्ट नहीं था कि किन मापदंडों को देखा जाना चाहिए। नतीजतन, प्रलेखन को देखने और प्रत्येक पुस्तकालयों के मुद्दों के माध्यम से देखने के बाद, मैं Telegraf.js पर बस गया। निर्णायक कारक बिचौलियों की उपलब्धता थी, जिसे उसी तरह से डिज़ाइन किया गया है जैसे कि लोकप्रिय एक्सप्रेस.जे. रूपरेखा। Telegraf.js में एक अधिक लगातार अद्यतन इतिहास और अच्छी तरह से संरचित प्रलेखन है, जो बताता है कि डेवलपर्स उपकरण को बेहतर बनाने में पर्याप्त प्रयास कर रहे हैं। इसके अलावा, इसमें टाइपस्क्रिप्ट के लिए टिपिंग शामिल है, जो निश्चित रूप से चयनित स्टैक के लिए एक प्लस है।

Telegraf.js

Telegraf.js मुख्य पुस्तकालय है जिस पर परियोजना लिखी गई थी। यह कई दिलचस्प तरीकों का उपयोग करता है जो आपको कोड की सादगी को बनाए रखते हुए जटिल बॉट बनाने की अनुमति देता है। नीचे सबसे दिलचस्प तंत्र हैं:

• Middlewares - हाँ, ये वही मिडवेअर हैं जो Express.js में उपलब्ध हैं। जब उपयोगकर्ता बॉट को कुछ भेजता है, तो संदेश पहले सभी पंजीकृत मिडवाइवर्स के माध्यम से जाता है, और उसके बाद यह नियंत्रक को मिलता है। मध्यवर्गीय संदर्भ को संशोधित कर सकते हैं, साथ ही अनुरोध के निष्पादन को निलंबित कर सकते हैं, उदाहरण के लिए, यदि एक नियमित उपयोगकर्ता प्रशासकों के लिए क्षेत्र में आने की कोशिश करता है। Telegraf.js बॉक्स से कुछ बेहद उपयोगी बिचौलियों को प्रदान करता है, लेकिन आप उन्हें स्वयं भी उपयोग कर सकते हैं। नामवर मध्यवर्गीयों को Telegraf.js की हत्यारा विशेषताएं माना जाता है
• सत्र - सत्र जो जानकारी को स्टोर कर सकते हैं जो नियंत्रक से बंधा नहीं है। आप वैश्विक चर के साथ एक सादृश्य दे सकते हैं जो बॉट में कहीं से भी सुलभ हैं। एक बहुत ही सुविधाजनक चीज, जिसका उपयोग किया जाता है, उदाहरण के लिए, स्थानीयकरण के लिए। सत्रों को अलग-अलग मोड में स्टोर करना संभव है - DB, redis, स्थानीय फाइलें, आदि।
• वेबूक - बॉट दो मोड में काम कर सकते हैं - लंबी पोलिंग या वेबहूक । और यद्यपि वे समान रूप से तेजी से काम करते हैं, उत्पादन वातावरण में दूसरे विकल्प का उपयोग करना बेहतर होता है। इस प्रकार, बॉट को टेलीग्राम सर्वर पर दस्तक देने की आवश्यकता नहीं होगी, इसके बजाय, वह सभी अपडेट स्वयं प्राप्त करेगा।
  
  महत्वपूर्ण: Webhooks के लिए एक शर्त SSL / TLS सर्वर के लिए समर्थन है। यह भी सुनिश्चित करें कि जिस पोर्ट पर Webhook चल रहा है वह बाहर से खुला और सुलभ है।
• मार्कअप - इस वर्ग के साथ आप मार्कअप / मार्कडाउन मार्कअप में जवाब देने के लिए बॉट सिखा सकते हैं। यह महत्वपूर्ण है अगर, उदाहरण के लिए, आप एक HTML गेम बना रहे हैं। हालाँकि, मेरी परियोजना में, मैंने इसे केवल बोल्ड / इटैलिक पाठ के लिए उपयोग किया।
• स्टेज एक बेहद दिलचस्प मॉड्यूल है जिसने मुझे मेरी नसों और कुछ घंटों के विकास को बनाए रखने में मदद की। यहाँ मैं और अधिक विस्तार से बताऊंगा।
  बॉट उपयोगकर्ता के संदेशों को सुन सकता है और, संदेश के प्रकार या सामग्री के आधार पर, इसे एक या किसी अन्य नियंत्रक पर पुनर्निर्देशित करता है, जो इसके कार्य को करेगा और उपयोगकर्ता को एक प्रतिक्रिया भेजेगा। यह इस तरह दिखता है:
  
  

  bot.hears('hello', async ctx => { await ctx.reply('Hello!'); }); 

  
  यह बस काम करता है: यदि आप बॉट को नमस्ते लिखते हैं, तो यह बस नमस्ते का जवाब देगा! काम के इस पहलू को जानने के बाद, यह कल्पना करने की कोशिश करें कि बॉट फिल्मों की खोज के लिए कैसे काम कर सकता है:
  
  
  1. उपयोगकर्ता लिखता है कि वह फिल्मों की खोज में जाना चाहता है;
  2. उपयोगकर्ता फिल्म का नाम चलाता है;
  3. बॉट फिल्मों की सूची लौटाता है और उपयोगकर्ता को अपनी लाइब्रेरी में चयनित फिल्म को बचाने के लिए प्रेरित करता है;
  4. ...
  
  ध्यान दें, एक सवाल! जब कोई उपयोगकर्ता उसे एक फिल्म की तलाश शुरू करना चाहता है, और जब वह फिल्म का नाम लिखता है, तो वह कैसे अंतर कर सकता है?
  
  हां, आप किसी भी भेजे गए पाठ को फिल्म के नाम के रूप में ले सकते हैं, लेकिन हम बॉट को लाठी और हुकर्स के साथ एक अच्छा इंटरफ़ेस बनाना चाहते हैं।
  
  और यहाँ दृश्य (स्टेज) खेल में आते हैं! ऊपर दिए गए उदाहरण से बताना आसान होगा। जब उपयोगकर्ता कहता है कि वह फिल्मों की तलाश में जाना चाहता है, तो हम इस दृश्य को लॉन्च करते हैं। इस दृश्य के अंदर अलग-अलग टेक्स्ट हैंडलर हैं - bot.hears (...)। इस प्रकार, बाद के सभी संदेश फिल्मों की खोज से सीधे संबंधित होंगे जब तक कि उपयोगकर्ता दृश्य से बाहर निकलने के लिए संदेश नहीं लिखता है। उसके बाद, इस दृश्य के अंदर के हैंडलर को तब तक निष्क्रिय कर दिया जाता है, जब तक उपयोगकर्ता फिर से वहां नहीं लौटता। आगे मैं वर्णन करूंगा कि कैसे मैंने इवेंट हैंडलिंग को सरल बनाने के लिए दृश्यों का उपयोग किया।
  

परियोजना की संरचना

इस बात पर संदेह है कि यह लेख काफी बड़ा हो जाएगा, और इसलिए, इसे आगे भी नहीं बढ़ाने के लिए, मैं कुछ बिंदुओं को छोड़ दूंगा। उदाहरण के लिए, बॉट के लिए काम करना शुरू करने के लिए, आपको टेलीग्राम बॉट एपीआई टोकन प्राप्त करके शुरू करना होगा। आप इसे आधिकारिक टेलीग्राम प्रलेखन या Telegraf.js के लिए प्रलेखन में कैसे करें, इसके बारे में पढ़ सकते हैं।

परियोजना की फ़ाइल संरचना इस प्रकार है:


यह निम्नानुसार काम करता है:

• src / नियंत्रकों - ये वही दृश्य हैं जिनके बारे में यह ऊपर लिखा गया था। इस परियोजना में, प्रत्येक दृश्य एक अलग नियंत्रक है जो संबंधित अनुरोधों को संसाधित करता है।
• src / स्थान - विभिन्न भाषाओं के लिए अनुवाद। Telegraf.js बिस्तरों का उपयोग करके बॉट में स्थानीयकरण जोड़ना अपेक्षाकृत आसान बनाता है।
• src / मॉडल - MongoDB के लिए मॉडल।
• src / type - टाइपस्क्रिप्ट के लिए टिपिंग। दुर्भाग्य से, परियोजना में प्रयुक्त सभी पुस्तकालयों में डिफ़ॉल्ट समय नहीं है।
• src / उपयोग - विभिन्न सहायक कार्य जो परियोजना के विभिन्न भागों में उपयोग किए जाते हैं। यहां आप देख सकते हैं कि डाउनलोड करने के लिए फिल्म की उपलब्धता, सत्र प्रबंधन, कीबोर्ड बनाने में त्रुटि हैंडलर और बहुत कुछ कैसे काम करता है।
• src / bot.ts - मुख्य फाइल जहां बॉट की पूरी तैयारी और लॉन्च किया जाता है।
• src / telegram.ts - इस मामले में, हम Telegraf.js लाइब्रेरी से टेलीग्राम वर्ग का एक ऑब्जेक्ट बनाते हैं। इस ऑब्जेक्ट का उपयोग करके, हम उपयोगकर्ताओं को पहले संदेश भेज सकते हैं, उनकी आईडी का उपयोग कर सकते हैं, और तब तक प्रतीक्षा नहीं कर सकते जब तक वे कुछ लिखते नहीं हैं। उदाहरण के लिए, इस परियोजना में, हम उपयोगकर्ता को यह कहते हुए एक संदेश भेजते हैं कि वह जिस फिल्म का अनुसरण कर रहा था, उसे पहले ही डाउनलोड किया जा सकता है। बेशक, यह ऑब्जेक्ट बहुत अधिक सुविधाएँ प्रदान करता है।
• इस आलेख में चर्चा नहीं की जाएगी परियोजना के विभिन्न भागों के लिए बाकी सब कुछ विन्यास है।

इनिशियलाइज़ेशन एंड लॉन्च

जब हमने परियोजना की संरचना का पता लगाया, तो आइए देखें कि वास्तव में बॉट कैसे शुरू होता है। फिर से, लेख को छोटा करने के लिए, मैं संपूर्ण कोड यहां नहीं डालूंगा, लेकिन केवल मुख्य के बारे में, मेरी राय में, क्षणों के बारे में बात करेंगे। आप रिपॉजिटरी में पूरा कोड देख सकते हैं, एक लिंक जो लेख के अंत में उपलब्ध है।

यह सब डेटाबेस से जुड़ने से शुरू होता है, जो उपयोगकर्ताओं और उनके द्वारा देखी जाने वाली फिल्मों के बारे में जानकारी संग्रहीत करता है। एक सफल कनेक्शन के बाद, हम परियोजना में उपयोग किए जाने वाले सभी दृश्यों को पंजीकृत करते हैं, स्थानीयकरण के लिए मापदंडों को निर्धारित करते हैं और कई मिडलवेर्स को जोड़ते हैं - प्रसंस्करण सत्र, स्थानीयकरण, दृश्यों की स्थापना, साथ ही साथ हमारे अपने कई। उनमें से एक, उदाहरण के लिए, अपनी आईडी के अनुसार उपयोगकर्ता के बारे में सभी जानकारी प्राप्त करता है और इसे उस संदर्भ में जोड़ता है जो नियंत्रकों में उपयोग किया जाता है। अंत में, सभी बुनियादी तैयारियों के बाद, हम बॉट को या तो विकास (लंबे मतदान) या उत्पादन (वेबहूक) मोड में लॉन्च करते हैं।

महत्वपूर्ण: यदि आप अपडेट प्राप्त करने के विभिन्न तरीकों (लॉन्ग पोलिंग और वेबहुक) का उपयोग करते हैं, तो लॉन्ग पोलिंग मोड में बॉट को शुरू करते समय, पहले api.telegram.org/botYOUR-TOKEN/deleteWebhook पर GET अनुरोध का उपयोग करके सुनने वाले Webhook को हटा दें । अन्यथा, बॉट ठीक से काम नहीं कर सकता है।

उपयोगकर्ता इनपुट संभालें

हुर्रे! बॉट काम करता है, डेटाबेस से जुड़ा है और उपयोगकर्ताओं से संदेश प्राप्त करने के लिए तैयार है। लेकिन यह सही कैसे करें?

सबसे पहले, उपयोगकर्ताओं के लिए अंतर्निहित टेलीग्राम-कीबोर्ड का उपयोग करना सुविधाजनक होगा। वास्तव में, जब आप इस कीबोर्ड के बटन पर क्लिक करते हैं, तो इन बटन की सामग्री के साथ संदेश भेजे जाते हैं। अगला, हम केवल इस पाठ के लिए हैंडलर जोड़ते हैं और कुछ कार्य करते हैं।

Bot.ts फ़ाइल में ऐसे हैंडलर होते हैं। चूंकि बॉट दो भाषाओं का समर्थन करता है, इसलिए बटन में अलग-अलग पाठ हो सकते हैं - रूसी और अंग्रेजी में। टेलीग्राफ-आई 18 एन में एक मैच फ़ंक्शन है जो विभिन्न भाषाओं के साथ एक ही बटन पर क्लिक करने में सक्षम है।

Bot.ts में अधिकांश हैंडलर एक ही कार्य करते हैं - वे उपयोगकर्ता को संबंधित दृश्य में लॉन्च करते हैं। इसलिए, हमारे पास कई खंड हैं - फिल्मों के लिए खोज, मेरा संग्रह, सेटिंग्स और संपर्क। प्रत्येक अनुभाग का अपना एक दृश्य और अपना बटन होता है, जब क्लिक किया जाता है, तो उपयोगकर्ता संबंधित दृश्य में चला जाता है।

महत्वपूर्ण: एक हैंडलर जोड़ना सुनिश्चित करें जो उपयोगकर्ता को दृश्य से मुक्त करेगा, अन्यथा वे हमेशा के लिए वहां रहने का जोखिम उठाते हैं! यह एक सामान्य कमांड बनाने के लिए भी उपयोगी होगा (/ बॉट में saveme का उपयोग किया जाता है), जिसे प्रत्येक दृश्य और मुख्य फ़ाइल में जोड़ा जाएगा। यह कमांड किसी भी दृश्य से बाहर निकलने के साथ-साथ उपयोगकर्ता सेटिंग्स को रीसेट करने का काम करेगा।

और अब, उपयोगकर्ता फिल्मों की खोज में जाना चाहता है। उपयुक्त बटन पर क्लिक करके, हम इसे खोज दृश्य पर ले जाते हैं। सुविधा के लिए, प्रत्येक दृश्य में फ़ाइलों के साथ अपना स्वयं का फ़ोल्डर होता है, जिनमें से प्रत्येक एक विशिष्ट कार्य करता है।

दृश्य के अंदर, आप अपने बिचौलियों का उपयोग कर सकते हैं, जो कि बिचौलियों की फ़ाइल में हैं। उदाहरण के लिए, खोज दृश्य में मिडलवेयर का उपयोग करते हुए, हम फिल्म के बारे में सभी जानकारी को उचित तरीकों से आगे बढ़ा सकते हैं, बजाय इसके कि हर बार एक ही कार्य करें।

टेलीग्राम में एक इनलाइन कीबोर्ड भी होता है। शायद आपके पास वोट के साथ संदेश आए हैं, जिसके तहत कई पारभासी बटन हैं, और जब आप उनमें से एक पर क्लिक करते हैं तो वोटों की संख्या बदल जाती है। ये बटन इनलाइन कीबोर्ड हैं


प्रत्येक बटन में जानकारी होती है, जब आप बटन पर क्लिक करते हैं, तो यह संबंधित हैंडलर को प्रेषित किया जाएगा। प्रेषित जानकारी का आकार 64 बाइट्स से अधिक नहीं होना चाहिए! बटन क्लिक के लिए बॉट को सिखाने के लिए, हमें उन्हें bot.action (/ ट्रिगर /, कॉलबैक) का उपयोग करके पंजीकृत करना होगा। पहले पैरामीटर में सभी डेटा शामिल हैं जो बटन से बंधा हुआ था। मैंने Redux से एक्शन जैसी किसी चीज़ का उपयोग करने का निर्णय लिया, जहाँ प्रत्येक बटन पर फॉर्म {a: actionName, p: पेलोड} का एक ऑब्जेक्ट संलग्न है। श्रोताओं को पंजीकृत करते समय, हम एक साधारण RegExp का उपयोग कर सकते हैं, उदाहरण के लिए: bot.action (/ actionName /, callBack)। इनलाइन कीबोर्ड के सभी हैंडलर एक्शन फ़ाइल में हैं।

इसके अलावा, कुछ दृश्यों में helpers.ts फाइलें हैं, जिसमें शेष फ़ाइलों को अनलोड करने के लिए वहां किए गए छोटे कार्य हैं। अधिकांश भाग के लिए, उपयोगकर्ता द्वारा विभिन्न कार्यों के लिए कीबोर्ड जनरेटर हैं।

स्थानीयकरण

चूंकि यह एक महत्वपूर्ण विषय है, मुझे लगता है कि यह अलग से ध्यान देने योग्य है। जैसा कि मैंने पहले कहा, Telegraf.js में काफी संख्या में बिचौलिये शामिल हैं, जिनमें से एक टेलीग्राफ -आई 18 एन है । रिपॉजिटरी में विस्तृत निर्देश हैं और मुझे इससे कोई विशेष समस्या नहीं है, लेकिन फिर भी मैं इस परियोजना में कैसे काम करता है, इसके बारे में कुछ शब्द जोड़ूंगा।

एक स्थान फ़ोल्डर है जहां स्थानीयकरण के लिए फाइलें स्थित हैं, जो फॉर्म {"कुंजी": "अनुवाद"} के JSON ऑब्जेक्ट हैं। इसके अलावा, जहाँ भी हमें अलग-अलग भाषाओं का उपयोग करने की आवश्यकता होती है, हम इस लाइब्रेरी से विधि का उपयोग करते हैं, जहाँ हम अनुवाद की आवश्यकता द्वारा ट्रांसफर करते हैं, और आउटपुट पर हमें संबंधित अनुवाद मिलता है। एक सत्र का उपयोग उपयोगकर्ता द्वारा चयनित भाषा के बारे में जानकारी संग्रहीत करने के लिए किया जा सकता है। इसके अलावा बटन के बारे में फिर से ध्यान देने योग्य है। एक ही लाइब्रेरी में मैच फंक्शन होता है, इसलिए यदि बटन पर पाठ भाषा के आधार पर बदलता है, तो यह फ़ंक्शन आपको सही श्रोता को लटकाने में मदद करेगा।

महत्वपूर्ण: यदि आप स्थानीयकरण का उपयोग करने जा रहे हैं और टाइपस्क्रिप्ट में एक बॉट लिखते हैं, तो अनुवाद फ़ोल्डर को tsconfig.json में जोड़ना न भूलें, अन्यथा कोड संकलित नहीं होगा। उदाहरण के लिए:

 "include": ["src/locales/*.json"] 

निष्कर्ष

अंत तक पढ़ने के लिए धन्यवाद! इस लेख में, मैंने अपनी परियोजना के लिए एक मजबूत लगाव के बिना, एक पूरे के रूप में संभव के रूप में एक टेलीग्राम बॉट बनाने की प्रक्रिया का वर्णन करने की कोशिश की। मुझे उम्मीद है कि इस लेख को पढ़ने के साथ-साथ ईव के लिए स्रोत कोड का अध्ययन करने के बाद, आप आसानी से एक बॉट बना सकते हैं जो आपकी मदद कर सकता है।

जैसा कि वादा किया गया था, आप गिटहब पर स्रोत कोड को देख सकते हैं, और यहां कार्रवाई में ईव का प्रयास कर सकते हैं । मैं किसी भी आलोचना और सुधार के सुझावों के लिए बहुत आभारी रहूंगा।

मैं दिलचस्प ओपन सोर्स प्रोजेक्ट्स के साथ टेलीग्राफ.जेएस डॉक्यूमेंट में सेक्शन को भी नोट करना चाहूंगा जिसे आप आर्किटेक्चर और सॉल्यूशंस से प्रेरित होकर देख सकते हैं। मैं, बदले में, उनमें से एक का उल्लेख करना चाहता हूं - द गार्ड बॉट । वास्तव में बड़ी और अच्छी तरह से निर्मित बॉट, जहां से मैंने अपने विकास के लिए कुछ समाधान उधार लिए।

और फिलहाल मैंने जो कुछ भी मुझसे कहा था, मुझे आपके सवालों, सुझावों और टिप्पणियों का जवाब देने में खुशी होगी!