Schreibe Middleware für die Verwendung in Express-Apps

Middleware Funktionen sind Funktionen, die Zugriff auf das request object (req), die Antwort-Objekt (res) und die next Funktion im Request-Antwort-Zyklus der Anwendung. Die next-Funktion ist eine Funktion im Express-Router, der beim Aufruf die Middleware ausführt, die die aktuelle Middleware abfolgt.

Middleware-Funktionen können folgende Aufgaben ausführen:

• Führe jeden Code aus.
• Änderungen an der Anfrage und den Antwort-Objekten vornehmen.
• Beende den Request-Antwort-Zyklus.
• Rufen Sie die nächste Middleware im Stapel auf.

Wenn die aktuelle Middleware-Funktion den Request-Antwort-Zyklus nicht beendet, muss sie next() aufrufen, um die Kontrolle an die nächste Middleware-Funktion zu übergeben. Andernfalls bleibt die Anfrage hängen.

Die folgende Abbildung zeigt die Elemente eines Middleware-Funktionsaufrufs:

HTTP-Methode, für die die Middleware-Funktion gilt. Pfad (Route), für den die Middleware-Funktion gilt. Die Middleware-Funktion. Callback-Argument an die Middleware-Funktion, genannt “Next” durch Konvention. HTTP Antwort Argument auf die Middleware-Funktion, genannt “res” von Konvention. HTTP Request Argument an die Middleware-Funktion, genannt “req” von Konvention.

Beginnend mit Express 5 ruft Middleware-Funktionen, die ein Versprechen zurückgeben, next(value) auf, wenn sie einen Fehler ablehnen oder werfen. next wird entweder mit dem abgelehnten Wert oder mit dem Wurffehler aufgerufen.

Beispiel

Hier ist ein Beispiel für eine einfache “Hallo World”-Express-Anwendung. Der Rest dieses Artikels definiert und fügt der Anwendung drei Middleware-Funktionen hinzu: eine mit dem Namen myLogger, die eine einfache Logmeldung ausgibt, einen namens requestTime, der den Zeitstempel der HTTP-Anfrage anzeigt und einen, der validateCookies genannt wird, der eingehende Cookies validiert.

const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000);

Middleware-Funktion myLogger

Hier ist ein einfaches Beispiel für eine Middleware-Funktion namens “myLogger”. Diese Funktion druckt nur “LOGGED”, wenn eine Anfrage an die App durchläuft. Die Middleware-Funktion wird einer Variable mit dem Namen myLogger zugewiesen.

const myLogger = function (req, res, next) {
  console.log('LOGGED');
  next();
};

Um die Middleware-Funktion zu laden, rufen Sie app.use() auf, indem Sie die Middleware-Funktion angeben. Zum Beispiel lädt der folgende Code die myLogger Middleware-Funktion vor der Route zum Root-Pfad (/).

const express = require('express');
const app = express();

const myLogger = function (req, res, next) {
  console.log('LOGGED');
  next();
};

app.use(myLogger);

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000);

Jedes Mal, wenn die App eine Anfrage erhält, gibt sie die Nachricht “LOGGED” auf das Terminal aus.

Die Reihenfolge des Laden von Middleware ist wichtig: Middleware-Funktionen, die zuerst geladen werden, werden auch zuerst ausgeführt.

Wenn myLogger nach der Route zum Wurzelpfad geladen wird, erreicht die Anfrage nie und die App druckt nicht “LOGGED”, da der Route-Handler des Root-Pfades den Request-Antwort-Zyklus beendet.

Die Middleware-Funktion myLogger druckt einfach eine Nachricht, übergibt dann die Anfrage an die nächste Middleware-Funktion im Stack durch Aufruf der next() Funktion.

Middleware-Funktionsanfragezeit

Als nächstes erstellen wir eine Middleware-Funktion namens “requestTime” und fügen eine Eigenschaft namens requestTime dem Anfrageobjekt hinzu.

const requestTime = function (req, res, next) {
  req.requestTime = Date.now();
  next();
};

Die App verwendet nun die „requestTime“-Middleware-Funktion. Auch die Callback-Funktion der Root-Pfadroute verwendet die Eigenschaft, die die Middleware-Funktion zu req hinzufügt (das Anfrageobjekt).

const express = require('express');
const app = express();

const requestTime = function (req, res, next) {
  req.requestTime = Date.now();
  next();
};

app.use(requestTime);

app.get('/', (req, res) => {
  let responseText = 'Hello World!<br>';
  responseText += `<small>Requested at: ${req.requestTime}</small>`;
  res.send(responseText);
});

app.listen(3000);

Wenn Sie eine Anfrage an das Stammverzeichnis der App stellen, zeigt die App nun den Zeitstempel Ihrer Anfrage im Browser an.

Middleware-Funktion validateCookies

Schließlich erstellen wir eine Middleware-Funktion, die eingehende Cookies validiert und eine 400 Antwort schickt, wenn Cookies ungültig sind.

Hier ist eine Beispielfunktion, die Cookies mit einem externen Asynchrondienst überprüft.

async function cookieValidator(cookies) {
  try {
    await externallyValidateCookie(cookies.testCookie);
  } catch {
    throw new Error('Invalid cookies');
  }
}

Hier verwenden wir die cookie-parser Middleware, um eingehende Cookies vom req Objekt zu analysieren und sie an unsere cookieValidator Funktion zu übergeben. Die validateCookies Middleware gibt ein Versprechen zurück, das bei Ablehnung automatisch unseren Fehlerhandler auslöst.

const express = require('express');
const cookieParser = require('cookie-parser');
const cookieValidator = require('./cookieValidator');

const app = express();

async function validateCookies(req, res, next) {
  await cookieValidator(req.cookies);
  next();
}

app.use(cookieParser());

app.use(validateCookies);

// error handler
app.use((err, req, res, next) => {
  res.status(400).send(err.message);
});

app.listen(3000);

Weil Sie Zugriff auf das Anfrageobjekt, das Antwortobjekt, die nächste Middleware-Funktion im Stapel und den gesamten Knoten haben. s API, die Möglichkeiten mit Middleware-Funktionen sind endlos.

Für weitere Informationen über Express Middleware siehe: Express Middleware.

Konfigurierbare Middleware

Wenn Sie Ihre Middleware konfigurieren müssen, exportieren Sie eine Funktion, die ein Optionsobjekt oder andere Parameter akzeptiert, , die dann die Middleware-Implementierung basierend auf den Eingabeparametern zurückgibt.

Datei: my-middleware.js

module.exports = function (options) {
  return function (req, res, next) {
    // Implement the middleware function based on the options object
    next();
  };
};

Die Middleware kann nun wie unten gezeigt verwendet werden.

const mw = require('./my-middleware.js');

app.use(mw({ option1: '1', option2: '2' }));

Siehe cookie-session und compression für Beispiele konfigurierbarer Middleware.