Weiterleitung (Routing)

Der Begriff Weiterleitung (Routing) bezieht sich auf die Definition von Anwendungsendpunkten (URIs) und deren Antworten auf Clientanforderungen. Eine Einführung in dieses Routing siehe Basisrouting.

Der folgende Code ist ein Beispiel für ein sehr einfaches Basisrouting.

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

// respond with "hello world" when a GET request is made to the homepage
app.get('/', function(req, res) {
  res.send('hello world');
});

Weiterleitungsmethoden

Eine Weiterleitungsmethode wird von einer HTTP-Methode abgeleitet und an eine Instanz der Klasse express angehängt.

Der folgende Code ist ein Beispiel für Weiterleitungen, die für die Methoden GET und POST zum Stamm (Root) der Anwendung definiert werden.

// GET method route
app.get('/', function (req, res) {
  res.send('GET request to the homepage');
});

// POST method route
app.post('/', function (req, res) {
  res.send('POST request to the homepage');
});

Express unterstützt die folgenden Weiterleitungsmethoden, die den HTTP-Methoden entsprechen: get, post, put, head, delete, options, trace, copy, lock, mkcol, move, purge, propfind, proppatch, unlock, report, mkactivity, checkout, merge, m-search, notify, subscribe, unsubscribe, patch, search und connect.

Es gibt eine spezielle Weiterleitungsmethode, app.all(), die nicht von einer HTTP-Methode abgeleitet wird. Diese Methode wird zum Laden von Middlewarefunktionen bei einem Pfad für alle Anforderungsmethoden verwendet.

Im folgenden Beispiel wird der Handler für Anforderungen zur Weiterleitung “/secret” ausgeführt, um herauszufinden, ob Sie GET-, POST-, PUT-, DELETE- oder andere HTTP-Anforderungsmethoden verwenden, die im HTTP-Modul unterstützt werden.

app.all('/secret', function (req, res, next) {
  console.log('Accessing the secret section ...');
  next(); // pass control to the next handler
});

Weiterleitungspfade

Über Weiterleitungspfade werden in Kombination mit einer Anforderungsmethode die Endpunkte definiert, bei denen Anforderungen erfolgen können. Weiterleitungspfade können Zeichenfolgen, Zeichenfolgemuster oder reguläre Ausdrücke sein.

Dies sind einige Beispiele für Weiterleitungspfade auf Basis von Zeichenfolgen.

Dieser Weiterleitungspfad gleicht Weiterleitungsanforderungen zum Stammverzeichnis (/) ab.

app.get('/', function (req, res) {
  res.send('root');
});

Dieser Weiterleitungspfad gleicht Anforderungen mit /about ab.

app.get('/about', function (req, res) {
  res.send('about');
});

Dieser Weiterleitungspfad gleicht Anforderungen mit /random.text ab.

app.get('/random.text', function (req, res) {
  res.send('random.text');
});

Dies sind einige Beispiele für Weiterleitungspfade auf Basis von Zeichenfolgemustern.

Dieser Weiterleitungspfad gleicht acd und abcd ab.

app.get('/ab?cd', function(req, res) {
  res.send('ab?cd');
});

Dieser Weiterleitungspfad gleicht abcd, abbcd, abbbcd usw. ab.

app.get('/ab+cd', function(req, res) {
  res.send('ab+cd');
});

Dieser Weiterleitungspfad gleicht abcd, abxcd, abRABDOMcd, ab123cd usw. ab.

app.get('/ab*cd', function(req, res) {
  res.send('ab*cd');
});

Dieser Weiterleitungspfad gleicht /abe und /abcde ab.

app.get('/ab(cd)?e', function(req, res) {
 res.send('ab(cd)?e');
});

Beispiele für Weiterleitungspfade auf Basis regulärer Ausdrücke:

Dieser Weiterleitungspfad gleicht alle Weiterleitungsnamen ab, die den Buchstaben “a” enthalten.

app.get(/a/, function(req, res) {
  res.send('/a/');
});

Dieser Weiterleitungspfad gleicht butterfly und dragonfly, jedoch nicht butterflyman, dragonfly man usw. ab.

app.get(/.*fly$/, function(req, res) {
  res.send('/.*fly$/');
});

Routenhandler (Weiterleitungsroutinen)

Sie können mehrere Callback-Funktionen angeben, die sich wie Middleware verhalten, um eine Anforderung zu verarbeiten. Die einzige Ausnahme hierbei ist, dass diese Callbacks möglicherweise next('route') aufrufen, um die verbleibenden Weiterleitungs-Callbacks zu umgehen. Mit diesem Verfahren können Sie Vorabbedingungen für eine Weiterleitung festlegen und dann die Steuerung an nachfolgende Weiterleitungen übergeben, wenn kein Grund vorliegt, mit der aktuellen Weiterleitung fortzufahren.

Routenhandler können eine Funktion und/oder ein Funktionsarray sein, wie in den folgenden Beispielen zu sehen ist.

Eine einzelne Callback-Funktion kann eine Weiterleitung verarbeiten. Beispiel:

app.get('/example/a', function (req, res) {
  res.send('Hello from A!');
});

Mehrere Callback-Funktionen können eine Weiterleitung verarbeiten (achten Sie darauf, dass Sie das Objekt next angeben). Beispiel:

app.get('/example/b', function (req, res, next) {
  console.log('the response will be sent by the next function ...');
  next();
}, function (req, res) {
  res.send('Hello from B!');
});

Ein Array von Callback-Funktionen kann eine Weiterleitung verarbeiten. Beispiel:

var cb0 = function (req, res, next) {
  console.log('CB0');
  next();
}

var cb1 = function (req, res, next) {
  console.log('CB1');
  next();
}

var cb2 = function (req, res) {
  res.send('Hello from C!');
}

app.get('/example/c', [cb0, cb1, cb2]);

Eine Kombination aus unabhängigen Funktionen und Funktionsarrays kann eine Weiterleitung verarbeiten. Beispiel:

var cb0 = function (req, res, next) {
  console.log('CB0');
  next();
}

var cb1 = function (req, res, next) {
  console.log('CB1');
  next();
}

app.get('/example/d', [cb0, cb1], function (req, res, next) {
  console.log('the response will be sent by the next function ...');
  next();
}, function (req, res) {
  res.send('Hello from D!');
});

Antwortmethoden

Über die Methoden für das Antwortobjekt (res) in der folgenden Tabelle kann eine Antwort an den Client gesendet und der Anforderung/Antwort-Zyklus beendet werden. Wenn keine dieser Methoden über einen Routenhandler aufgerufen wird, bleibt die Clientanforderung im Status “blockiert”.

app.route()

Sie können mithilfe von app.route() verkettbare Routenhandler für einen Weiterleitungspfad erstellen. Da der Pfad an einer einzelnen Position angegeben wird, ist das Erstellen modularer Weiterleitungen hilfreich, da Redundanzen und Schreibfehler reduziert werden. Weitere Informationen zu Weiterleitungen finden Sie in der Dokumentation zu Router().

Dies ist ein Beispiel für verkettete Routenhandler, die mit der Funktion app.route() definiert werden.

app.route('/book')
  .get(function(req, res) {
    res.send('Get a random book');
  })
  .post(function(req, res) {
    res.send('Add a book');
  })
  .put(function(req, res) {
    res.send('Update the book');
  });

express.Router

Mit der Klasse express.Router lassen sich modular einbindbare Routenhandler erstellen. Eine Router-Instanz ist ein vollständiges Middleware- und Routingsystem. Aus diesem Grund wird diese Instanz oft auch als “Mini-App” bezeichnet.

Im folgenden Beispiel wird ein Router als Modul erstellt, eine Middlewarefunktion in das Modul geladen, es werden Weiterleitungen definiert und das Modul letztendlich in einen Pfad in der Hauptanwendung eingebunden.

Erstellen Sie eine Routerdatei namens birds.js mit dem folgenden Inhalt im Anwendungsverzeichnis:

var express = require('express');
var router = express.Router();

// middleware that is specific to this router
router.use(function timeLog(req, res, next) {
  console.log('Time: ', Date.now());
  next();
});
// define the home page route
router.get('/', function(req, res) {
  res.send('Birds home page');
});
// define the about route
router.get('/about', function(req, res) {
  res.send('About birds');
});

module.exports = router;

Laden Sie dann das Routermodul in die Anwendung:

var birds = require('./birds');
...
app.use('/birds', birds);

Die Anwendung kann nun Anforderungen an die Pfade /birds und /birds/about bearbeiten und ruft die Middlewarefunktion timeLog auf, die speziell für diese Weiterleitung bestimmt ist.