Schritt-für-Schritt-Anleitungen

Python

In unserem Python-Beispiel wird das Flask-Framework verwendet. Sie können den vollständigen Quellcode über die angegebenen Links herunterladen.

Installieren Sie bei Bedarf Python 3.7 oder höher und prüfen Sie, ob pip verfügbar ist.

python3 -m ensurepip --upgrade

Wir empfehlen außerdem, eine neue virtuelle Python-Umgebung einzurichten und zu aktivieren.

python3 -m venv .classroom-addon-env
source .classroom-addon-env/bin/activate

In jedem Unterverzeichnis der heruntergeladenen Beispiele befindet sich ein requirements.txt. Mit pip können Sie die erforderlichen Bibliotheken schnell installieren. Verwenden Sie die folgenden Befehle, um die erforderlichen Bibliotheken für die erste Schritt-für-Schritt-Anleitung zu installieren.

cd flask/01-basic-app
pip install -r requirements.txt

Node.js

In unserem Node.js-Beispiel wird das Express-Framework verwendet. Sie können den vollständigen Quellcode über die angegebenen Links herunterladen.

Für dieses Beispiel ist Node.js Version 16.13 oder höher erforderlich.

Installieren Sie die erforderlichen Node-Module mit npm.

npm install

Java

In unserem Java-Beispiel wird das Spring Boot-Framework verwendet. Sie können den vollständigen Quellcode über die angegebenen Links herunterladen.

Installieren Sie Java 11 oder höher, falls es noch nicht auf Ihrem Computer installiert ist.

Für Spring Boot-Anwendungen können Gradle oder Maven zum Verwalten von Builds und Abhängigkeiten verwendet werden. Dieses Beispiel enthält den Maven-Wrapper, der einen erfolgreichen Build ermöglicht, ohne dass Sie Maven selbst installieren müssen.

Führen Sie im Verzeichnis, in das Sie das Projekt heruntergeladen oder geklont haben, die folgenden Befehle aus, um sicherzustellen, dass Sie die Voraussetzungen für die Ausführung des Projekts erfüllen.

java --version
./mvnw --version

Auf Windows:

java -version
mvnw.cmd --version

Python

• Das Verzeichnisverzeichnis enthält die folgenden Dateien:

  • main.py – der Einstiegspunkt der Python-Anwendung. Geben Sie die gewünschte Serverkonfiguration in dieser Datei an und führen Sie sie aus, um den Server zu starten.
  • requirements.txt: Die Python-Module, die zum Ausführen der Webanwendung erforderlich sind. Sie können mit pip install -r requirements.txt automatisch installiert werden.

  • client_secret.json: die Clientschlüsseldatei, die aus Google Cloud heruntergeladen wurde. Diese Datei ist nicht im Beispielarchiv enthalten. Sie sollten die heruntergeladene Anmeldedatendatei umbenennen und in das Stammverzeichnis jedes Verzeichnisses kopieren.

• config.py – Konfigurationsoptionen für den Flask-Server.

• Das Verzeichnis webapp enthält die Inhalte der Webanwendung. Folgende Angaben sind enthalten:

• Das Verzeichnis /templates/ mit Jinja-Vorlagen für verschiedene Seiten.

• Das Verzeichnis /static/ mit Bildern, CSS- und ergänzenden JavaScript-Dateien.

• routes.py: die Handlermethoden für die Webanwendungsrouten.

• __init__.py: der Initiator für das webapp-Modul. Dieser Initializer startet den Flask-Server und lädt die in config.py festgelegten Konfigurationsoptionen.

• Zusätzliche Dateien, die für einen bestimmten Schritt der Anleitung erforderlich sind.

Node.js

Jeder Schritt der Anleitung befindet sich in einem eigenen Unterordner von <step>. Jeder Schritt enthält Folgendes:

• Statische Dateien wie JavaScript, CSS und Bilder befinden sich im Ordner ./<step>/public.
• Expressrouter befinden sich in den Ordnern ./<step>/routes.
• HTML-Vorlagen finden Sie in den Ordnern ./<step>/views.
• Die Serveranwendung ist ./<step>/app.js.

Java

Das Projektverzeichnis enthält Folgendes:

• Das Verzeichnis src.main enthält den Quellcode und die Konfiguration, die zum Ausführen der Anwendung erforderlich sind. Dieses Verzeichnis enthält Folgendes: + java.com.addons.spring-Verzeichnis mit den Dateien Application.java und Controller.java. Die Datei Application.java ist für die Ausführung des Anwendungsservers verantwortlich, während die Datei Controller.java die Endpunktlogik verarbeitet. + Das Verzeichnis resources enthält das Verzeichnis templates mit HTML- und JavaScript-Dateien. Außerdem enthält es die Datei application.properties, in der der Port zum Ausführen des Servers, der Pfad zur Keystore-Datei und der Pfad zum Verzeichnis templates angegeben sind. In diesem Beispiel befindet sich die Keystore-Datei im Verzeichnis resources. Sie können sie an einem beliebigen Ort speichern. Achten Sie jedoch darauf, die Datei application.properties entsprechend mit dem Pfad zu aktualisieren.
  • pom.xml enthält die Informationen, die zum Erstellen des Projekts und zum Definieren der erforderlichen Abhängigkeiten erforderlich sind.
  • .gitignore enthält Dateinamen, die nicht in Git hochgeladen werden sollten. Fügen Sie in diesem .gitignore den Pfad zu Ihrem Schlüsselspeicher hinzu. Im Beispiel ist das secrets/*.p12. Der Zweck des Schlüsselspeichers wird im folgenden Abschnitt erläutert. Ab Schritt 2 sollten Sie auch den Pfad zu Ihrer client_secret.json-Datei angeben, damit Ihre Secrets nicht in einem Remote-Repository enthalten sind. Ab Schritt 3 sollten Sie den Pfad zur H2-Datenbankdatei und zur Dateidatenspeicher-Fabrik hinzufügen. Weitere Informationen zur Einrichtung dieser Datenspeicher finden Sie in der dritten Schritt-für-Schritt-Anleitung zum Umgang mit wiederholten Besuchen.
  • mvnw und mvnw.cmd sind die ausführbaren Maven-Wrapper für Unix bzw. Windows. Wenn Sie beispielsweise ./mvnw --version unter Unix ausführen, wird unter anderem die Apache Maven-Version ausgegeben.
  • Das Verzeichnis .mvn enthält die Konfiguration für den Maven-Wrapper.

Python

OAuth-Anmeldedaten

Erstellen und laden Sie Ihre OAuth-Anmeldedaten wie zuvor beschrieben herunter. Platzieren Sie die JSON-Datei im Stammverzeichnis neben der Serverstartdatei Ihrer Anwendung.

Server konfigurieren

Es gibt mehrere Möglichkeiten, den Webserver auszuführen. Fügen Sie am Ende Ihrer Python-Datei einen der folgenden Befehle hinzu:

1. Ungesicherte localhost. Hinweis: Diese Methode eignet sich nur für den direkten Test in einem Browserfenster. Nicht gesicherte Domains können nicht im iframe des Classroom-Add-ons geladen werden.

   if __name__ == "__main__":
     # Disable OAuthlib's HTTPs verification.
     os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"
   
     # Run the web app at http://localhost:5000.
     app.run(debug=True)
   

2. localhost sperren Sie müssen für das Argument ssl_context ein Tupel von SSL-Schlüsseldateien angeben.

   if __name__ == "__main__":
     # Run the web app at https://localhost:5000.
     app.run(host="localhost",
             ssl_context=("localhost.pem", "localhost-key.pem"),
             debug=True)
   

3. Gunicorn-Server Dies eignet sich für eine produktionsreife Server- oder Cloud-Bereitstellung. Wir empfehlen, eine Umgebungsvariable vom Typ PORT für die Verwendung mit dieser Startoption festzulegen.

   if __name__ == "__main__":
     # Run the web app at https://<your domain>:<server_port>.
     # Defaults to https://<your domain>:8080.
     server_port = os.environ.get("PORT", "8080")
     app.run(debug=True, port=server_port, host="0.0.0.0")
   

Server starten

Führen Sie Ihre Python-Anwendung aus, um den Server wie im vorherigen Schritt konfiguriert zu starten.

python main.py

Klicken Sie auf die angezeigte URL, um Ihre Webanwendung in einem Browser aufzurufen und zu prüfen, ob sie richtig funktioniert.

Node.js

Server konfigurieren

Wenn Sie den Server über HTTPS ausführen möchten, müssen Sie ein selbstsigniertes Zertifikat erstellen, das zum Ausführen der Anwendung über HTTPS verwendet wird. Diese Anmeldedaten sollten im Stammverzeichnis des Repositorys als sslcert/cert.pem und sslcert/key.pem gespeichert werden. Möglicherweise müssen Sie diese Schlüssel Ihrem OS-Schlüsselbund hinzufügen, damit sie von Ihrem Browser akzeptiert werden.

Achten Sie darauf, dass sich *.pem in der Datei .gitignore befindet, da Sie die Datei nicht in Git committen möchten.

Server starten

Sie können die Anwendung mit dem folgenden Befehl ausführen. Ersetzen Sie dabei step01 durch den Schritt, den Sie als Server ausführen möchten (z. B. step01 für 01-basic-app und step02 für 02-sign-in).

npm run step01

oder

npm run step02

Dadurch wird der Webserver unter https://localhost:5000 gestartet.

Sie können den Server mit Control + C in Ihrem Terminal beenden.

Java

Server konfigurieren

Wenn Sie den Server über HTTPS ausführen möchten, müssen Sie ein selbstsigniertes Zertifikat erstellen, das zum Ausführen der Anwendung über HTTPS verwendet wird.

Verwenden Sie für die lokale Entwicklung mkcert. Nachdem Sie mkcert installiert haben, generieren die folgenden Befehle ein lokal gespeichertes Zertifikat, das über HTTPS ausgeführt wird.

mkcert -install
mkcert -pkcs12 -p12-file <path_to_keystore> <domain_name>

In diesem Beispiel befindet sich die Keystore-Datei im Ressourcenverzeichnis. Sie können sie an einem beliebigen Ort speichern. Achten Sie aber darauf, den Pfad in der Datei application.properties entsprechend zu aktualisieren. Der Domainname ist die Domain, auf der Sie das Projekt ausführen (z. B. localhost).

Achten Sie darauf, dass sich *.p12 in der Datei .gitignore befindet, da Sie die Datei nicht in Git committen möchten.

Server starten

Starten Sie den Server, indem Sie die Methode main in der Datei Application.java ausführen. In IntelliJ können Sie beispielsweise im Verzeichnis src/main/java/com/addons/spring entweder mit der rechten Maustaste auf Application.java > Run 'Application' klicken oder die Datei Application.java öffnen und auf den grünen Pfeil links neben der main(String[] args)-Methodensignatur klicken. Alternativ können Sie das Projekt in einem Terminalfenster ausführen:

./mvnw spring-boot:run

Unter Windows:

mvnw.cmd spring-boot:run

Dadurch wird der Server unter https://localhost:5000 oder unter dem in application.properties angegebenen Port gestartet.