👵 👩🏾‍🎤 🐅 JSON-RPC 2.0 और PHP ⚽️ 😷 🥔

यदि आप एक डेवलपर हैं, और आपके पास पीएचपी में एक परियोजना है, और उसे अंततः अपने स्वयं के एपीआई को लागू करने की आवश्यकता है - यह लेख निश्चित रूप से आपके लिए है;)।

JSON-RPC v1.0 2005 में दिखाई दिया, 5 साल बाद दूसरा संस्करण दिखाई दिया । जावास्क्रिप्ट और मोबाइल अनुप्रयोगों के युग में, कई डेवलपर्स अभी भी तैयार किए गए सरल मानक के बजाय अपनी बाइक का उपयोग करते हैं।

JSON-RPC और 2.0 भी क्यों?

मैं प्रमुख विशेषताओं को उजागर करने का प्रयास करूंगा:

यह कम से कम कुछ मानक है। विभिन्न प्लेटफार्मों के लिए पुस्तकालयों की एक विस्तृत चयन।
तेजी से आसान पार्सिंग। JSON-RPC XML-RPC या SOAP की तरह राक्षसी नहीं है।
अंतर्निहित त्रुटि हैंडलिंग। REST बाइक के साथ, आपको यह पता लगाना होगा कि उत्तर का निर्माण कैसे करें और आगे क्या करना है।
कतार समर्थन को बुलाओ। अब 5 HTTP अनुरोधों को एक में लपेटा जा सकता है :)।
एपीआई के लिए एक एकल बिंदु। उदाहरण के लिए, /rpc-server.php विभिन्न तरीकों को संभालने में सक्षम होगा।
फोन करते समय नामित और वैकल्पिक मापदंडों के लिए समर्थन।

संस्करण 1.0 से परिचित लोगों के लिए, 2.0 में महत्वपूर्ण नवाचारों को पैरामीटर और कॉल कतार नाम दिया गया था।
एक साधारण अनुरोध / प्रतिक्रिया इस प्रकार है:

--> {"jsonrpc": "2.0", "method": "subtract", "params": {"subtrahend": 23, "minuend": 42}, "id": 3} <-- {"jsonrpc": "2.0", "result": 19, "id": 3} --> {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": 1} <-- {"jsonrpc": "2.0", "result": 19, "id": 1} --> [ {"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"}, {"jsonrpc": "2.0", "method": "foobar", "id": "2"} ] <-- [ {"jsonrpc": "2.0", "result": 7, "id": "1"}, {"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found."}, "id": "2"} ]

प्रोग्रामिंग की इस जटिल "रचनात्मक" दुनिया में, यह सवाल हमेशा उठता है: कुछ तैयार करें या अपना खुद का कुछ लिखें?

एकदम सही दुनिया। हमें क्या चाहिए?

हमेशा की तरह, हम उस टूल के मापदंड को परिभाषित करते हैं जिसे आप खोजना / प्राप्त करना चाहते हैं:

विनिर्देशों के साथ पूर्ण अनुपालन। इस कारक को देखते हुए, सबसे अधिक संभावना है कि अन्य क्लाइंट / सर्वर समाधान के साथ कोई समस्या नहीं होगी
एकल-फाइल स्वतंत्र कार्यान्वयन। मैं किसी भी ढांचे को ला ज़ेंड या PEAR नहीं खींचना चाहता
परीक्षणों की उपलब्धता। कम से कम कुछ गारंटी है कि ओपन-सोर्स समाधान सही ढंग से काम करेगा;)
अंदर सुंदर कार्यान्वयन । सब कुछ यथासंभव सरल, स्पष्ट और तार्किक होना चाहिए।
ऑटो-खोज तंत्र की उपस्थिति। JSON-RPC सर्वर को इसके तरीकों के बारे में मेटा जानकारी प्रदान करने में सक्षम होना चाहिए
साधारण कनेक्शन। मैंने फ़ाइल को कनेक्ट किया, कुछ तरीकों को बुलाया, सब कुछ काम करता है।
क्लाइंट प्रॉक्सी कक्षाओं का निर्माण। जब हम पहले से ही मेटाडेटा के साथ तैयार सर्वर रखते हैं तो क्लाइंट क्यों लिखें? ;)

एक शुरुआत के लिए पर्याप्त।

सिद्धांत की बिट

क्योंकि JSON-RPC एक काफी युवा प्रोटोकॉल है, फिर भी इसमें कुछ क्षण हैं जो पूरी तरह से अनुमोदित नहीं हैं। उनमें से एक Dojo द्वारा प्रस्तावित सेवा मानचित्रण विवरण है । एसएमडी पूरी तरह से एक वेब सेवा का वर्णन कर सकता है, जो अपने तरीकों से शुरू होती है, तैनात रिटर्न प्रकारों के साथ समाप्त होती है। दुर्भाग्य से, बहुत कम समाधान इसके क्रियान्वयन का समर्थन करते हैं, उदाहरण के लिए, Zend_Json_Server , inputEx ढांचा ( परीक्षण रूपों का निर्माण ) और स्वयं Dojo रूपरेखा ।

आइए मौजूदा समाधानों की खोज पर जाएं।

PHP के लिए मौजूदा कार्यान्वयन

मैंने विकिपीडिया पर एक टैबलेट से ग्राहकों की सूची ली।

	php-JSON-RPC	jsonrpc2php	tivoka	कनिष्ठ	JSON-RPC-php	JSONRpc2	Zend Json सर्वर	zoServices
सर्वर
विनिर्देशों के साथ अनुपालन	-	बैच मोड में अधिसूचना के लिए सही समर्थन।	+	परम नाम का कोई वैकल्पिक नहीं	+	+	+	परम नाम का कोई वैकल्पिक नहीं
फाइलों की संख्या	-	2	> 7	3	6	1	> ५	6
SMD सर्किट	-	-	-	-	-	-	+	-
परीक्षण	-	+	-	+	-	+	+	-
आंतरिक कार्यान्वयन (1..5)	-	4 निर्यात कार्यों की मैनुअल मैपिंग	3. इस तरह के एक सरल कार्य के लिए बहुत जटिल कार्यान्वयन	4	4. कठिन	4. अंदर जादू!	4। Zend	3।
ग्राहक
विनिर्देशों के साथ अनुपालन	कोई बैच और अधिसूचना नहीं	-	+	+	+	कोई बैच नहीं	-	उल्लेखनीय नहीं है
फाइलों की संख्या	1	-	> 7	4	2	1	-	6
परीक्षण	-	-	-	+	-	+	-	-
आंतरिक कार्यान्वयन (1..5)	4	-	3. कॉल करने के तरीकों के लिए अतिरिक्त कदम	4	4	4। :)	-	3
स्वचालित पीढ़ी	-	-	-	-	-	-	-	-

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

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

प्रश्न का उत्तर "कुछ तैयार उपयोग करें" या "अपना खुद का लिखें" स्पष्ट है।

ईज़ी JSON-RPC 2.0

GitHub पर परियोजना। पहले बताई गई सभी आवश्यकताएं लागू की गई हैं :)

सर्वर

दो उपयोग के मामले हैं: या तो BaseJsonRpcServer वर्ग से इनहेरिट करें, या इसका एक उदाहरण बनाएं और निर्यात किए गए ऑब्जेक्ट को कंस्ट्रक्टर को पास करें:

 <?php include 'BaseJsonRpcServer.php'; include 'tests/lib/DateTimeRpcService.php'; //   $server = new DateTimeRpcService(); //  new BaseJsonRpcServer( new DateTimeService() ); $server->Execute();

इस प्रकार, हमने DateTimeRpcService वर्ग के सभी सार्वजनिक तरीकों को उजागर किया। SMD स्कीम smd GET पैरामीटर (उदाहरण के लिए, ezyjsonrpc / example-server.php? Smd ) के माध्यम से प्राप्त की जा सकती है। योजना बनाते समय, phpDoc ब्लॉकों को ध्यान में रखा जाता है।

किस तरह का सर्किट है ...

 {"transport":"POST","envelope":"JSON-RPC-2.0","SMDVersion":"2.0","contentType":"application\/json","target":"\/example-server.php","services":{"GetTime":{"parameters":[{"name":"timezone","optional":true,"type":"string","default":"UTC"},{"name":"format","optional":true,"type":"string","default":"c"}],"description":"Get Current Time","returns":{"type":"string"}},"GetTimeZones":{"parameters":[],"description":"Returns associative array containing dst, offset and the timezone name","returns":{"type":"array"}},"GetRelativeTime":{"parameters":[{"name":"text","optional":false,"type":"string","description":"a date\/time string\r"},{"name":"timezone","optional":true,"type":"string","default":"UTC"},{"name":"format","optional":true,"type":"string","default":"c"}],"description":"Get Relative time","returns":{"type":"string"}},"Implode":{"parameters":[{"name":"glue","optional":false,"type":"string"},{"name":"pieces","optional":true,"type":"array","default":["1","2","3"]}],"description":"Implode Function","returns":{"type":"string","description":"string"}}},"description":"Simple Date Time Service"}

ग्राहक

फिर से दो संभावित उपयोग हैं: या तो BaseJsonRpcClient वर्ग का एक उदाहरण बनाएं और इसे कंस्ट्रक्टर में वेब सेवा लिंक पास करें, या जनरेटर का उपयोग करें:

 <?php include 'BaseJsonRpcClient.php'; $client = new BaseJsonRpcClient( 'http://eazyjsonrpc/example-server.php' ); $result = $client->GetRelativeTime( 'yesterday' );

जनक

एसएमडी योजना के आधार पर, हम सर्वर के साथ काम करने के लिए एक वर्ग उत्पन्न कर सकते हैं (उदाहरण देखें DateTimeServiceClient.php )। ऐसा करने के लिए, जनरेटर को कॉल करें:

 php JsonRpcClientGenerator.php http://eazyjsonrpc/example-server.php?smd DateTimeServiceClient

कमांड का परिणाम हमारे द्वारा आवश्यक विधियों के साथ एक DateTimeServiceClient.php फ़ाइल होगा।

मरहम में उड़ना

JSON-RPC में कॉलिंग क्लास- > मेथड () के लिए एक अनस्पोक नियम क्लासमैथोड को विधि के नाम (डॉट के माध्यम से) के रूप में उपयोग कर रहा है।
वर्तमान कार्यान्वयन में, ऐसी कार्यक्षमता प्रदान नहीं की गई है। यह माना जाता है कि url एक निर्यातित वर्ग है, फिर बिंदीदार विकल्प गायब हो जाता है :)। ग्राहक पक्ष के बारे में - आप हमेशा यहां जोड़ सकते हैं, यह सिर्फ PHP है।

एसएमडी में भी उनके गुणों के साथ वस्तुओं के रूप में रिटर्न प्रकार का वर्णन करना संभव है, लेकिन कार्यान्वयन की जटिलता को देखते हुए, हम इस क्षण को छोड़ देंगे।

जो लोग विस्तृत दस्तावेज ढूंढना चाहते हैं, उनके लिए मैं तरीकों के नाम, phpDoc टिप्पणियों और सर्वर या क्लाइंट के स्रोत कोड को पढ़ने का सुझाव दे सकता हूं।

जीवन हैक

हमारे पास प्रमाणीकरण के साथ क्या है?

कई कार्यान्वयन विकल्प हैं:

HTTP बेसिक प्रामाणिक का उपयोग करें। क्लाइंट में, $ CurlOptions array में केवल उपयोगकर्ता नाम और पासवर्ड जोड़ें :)
HTTP हेडर के माध्यम से टोकन का उपयोग करें। टोकन प्राप्त करने के लिए, आप आवश्यक विधि लिख सकते हैं।
विधि मापदंडों के रूप में टोकन का उपयोग करें।

फ़ाइलों को अपलोड करने के बारे में क्या?

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

उदाहरण

 --> {"jsonrpc": "2.0", "method": "send_image", "params": ..., "id": 1} <-- {"jsonrpc": "2.0", "result": {"URL": "/exampleurl?id=12345", "maxsize": 10000000, "accepted-format":["jpg", "png"]}, "id": 1} -->      .      ,    --> {"jsonrpc": "2.0", "method": "send_done", "params": {"checksum": "1a5e8f13"}, "id": 2} <-- {"jsonrpc": "2.0", "result": "ok"}

हैंडलिंग में त्रुटि

प्रोटोकॉल ही कोड , संदेश और डेटा फ़ील्ड के साथ त्रुटि ऑब्जेक्ट के अस्तित्व के लिए पहले से ही प्रदान करता है। BaseJsonRpcServer नामक विधि का उपयोग करते समय, आप एक अपवाद को फेंक सकते हैं जिसमें कोड और डेटा पास करना है । आप किसी विशिष्ट कोड का उपयोग करके अपने संदेश को $ errorMessages सरणी में जोड़ सकते हैं।

केवल विशिष्ट फ़ील्ड्स के साथ ऑब्जेक्ट निर्यात करें

यह सब पूरी तरह आप पर निर्भर करता है कि आप इसे कैसे लागू करते हैं। मैं आपको केवल कुछ वर्ग ObjectToJsonConverter बनाने की सलाह दे सकता हूं , जिसमें आवश्यक सरणी में ऑब्जेक्ट के रूपांतरण को लागू करने के लिए।