📩 😋 🕶️ वृक्ष डेटा संरचनाओं का विवरण और सत्यापन। JSON-स्कीमा 👨🏼‍⚕️ 🧠 🧘🏾

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

JSON- स्कीमा JSON प्रारूप में डेटा संरचनाओं का वर्णन करने के लिए एक मानक है, जिसे XML-स्कीमा के आधार पर विकसित किया गया है, मसौदा यहां पाया जा सकता है (नीचे विवरण संस्करण 03 के अनुरूप होगा)। इस मानक द्वारा वर्णित स्कीमा में MIME "एप्लिकेशन / स्कीमा + json" होता है। मानक का उपयोग करने के लिए सुविधाजनक है जब संख्याओं, तारों, सरणियों और कुंजी-मूल्य संरचनाओं से युक्त डेटा संरचनाओं को मान्य और प्रलेखित किया जाता है (जो, प्रोग्रामिंग भाषा के आधार पर कहा जा सकता है: एक वस्तु, एक शब्दकोश, एक हैश तालिका, एक सहयोगी सरणी या एक नक्शा, फिर नाम "ऑब्जेक्ट" या "ऑब्जेक्ट" का उपयोग किया जाएगा)। वर्तमान में, विशेष रूप से जावास्क्रिप्ट, php, रूबी, अजगर, जावा में विभिन्न प्लेटफार्मों और भाषाओं के लिए पूर्ण और आंशिक कार्यान्वयन हैं ।

योजना

एक स्कीमा JSON प्रारूप में किसी भी डेटा का वर्णन करने के लिए डिज़ाइन की गई JSON ऑब्जेक्ट है। इस ऑब्जेक्ट के गुण वैकल्पिक हैं, उनमें से प्रत्येक एक निश्चित सत्यापन नियम (बाद में - नियम) का एक निर्देश है। सबसे पहले, एक योजना डेटा प्रकार को सीमित कर सकती है (नियम टाइप या अस्वीकृत है, यह या तो एक स्ट्रिंग या एक सरणी हो सकती है):

स्ट्रिंग (स्ट्रिंग)
संख्या (संख्या, सभी वास्तविक संख्याओं सहित)
पूर्णांक (पूर्णांक, संख्या का सबसेट है)
बूलियन (सच्चा या गलत)
ऑब्जेक्ट, एक वस्तु, कुछ भाषाओं में इसे एक साहचर्य सरणी, हैश, हैश टेबल, मानचित्र या शब्दकोश कहा जाता है)
सरणी (सरणी)
अशक्त ("कोई डेटा नहीं" या "अज्ञात", केवल अशक्त संभव है)
कोई भी (शून्य सहित कोई भी प्रकार)

इसके अलावा, जाँच किए जा रहे डेटा के प्रकार के आधार पर, अतिरिक्त नियम लागू होते हैं। उदाहरण के लिए, यदि जाँच किया जा रहा डेटा एक संख्या है, तो न्यूनतम, अधिकतम, विभाज्य है। यदि जाँच किया जा रहा डेटा एक सरणी है, तो नियम लागू होते हैं: minItems, maxItems, uniqueItems, items। यदि डेटा की जाँच की जा रही है, तो एक स्ट्रिंग है: लागू करें: पैटर्न, माइनलेंग्थ, मैक्स लर्निंग। यदि ऑब्जेक्ट की जाँच की जाती है, तो नियमों पर विचार किया जाता है: गुण, प्रतिरूप, अतिरिक्त।

प्रकार-विशिष्ट नियमों के अतिरिक्त, अतिरिक्त सामान्य नियम हैं, जैसे आवश्यक और प्रारूप, साथ ही विवरणात्मक नियम, जैसे आईडी, शीर्षक, विवरण, $ स्कीमा। विनिर्देश कई माइक्रोफ़ॉर्मेट्स को परिभाषित करता है, जैसे: दिनांक-समय (ISO 8601), तिथि, समय, utc-millisec, regex, color (W3C.CR-CSS21-20070719), शैली (WCC.CR-CSS21-20070719), फ़ोन यूरी, ईमेल, आईपी-एड्रेस (वी 4), आईपीवी 6, होस्ट-नाम, जिसे वर्तमान कार्यान्वयन द्वारा परिभाषित और समर्थित होने पर अतिरिक्त जाँच की जा सकती है। इन और अन्य नियमों को विनिर्देश में अधिक विस्तार से पाया जा सकता है।

चूंकि स्कीमा एक JSON ऑब्जेक्ट है, इसलिए इसे संबंधित स्कीमा द्वारा भी चेक किया जा सकता है। जिस स्कीमा में मौजूदा स्कीमा संगत होती है, उसे $ स्कीमा विशेषता में लिखा जाता है। इसका उपयोग करके, आप उस प्रारूप के संस्करण को निर्धारित कर सकते हैं जिसका उपयोग योजना लिखने के लिए किया गया था। इन योजनाओं को यहां खोजें।

JSON-Schema के सबसे शक्तिशाली और आकर्षक कार्यों में से एक योजना से अन्य योजनाओं को संदर्भित करने की क्षमता है, साथ ही साथ योजना का विस्तार (विस्तार) ( JSON-Ref लिंक का उपयोग करके) है। यह आईडी, एक्सटेंड और $ रेफ का उपयोग करके किया जाता है। योजना का विस्तार करते समय, आप नियमों को फिर से परिभाषित नहीं कर सकते, केवल उन्हें पूरक कर सकते हैं। जब सत्यापनकर्ता काम कर रहा है, तो माता-पिता और बच्चे की योजनाओं के सभी नियमों को जांचे जा रहे डेटा पर लागू किया जाना चाहिए। हम आगे के उदाहरणों पर विचार करेंगे।

उदाहरण

मान लीजिए कि माल के बारे में जानकारी है। प्रत्येक आइटम का एक नाम है। यह 3 से 50 अक्षरों की एक स्ट्रिंग है, जिसके सिरों पर कोई स्थान नहीं है। उत्पाद नाम के लिए एक स्कीमा निर्धारित करें:

{ "$schema": "http://json-schema.org/draft-03/schema#", //      "id": "urn:product_name#", "type": "string", "pattern": "^\\S.*\\S$", "minLength": 3, "maxLength": 50, }

खैर, अब इस योजना के साथ आप उत्पाद के नाम से मिलान करने के लिए किसी भी स्ट्रिंग का वर्णन या सत्यापन कर सकते हैं। इसके अलावा, उत्पाद में एक गैर-नकारात्मक मूल्य, प्रकार ('फोन' या 'नोटबुक') है, और वाई-फाई एन और जी के लिए समर्थन है। माल के लिए योजना को परिभाषित करें:

  { "$schema":"http://json-schema.org/draft-03/schema#", "id": "urn:product#", "type": "object", "additionalProperties": false, "properties": { "name": { "extends": {"$ref": "urn:product_name#"}, "required": true }, "price": { "type": "integer", "min": 0, "required": true }, "type": { "type": "string", "enum": ["phone", "notebook"], "required": true }, "wi_fi": { "type": "array", "items": { "type": "string", "enum": ["n", "g"] }, "uniqueItems": true } } }

यह योजना पिछली योजना के लिंक और आवश्यक नियम के साथ इसके विस्तार का उपयोग करती है। यह पिछली योजना में नहीं किया जा सकता है, क्योंकि कहीं नाम वैकल्पिक हो सकता है, और सभी नियम लागू होंगे।

उत्पादकता

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

स्रोत कोड का परीक्षण करें

 var jsv = require('JSV').JSV.createEnvironment(); console.time('load schemas'); jsv.createSchema( { "$schema": "http://json-schema.org/draft-03/schema#", "id": "urn:product_name#", "type": "string", "pattern": "^\\S.*\\S$", "minLength": 3, "maxLength": 50, } ); jsv.createSchema( { "$schema":"http://json-schema.org/draft-03/schema#", "id": "urn:product#", "type": "object", "additionalProperties": false, "properties": { "name": { "extends": {"$ref": "urn:product_name#"}, "required": true }, "price": { "type": "integer", "min": 0, "required": true }, "type": { "type": "string", "enum": ["phone", "notebook"], "required": true }, "wi_fi": { "type": "array", "items": { "type": "string", "enum": ["n", "g"] }, "uniqueItems": true } } } ); console.timeEnd('load schemas'); console.time('prepare data'); var i, j; var product; var products = []; var names = []; for (i = 0; i < 1000; i++) { product = { name: 'product ' + i }; if (Math.random() < 0.05) { while (product.name.length < 60) { product.name += 'long'; } } names.push(product.name); if (Math.random() < 0.95) { product.price = Math.floor(Math.random() * 200 - 2); } if (Math.random() < 0.95) { product.type = ['notebook', 'phone', 'something'][Math.floor(Math.random() * 3)]; } if (Math.random() < 0.5) { product.wi_fi = []; for (j = 0; j < 3; j++) { if (Math.random() < 0.5) { product.wi_fi.push(['g', 'n', 'a'][Math.floor(Math.random() * 3)]); } } } products.push(product); } console.timeEnd('prepare data'); var errors; var results = {}; var schema; var message; schema = jsv.findSchema('urn:product_name#'); console.time('names validation'); for (i = 0; i < names.length; i++) { errors = schema.validate(names[i]).errors; for (j = 0; j < errors.length; j++) { message = errors[j].message; if (!results.hasOwnProperty(message)) { results[message] = 0; } results[message]++; } } console.timeEnd('names validation'); console.dir(results); results = {}; schema = jsv.findSchema('urn:product#'); console.time('products validation'); for (i = 0; i < products.length; i++) { errors = schema.validate(products[i]).errors; for (j = 0; j < errors.length; j++) { message = errors[j].message; if (!results.hasOwnProperty(message)) { results[message] = 0; } results[message]++; } } console.timeEnd('products validation'); console.dir(results);

1000 चेक के परिणाम काफी संतोषजनक हैं।
(एक ही समय में, कुछ पुस्तकालय परिमाण उच्च गति के आदेश का दावा करते हैं )।
मेरे लैपटॉप पर (MBA, OSX, 1.86 GHz Core2Duo):
नाम सत्यापन: 180ms
उत्पाद सत्यापन: 743ms

निष्कर्ष

JSON-स्कीमा डेटा संरचनाओं के दस्तावेज़ीकरण और अनुप्रयोगों में स्वचालित बाहरी डेटा सत्यापनकर्ताओं को कॉन्फ़िगर करने के लिए एक काफी सुविधाजनक उपकरण है। यह कम पाठ स्थान लेते हुए, XML स्कीमा की तुलना में सरल और अधिक पठनीय दिखता है। यह प्रोग्रामिंग भाषा पर निर्भर नहीं करता है और कई क्षेत्रों में एक उदाहरण पा सकता है: POST अनुरोध फ़ॉर्म, JSON रीस्ट API को मान्य करना, सॉकेट्स के माध्यम से डेटा का आदान-प्रदान करते समय पैकेट की जाँच करना, दस्तावेज़-उन्मुख डेटाबेस में दस्तावेजों को मान्य करना, आदि ।SON-स्कीमा का उपयोग करने का मुख्य लाभ। मानकीकरण और, परिणामस्वरूप, सॉफ्टवेयर एकीकरण के समर्थन और सुधार का सरलीकरण है।

वृक्ष डेटा संरचनाओं का विवरण और सत्यापन। JSON-स्कीमा

योजना

उदाहरण

उत्पादकता

निष्कर्ष

More articles: