JavaScript-Module und Bibliotheken von Drittanbietern

Optimieren Sie Ihre Codebasis mit JavaScript-Modulen, um zugehörigen Code zu gruppieren, oder fügen Sie Bibliotheken von Drittanbietern hinzu, und verwenden Sie ihren Code in Anwendungen wieder.

Übersicht

Ein Modul ist eine JavaScript-Datei, die zugehörigen Code enthält, der exportiert und in Anwendungen einer Instanz wiederverwendet wird. In bereichsbezogenen Anwendungen, die mit dem SDK von [ ServiceNow erstellt oder konvertiert werden, können Sie JavaScript-Module und Bibliotheken von Drittanbietern aus Visual Studio Codehinzufügen. Sie können TypeScript auch verwenden, um Module zu erstellen und in JavaScript zu kompilieren, bevor Sie Ihre Anwendung mit dem SDK erstellen.

In einem Modul identifizieren Sie Code für die Wiederverwendung mit Export -Anweisungen. Damit externe Module und Skripts auf den Modulcode zugreifen können, fügen Sie Einstiegspunkte im Exportfeld in der Datei „ package.json “ der Anwendung hinzu. Verwenden Sie dann Import- oder Require -Anweisungen, um den Code an anderer Stelle in Ihren Anwendungen wiederzuverwenden. Anwendungen müssen Abhängigkeiten von anderen Anwendungen oder npm-Bibliotheken (Node Package Manager) von Drittanbietern deklarieren, um ihren Modulcode zu verwenden.

Nachdem Sie Module hinzugefügt und die lokale Anwendung in einer Instanz bereitgestellt haben, werden die Module in der Tabelle „EcmaScript-Modul“ [sys_module] gespeichert. Wenn ein Modul in mehreren Anwendungen verwendet wird, verfügt es über mehrere Datensätze in der Tabelle „EcmaScript-Modul“ [sys_module].

Allgemeine Informationen zur Syntax zum Erstellen von JavaScript-Modulen finden Sie auf der Seite „ JavaScript -Module“ auf der MDN-Webdokument-Website. Informationen zur Verwendung von TypeScript in Ihrer Anwendung finden Sie unter Verwenden von TypeScript mit dem ServiceNow SDK.

Einschränkungen

• Globale Anwendungen und Anwendungsanpassungen werden nicht unterstützt.
• Eine Teilmenge der ECMAScript-Funktionen wird in Modulen gemäß Unterstützung der JavaScript-Engine-Funktionunterstützt.
• Node.js-APIs werden in -Modulen nicht unterstützt.
• Globale Variablen im Zusammenhang mit Web-APIs werden nicht unterstützt.
• import- und export- Anweisungen werden in Skripts wie Business Rules oder Skripteinbindungen nicht unterstützt. Sie werden nur in -Modulen unterstützt
• Bibliotheken von Drittanbietern, die Ihrer Anwendung hinzugefügt wurden, können ServiceNow APIs nicht aufrufen oder aufrufen.
• CommonJS-Module aus Bibliotheken von Drittanbietern werden nur unterstützt, wenn sie Exporte definieren. Subpfad-Importe werden bei CommonJS-Modulen nicht unterstützt. ECMAScript-Module aus Bibliotheken von Drittanbietern werden unterstützt.
• Globale Glide-APIs sind standardmäßig nicht in -Modulen verfügbar. Sie können aus dem Paket @servicenow/glide importiert werden.
• JavaScript-Module [sys_module] können nicht über die Plattform geändert werden. Sie müssen in Visual Studio Code geändert und mit dem SDK in der Instanz bereitgestellt werden.

Wichtig:

Sie können keine Bibliotheken von Drittanbietern verwenden, die auf nicht unterstützten Funktionen basieren, z. B. nicht unterstützte APIs oder ECMAScript-Funktionen.

Module werden exportiert

Identifizieren Sie in einem Modul Code für die Wiederverwendung mit Export -Anweisungen. Sie können benannte Exporte oder Standardexporte verwenden. Benannte Exporte können für Variablen, Konstanten, Funktionen oder Klassen erfolgen, während Standardexporte nur für Funktionen oder Klassen möglich sind. Das folgende Beispiel zeigt eine Möglichkeit, einen benannten Export für mehrere Features (eine Funktion und eine Variable) in einem Modul hinzuzufügen:

export { myFunction, myVariable };

Damit Skripts und Module in verschiedenen Anwendungen auf Code aus einem Modul zugreifen können, definieren Sie einen Einstiegspunkt in die Anwendung mit dem Export -Feld in der Datei „package.json “. Die folgenden Beispiele beziehen sich auf eine Anwendung mit dem Namen „Math“ für mathematische Funktionen.

Tabelle : 1. Modulcode wird aus einem Paket exportiert

Methode	Beispiel
Geben Sie einen Zeichenfolgenwert an, der auf ein Modul verweist.	{ "name": "math", "version": "1.0.0", "exports": "./src/main.js" }
Verwenden Sie ein Objekt, wobei „.“ ist der Unterpfad für das main.js -Modul.	{ "name": "math", "version": "1.0.0", "exports": { ".": "./src/main.js" } }
Exportieren Sie nur die Module add.js und subtract.js als Unterpfadexporte.	{ "name": "math", "version": "1.0.0", "exports": { "./add": "./src/functions/add.js", "./sub": "./src/functions/subtract.js" } }
Exportiert alle Dateien, einschließlich Unterverzeichnisse, aus einem angegebenen Pfad.	{ "name": "math", "version": "1.0.0", "exports": { "./functions/*": "./src/functions/*" } }
Exportieren Sie nur Dateien eines bestimmten Dateityps aus einem angegebenen Pfad.	{ "name": "math", "version": "1.0.0", "exports": { "./functions/*.js": "./src/functions/*.js" } }
Exportieren Sie Dateien eines bestimmten Dateityps, behalten Sie jedoch einen Ordner in einem Verzeichnis privat.	{ "name": "math", "version": "1.0.0", "exports": { "./functions/*.js": "./src/functions/*.js", "./functions/private-functions/*": null } }

Module werden importiert

Um den Modulcode zu importieren, den Sie wiederverwenden möchten, verwenden Sie Importanweisungen in anderen Modulen oder Require -Anweisungen in serverseitigen Skripts.

Das folgende Beispiel zeigt, wie Sie eine exportierte Funktion in ein Modul importieren können:

import { feature } from "path/to/module";

Das folgende Beispiel zeigt, wie Sie eine exportierte Funktion in ein Skript importieren können:

const { feature } = require("path/to/module");

Um die Kurzform zum Importieren von Modulcode zu verwenden, können Sie Unterpfade im Importfeld der Datei „ package.json “ der Anwendung verwenden. Beispiel:

{
	"name": "math",
	"version": "1.0.0",
	"exports": {
		"./functions/*.js": "./src/functions/*.js",
		"./functions/private-functions/*": null
	},
	"imports": {
		"#calc": "calculus",
		"#derivative": "calculus/derivative"
	},
	"dependencies": {
		"calculus": "1.0.0"
	}
}

Basierend auf diesem Beispiel können Sie, anstatt den relativen Pfad zu „ derivate.js “ jedes Mal, wenn Sie ihn in die mathematische Anwendung importieren möchten, die Kurzform #derive verwenden. Unterpfade können auch im Importfeld verwendet werden, um eine Kurzform für Abhängigkeiten zu verwenden, z. B. #calc.

import { derivative } from '#derivative';
import * as calculus from '#calc';

Hinzufügen von Abhängigkeiten

Anwendungen müssen Abhängigkeiten von anderen Anwendungen oder Bibliotheken von Drittanbietern deklarieren, um ihren Modulcode zu verwenden. Fügen Sie in der Datei „ package.json “ einer Anwendung den Paketnamen und die Version für alle Abhängigkeiten hinzu. Um beispielsweise Module aus der Anwendung „Mathe“ in der Anwendung „Test“ zu verwenden, fügen Sie das Paket „Mathe“ als Abhängigkeit hinzu:

{
	"name": "test",
	"version": "1.0.0",
	"dependencies": {
		"math": "1.0.0"
	}
}