👨🏾‍🎨 🤗 👍🏻 नोड-दोषी का उपयोग करते हुए वेब अनुप्रयोग कॉन्फ़िगरेशन को छेड़ना 🤽🏾 👧🏿 👈🏽

एक अनुवादक से: यह मोज़िला आइडेंटिटी टीम से Node.js श्रृंखला में सातवां लेख है, जो पर्सोना प्रोजेक्ट में शामिल है।

श्रृंखला के सभी लेख:

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

समस्या का बयान

दो मुख्य समस्याएं हैं जो अनुप्रयोगों को कॉन्फ़िगर करने के लिए आवश्यक बनाती हैं:

अधिकांश एप्लिकेशन कई वातावरणों में विभिन्न कॉन्फ़िगरेशन विकल्पों के साथ चल सकते हैं।
आवेदन कोड में क्रेडेंशियल्स और अन्य गोपनीय जानकारी शामिल करने से समस्याएं हो सकती हैं।

वर्तमान डेटा के आधार पर कुछ चर को प्रारंभ करके और संवेदनशील डेटा को संग्रहीत करने के लिए पर्यावरण चर का उपयोग करके इन समस्याओं को हल किया जा सकता है। इस दृष्टिकोण को लागू करने के लिए आमतौर पर Node.js वातावरण में उपयोग किया जाने वाला टेम्पलेट कॉन्फ़िगरेशन को निर्यात करने वाले मॉड्यूल को बनाना है:

var conf = { //   - // "production", "development",  "test env: process.env.NODE_ENV || "development", // IP  ip: process.env.IP_ADDRESS || "127.0.0.1", //  port: process.env.PORT || 0, //   database: { host: process.env.DB_HOST || "localhost:8091" } }; module.exports = conf;

यह ठीक काम करता है, लेकिन कुछ और समस्याएं हैं:

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

पेश है दोषी

नोड-इनकॉन्फ़िगरेशन स्कीम प्रदान करके इन दोनों समस्याओं को हल करता है जहाँ आप प्रत्येक सेटिंग के लिए टाइप जानकारी, डिफ़ॉल्ट मान, पर्यावरण चर और प्रलेखन निर्दिष्ट कर सकते हैं।

सजा का उपयोग करते हुए, ऊपर दिया गया उदाहरण फॉर्म लेता है:

 var conf = convict({ env: { doc: "The applicaton environment.", format: ["production", "development", "test"], default: "development", env: "NODE_ENV" }, ip: { doc: "The IP address to bind.", format: "ipaddress", default: "127.0.0.1", env: "IP_ADDRESS" }, port: { doc: "The port to bind.", format: "port", default: 0, env: "PORT" }, database: { host: { default: "localhost:8091", env: "DB_HOST" } } }); conf.validate(); module.exports = conf;

इसमें लगभग समान जानकारी होती है, लेकिन आरेख के रूप में प्रस्तुत की जाती है। इसके लिए धन्यवाद, हमारे लिए इसे निर्यात करना और इसे पढ़ने योग्य रूप में प्रदर्शित करना, सत्यापन करना अधिक सुविधाजनक है। घोषणात्मक प्रारूप आवेदन को सभी टीम के सदस्यों के लिए अधिक विश्वसनीय और अधिक अनुकूल बनाता है।

सर्किट कैसे काम करता है

प्रत्येक सेटिंग के लिए चार गुण हैं, जिनमें से प्रत्येक एप्लिकेशन को अधिक विश्वसनीय और समझने में आसान बनाने में मदद करता है:

टाइप करें। format संपत्ति या तो दोषी में निर्मित प्रकारों में से एक ( ipaddress , port , int , आदि) या कस्टम प्रकारों को मान्य करने के लिए एक फ़ंक्शन निर्दिष्ट करती है। यदि सत्यापन के दौरान पैरामीटर टाइप चेक पास नहीं करता है, तो एक त्रुटि होती है।
डिफ़ॉल्ट मान । प्रत्येक पैरामीटर में एक डिफ़ॉल्ट मान होना चाहिए ।
पर्यावरण चर । यदि env, में निर्दिष्ट चर सेट किया गया है, तो इसका मान डिफ़ॉल्ट मान के बजाय उपयोग किया जाएगा।
प्रलेखन। doc संपत्ति काफी स्पष्ट है। कोड में टिप्पणियों पर एक स्कीमा में प्रलेखन सहित लाभ यह है कि इस जानकारी का उपयोग अधिक जानकारीपूर्ण आउटपुट के लिए conf.toSchemaString() विधि में किया जाता है।

अतिरिक्त कॉन्फ़िगरेशन स्तर

डिफ़ॉल्ट मानों की नींव पर, आप कॉल conf.load() और conf.loadFile() का उपयोग करके अतिरिक्त कॉन्फ़िगरेशन स्तर जोड़ सकते हैं। उदाहरण के लिए, आप किसी विशिष्ट वातावरण के लिए जावास्क्रिप्ट ऑब्जेक्ट से अतिरिक्त पैरामीटर लोड कर सकते हैं:

 var conf = convict({ //   ,      }); if (conf.get('env') === 'production') { //          conf.load({ port: 8080, database: { host: "ec2-117-21-174-242.compute-1.amazonaws.com:8091" } }); } conf.validate(); module.exports = conf;

या आप प्रत्येक वातावरण के लिए अलग विन्यास फाइल बना सकते हैं, और उन्हें conf.loadFile() का उपयोग करके लोड कर conf.loadFile() :

 conf.loadFile('./config/' + conf.get('env') + '.json');

loadFile() एक बार में कई फाइलों को लोड कर सकता है, यदि आप एक तर्क देते हैं:

 // CONFIG_FILES=/path/to/production.json,/path/to/secrets.json,/path/to/sitespecific.json conf.loadFile(process.env.CONFIG_FILES.split(','));

लोड के माध्यम से अतिरिक्त पैरामीटर लोड हो रहा है load() और load() - loadFile() उपयोगी है जब वातावरण में से प्रत्येक के लिए सेटिंग्स हैं जो पर्यावरण चर में सेट नहीं होनी चाहिए। JSON प्रारूप में अलग-अलग घोषणात्मक कॉन्फ़िगरेशन फ़ाइलें आपको अलग-अलग वातावरण में मापदंडों के बीच के अंतर को अधिक स्पष्ट रूप से दर्शाने की अनुमति देती हैं। और चूंकि फाइलें cjson का उपयोग करके अपलोड की जाती हैं , इसलिए उनमें टिप्पणियां हो सकती हैं, जो उन्हें और भी समझने योग्य बनाती हैं।

कृपया ध्यान दें कि पर्यावरण चर में सर्वोच्च प्राथमिकता होती है, जो डिफ़ॉल्ट सेटिंग्स और load() और loadFile() माध्यम से भरी गई सेटिंग्स से अधिक होती है। यह जांचने के लिए कि कौन सी सेटिंग काम कर रही है, आप conf.toString() कॉल कर सकते हैं।

"V" का अर्थ है सत्यापन

सेटिंग्स लोड होने के बाद, आप यह जांचने के लिए सत्यापन चला सकते हैं कि क्या उनके पास योजना के अनुसार सही प्रारूप है। सजा में कई अंतर्निहित प्रारूप हैं, जैसे कि url , ports या ipaddress , और आप अंतर्निहित JavaScript कंस्ट्रक्टर (जैसे Number ) का भी उपयोग कर सकते हैं। यदि format गुण सेट नहीं है, तो दोषी डिफ़ॉल्ट प्रकार से मेल खाने के लिए पैरामीटर प्रकार की जाँच करेगा ( Object.prototype.toString.call पर कॉल करके )। नीचे दी गई तीन योजनाएँ समतुल्य हैं:

 var conf1 = convict({ name: { format: String default: 'Brendan' } }); //    , ,     //  ,      var conf2 = convict({ name: { default: 'Brendan' } }); //    var conf3 = convict({ name: 'Brendan' });

प्रारूप को एक गणना के रूप में भी निर्दिष्ट किया जा सकता है, स्पष्ट रूप से वैध मूल्यों की सूची निर्दिष्ट करता है, उदाहरण के लिए ["production", "development", "test"] । कोई भी मूल्य जो सूची में नहीं है, सत्यापन को पारित नहीं करेगा।

अंतर्निहित प्रकारों के बजाय, आप अपने स्वयं के सत्यापनकर्ताओं का उपयोग कर सकते हैं। उदाहरण के लिए, हम चाहते हैं कि पैरामीटर 64 हेक्साडेसिमल अंकों की एक स्ट्रिंग हो:

 var check = require('validator').check; var conf = convict({ key: { doc: "API key", format: function (val) { check(val, 'should be a 64 character hex key').regex(/^[a-fA-F0-9]{64}$/); }, default: '3cec609c9bc601c047af917a544645c50caf8cd606806b4e0a23312441014deb' } });

conf.validate() कॉल प्रत्येक गलत सेटिंग के बारे में विस्तृत जानकारी लौटाएगा, यदि कोई हो। यह प्रत्येक कॉन्फ़िगरेशन त्रुटि का पता चलने पर अनुप्रयोग को फिर से तैयार करने से बचने में मदद करता है। यदि हम पिछले उदाहरण से 'foo' लिए key पैरामीटर सेट करने का प्रयास करते हैं तो यह त्रुटि संदेश कैसा दिखेगा:

 conf.set('key', 'foo'); conf.validate(); // Error: key: should be a 64 character hex key: value was "foo"

निष्कर्ष

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