Meilleures pratiques de gestion des erreurs NodeJS

NodeJS est un environnement d'exécution JavaScript open source côté serveur basé sur des E/S asynchrones basées sur des événements. Son efficacité et son évolutivité font de NodeJS la technologie de choix pour de nombreuses applications Web d'entreprise. Cependant, comme tous les autres logiciels, les applications NodeJS ne sont pas totalement à l'abri des erreurs et des exceptions. Afin d’améliorer la robustesse et la fiabilité de votre code, il est très important de gérer correctement les erreurs.

Cet article vise à fournir quelques bonnes pratiques pour la gestion des erreurs NodeJS afin d'aider les développeurs à améliorer fondamentalement la façon dont ils gèrent les erreurs.

1. Utilisation des objets d'erreur

JavaScript fournit des objets d'erreur intégrés, qui sont des moyens standard de représenter les erreurs d'exécution. Dans NodeJS, les développeurs peuvent créer leurs propres objets d'erreur personnalisés basés sur l'objet Error pour mieux s'adapter aux besoins spécifiques de l'application. Voici un exemple simple :

class DatabaseConnectionError extends Error {
  constructor(msg, userFriendlyMsg) {
    super(msg);
    this.userFriendlyMsg = userFriendlyMsg;
    this.name = this.constructor.name;
    Error.captureStackTrace(this, this.constructor);
  }
}

Dans cet exemple, nous étendons l'objet Error intégré de NodeJS et ajoutons un attribut userFriendlyMsg pour fournir des informations d'erreur conviviales, et surchargeons le constructeur pour permettre la création de messages d'erreur. ces informations de manière transparente.

2. Gérez les exceptions asynchrones avec élégance

Étant donné que NodeJS est une E/S asynchrone, sa méthode de gestion des exceptions est différente du code synchrone traditionnel. Par conséquent, la gestion des exceptions dans le code asynchrone nécessite de suivre des règles différentes. Voici deux façons de gérer les exceptions asynchrones avec élégance :

1. Gestion des exceptions dans les fonctions de rappel

Dans NodeJS, les fonctions de rappel sont au cœur des solutions basées sur les événements. Habituellement, la fonction de rappel prendra la forme à deux paramètres de (erreur, données), où le paramètre d'erreur représente l'erreur qui peut survenir lors d'un fonctionnement asynchrone et le paramètre de données représente le résultat de l'opération asynchrone.

Afin de gérer correctement les exceptions dans les fonctions de rappel, nous vous recommandons d'utiliser le modèle de rappel d'erreur en premier, c'est-à-dire de transmettre l'objet d'erreur dans le premier paramètre de la fonction de rappel. Bien sûr, dans certains cas, vous pouvez utiliser une instruction try-catch pour intercepter les exceptions dans une fonction de rappel, mais ce n'est généralement pas une bonne pratique.

Voici un exemple simple :

function readFile(filePath, callback) {
  fs.readFile(filePath, (err, data) => {
    if (err) {
      callback(new Error(`Failed to read file: ${filePath}`));
    } else {
      callback(null, data);
    }
  });
}

Dans cet exemple, nous vérifions manuellement les erreurs dans la fonction de rappel et passons l'objet d'erreur comme premier paramètre au rappel.

2. Gestion des exceptions Promise

Promise est une manière plus élégante de gérer le code asynchrone dans JavaScript moderne. Avec Promise, les exceptions pouvant survenir lors d'opérations asynchrones peuvent être gérées plus naturellement. Voici un exemple simple :

function readFilePromise(filePath) {
  return new Promise((resolve, reject) => {
    fs.readFile(filePath, (err, data) => {
      if (err) {
        reject(new Error(`Failed to read file: ${filePath}`));
      } else {
        resolve(data);
      }
    });
  });
}

Dans cet exemple, nous utilisons l'objet Promise pour gérer l'opération de lecture asynchrone du fichier, et utilisons la méthode de rejet pour définir le statut de la promesse sur "rejeté" en cas de problème. exception. Notez que chaque lien de la chaîne de gestion des exceptions Promise doit appeler la méthode catch ou utiliser la méthode Promise.allSettled() pour garantir qu'aucune exception n'est ignorée.

3. Rédigez de bons enregistrements de journal

Lorsqu'une erreur se produit, la journalisation est une tâche importante. Les journaux peuvent nous aider à localiser rapidement les problèmes, à trouver la cause première des erreurs et à trouver des solutions appropriées.

Dans NodeJS, la journalisation peut utiliser l'objet console intégré, ou vous pouvez utiliser des bibliothèques de journalisation tierces, telles que winston.js, bunyan, etc.

Si vous disposez de plusieurs instances NodeJS ou que vous exécutez sur plusieurs serveurs, vous devez enregistrer les erreurs dans un système de journalisation central tel que Elasticsearch, Graylog, Logstash, etc.

4. Utilisez des outils de débogage appropriés

Les grandes applications serveur comme NodeJS peuvent devenir très complexes, et le débogage lorsque des erreurs se produisent peut devenir délicat. Pour déboguer plus facilement les applications NodeJS, nous pouvons utiliser certains outils de débogage appropriés. Voici quelques outils de débogage couramment utilisés :

1. Débogueur intégré de Node.js

Le débogueur intégré de NodeJS est un environnement REPL qui s'exécute dans le processus NodeJS. Il nous aide à effectuer le débogage interactif au moment de l'exécution, à inspecter les variables, à exécuter des expressions, à parcourir le code, etc.

Pour activer le débogueur intégré de NodeJS, utilisez la ligne de commande suivante :

node debug [app.js]

2. Chrome Developer Tools

Chrome Developer Tools est l'un des outils de débogage couramment utilisés par les développeurs Web et peut également être utilisé pour déboguer le programme d'applications NodeJS. . Pour déboguer une application NodeJS à l'aide des outils de développement Chrome, utilisez la ligne de commande suivante :

node --inspect[=[host:port]] [app.js]

Ensuite, nous pouvons ouvrir le navigateur Chrome et visiter l'URL suivante :

chrome://inspect

Dans l'option "Remote Target", recherchez notre application NodeJS et cliquez sur le bouton "Inspecter" pour ouvrir les outils de développement.

Résumé

Cet article présente quelques bonnes pratiques pour la gestion des erreurs NodeJS, qui peuvent aider les développeurs à mieux gérer et résoudre les erreurs dans les applications Web. En utilisant des objets Error, en gérant les exceptions asynchrones avec élégance, en écrivant une bonne journalisation et en utilisant des outils de débogage appropriés, nous pouvons rapidement localiser et résoudre les problèmes, améliorant ainsi la fiabilité et la robustesse de nos applications.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!