Umgebungsvariablen

Umgebungsvariablen ermöglichen Ihnen, Variablen zu einem in einer Umgebung laufenden Anwendungsprozess hinzuzufügen, ohne Codeänderungen vornehmen zu müssen. Umgebungsvariablen werden sicher gespeichert, was sie ideal für Anwendungsbeispiele wie Folgendes macht:

API-Schlüssel für Drittanbieter-Integrationen
Funktionalitätsmarker für Anwendungslogik
Konfiguration, die sich von Umgebung zu Umgebung unterscheidet oder möglicherweise nicht geheim ist

Umgebungsvariablen sind nur auf dem App-Server zugänglich. Sie können das Verhalten von Edge-Services, einschließlich Proxys und Edge-Funktionen, nicht ändern.

Sehen Sie siche diese Tutorials an, um Umgebungsvariablen festzulegen und dann Code auf Ihrer PWA Kit-Website zu implementieren, um die Variablen zu verwenden. Sie können den Code an Ihre spezifischen Anforderungen anpassen. In den Tutorials erfahren Sie mehr über Folgendes:

Es wird empfohlen, die Schritte auf Ihrem lokalen Computer und dann in einer Nicht-Production-Umgebung zu testen, bevor Sie Ihre Änderungen in Production bereitstellen. Weitere Anleitungen finden Sie unter Best Practices, Fehlerbehebung bei Umgebungsvariablen und Lokales Debuggen.

Umgebungsvariablen:

Verwaltung mit der Managed Runtime API oder Runtime Admin
Zugriff erfolgt in Node.js über process.env

Wenn Sie eine neue Umgebungsvariable einführen, legen Sie sie zuerst über die API oder in Runtime Admin fest. Warten Sie, bis die erneute Bereitstellung abgeschlossen ist, und stellen Sie dann ein neues Bündel bereit, das es verwendet.

Setzen, Aktualisieren und Löschen von Umgebungsvariablen

Verwenden Sie projects_target_env_var_partial_update:

Um eine vorhandene Umgebungsvariable zu löschen, setzen Sie ihren Wert auf null.

Durch das Ändern von Umgebungsvariablen wird die Umgebung erneut bereitgestellt. Die aktualisierten Werte sind verfügbar, wenn die Bereitstellung abgeschlossen ist.

Abrufen aller Umgebungsvariablen

Verwenden Sie projects_target_env_var_list:

So erstellen, aktualisieren, entfernen oder zeigen Sie Umgebungsvariablen an:

Melden Sie sich bei Runtime Admin an. Zum Zugriff auf Runtime Admin siehe Managed Runtime Administration.
Rufen Sie die Übersichtsseite eines Projekts auf.
Klicken Sie auf den Namen der Umgebung, für die Sie Umgebungsvariablen verwalten möchten.
Klicken Sie im linken Navigationsbereich auf Umgebungsvariablen.

Wählen Sie Namen für die Umgebungsvariablen, die im Rahmen Ihrer App aussagekräftig sind. Verwenden Sie aussagekräftige Namen: Wählen Sie klare, aussagekräftige Namen für Umgebungsvariablen, damit Ihr Team sie leicht verstehen kann.
Vermeiden Sie das Hardcoding von vertraulichen Informationen wie API-Schlüssel in Ihrem Code. Verwenden Sie Umgebungsvariablen, um diese zu schützen.
Übergeben Sie keine Umgebungsvariablen an Daten, die auf der Seite serialisiert werden. Erwägen Sie das Hinzufügen eines Tests, um sicherzustellen, dass keine Daten aus Umgebungsvariablen verloren gehen.
Geben Sie keine Umgebungsvariablen von getProps oder React Query Hooks zurück.
Verwenden Sie Umgebungsvariablen nur serverseitig. Standardmäßig werden Umgebungsvariablen nicht clientseitig bereitgestellt. Sie können sie für Clients verfügbar machen (z. B. in Ihrer Konfigurationsdatei), sollten aber sicherstellen, dass dies Ihren Sicherheitspraktiken entspricht.
Testen Sie Ihre Umgebungsvariablen auf Ihrem lokalen Computer und dann in einer Nicht-Production-Umgebung, bevor Sie sie in Production bereitstellen. So können Sie sicherstellen, dass sich Probleme schnell lokal beheben lassen. Dann können Sie das Verhalten der Website simulieren, die Funktionalität validieren und alle Benutzerakzeptanztests durchführen, bevor Sie sie in Production bereitstellen.
Integrieren Sie die Fehlerbehandlung in Ihren Code, der Umgebungsvariablen verwendet, um Fehler wegen nicht definierter Umgebungsvariablen zu verhindern.
Steuern Sie den Zugriff auf die Umgebungsvariablen, um nicht autorisierte Änderungen zu verhindern.
Dokumentieren Sie den Zweck und die Konfiguration der einzelnen Umgebungsvariablen. Dies hilft bei der Einarbeitung neuer Entwickler und bei der Fehlerbehebung.

Die Verwendung von Umgebungsvariablen unterliegt den folgenden Einschränkungen:

Bei den Werten der Umgebungsvariablen muss es sich um Strings handeln. Um komplexe Werte zu speichern, codieren Sie JSON in einen String.
Jede Umgebung kann maximal 100 Umgebungsvariablen enthalten.
Die maximale Größe der für eine Umgebung festgelegten Werte von Umgebungsvariablen beträgt 32 KB.
Die Namen von Umgebungsvariablen dürfen höchsten 512 Zeichen lang sein und dürfen nicht mit den reservierten Präfixen AWS, MRT, X_MRT, MOBIFY, X_MOBIFY, SSR_PROXY, NODE beginnen.
Die Namen von Umgebungsvariablen dürfen keine der reservierten Namen verwenden: BUNDLE_ID, DEPLOY_ID, DEPLOY_TARGET, EXTERNAL_DOMAIN_NAME, HANDLER, LAMBDA_RUNTIME_DIR, LAMBDA_TASK_ROOT, NODE_ENV, REDIRECT_BUCKET, REDIRECT_KEY, REDIRECT_UPDATE, REMOTE, X_AMZN_TRACE_ID.

In diesem Abschnitt werden Lösungsvorschläge für häufige Fehler vorgestellt, die bei der Verwendung von Umgebungsvariablen auftreten können.

Der Code meldet einen Error wegen einer fehlenden Variable.

Ursache: Die Umgebungsvariable, die der Code aufruft, ist nicht festgelegt.

Vorgeschlagene Lösung: Rufen Sie den API-Endpunkt projects_target_env_var_partial_update auf, um die entsprechende Umgebungsvariable festzulegen.

Im Code-Log besagt eine Fehlermeldung, dass die Umgebungsvariable nicht gefunden wurde.

Ursache: Der Code konnte die Umgebungsvariable nicht finden, da der Code einen Tippfehler enthält oder ein falscher Umgebungsvariablenname verwendet wird.

Vorgeschlagene Lösung: Vergewissern Sie sich, dass Sie den Namen der Umgebungsvariablen im Code richtig geschrieben und den korrekten Namen der Umgebungsvariablen verwendet haben. Überprüfen Sie den Namen der Umgebungsvariablen, indem Sie den API-Endpunkt projects_target_env_var_list aufrufen, um die vollständige Liste der festgelegten Variablen anzuzeigen.

Ihr API-Aufruf zum Festlegen einer Umgebungsvariablen schlägt fehl.

Ursache: Der Name der Umgebungsvariablen entspricht möglicherweise nicht den Einschränkungen. Die Umgebungsvariable ist z. B. größer als 32 KB.

Vorgeschlagene Lösung: Vergewissern Sie sich, dass die Umgebungsvariable den Einschränkungen entspricht.

Authentifizierungsfehler treten auf, wenn Sie Code ausführen, der die Verwendung eines API-Schlüssels beinhaltet.

Ursache: Der API-Schlüssel, den Sie beim Festlegen der Umgebungsvariablen verwendet haben, hat nicht das erwartete Format oder fehlt.

Vorgeschlagene Lösung: Vergewissern Sie sich, dass der von einer Umgebungsvariablen gespeicherte API-Schlüssel korrekt ist. Rufen Sie bei Bedarf den API-Endpunkt projects_target_env_var_partial_update auf, um den API-Schlüssel zu korrigieren.

Eine fetch-Anfrage schlägt mit einem Netzwerkfehler fehl.

Ursache: Eine URL für einen API-Endpunkt, der in Ihrem Code aufgerufen wird, wurde möglicherweise nicht korrekt definiert oder ist ungültig. Beispielsweise ist die URL für einen Endpunkt eines Content-Management-Systems (CMS) falsch.

Vorgeschlagene Lösung: Vergewissern Sie sich, dass alle URLs für API-Endpunkte in Ihrem Code korrekt sind.