Erste Schritte in Node.js - AWS SDK for JavaScript

Wir haben das Kommende end-of-support für AWS SDK for JavaScript v2 angekündigt. Wir empfehlen Ihnen, auf AWS SDK for JavaScript Version 3 zu migrieren. Termine, weitere Details und Informationen zur Migration finden Sie in der verlinkten Ankündigung.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Erste Schritte in Node.js

JavaScript code example that applies to Node.js execution

Dieses Node.js-Codebeispiel zeigt:

  • Wie das package.json-Manifest für Ihr Projekt erstellt wird.

  • Wie die Module, die Ihr Projekt verwendet, installiert und eingeschlossen werden.

  • So erstellen Sie ein Amazon Simple Storage Service (Amazon S3) -Serviceobjekt aus der AWS.S3 Client-Klasse.

  • So erstellen Sie einen Amazon S3 S3-Bucket und laden ein Objekt in diesen Bucket hoch.

Das Szenario

Das Beispiel zeigt, wie Sie ein einfaches Modul Node.js einrichten und ausführen, das einen Amazon S3 S3-Bucket erstellt und ihm dann ein Textobjekt hinzufügt.

Da Bucket-Namen in Amazon S3 global eindeutig sein müssen, beinhaltet dieses Beispiel ein Drittanbieter-Modul Node.js, das einen eindeutigen ID-Wert generiert, den Sie in den Bucket-Namen integrieren können. Dieses zusätzliche Modul trägt den Namen uuid.

Erforderliche Aufgaben

Zum Einrichten und Ausführen dieses Beispiels müssen Sie zunächst diese Aufgaben abschließen:

  • Erstellen Sie ein Arbeitsverzeichnis zum Entwickeln Ihres Node.js-Moduls. Geben Sie diesem Verzeichnis den Namen awsnodesample. Beachten Sie, dass das Verzeichnis an einem Speicherort erstellt werden muss, der von Anwendungen aktualisiert werden kann. Beispiel: Erstellen Sie bei Windows das Verzeichnis nicht unter "C:\Programme".

  • Installieren Sie Node.js. Weitere Informationen finden Sie auf der Node.js-Website. Sie finden Downloads der aktuellen und LTS-Versionen von Node.js für eine Vielzahl von Betriebssystemen unter https://nodejs.org/en/download/current/.

Schritt 1: Installieren Sie das SDK und die Abhängigkeiten

Sie installieren das SDK für das JavaScript Paket mit npm (dem Paketmanager Node.js).

Geben Sie im awsnodesample-Verzeichnis im Paket den folgenden Befehl in die Befehlszeile ein.

npm install aws-sdk

Mit diesem Befehl wird das SDK für JavaScript in Ihrem Projekt installiert und aktualisiertpackage.json, sodass das SDK als Projektabhängigkeit aufgeführt wird. Sie finden Informationen zu diesem Paket , indem Sie nach "aws-sdk" auf der npm-Website suchen.

Als Nächstes installieren Sie das uuid-Modul in das Projekt, indem Sie den folgenden Befehl zur Installation des Moduls und Aktualisierung von package.json in die Befehlszeile eingeben. Weitere Informationen zu uuid finden Sie auf der Modulseite unter https://www.npmjs.com/package/uuid.

npm install uuid

Diese Pakete und der zugehörige Code werden im node_modules-Unterverzeichnis Ihres Projekts installiert.

Weitere Informationen zum Installieren von Node.js-Paketen finden Sie unter Herunterladen und Installieren von lokalen Paketen und Erstellen von Node.js-Modulen auf der Node.js-Paketmanager (npm)-Website. Informationen zum Herunterladen und Installieren von finden Sie unterInstallieren des SDK für JavaScript. AWS SDK for JavaScript

Schritt 2: Konfigurieren Sie Ihre Anmeldeinformationen

Sie müssen Anmeldeinformationen angeben, AWS damit das SDK nur auf Ihr Konto und die zugehörigen Ressourcen zugreifen kann. Weitere Informationen zum Abrufen Ihrer Kontoanmeldeinformationen finden Sie unter SDK-Authentifizierung mit AWS.

Um diese Informationen zu speichern, empfehlen wir Ihnen, eine gemeinsame Anmeldeinformationsdatei zu erstellen. Um zu erfahren wie dies geht, vgl. Laden der Anmeldeinformationen in Node.js aus der freigegebenen Anmeldeinformationsdatei. Ihre Anmeldeinformationsdatei sollte dem folgenden Beispiel ähneln.

[default] aws_access_key_id = YOUR_ACCESS_KEY_ID aws_secret_access_key = YOUR_SECRET_ACCESS_KEY

Sie können feststellen, ob Sie Ihre Anmeldeinformationen korrekt festgelegt haben, indem Sie den folgenden Code mit Node.js ausführen:

var AWS = require("aws-sdk"); AWS.config.getCredentials(function(err) { if (err) console.log(err.stack); // credentials not loaded else { console.log("Access key:", AWS.config.credentials.accessKeyId); } });

Wenn Sie Ihre Region in Ihrer config Datei korrekt festgelegt haben, können Sie diesen Wert ebenfalls anzeigen, indem Sie die AWS_SDK_LOAD_CONFIG Umgebungsvariable auf einen beliebigen Wert setzen und den folgenden Code verwenden:

var AWS = require("aws-sdk"); console.log("Region: ", AWS.config.region);

Schritt 3: Erstellen Sie das Paket-JSON für das Projekt

Nachdem Sie das awsnodesample-Projektverzeichnis erstellt haben, erstellen und fügen Sie eine package.json-Datei für die Speicherung der Metadaten für Ihr Node.js-Projekt hinzu. Einzelheiten zur Verwendung package.json in einem Node.js -Projekt finden Sie unter Erstellen einer package.json-Datei.

Erstellen Sie im Projektverzeichnis eine neue Datei namens package.json. Fügen Sie dann dieses JSON der Datei hinzu.

{ "dependencies": {}, "name": "aws-nodejs-sample", "description": "A simple Node.js application illustrating usage of the SDK for JavaScript.", "version": "1.0.1", "main": "sample.js", "devDependencies": {}, "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "author": "NAME", "license": "ISC" }

Speichern Sie die Datei. Wenn Sie die benötigten Module installieren, wird der dependencies-Teil der Datei abgeschlossen. Eine JSON-Datei, die ein Beispiel für diese Abhängigkeiten zeigt, finden Sie hier unter. GitHub

Schritt 4: Schreiben des Node.js-Codes

Erstellen Sie eine neue Datei mit dem Namen sample.js, wohin Sie den Beispielcode speichern möchten. Fügen Sie zunächst die require Funktionsaufrufe hinzu, um das SDK für JavaScript und die uuid Module einzubeziehen, sodass sie für Sie verfügbar sind.

Erstellen Sie einen eindeutigen Bucket-Namen, der zur Erstellung eines Amazon S3 S3-Buckets verwendet wird, indem Sie in diesem Fall 'node-sdk-sample-' einen eindeutigen ID-Wert an ein erkennbares Präfix anhängen. Sie generieren die eindeutige ID durch Aufrufen des uuid-Moduls. Erstellen Sie dann einen Namen für den Key-Parameter, der zum Hochladen eines Objekts in den Bucket verwendet wird.

Erstellen Sie ein promise-Objekt zum Aufrufen der createBucket-Methode des AWS.S3-Serviceobjekts. Bei einer erfolgreichen Antwort erstellen Sie die erforderlichen Parameter zum Hochladen von Text in den neu erstellten Bucket. Bei Verwendung eines anderen Promise rufen Sie die putObject-Methode auf, um das Textobjekt in den Bucket hochzuladen.

// Load the SDK and UUID var AWS = require("aws-sdk"); var uuid = require("uuid"); // Create unique bucket name var bucketName = "node-sdk-sample-" + uuid.v4(); // Create name for uploaded object key var keyName = "hello_world.txt"; // Create a promise on S3 service object var bucketPromise = new AWS.S3({ apiVersion: "2006-03-01" }) .createBucket({ Bucket: bucketName }) .promise(); // Handle promise fulfilled/rejected states bucketPromise .then(function (data) { // Create params for putObject call var objectParams = { Bucket: bucketName, Key: keyName, Body: "Hello World!", }; // Create object upload promise var uploadPromise = new AWS.S3({ apiVersion: "2006-03-01" }) .putObject(objectParams) .promise(); uploadPromise.then(function (data) { console.log( "Successfully uploaded data to " + bucketName + "/" + keyName ); }); }) .catch(function (err) { console.error(err, err.stack); });

Diesen Beispielcode finden Sie hier auf GitHub.

Schritt 5: Ausführen des Beispiels

Geben Sie den folgenden Befehl ein, um das Beispiel auszuführen.

node sample.js

Wenn der Upload erfolgreich ist, sehen Sie eine Bestätigungsmeldung in der Befehlszeile. Sie können zudem den Bucket und das hochgeladene Textobjekt in der Amazon S3-Konsole finden.