Node.js - Verwendung von module.exports als Konstruktor

Laut dem Node.js-Handbuch:

Wenn Sie möchten, dass das Stammverzeichnis des Exports Ihres Moduls eine Funktion ist (z. B. ein Konstruktor), oder wenn Sie ein vollständiges Objekt in einer Zuweisung exportieren möchten, anstatt jeweils eine Eigenschaft zu erstellen, weisen Sie es module.exports anstelle von export zu .

Das gegebene Beispiel ist:

// file: square.js
module.exports = function(width) {
  return {
    area: function() {
      return width * width;
    }
  };
}

und so verwendet:

var square = require('./square.js');
var mySquare = square(2);
console.log('The area of my square is ' + mySquare.area());

Meine Frage: Warum verwendet das Beispiel kein Quadrat als Objekt? Ist das Folgende gültig und macht es das Beispiel "objektorientierter"?

var Square = require('./square.js');
var mySquare = new Square(2);
console.log('The area of my square is ' + mySquare.area());

Mit CommonJS-Modulen können exportierte Eigenschaften auf zwei Arten definiert werden. In beiden Fällen geben Sie ein Objekt / eine Funktion zurück. Da Funktionen in JavaScript erstklassige Bürger sind, können sie sich wie Objekte verhalten (technisch gesehen sind sie Objekte). Ihre Frage zur Verwendung der newSchlüsselwörter hat jedoch eine einfache Antwort: Ja. Ich werde veranschaulichen ...

Modulexporte

Sie können entweder die exportsbereitgestellte Variable verwenden, um Eigenschaften daran anzuhängen. Sobald diese Zuweisungseigenschaften in einem anderen Modul erforderlich sind, werden sie verfügbar. Oder Sie können der Eigenschaft module.exports ein Objekt zuweisen. In beiden Fällen require()wird ein Verweis auf den Wert von zurückgegeben module.exports.

Ein Pseudocode-Beispiel für die Definition eines Moduls:

var theModule = {
  exports: {}
};

(function(module, exports, require) {

  // Your module code goes here

})(theModule, theModule.exports, theRequireFunction);

Im obigen Beispiel module.exportsund exportssind das gleiche Objekt. Der coole Teil ist, dass Sie nichts davon in Ihren CommonJS-Modulen sehen, da das gesamte System sich darum kümmert. Alles, was Sie wissen müssen, ist, dass es ein Modulobjekt mit einer Exporteigenschaft und einer Exportvariablen gibt, die auf das zeigt das gleiche macht das module.exports.

Mit Konstruktoren anfordern

Da Sie eine Funktion direkt anhängen können, können module.exportsSie im Wesentlichen eine Funktion zurückgeben und wie jede Funktion als Konstruktor verwalten. (Dies ist kursiv dargestellt, da der einzige Unterschied zwischen einer Funktion und einem Konstruktor in JavaScript darin besteht, wie Sie sie verwenden möchten. Technisch es gibt keinen Unterschied.)

Folgendes ist also ein perfekter Code, und ich persönlich ermutige ihn:

// My module
function MyObject(bar) {
  this.bar = bar;
}

MyObject.prototype.foo = function foo() {
  console.log(this.bar);
};

module.exports = MyObject;

// In another module:
var MyObjectOrSomeCleverName = require("./my_object.js");
var my_obj_instance = new MyObjectOrSomeCleverName("foobar");
my_obj_instance.foo(); // => "foobar"

Für Nichtkonstruktoren erforderlich

Gleiches gilt für nicht konstruktorähnliche Funktionen:

// My Module
exports.someFunction = function someFunction(msg) {
  console.log(msg);
}

// In another module
var MyModule = require("./my_module.js");
MyModule.someFunction("foobar"); // => "foobar"

Meiner Meinung nach sind einige der Beispiele von node.j ziemlich erfunden.

Sie könnten erwarten, so etwas in der realen Welt zu sehen

// square.js
function Square(width) {

  if (!(this instanceof Square)) {
    return new Square(width);
  }

  this.width = width;
};

Square.prototype.area = function area() {
  return Math.pow(this.width, 2);
};

module.exports = Square;

Verwendung

var Square = require("./square");

// you can use `new` keyword
var s = new Square(5);
s.area(); // 25

// or you can skip it!
var s2 = Square(10);
s2.area(); // 100

Für die ES6-Leute

class Square {
  constructor(width) {
    this.width = width;
  }
  area() {
    return Math.pow(this.width, 2);
  }
}

export default Square;

Verwenden Sie es in ES6

import Square from "./square";
// ...

Wenn Sie eine Klasse verwenden, müssen Sie das newSchlüsselwort verwenden, um sie zu instanziieren. Alles andere bleibt gleich.

Diese Frage hat eigentlich nichts damit zu tun, wie es require()funktioniert. Grundsätzlich wird alles, was Sie module.exportsin Ihrem Modul eingestellt haben, vom require()Aufruf zurückgesendet.

Dies wäre gleichbedeutend mit:

var square = function(width) {
  return {
    area: function() {
      return width * width;
    }
  };
}

newBeim Aufrufen ist das Schlüsselwort nicht erforderlich square. Sie geben nicht die Funktionsinstanz selbst zurück square, sondern am Ende ein neues Objekt. Daher können Sie diese Funktion einfach direkt aufrufen.

Weitere Informationen zu komplizierten Argumenten newfinden Sie hier: Wird das "neue" Schlüsselwort von JavaScript als schädlich eingestuft?

Der Beispielcode lautet:

in der Hauptsache

square(width,function (data)
{
   console.log(data.squareVal);
});

Die Verwendung der folgenden kann funktionieren

exports.square = function(width,callback)
{
     var aa = new Object();
     callback(aa.squareVal = width * width);    
}

Am Ende geht es bei Node um Javascript. JS hat mehrere Möglichkeiten, etwas zu erreichen. Es ist dasselbe, einen "Konstruktor" zu erhalten. Wichtig ist, eine Funktion zurückzugeben .

Auf diese Weise erstellen Sie tatsächlich eine neue Funktion, wie wir sie beispielsweise mit JS in einer Webbrowser-Umgebung erstellt haben.

Persönlich bevorzuge ich den Prototyp-Ansatz, wie Sukima in diesem Beitrag vorgeschlagen hat: Node.js - Verwendung von module.exports als Konstruktor