🌩️ 👩🏼‍🏭 🌒 जीआरपीसी और प्रोटोबुफ़ के लिए बस एक और क्यूटी आवरण 🧘🏼 🛌🏽 🧓🏿

बहुत पहले नहीं, मैं इस तथ्य से हैरान था कि प्रोटोबाफ़ और जीआरपीसी के लिए पर्याप्त सुविधाजनक और सरल रैपर और जनरेटर नहीं हैं, जो कि क्यूटी पर आधारित और पूरी तरह से संगत हैं। मैं सहित लेखों में आया था यहाँ रैपर के बारे में, लेकिन उनका उपयोग मुझे मौजूदा C ++ API की तुलना में बहुत कम व्यावहारिक लगा।

जीआरपीसी और प्रोटोबुफ़ के बारे में थोड़ा सा

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

संक्षिप्त और स्पष्ट IDL
विभिन्न प्लेटफार्मों के लिए बड़ी संख्या में जनरेटर की उपस्थिति
त्वरित और आसान प्रोटोटाइप और परीक्षण अनुप्रयोगों को लिखने के लिए उत्पन्न क्लाइंट / सर्वर कोड

टू द पॉइंट

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

qtprotobufgen

qtprotobufgen सबसे सरल अंतर्निहित जनरेटर है, जो कि libprotoc द्वारा प्रदान की गई API पर आधारित है। यदि आप अपनी जरूरतों के लिए ऐसा कुछ करना चाहते हैं तो मैं थोड़ा धोखा खा सकता हूं।

आपके पास प्लग इन क्लास के लिए एक सिंगल एंट्री पॉइंट है :: google :: protobuf :: compiler :: CodeGenerator, जिसमें से आपको इनहेरिट करने की आवश्यकता है
एक अलग .proto फ़ाइल के साथ काम करते समय वर्चुअल विधि जनरेट करता है
वर्चुअल GenerateAll विधि पीढ़ी के लिए प्रदान की गई .proto फ़ाइलों की पूरी सरणी के साथ काम करते समय या निर्भरता होने पर पीढ़ी को निर्धारित करती है
आभासी HasGenerateAll विधि अनिवार्य रूप से पिछले संस्करणों से जीवित अवशेष है। सच लौटा दो

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

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

जनरेटर मौजूदा प्रोटोकोक नियमों के अधीन है, और लेखन के समय, कोई अतिरिक्त पीढ़ी विकल्प प्रस्तुत नहीं करता है:

protoc --plugin=protoc-gen-qtprotobuf=<path/to/bin>/qtprotobufgen --qtprotobuf_out=<output_dir> <protofile>.proto [--qtprotobuf_opt=out=<output_dir>]

सादगी और उपयोग में आसानी के लिए, आप कोड तैयार करने के लिए विशेष रूप से तैयार किए गए cmake रूटीन का उपयोग कर सकते हैं, और उन्हें cmake प्रोजेक्ट में एम्बेड कर सकते हैं। अधिक जानकारी ...

पुस्तकालयों के बारे में

मैं विस्तार से एपीआई का वर्णन करने में बहुत अधिक बिंदु नहीं देख रहा हूं। जो लोग चाहते हैं कि प्रलेखन उत्पन्न कर सकें और वर्तमान में उपलब्ध एपीआई के बारे में थोड़ा और पढ़ सकें।

परियोजना को 2 तार्किक भागों में विभाजित किया गया है qtprotobuf और qtgrpc। नामों से, मुझे लगता है कि प्रत्येक घटक का उद्देश्य स्पष्ट है। हमने उपयोग को यथासंभव सुविधाजनक बनाने की कोशिश की, क्योंकि पुस्तकालय में सिस्टम में पूर्व-इकट्ठे और स्थापित दोनों के साथ एकीकरण विकल्प हैं, और आपके cmake प्रोजेक्ट में उपप्रोजेक्ट का एकीकरण है।

उत्पन्न कोड पूरी तरह से * QML को निर्यात किया जाता है, जो कि GRPC एपीआई के साथ काम करना बहुत आसान बनाता है।

के उपयोग

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

 ... #include <QtProtobufTypes> ... int main(int argc, char *argv[]) { QtProtobuf::registerProtoTypes(); ... //   Qt  }

लेखन के समय, प्रोटो-पैकेज के लिए उत्पन्न सभी प्रकारों को पंजीकृत करने के लिए कोई एकल विधि नहीं है, इसलिए आपको एप्लिकेशन में उपयोग किए जाने वाले सभी प्रकारों के लिए qRegisterProtobufType विधि को कॉल करने की आवश्यकता है:

 ... qRegisterProtobufType<MyProtoType>(); ...

पुस्तकालयों और एक जनरेटर का उपयोग README में वर्णित है, और परियोजना के साथ कुछ उदाहरण हैं। उन लोगों के लिए जो gRPC / protobuf से बिल्कुल भी परिचित नहीं हैं, मेरा सुझाव है कि आप आधिकारिक दस्तावेज पढ़ें

डेवलपर्स के लिए

हमने विकास के दौरान टीडीडी का पालन करने की कोशिश की, और इससे विचलित नहीं होना चाहते। जैसा कि हमारे अनुभव से पता चला है, TDD जब एपीआई को रीफ़ैक्‍ट करने या अपडेट करने से बचाता है, तो यह छिपी हुई समस्याओं का पता लगाने में मदद करता है। इसलिए, यदि योगदान करने की इच्छा है, तो इकाइयों, इकाई और कार्यात्मक परीक्षणों को लिखने के लिए तैयार रहें।

* ज्ञात मुद्दे

वर्तमान में Qt से संबंधित कई समस्याएं हैं। उनमें से कुछ का समाधान हमारी या हमारी भागीदारी के बिना किया गया था, लेकिन उनमें से सभी वर्तमान क्यूटी रिलीज में शामिल नहीं थे। मुख्य एक qml कोड से कुछ मूल प्रोटोबोफ़ प्रकार की दुर्गमता है। मुझे लगता है कि यह किसी के लिए कोई रहस्य नहीं है कि जेएम इंजन के रूप में वी 8 के उपयोग के कारण क्यूएमएल में उपलब्ध प्रकारों का सेट बहुत सीमित है। QML को अनुकूलित प्रकारों (उदाहरण के लिए, फिक्स्ड, sint32) के लिए थोड़ा अधिक अनुकूल बनाने का प्रयास विफल रहा, लेकिन यह समस्या के स्रोत को ठीक करने के लिए निकला। QtNetwork के वर्तमान कार्यान्वयन में भी कई समस्याएं हैं, लेकिन क्यूटी टीम उन्हें जल्दी से ठीक कर देती है।
QTBUG-77,852
QTBUG-76,303
QTBUG-78,310

योजनाओं

सभी वर्तमान गतिविधियाँ प्रोजेक्ट कोड या Qt कोड में समस्या निवारण से संबंधित हैं। लेकिन नई कार्यक्षमता के साथ जुड़े काम की एक बड़ी मात्रा है:

~~उत्पन्न कोड के लिए .h / .cpp फ़ाइलों की एकल जोड़ी में संक्रमण~~
जीआरपीसी सर्वर कार्यान्वयन
~~जीआरपीसी क्रेडेंशियल के लिए पुनर्चक्रण एपीआई~~
जेनरेट किए गए पैकेज और मॉड्यूल्स के अलग-अलग लोडिंग के लिए डायरेक्टरी में जेनरेट किए गए कोड का वितरण और सबप्रोजेक्ट प्लग-इन का निर्माण
~~Qmake एकीकरण~~
~~सीआई कार्यान्वयन~~

कुछ बैकलॉग है, जो अभी भी अपने स्वयं के प्रोजेक्ट रिपॉजिटरी में संग्रहीत है।

एक निष्कर्ष के बजाय, मैं ओएसएस परियोजनाओं के लिए प्रदान की गई कुंजी के लिए पीवीएस-स्टूडियो के साथियों से धन्यवाद कहना चाहूंगा। उनकी मदद से, उन्हें उत्पन्न कोड में एक महत्वपूर्ण बग मिला।

डाउनलोड करें, प्रोजेक्ट देखें और यहां उदाहरणों के साथ खेलें।

जीआरपीसी और प्रोटोबुफ़ के लिए बस एक और क्यूटी आवरण