एक्सप्रेस में त्रुटि से निपटने

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

सिंक्रोनस त्रुटि हैंडलिंग

यदि आपको एक तुल्यकालिक त्रुटि को संभालने की आवश्यकता है, तो आप सबसे पहले, throw स्टेटमेंट का उपयोग कर सकते हैं, इस तरह की त्रुटि को एक्सप्रेस अनुरोध हैंडलर में throw हैं। कृपया ध्यान दें कि अनुरोध हैंडलर को "नियंत्रक" भी कहा जाता है, लेकिन मैं "अनुरोध हैंडलर" शब्द का उपयोग करना पसंद करता हूं क्योंकि यह मुझे अधिक स्पष्ट रूप से लगता है।

यहाँ यह कैसा दिखता है:

 app.post('/testing', (req, res) => {  throw new Error('Something broke! ') }) 

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

यहाँ मानक एक्सप्रेस त्रुटि हैंडलर क्या करता है:

1. HTTP प्रतिक्रिया स्थिति कोड को 500 पर सेट करता है।
2. अनुरोध को निष्पादित करने वाली इकाई को एक पाठ प्रतिक्रिया भेजता है।
3. कंसोल पर एक पाठ प्रतिक्रिया लॉग करता है।

कंसोल में प्रदर्शित त्रुटि संदेश

अतुल्यकालिक त्रुटि हैंडलिंग

अतुल्यकालिक त्रुटियों को संभालने के लिए, आपको next तर्क के माध्यम से एक्सप्रेस त्रुटि हैंडलर को एक त्रुटि भेजने की आवश्यकता है:

 app.post('/testing', async (req, res, next) => {  return next(new Error('Something broke again! ')) }) 

इस त्रुटि को लॉग करते समय कंसोल को यही मिलता है।


कंसोल में प्रदर्शित त्रुटि संदेश

यदि आप किसी एक्सप्रेस एप्लिकेशन में async / wait निर्माण का उपयोग करते हैं, तो आपको एक्सप्रेस-async-हैंडलर जैसे आवरण फ़ंक्शन का उपयोग करना होगा। यह आपको बिना कोशिश / ब्लॉक को पकड़ने के लिए एसिंक्रोनस कोड लिखने की अनुमति देता है। एक्सप्रेस में async / प्रतीक्षा के बारे में और पढ़ें।

 const asyncHandler = require('express-async-handler') app.post('/testing', asyncHandler(async (req, res, next) => {  //  - })) 

अनुरोध हैंडलर को express-async-handler में लपेटे जाने के बाद, आप ऊपर बताए अनुसार, throw स्टेटमेंट का उपयोग करके एक त्रुटि throw । यह त्रुटि एक्सप्रेस त्रुटि हैंडलर के पास जाएगी।

 app.post('/testing', asyncHandler(async (req, res, next) => {  throw new Error('Something broke yet again! ') })) 

कंसोल में प्रदर्शित त्रुटि संदेश

अपनी खुद की त्रुटि हैंडलर लेखन

एक्सप्रेस त्रुटि संचालकों 4 तर्क ले:

1. त्रुटि
2. अनुरोध
3. रेस
4. अगला

आपको मध्यवर्ती हैंडलर और मार्गों के बाद उन्हें रखने की आवश्यकता है।

 app.use(/*...*/) app.get(/*...*/) app.post(/*...*/) app.put(/*...*/) app.delete(/*...*/) //           app.use((error, req, res, next) => { /* ... */ }) 

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

1. एक उपयुक्त प्रतिक्रिया स्थिति कोड बनाएं और भेजें।
2. फॉर्म और एक उपयुक्त उत्तर भेजें।

प्रत्येक विशेष मामले में कौन सा स्थिति कोड उपयुक्त है यह इस बात पर निर्भर करता है कि वास्तव में क्या हुआ था। यहां उन सामान्य त्रुटियों की एक सूची दी गई है जिन्हें आपको संभालने के लिए तैयार रहना चाहिए:

1. त्रुटि 400 Bad Request । दो स्थितियों में इस्तेमाल किया। सबसे पहले, जब उपयोगकर्ता ने अनुरोध में आवश्यक फ़ील्ड को शामिल नहीं किया था (उदाहरण के लिए, क्रेडिट कार्ड की जानकारी वाला फ़ील्ड भेजे गए भुगतान फ़ॉर्म में नहीं भरा गया था)। दूसरे, जब अनुरोध में गलत डेटा होता है (उदाहरण के लिए, पासवर्ड फ़ील्ड में और पासवर्ड पुष्टि क्षेत्र में अलग-अलग पासवर्ड दर्ज करना)।
2. त्रुटि 401 Unauthorized । यदि उपयोगकर्ता ने गलत क्रेडेंशियल (जैसे उपयोगकर्ता नाम, ईमेल पता या पासवर्ड) दर्ज किया है तो यह प्रतिक्रिया स्थिति कोड लागू होता है।
3. त्रुटि 403 Forbidden । उपयोग किया जाता है जब उपयोगकर्ता को समापन बिंदु तक पहुंच की अनुमति नहीं है।
4. त्रुटि 404 Not Found । इसका उपयोग उन मामलों में किया जाता है जहां समापन बिंदु का पता नहीं लगाया जा सकता है।
5. 500 Internal Server Error । यह तब लागू किया जाता है जब फ्रंट-एंड द्वारा भेजा गया अनुरोध सही तरीके से बनता है, लेकिन बैक-एंड पर कुछ त्रुटि हुई।

उपयुक्त प्रतिक्रिया स्थिति कोड परिभाषित होने के बाद, इसे res.status का उपयोग करके सेट किया जाना चाहिए:

 app.use((error, req, res, next) => {  // ,         res.status(400)  res.json(/* ... */) }) 

प्रतिक्रिया स्थिति कोड त्रुटि संदेश के अनुरूप होना चाहिए। ऐसा करने के लिए, त्रुटि के साथ स्थिति कोड भेजें।

ऐसा करने का सबसे आसान तरीका http-त्रुटियों का पैकेज है। यह त्रुटि में जानकारी के तीन टुकड़े भेजने की अनुमति देता है:

1. प्रतिक्रिया स्थिति कोड।
2. त्रुटि के साथ जुड़ा संदेश।
3. कोई भी डेटा जिसे भेजा जाना आवश्यक है (यह वैकल्पिक है)।

http-errors पैकेज को कैसे स्थापित करें:

 npm install http-errors --save 

इस पैकेज का उपयोग कैसे करें:

 const createError = require('http-errors') //   throw createError(status, message, properties) 

एक उदाहरण पर विचार करें जो आपको यह सब ठीक से समझने की अनुमति देगा।

कल्पना कीजिए कि हम एक उपयोगकर्ता को उसके ईमेल पते पर खोजने की कोशिश कर रहे हैं। लेकिन यह उपयोगकर्ता नहीं मिल सकता है। नतीजतन, हम User not found कॉल करने वाले को सूचित करते हुए, संबंधित अनुरोध के जवाब में एक User not found त्रुटि भेजने का निर्णय लेते हैं।

त्रुटि पैदा करते समय हमें यही करना होगा:

1. प्रतिक्रिया स्थिति कोड को 400 Bad Request सेट करें (आखिरकार, उपयोगकर्ता ने गलत डेटा दर्ज किया)। यह हमारा पहला पैरामीटर होगा।
2. कॉल करने वाले को संदेश भेजें जैसे User not found । यह दूसरा पैरामीटर होगा।

 app.put('/testing', asyncHandler(async (req, res) => {  const { email } = req.body  const user = await User.findOne({ email })  //     -    if (!user) throw createError(400, `User '${email}' not found`) })) 

आप error.status निर्माण, और error.message का उपयोग कर त्रुटि संदेश का उपयोग करके स्थिति कोड प्राप्त कर सकते हैं:

 //   app.use((error, req, res, next) => {  console.log('Error status: ', error.status)  console.log('Message: ', error.message) }) 

कंसोल में लॉगिंग त्रुटियों का परिणाम

तब प्रतिक्रिया स्थिति res.status का उपयोग करके सेट की res.status , और संदेश res.json को लिखा जाता है:

 app.use((error, req, res, next) => {  //      res.status(error.status)  //    res.json({ message: error.message }) }) 

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

 app.use((error, req, res, next) => {  //      res.status(error.status)  //    res.json({    status: error.status,    message: error.message,    stack: error.stack  }) }) 

Code डिफ़ॉल्ट प्रतिक्रिया स्थिति कोड

यदि त्रुटि का स्रोत createError नहीं है, तो उसके पास status प्रॉपर्टी नहीं होगी। यहाँ एक उदाहरण है जिसमें fs.readFile का उपयोग करके एक गैर-मौजूद फ़ाइल को पढ़ने का प्रयास किया गया था:

 const fs = require('fs') const util = require('util') //  readFile  ,  ,  async/await-. //     : https://zellwk.com/blog/callbacks-to-promises const readFilePromise = util.promisify(fs.readFile) app.get('/testing', asyncHandler(async (req, res, next) => {  const data = await readFilePromise('some-file') }) 

ऐसी त्रुटि ऑब्जेक्ट में status गुण नहीं होगा:

 app.use((error, req, res, next) => {  console.log('Error status: ', error.status)  console.log('Message: ', error.message) }) 

कंसोल में लॉगिंग त्रुटियों का परिणाम

ऐसे मामलों में, आप डिफ़ॉल्ट त्रुटि कोड सेट कर सकते हैं। अर्थात्, हम 500 Internal Server Error बारे में बात कर रहे हैं:

 app.use((error, req, res, next) => {  res.status(error.status || 500)  res.json({    status: error.status,    message: error.message,    stack: error.stack  }) }) 

Code त्रुटि स्थिति कोड को बदलना

मान लीजिए कि हम उपयोगकर्ता द्वारा प्रदान किए गए डेटा का उपयोग करके एक निश्चित फ़ाइल पढ़ने जा रहे हैं। यदि ऐसी कोई फ़ाइल मौजूद नहीं है, तो इसका मतलब है कि हमें 400 Bad Request त्रुटि देने की आवश्यकता है। आखिरकार, सर्वर नहीं मिल सकता है क्योंकि फ़ाइल नहीं मिल सकती है।

इस मामले में, आपको मूल त्रुटि को पकड़ने के लिए कोशिश / पकड़ने के निर्माण का उपयोग करने की आवश्यकता है। फिर आपको createError का उपयोग करके त्रुटि ऑब्जेक्ट को फिर से createError :

 app.get('/testing', asyncHandler(async (req, res, next) => {  try {    const { file } = req.body    const contents = await readFilePromise(path.join(__dirname, file))  } catch (error) {    throw createError(400, `File ${file} does not exist`)  } }) 

▍ 404 त्रुटि से निपटने

यदि अनुरोध सभी मध्यवर्ती हैंडलर और मार्गों के माध्यम से चला गया, लेकिन संसाधित नहीं किया गया था, तो इसका मतलब है कि इस तरह के अनुरोध के अनुरूप समापन बिंदु नहीं मिला था।

404 Not Found त्रुटियों को संभालने के लिए, आपको मार्गों और त्रुटि हैंडलर, एक अतिरिक्त हैंडलर के बीच जोड़ना होगा। यहाँ 404 त्रुटि ऑब्जेक्ट का निर्माण कैसा दिखता है:

 //  ... // ... app.use((req, res, next) => {  next(createError(404)) }) //  ... 

त्रुटि विवरण

HT ERR_HTTP_HEADERS_SENT त्रुटि नोट

यदि आपको त्रुटि संदेश ERR_HTTP_HEADERS_SENT: Cannot set headers after they are sent to the client दिखाई देता है तो ERR_HTTP_HEADERS_SENT: Cannot set headers after they are sent to the client । यह उठता है क्योंकि उसी हैंडलर में प्रतिक्रिया हेडर सेट करने वाली विधि को बार-बार कहा जाता है। यहां वे विधियां हैं जो प्रतिक्रिया हेडर को स्वचालित रूप से सेट करने के लिए कहते हैं:

1. res.send
2. res.json
3. res.render
4. res.sendFile
5. res.sendStatus
6. res.end
7. res.redirect

इसलिए, उदाहरण के लिए, यदि आप एक ही प्रतिक्रिया हैंडलर में res.render और res.json को कॉल करते हैं, तो आपको त्रुटि ERR_HTTP_HEADERS_SENT :

 app.get('/testing', (req, res) => {  res.render('new-page')  res.json({ message: '¯\_(ツ)_/¯' }) }) 

परिणामस्वरूप, यदि आप इस त्रुटि का सामना करते हैं, तो प्रतिक्रिया हैंडलर कोड की सावधानीपूर्वक जांच करें और सुनिश्चित करें कि ऐसी कोई स्थिति नहीं है जिसमें ऊपर वर्णित कई विधियां कहलाती हैं।

▍ त्रुटि से निपटने और डेटा स्ट्रीमिंग

यदि फ्रंटएंड की प्रतिक्रिया को स्ट्रीम करते समय कुछ गलत हो जाता है, तो आप उसी त्रुटि ERR_HTTP_HEADERS_SENT सामना कर सकते हैं।

इस स्थिति में, त्रुटि से निपटने के मानक हैंडलर को पारित किया जाना चाहिए। ऐसा हैंडलर एक त्रुटि भेजेगा और स्वचालित रूप से कनेक्शन बंद कर देगा।

 app.use((error, req, res, next) => {  //       ,        if (res.headersSent) {    return next(error)  }  //     }) 

परिणाम

आज मैंने आपको एक्सप्रेस में त्रुटि से निपटने के बारे में सब कुछ बताया। मुझे आशा है कि यह आपको अधिक विश्वसनीय एक्सप्रेस एप्लिकेशन लिखने में मदद करता है।

प्रिय पाठकों! आप अपनी Node.js परियोजनाओं में त्रुटियों को कैसे संभालते हैं?