Ambiente di runtime Java

Il runtime Java è lo stack software responsabile dell'installazione del codice del servizio web e delle relative dipendenze ed esegue il servizio.

Dichiara il runtime Java per l'ambiente standard di App Engine nel file app.yaml. Ad esempio:

runtime: javaVERSION

Dove VERSION è il numero di versione di MAJOR Java. Ad esempio, per utilizzare la versione Java più recente, Java 21, specifica 21.

Per altre versioni Java supportate e la versione di Ubuntu corrispondente alla tua versione Java, consulta la pianificazione del supporto del runtime.

Prima di iniziare

  1. Scarica la versione più recente di Google Cloud CLI o aggiorna gcloud CLI alla versione corrente:

    gcloud components update
    
  2. Per eseguire il deployment utilizzando Maven, devi aggiungere il plug-in Maven per App Engine al tuo file pom.xml:

    <plugin>
       <groupId>com.google.cloud.tools</groupId>
       <artifactId>appengine-maven-plugin</artifactId>
       <version>2.7.0</version>
    </plugin>

    Altre opzioni per il deployment includono l'utilizzo del comando gcloud app deploy o del plug-in Gradle di App Engine.

  3. Segui le istruzioni relative al framework dell'applicazione per configurare la build di un file JAR eseguibile.

Compatibilità del framework

Con il runtime Java di App Engine, puoi eseguire il deployment di file JAR executable. I runtime non includono alcun framework per il servizio web, il che significa che non sei limitato all'utilizzo di librerie o framework basati su servlet. Usa le tue dipendenze native oppure come la libreria Netty.

Sono disponibili hello world esempi che utilizzano i framework web Java più diffusi sulla Repository GitHub di Google Cloud:

Non sei limitato a questi framework e ti invitiamo a provare quello che preferisci, ad esempio Grails, Blade, Play!, Vaadin o jHipster.

Esegui il deployment dei progetti di origine Maven nel runtime Java

Puoi eseguire il deployment del tuo progetto Maven come codice sorgente e fare in modo che venga creato e sottoposto a deployment. utilizzando i buildpack di Google Cloud.

Per eseguire il deployment di un progetto Maven come codice sorgente, vai alla directory di primo livello del progetto e digita:

gcloud app deploy pom.xml

I log di compilazione e di deployment verranno trasmessi in streaming e potrai visualizzare i log dettagliati nella sezione Cronologia di Cloud Build della console Cloud.

Utilizzo degli eseguibili GraalVM

Il runtime Java dell'ambiente standard di App Engine supporta gli eseguibili delle immagini native GraalVM. Dopo aver compilato l'app Java in un'immagine nativa GraalVM, puoi utilizzare l'impostazione entrypoint nel file app.yaml per indicare l'eseguibile.

Ad esempio, un eseguibile con il nome file myexecutable potrebbe avere la classe seguenteapp.yaml:

runtime: java17 # or another supported runtime
entrypoint: ./myexecutable

Le librerie client di Google Cloud possono essere utilizzate per compilare le applicazioni come immagine nativa GraalVM. Per ulteriori informazioni, consulta la documentazione su come Compila immagini native.

Versione Java

Il runtime Java utilizza l'ultima release stabile della versione è specificato nel file app.yaml. App Engine si aggiorna automaticamente alle nuove versioni delle release delle patch, ma non aggiorna automaticamente la versione minore.

Ad esempio, l'applicazione potrebbe essere dipiattaformata con Java 11.0.4 e aggiornata automaticamente alla versione Java 11.0.5 in un successivo dipiattaforma della piattaforma gestita, ma non verrà aggiornata automaticamente a Java 12.

Per informazioni su come eseguire l'upgrade della tua versione di Java, consulta Eseguire l'upgrade di un'applicazione esistente.

L'ambiente aperto JDK del runtime

App Engine esegue le app Java in un contenitore protetto da gVisor su una distribuzione Ubuntu Linux aggiornata e il relativo openjdk-11-jdk supportato per il runtime Java 11 o openjdk-17-jdk per il runtime Java 17.

Per le versioni di Ubuntu supportate per la tua versione di Java, consulta la pianificazione del supporto del runtime.

App Engine gestisce l'immagine di base e aggiorna il pacchetto OpenJDK 11 e OpenJDK 17 senza che tu debba eseguire nuovamente il deployment dell'app.

L'app di cui hai eseguito il deployment si trova nella directory /workspace del runtime. È accessibile anche tramite un link simbolico all'indirizzo /srv.

Release Java di App Engine

Tutti gli elementi rilasciati che iniziano con la versione 2.x.x utilizzano il meccanismo di rilascio open source. Gli elementi pubblicati che iniziano con la versione 1.9.9xx o precedente utilizzano il sistema di compilazione interno. Consulta le Repository GitHub per ulteriori dettagli.

Dipendenze

Per ulteriori informazioni su come dichiarare e gestire le dipendenze, consulta Specificare le dipendenze.

Avvio dell'applicazione

Framework come Spring Boot, Micronaut e Ktor creano un uber eseguibile JAR per impostazione predefinita. Se il file di build Maven o Gradle produce un file JAR Uber eseguibile, il runtime avvia l'applicazione eseguendo un'applicazione JAR Uber.

In alternativa, App Engine utilizzerà i contenuti del campo facoltativoentrypoint nel file app.yaml. Ad esempio:

runtime: java21 # or another supported runtime
entrypoint: java -Xmx64m -jar YOUR-ARTIFACT.jar

Dove il file jar dell'applicazione YOUR-ARTIFACT.jar di esempio deve:

  • Devi essere nella directory principale con il file app.yaml.
  • Contiene una voce Main-Class nel file di metadati META-INF/MANIFEST.MF.
  • Facoltativamente, contiene una voce Class-Path con un elenco di percorsi relativi a altri jar dipendenti. Questi verranno caricati automaticamente con l'applicazione.

Affinché la tua app riceva richieste HTTP, il tuo punto di ingresso deve avviare un server web in ascolto sulla porta specificata dalla variabile di ambiente PORT. Il valore della variabile di ambiente PORT viene impostato dinamicamente dall'ambiente di pubblicazione di App Engine. Questo valore non può essere impostato nella sezione env_variables del file app.yaml.

Con un punto di contatto personalizzato, puoi creare e pacchettizzare l'applicazione come un file JAR ridotto che contiene solo il codice dell'applicazione e le dipendenze dirette. Durante il deployment dell'applicazione, il plug-in App Engine caricherà solo i file modificati, anziché l'intero pacchetto JAR di Uber.

Assicurati di utilizzare la variabile di ambiente PORT

Se nei file di log dell'app vengono visualizzati avvisi sulla porta 8080 e su NGINX, il server web dell'app è in ascolto sulla porta predefinita 8080. In questo modo Ad App Engine di usare il proprio livello NGINX per comprimere le risposte HTTP. Me di configurare il server web in modo che risponda alle richieste HTTP specificata dalla variabile di ambiente PORT, in genere 8081. Ad esempio:

/*
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.example.appengine;

import com.sun.net.httpserver.HttpServer;
import java.io.IOException;
import java.io.OutputStream;
import java.net.InetSocketAddress;

public class Main {

  public static void main(String[] args) throws IOException {
    // Create an instance of HttpServer bound to port defined by the 
    // PORT environment variable when present, otherwise on 8080.
    int port = Integer.parseInt(System.getenv().getOrDefault("PORT", "8080"));
    HttpServer server = HttpServer.create(new InetSocketAddress(port), 0);

    // Set root URI path.
    server.createContext("/", (var t) -> {
      byte[] response = "Hello World!".getBytes();
      t.sendResponseHeaders(200, response.length);
      try (OutputStream os = t.getResponseBody()) {
        os.write(response);
      }
    });

    // Create a second URI path.
    server.createContext("/foo", (var t) -> {
      byte[] response = "Foo!".getBytes();
      t.sendResponseHeaders(200, response.length);
      try (OutputStream os = t.getResponseBody()) {
        os.write(response);
      }
    });

    server.start();
  }
}

Compatibilità con le versioni Java precedenti

Per le differenze tra Java 8 e l'ultima versione di Java supportata, vedi Differenze principali tra i runtime Java 8 e Java 11+.

Variabili di ambiente

Le seguenti variabili di ambiente sono impostate dal runtime:

Variabile di ambiente Descrizione
GAE_APPLICATION L'ID della tua applicazione App Engine. Questo ID è preceduto da "region code~", ad esempio "e~" per le applicazioni di cui è stato eseguito il deployment in Europa.
GAE_DEPLOYMENT_ID L'ID del deployment attuale.
GAE_ENV L'ambiente App Engine. Impostato su standard.
GAE_INSTANCE L'ID dell'istanza su cui è attualmente in esecuzione il servizio.
GAE_MEMORY_MB La quantità di memoria disponibile per il processo di richiesta, in MB.
GAE_RUNTIME Il runtime specificato nel file app.yaml.
GAE_SERVICE Il nome del servizio specificato nel file app.yaml. Se non viene specificato alcun nome di servizio, viene impostato su default.
GAE_VERSION L'etichetta della versione corrente del servizio.
GOOGLE_CLOUD_PROJECT L'ID progetto Google Cloud associato alla tua applicazione.
PORT La porta che riceve le richieste HTTP.
NODE_ENV (disponibile solo nel runtime Node.js) Imposta su production quando viene eseguito il deployment del servizio.

Puoi definisci altre variabili di ambiente nel file app.yaml, ma non è possibile eseguire l'override dei valori precedenti, ad eccezione di NODE_ENV.

Proxy HTTPS e di inoltro

App Engine termina le connessioni HTTPS al bilanciatore del carico e inoltra le richieste alla tua applicazione. Alcune applicazioni devono determinare l'IP e il protocollo della richiesta originale. L'indirizzo IP dell'utente è disponibile in l'intestazione X-Forwarded-For standard. Le applicazioni che richiedono queste informazioni devono configurare il proprio framework web in modo che attenda il proxy.

Accesso al file system

Il runtime include una directory /tmp accessibile in scrittura, con tutte le altre directory con accesso di sola lettura. La scrittura in /tmp occupa memoria di sistema.

Server dei metadati

Ogni istanza dell'applicazione può utilizzare il server di metadati di App Engine per eseguire query sulle informazioni sull'istanza e sul tuo progetto.

Puoi accedere al server di metadati tramite i seguenti endpoint:

  • http://metadata
  • http://metadata.google.internal

Le richieste inviate al server dei metadati devono includere l'intestazione della richiesta Metadata-Flavor: Google. Questa intestazione indica che la richiesta è stata inviata con l'intenzione di recuperare i valori dei metadati.

La tabella seguente elenca gli endpoint in cui puoi inviare richieste HTTP per metadati specifici:

Endpoint dei metadati Descrizione
/computeMetadata/v1/project/numeric-project-id Il numero di progetto assegnato al progetto.
/computeMetadata/v1/project/project-id L'ID progetto assegnato al progetto.
/computeMetadata/v1/instance/region La regione in cui è in esecuzione l'istanza.
/computeMetadata/v1/instance/service-accounts/default/aliases
/computeMetadata/v1/instance/service-accounts/default/email L'indirizzo email dell'account di servizio predefinito assegnato al progetto.
/computeMetadata/v1/instance/service-accounts/default/ Elenca tutti gli account di servizio predefiniti per il tuo progetto.
/computeMetadata/v1/instance/service-accounts/default/scopes Elenca tutti gli ambiti supportati per gli account di servizio predefiniti.
/computeMetadata/v1/instance/service-accounts/default/token Restituisce il token di autenticazione che può essere utilizzato per autenticare la tua applicazione ad altre API Google Cloud.

Ad esempio, per recuperare l'ID progetto, invia una richiesta a http://metadata.google.internal/computeMetadata/v1/project/project-id.