Procedure dettagliate

Python

Il nostro esempio Python utilizza il framework Flask. Puoi scaricare il codice sorgente completo dai link forniti.

Se necessario, installa Python 3.7 o versioni successive e assicurati che pip sia disponibile.

python3 -m ensurepip --upgrade

Ti consigliamo inoltre di configurare e attivare un nuovo ambiente virtuale Python.

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

In ogni sottodirectory della procedura dettagliata negli esempi scaricati è presente un requirements.txt. Puoi installare rapidamente le librerie richieste utilizzando pip. Utilizza i seguenti comandi per installare le librerie richieste per la prima procedura dettagliata.

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

Node.js

Il nostro esempio Node.js utilizza il framework Express. Puoi scaricare il codice sorgente completo dai link forniti.

Questo esempio richiede Node.js v16.13 o versioni successive.

Installa i moduli nodo richiesti utilizzando npm.

npm install

Java

Il nostro esempio Java utilizza il framework Spring Boot. Puoi scaricare il codice sorgente completo dai link forniti.

Installa Java 11+ se non è già installato sulla tua macchina.

Le applicazioni Spring Boot possono utilizzare Gradle o Maven per gestire le build e le dipendenze. Questo esempio include il wrapper Maven che garantisce una compilazione riuscita senza richiedere l'installazione di Maven.

Nella directory in cui hai scaricato o clonato il progetto, esegui i seguenti comandi per assicurarti di disporre dei prerequisiti per eseguire il progetto.

java --version
./mvnw --version

Oppure su Windows:

java -version
mvnw.cmd --version

Python

• La radice della directory contiene i seguenti file:

  • main.py: il punto di accesso dell'applicazione Python. Specifica la configurazione del server da utilizzare in questo file, quindi eseguilo per avviare il server.
  • requirements.txt: i moduli Python necessari per eseguire l'app web. Possono essere installati automaticamente utilizzando pip install -r requirements.txt.

  • client_secret.json: il file client secret scaricato da Google Cloud. Tieni presente che questo non è incluso nell'archivio di esempio. Devi rinominare e copiare il file delle credenziali scaricato in ogni directory principale.

• config.py: opzioni di configurazione per il server Flask.

• La directory webapp contiene i contenuti dell'applicazione web. Include i seguenti contenuti:

• La directory /templates/ con i modelli Jinja per varie pagine.

• La directory /static/ con immagini, CSS e file JavaScript ausiliari.

• routes.py: i metodi di gestione per le route dell'applicazione web.

• __init__.py: l'inizializzatore per il modulo webapp. Questo inizializzatore avvia il server Flask e carica le opzioni di configurazione impostate in config.py.

• File aggiuntivi richiesti da un particolare passaggio della procedura dettagliata.

Node.js

Ogni passaggio della procedura dettagliata si trova nella propria sottocartella <step>. Ogni passaggio contiene:

• I file statici come JavaScript, CSS e immagini si trovano nella cartella ./<step>/public.
• I router Express si trovano nelle cartelle ./<step>/routes.
• I modelli HTML si trovano nelle cartelle ./<step>/views.
• L'applicazione server è ./<step>/app.js.

Java

La directory del progetto include quanto segue:

• La directory src.main contiene il codice sorgente e la configurazione per eseguire l'applicazione correttamente. Questa directory include quanto segue: + La directory java.com.addons.spring contiene i file Application.java e Controller.java. Il file Application.java è responsabile dell'esecuzione del server delle applicazioni, mentre il file Controller.java gestisce la logica dell'endpoint. + La directory resources contiene la directory templates con i file HTML e JavaScript. Contiene anche il file application.properties che specifica la porta su cui eseguire il server, il percorso del file archivio chiavi e il percorso della directory templates. Questo esempio include il file dell'archivio chiavi nella directory resources. Puoi memorizzarlo dove preferisci, ma assicurati di aggiornare il file application.properties con il percorso corrispondente.
  • pom.xml contiene le informazioni necessarie per creare il progetto e definire le dipendenze richieste.
  • .gitignore contiene nomi file che non devono essere caricati su Git. Assicurati di aggiungere il percorso del keystore in questo .gitignore. Nell'esempio fornito, si tratta di secrets/*.p12 (lo scopo del keystore è descritto nella sezione seguente). Per le procedure dettagliate 2 e successive, devi includere anche il percorso del file client_secret.json per assicurarti di non includere i tuoi segreti in un repository remoto. Per le procedure dettagliate 3 e successive, devi aggiungere il percorso al file di database H2 e al factory di datastore dei file. Per ulteriori informazioni sulla configurazione di questi data store, consulta la terza procedura dettagliata sulla gestione delle visite ripetute.
  • mvnw e mvnw.cmd sono i file eseguibili del wrapper Maven per Unix e Windows, rispettivamente. Ad esempio, l'esecuzione di ./mvnw --version su Unix restituisce la versione di Apache Maven, tra le altre informazioni.
  • La directory .mvn contiene la configurazione per il wrapper Maven.

Python

Credenziali OAuth

Crea e scarica le credenziali OAuth come descritto in precedenza. Posiziona il file JSON nella directory principale insieme al file di avvio del server dell'applicazione.

Configurare il server

Hai diverse opzioni per eseguire il server web. Alla fine del file Python, aggiungi uno dei seguenti codici:

1. localhost non protetto. Tieni presente che questo è adatto solo per i test diretti in una finestra del browser; i domini non protetti non possono essere caricati nell'iframe del componente aggiuntivo Classroom.

   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. Proteggi localhost. Devi specificare una tupla di file di chiavi SSL per l'argomento ssl_context.

   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. server Gunicorn. Questa opzione è adatta a un server pronto per la produzione o a un deployment cloud. Ti consigliamo di impostare una variabile di ambiente PORT da utilizzare con questa opzione di avvio.

   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")
   

Avvia il server

Esegui l'applicazione Python per avviare il server come configurato nel passaggio precedente.

python main.py

Fai clic sull'URL visualizzato per visualizzare la tua app web in un browser e verificare che venga eseguita correttamente.

Node.js

Configurare il server

Per eseguire il server su HTTPS, devi creare un certificato autofirmato che viene utilizzato per eseguire l'applicazione su HTTPS. Queste credenziali devono essere salvate come sslcert/cert.pem e sslcert/key.pem nella cartella radice del repository. Potresti dover aggiungere queste chiavi al portachiavi del sistema operativo affinché il browser le accetti.

Assicurati che *.pem sia nel file .gitignore perché non vuoi eseguire il commit del file in Git.

Avvia il server

Puoi eseguire l'applicazione con il seguente comando sostituendo step01 con il passaggio corretto che vuoi eseguire come server (ad esempio, step01 per 01-basic-app e step02 per 02-sign-in).

npm run step01

o

npm run step02

In questo modo viene avviato il server web all'indirizzo https://localhost:5000.

Puoi terminare il server con Control + C nel terminale.

Java

Configurare il server

Per eseguire il server su HTTPS, devi creare un certificato autofirmato che viene utilizzato per eseguire l'applicazione su HTTPS.

Valuta la possibilità di utilizzare mkcert per lo sviluppo locale. Una volta installato mkcert, i seguenti comandi generano un certificato archiviato localmente da eseguire tramite HTTPS.

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

Questo esempio include il file del keystore nella directory delle risorse. Puoi memorizzarlo dove preferisci, ma assicurati di aggiornare il file application.properties con il percorso corrispondente. Il nome di dominio è il dominio su cui esegui il progetto (ad esempio, localhost).

Assicurati che *.p12 sia nel file .gitignore perché non vuoi eseguire il commit del file in Git.

Avvia il server

Avvia il server eseguendo il metodo main nel file Application.java. In IntelliJ, ad esempio, puoi fare clic con il tasto destro del mouse su Application.java > Run 'Application' nella directory src/main/java/com/addons/spring oppure aprire il file Application.java per fare clic sulla freccia verde a sinistra della firma del metodo main(String[] args). In alternativa, puoi eseguire il progetto in una finestra del terminale:

./mvnw spring-boot:run

o su Windows:

mvnw.cmd spring-boot:run

In questo modo il server viene avviato all'indirizzo https://localhost:5000 o alla porta che hai specificato in application.properties.