Analyse der modul- und paketbasierten Codebereitstellungsmethode von Node.js_node.js

Regeln zur Modulpfadauflösung

Erfahrene C-Programmierer beginnen mit der Make-Datei, wenn sie ein neues Programm schreiben. Bevor Sie NodeJS zum Schreiben eines Programms verwenden, müssen Sie für einen guten Start zunächst die Verzeichnisstruktur und die Bereitstellungsmethode des Codes vorbereiten, genau wie beim Bau eines Gerüsts bei der Reparatur eines Hauses. In diesem Kapitel werden verschiedene verwandte Kenntnisse vorgestellt.

Regeln zur Modulpfadauflösung
Wir wissen bereits, dass die Funktion require absolute Pfade unterstützt, die mit einem Schrägstrich (/) oder einem Laufwerksbuchstaben (C:) beginnen, und auch relative Pfade, die mit ./ beginnen. Diese beiden Pfade stellen jedoch eine starke Kopplungsbeziehung zwischen Modulen her. Sobald der Speicherort einer Moduldatei geändert werden muss, muss auch der Code anderer Module, die dieses Modul verwenden, entsprechend angepasst werden, was zu einem Problem für den gesamten Körper wird . Daher unterstützt die Anforderungsfunktion die dritte Pfadform, die ähnlich wie foo/bar geschrieben ist, und analysiert den Pfad nacheinander gemäß den folgenden Regeln, bis der Modulspeicherort gefunden wird.

Eingebaute Module

Wenn der an die Anforderungsfunktion übergebene Name ein in NodeJS integrierter Modulname ist, wird keine Pfadanalyse durchgeführt und das exportierte Objekt des internen Moduls wird direkt zurückgegeben, z. B. require('fs').

node_modules-Verzeichnis

NodeJS definiert ein spezielles node_modules-Verzeichnis zum Speichern von Modulen. Der absolute Pfad eines Moduls lautet beispielsweise /home/user/hello.js. Wenn die Methode require('foo/bar') zum Laden des Moduls verwendet wird, versucht NodeJS, die folgenden Pfade nacheinander zu verwenden .

 /home/user/node_modules/foo/bar
 /home/node_modules/foo/bar
 /node_modules/foo/bar

NODE_PATH Umgebungsvariable

Ähnlich wie die Umgebungsvariable PATH ermöglicht NodeJS die Angabe zusätzlicher Modulsuchpfade über die Umgebungsvariable NODE_PATH. Die Umgebungsvariable NODE_PATH enthält einen oder mehrere Verzeichnispfade. Die Pfade werden durch : unter Linux und ; unter Windows getrennt. Beispielsweise ist die folgende Umgebungsvariable NODE_PATH definiert:

NODE_PATH=/home/user/lib:/home/lib
Wenn Sie require('foo/bar') zum Laden eines Moduls verwenden, versucht NodeJS nacheinander die folgenden Pfade.

 /home/user/lib/foo/bar
 /home/lib/foo/bar

Packen

Wir wissen bereits, dass die Grundeinheit eines JS-Moduls eine einzelne JS-Datei ist, komplexere Module bestehen jedoch häufig aus mehreren Untermodulen. Um die Verwaltung und Verwendung zu erleichtern, können wir ein großes Modul, das aus mehreren Untermodulen besteht, als Paket bezeichnen und alle Untermodule im selben Verzeichnis ablegen.

Unter allen Untermodulen, aus denen ein Paket besteht, muss es ein Einstiegsmodul geben, und das Exportobjekt des Einstiegsmoduls wird als Exportobjekt des Pakets verwendet. Beispielsweise gibt es die folgende Verzeichnisstruktur.

- /home/user/lib/
  - cat/
    head.js
    body.js
    main.js

Das Cat-Verzeichnis definiert ein Paket, das 3 Untermodule enthält. main.js dient als Einstiegsmodul und hat folgenden Inhalt:

var head = require('./head');
var body = require('./body');

exports.create = function (name) {
  return {
    name: name,
    head: head.create(),
    body: body.create()
  };
};

Wenn Sie ein Paket in anderen Modulen verwenden, müssen Sie das Einstiegsmodul des Pakets laden. Um mit dem obigen Beispiel fortzufahren, kann die Verwendung von require('/home/user/lib/cat/main') das Ziel erreichen, aber es scheint keine gute Idee zu sein, wenn der Name des Eingabemoduls im Pfad erscheint. Wir müssen also ein wenig zusätzliche Arbeit leisten, damit sich das Paket eher wie ein einzelnes Modul verhält.

index.js
Wenn der Dateiname des Moduls index.js lautet, können Sie beim Laden des Moduls den Pfad des Verzeichnisses verwenden, in dem sich das Modul befindet, anstelle des Moduldateipfads. Befolgen Sie daher die folgenden beiden Aussagen sind gleichwertig.

var cat = require('/home/user/lib/cat');
var cat = require('/home/user/lib/cat/index');

Nach der Verarbeitung auf diese Weise müssen Sie nur noch den Paketverzeichnispfad an die Anforderungsfunktion übergeben. Es fühlt sich an, als würde das gesamte Verzeichnis als einzelnes Modul verwendet, was ein ganzheitlicheres Gefühl vermittelt.

package.json
Wenn Sie den Dateinamen und den Speicherort des Einstiegsmoduls anpassen möchten, müssen Sie eine package.json-Datei in das Paketverzeichnis einfügen und darin den Pfad des Einstiegsmoduls angeben. Das Cat-Modul im obigen Beispiel kann wie folgt umgestaltet werden.

- /home/user/lib/
  - cat/
    + doc/
    - lib/
      head.js
      body.js
      main.js
    + tests/
    package.json

Der Inhalt von package.json ist wie folgt.

{
  "name": "cat",
  "main": "./lib/main.js"
}

Auf diese Weise können Sie auch require('/home/user/lib/cat') verwenden, um das Modul zu laden. NodeJS findet den Speicherort des Einstiegsmoduls basierend auf package.json im Paketverzeichnis.