Erstellen von öffentlichen und privaten Knotenmodulen

Warum Module wichtig sind

Das Erstellen von Modulen ist wichtig, insbesondere wenn Sie möchten, dass Ihr Code wiederverwendbar ist. Node bietet eine Architektur, in der Sie Ihren Code in Form von Modulen über die npm-Registrierung schreiben und wiederverwenden können. Die Pakete können je nach Bedarf öffentlich oder privat veröffentlicht werden. Mit privaten Modulen können Sie Ihren Code auch an die vorgesehenen Benutzer, Ihre Teamkollegen oder privat an sich selbst verteilen und von überall darauf zugreifen.

Schreiben eines öffentlichen Moduls

Erstellen Sie zunächst einen Ordner MeinModul irgendwo. Stellen Sie dann den Pfad auf ein MeinModul im cmd. Dann müssen Sie nur noch zwei Dateien erstellen, um Ihr erstes Beispielpaket zu erstellen.

Jetzt kann dies das einfachste Modul sein, das wir mit nur zwei Dateien erstellen können.

Paket.json-Datei erstellen

Sie müssen nicht explizit eine erstellen Paket.json Datei. Um es zu erstellen, schreiben Sie in die Eingabeaufforderung.

$npm init

Dabei sollten Ihnen folgende Fragen gestellt werden:

name: (MyModule) 
version: (1.0.0)           
description:                        
entry point: (index.js)     
test command:                 
git repository:                      
keywords:                                     
author:            
license: (ISC) 

Jetzt müssen Sie diese nicht einmal beantworten, einige wichtige Fragen sind: Version, Beschreibung, Einstiegspunkt (der geändert werden kann, standardmäßig ist es die Datei index.js) und Autor.

Beantworten Sie diese und überspringen Sie den Rest, indem Sie die Eingabetaste drücken. Dadurch entsteht ein Paket.json Datei für Ihr Modul.

Optional können Sie direkt eine package.json-Datei erstellen, indem Sie die nächsten Schritte ausführen:

  • Erstellen Sie eine Textdatei, benennen Sie sie um in Paket.json
  • Fügen Sie darin den folgenden Code hinzu:
{
  "name": "MyModule",
  "version": "1.0.0",
  "description": "My First Module",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "naeem shaikh",
  "license": "MIT"
}

Jetzt haben wir die erstellt Paket.json Datei erstellen wir die index.js Datei, die der Einstiegspunkt unseres Moduls ist.

Das index.js Datei

Dies ist nun unser Einstiegspunkt in das Modul. Wir werden einen einfachen Array-zu-Objekt-Konverter erstellen. Zum Beispiel:

wir werden das umwandeln

['john','martin','scott']

zu

{
"0": "john",
"1": "martin",
"2": "scott"
}

Schreiben Sie folgenden Code in Ihre index.js Datei.

exports.to_Object=function (arr) {
  var obj = {};
  for (var i = 0; i < arr.length; ++i)
    obj[i] = arr[i];
  return obj;
}

Fertig! Wir haben ein Modul erstellt, das eine Funktion exportiert to_Objectdie ein Array als Parameter akzeptiert und ein konvertiertes Objekt zurückgibt.

Veröffentlichen des Moduls

Da wir das Modul abgeschlossen haben, können wir es jetzt in der npm-Registrierung veröffentlichen. Um Ihr Modul zu veröffentlichen, müssen Sie über einen Benutzer verfügen npm-Registrierung. Wenn Sie keine haben, erstellen Sie sie mit dem folgenden Befehl:

 npm adduser

Dabei werden Sie nach dem Benutzernamen, dem festzulegenden Passwort und Ihrer E-Mail-Adresse gefragt. Sobald Sie fertig sind, können Sie sich mit dem folgenden Befehl bei npm anmelden:

npm login

Dadurch werden Ihre Anmeldeinformationen auf dem Client gespeichert, und Sie können Ihr Modul jetzt veröffentlichen npm-Registrierung.

Jetzt der magische Schritt, verwenden Sie diesen Befehl

 npm publish

Dadurch veröffentlichen Sie Ihr Paket. Um zu sehen, ob Ihr Paket tatsächlich auf npm gepusht wird oder nicht? Sie können von Ihrem Browser aus zu folgender URL gehen:


Wo?

Paketnamen ist der Paketname, den Sie gerade erstellt und veröffentlicht haben.

Aktualisieren Ihres Pakets

Sie müssen Ihr Paket irgendwann mit einer zusätzlichen Funktion aktualisieren. Wenn Sie dies tun, können Sie die Version Ihres Moduls ändern, indem Sie den folgenden Befehl verwenden:

npm version <update-type>

Wo?

Update-Typ ist einer der Release-Typen der semantischen Versionierung, Patch, Minor oder Major. Dieser Befehl ändert die Versionsnummer in package.json.

Beachten Sie, dass dies auch ein Tag mit dieser Versionsnummer zu Ihrem Git-Repository hinzufügt, falls Sie eines haben.

Zusätzlich können Sie die Versionsnummer auch direkt in Ihrer ändern Paket.json Datei.

Nachdem Sie die Versionsnummer aktualisiert haben, können Sie dies tun npm veröffentlichen wieder. Sie können dann das aktualisierte Paket unter derselben URL sehen:

Erstellen Sie nun ein Knotenprojekt und ändern Sie das aktuelle Verzeichnis in _cmd _in Ihr Projekt. Sie können Ihr Modul nun direkt mit installieren

npm install Package-Name

Die Verwendung Ihres eigenen Moduls in Ihrem Knotenprojekt ähnelt der Verwendung anderer Module wie z ausdrücken

var MyModule= require('MyModule');

Jetzt erhalten Sie Zugriff auf Ihr Modul und die darin definierte Methode als

MyModule.to_Object(parameterArray)

Schreiben Sie ein einfaches Node-Programm, das unser Modul verwendet.

var MyModule= require('MyModule');

var arr=['john','martin','scott'];
var result=MyModule.to_Object(arr)
console.log(result)

Dies ist, was Sie in Ihrer Konsole erhalten.

{
"0": "john",
"1": "martin",
"2": "scott"
}

Private Module erstellen

Wenn Sie Ihr Modul nur für wenige Personen veröffentlichen möchten, können Sie ein privates Modul erstellen.

Das Veröffentlichen des privaten Moduls ähnelt dem Veröffentlichen des öffentlichen Moduls, wie oben beschrieben, mit nur einem Unterschied, Sie veröffentlichen es in Ihrem Namensraum oder die Ihres Teams Namensraum (mit wem Sie Ihr Modul teilen möchten), indem Sie ihnen einfach einen Namen in package.json geben:

{
  "name": "@myuser/MyModule"
}

Veröffentlichen Sie sie mit npm veröffentlichen genau wie jedes andere Paket, und Sie installieren sie nach Namespace:

npm install @myuser/MyModule

Verwenden Sie sie nach der Installation, indem Sie sie wie jedes Paket nach Namensraum anfordern:

var MyModule= require('@myuser/MyModule');

Fazit

Das Erstellen privater oder öffentlicher Module ist besonders hilfreich, um Ihren Code wiederverwendbar und verteilbar zu machen und Ihren Code modular zu gestalten, sodass er viel besser lesbar ist.

Similar Posts

Leave a Reply

Your email address will not be published. Required fields are marked *