ID regione
REGION_ID
è un codice abbreviato assegnato da Google in base all'area geografica selezionata al momento della creazione dell'app. Il codice non corrisponde a un paese o a una provincia, anche se alcuni ID regione possono sembrare simili ai codici paese e provincia di uso comune. Per le app create dopo febbraio 2020, REGION_ID.r
è incluso negli URL di App Engine. Per le app esistenti create prima di questa data, l'ID regione è facoltativo nell'URL.
Scopri di più sugli ID regione.
Devi utilizzare il file appengine-web.xml
per configurare l'app solo se stai eseguendo la migrazione di un'app esistente dal runtime di App Engine Java 8 alla versione Java più recente supportata e vuoi utilizzare i servizi in bundle legacy.
Se utilizzi un appengine-web.xml
nel progetto, app.yaml
viene generato automaticamente al momento del deployment.
Le applicazioni Java di App Engine utilizzano un file di configurazione, denominato appengine-web.xml
, per specificare informazioni sull'app e per identificare quali file all'interno del file WAR
dell'app sono file statici (ad esempio, immagini) e quali file di risorse utilizzati dall'applicazione.
Sintassi
Un'app Java di App Engine deve avere un file denominato appengine-web.xml
nella relativa
WAR, nella directory WEB-INF/
. Questo è un file XML il cui elemento principale è <appengine-web-app>
.
Puoi trovare la definizione del tipo di documento e le specifiche dello schema per appengine-web.xml
nella directory docs/
dell'SDK.
Elemento | Descrizione |
---|---|
<application> |
Non richiesto se esegui il deployment della tua app utilizzando strumenti basati su Google Cloud SDK, come il comando |
|
Facoltativo. Se vuoi utilizzare i
servizi in bundle legacy di App Engine per i runtime di seconda generazione,
imposta questo campo su |
|
Facoltativo e solo per i runtime di seconda generazione. Esegue l'override del punto di ingresso predefinito, ovvero la riga di comando del processo che avvia l'applicazione Java. Per impostazione predefinita, il punto di ingresso generato per una classe di istanza F4 (le impostazioni di memoria vengono calcolate dalla classe di istanza) equivale alla seguente configurazione: <appengine-web-app xmlns="http://appengine.google.com/ns/1.0"> <entrypoint> java -showversion -Xms32M -Xmx819M -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:+PrintCommandLineFlags --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.nio.charset=ALL-UNNAMED --add-opens java.logging/java.util.logging=ALL-UNNAMED --add-opens java.base/java.util.concurrent=ALL-UNNAMED -Dclasspath.runtimebase=/base/java_runtime -Djava.class.path=/base/java_runtime/runtime-main.jar -Djava.library.path=/base/java_runtime: com/google/apphosting/runtime/JavaRuntimeMainWithDefaults --fixed_application_path=/workspace /base/java_runtime </entrypoint> </appengine-web-app>
Puoi modificare la configurazione per aggiungere ulteriori flag di processo JVM o definire un processo di avvio personalizzato.
Il deployment dell'applicazione è stato eseguito nella directory |
<async-session-persistence> |
Facoltativo. È possibile ridurre la latenza delle richieste configurando la tua applicazione per la scrittura asincrona dei dati delle sessioni HTTP nel datastore: <async-session-persistence enabled="true" /> Quando la persistenza della sessione asincrona è attivata, App Engine invia un'attività della coda di attività per scrivere i dati della sessione nel datastore prima di scriverli in memcache. Per impostazione predefinita, l'attività verrà inviata alla coda "predefinita". Se vuoi utilizzare una coda diversa, aggiungi l'attributo "queue-name": <async-session-persistence enabled="true" queue-name="myqueue"/> I dati della sessione sono sempre scritti in modo sincrono in memcache. Se una richiesta tenta di leggere i dati della sessione quando memcache non è disponibile (o i dati della sessione sono stati svuotati), verrà eseguito il failover su Datastore, che potrebbe non disporre ancora dei dati della sessione più recenti. Ciò significa che la persistenza della sessione asincrona può causare la visualizzazione da parte dell'applicazione dei dati di sessione inattivi. Tuttavia, per la maggior parte delle applicazioni, il vantaggio della latenza supera di gran lunga il rischio. |
<auto-id-policy> |
Facoltativo. Se
imposti automaticamente gli identificatori di entità, puoi modificare il metodo utilizzato impostando il criterio ID automatico. Di seguito sono riportate le opzioni valide:
|
<automatic-scaling> |
Facoltativo. Per una spiegazione completa, consulta la sezione relativa alla scalabilità automatica. |
<basic-scaling> |
Facoltativo. Per una spiegazione completa, consulta la sezione relativa alla scalabilità di base. |
<env-variables> |
Facoltativo.
Il file <env-variables> <env-var name="DEFAULT_ENCODING" value="UTF-8" /> </env-variables> Per evitare conflitti con l'ambiente locale, il server di sviluppo non imposta le variabili di ambiente basate su questo file e richiede che queste variabili siano già impostate nell'ambiente locale sui valori corrispondenti. export DEFAULT_ENCODING="UTF-8" dev_appserver war Al momento del deployment in App Engine, l'ambiente viene creato con queste variabili già impostate. |
<inbound-services> |
Facoltativo.
Prima che un'applicazione possa ricevere email, è necessario che sia configurata per abilitare il servizio.
Puoi abilitare il servizio per un'app Java includendo una
sezione È disponibile il seguente servizio in entrata:
|
<instance-class> |
Facoltativo. La dimensione della classe di istanza per questo modulo. Quando specifichi diverse opzioni di scalabilità, sono disponibili le seguenti classi di istanza:
|
<manual-scaling> |
Facoltativo. Per una spiegazione completa, consulta la sezione relativa alla scalabilità manuale. |
<precompilation-enabled> |
Facoltativo. App Engine utilizza un processo di "precompilazione" con il bytecode Java di un'app per migliorare le prestazioni dell'app nell'ambiente di runtime Java. Il codice precompilato funziona in modo identico al bytecode originale.
Se per qualche motivo preferisci che la tua app non utilizzi la precompilazione,
puoi disattivarla aggiungendo quanto segue al
file <precompilation-enabled>false</precompilation-enabled> |
<module> |
Nota: i moduli sono ora denominati
Servizi,
mentre i servizi vengono ancora dichiarati nei file Obbligatorio se stai creando un servizio. Facoltativo per il servizio predefinito. Ogni servizio e ogni versione devono avere un nome. Un nome può contenere numeri, lettere e trattini. Non può superare i 63 caratteri, iniziare o terminare con un trattino e contenere la stringa "-dot". Scegli un nome univoco per ogni servizio e ogni versione. Non riutilizzare i nomi tra servizi e versioni. Vedi anche service. |
<public-root> |
Facoltativo.
Il valore predefinito di
Ad esempio, quanto segue mappa il percorso dell'URL <public-root>/static</public-root> |
<resource-files> |
Facoltativo. I file elencati nell'elemento
L'elemento
I file di risorse App Engine vengono letti utilizzando |
<runtime> |
Per utilizzare l'ultima versione di Java supportata, devi specificare questa voce con il valore <runtime>java21</runtime> |
<service> |
I servizi in precedenza erano noti come moduli. Attualmente, la definizione di un servizio come |
<service-account> |
Facoltativo. L'elemento <service-account>[SERVICE_ACCOUNT_NAME]@[PROJECT_ID].iam.gserviceaccount.com</service-account> |
<sessions-enabled> |
Facoltativo. App Engine include un'implementazione di sessioni, utilizzando l'interfaccia di sessione Servit. L'implementazione archivia i dati di sessione in Datastore per la persistenza e utilizza memcache per la velocità. Come per la maggior parte degli altri container servlet, gli attributi di sessione impostati con "session.setAttribute()" durante la richiesta vengono mantenuti alla fine di quest'ultima.
Questa funzionalità è disattivata per impostazione predefinita. Per attivarlo, aggiungi quanto segue a
<sessions-enabled>true</sessions-enabled>
L'implementazione crea entità Datastore del tipo
Nota: poiché App Engine archivia i dati di sessione in Datastore e memcache, tutti i valori archiviati nella sessione devono implementare l'interfaccia
Vedi l'elemento
|
<ssl-enabled> |
Facoltativo. Per impostazione predefinita, qualsiasi utente può accedere a qualsiasi URL tramite HTTP o HTTPS. Puoi configurare un'app in modo che richieda HTTPS per determinati URL nel descrittore di deployment. Consulta la pagina relativa al descrittore del deployment: URL protetti.
Se vuoi impedire l'utilizzo di HTTPS per l'applicazione, inserisci quanto segue nel file <ssl-enabled>false</ssl-enabled> Non esiste un modo per non consentire HTTPS per alcuni percorsi URL e non per altri nell'ambiente di runtime Java. |
<static-error-handlers> |
Facoltativo.
Quando si verificano determinati errori, App Engine pubblica una pagina di errore generica. Puoi configurare la tua app in modo che pubblichi un file statico personalizzato al posto di queste pagine di errore generiche, a condizione che i dati di errore personalizzati siano inferiori a 10 kilobyte. Puoi configurare diversi file statici da pubblicare per ogni codice di errore supportato specificando i file nel file <static-error-handlers> <handler file="default_error.html" /> <handler file="over_quota.html" error-code="over_quota" /> </static-error-handlers> Avviso: assicurati che il percorso del file di risposta all'errore non si sovrapponga ai percorsi dei gestori di file statici.
Ogni voce
Facoltativamente, puoi specificare un |
<static-files> |
Facoltativo.
L'elemento
L'elemento
<static-files> <include path="/my_static-files" > <http-header name="Access-Control-Allow-Origin" value="http://example.org" /> </include> </static-files> |
<system-properties> |
Facoltativo. Il file <system-properties> <property name="myapp.maximum-message-length" value="140" /> <property name="myapp.notify-every-n-signups" value="1000" /> <property name="myapp.notify-url" value="http://www.example.com/signupnotify" /> </system-properties> <env-variables> <env-var name="DEFAULT_ENCODING" value="UTF-8" /> </env-variables> A partire da Java 21, puoi configurare il server web Java per l'utilizzo di thread virtuali. Ad esempio: <system-properties> <property name="appengine.use.virtualthreads" value="true"/> </system-properties>Per saperne di più sul supporto dei thread, vedi Jetty 12 - Supporto di Thread virtuali. |
<url-stream-handler> |
Facoltativo. Valori possibili: Il valore predefinito è Se imposti <url-stream-handler>urlfetch</url-stream-handler> |
<version> |
L'elemento
I nomi di versione devono iniziare con una lettera per distinguerli dalle istanze numeriche sempre specificate da un numero. Ciò consente di evitare
l'ambiguità con URL come |
<warmup-requests-enabled> |
Facoltativo. Valore predefinito: true. Le richieste di warmup sono abilitate per impostazione predefinita per le applicazioni Java.
Con le richieste di warmup abilitate, l'infrastruttura di App Engine invia richieste "GET" a
Per disabilitare le richieste di warmup, specifica <warmup-requests-enabled>false</warmup-requests-enabled> |
<vpc-access-connector> |
Facoltativo.
Configura la tua applicazione in modo che utilizzi un connettore di accesso VPC serverless, consentendo all'applicazione di inviare richieste alle risorse interne nella tua rete VPC. Specifica il nome completo di un
connettore nell'elemento <vpc-access-connector> <name>projects/[PROJECT_ID]/locations/[REGION]/connectors/[CONNECTOR_NAME]</name> </vpc-access-connector> Per maggiori informazioni, consulta Connessione alle risorse interne in una rete VPC. |
Ridimensionare gli elementi
La tabella seguente elenca le opzioni per definire come specificare la scalabilità dell'applicazione.
Per un confronto delle funzionalità relative alle prestazioni dei tipi di scalabilità, consulta Scalabilità delle istanze dinamiche.
Elemento | Descrizione |
---|---|
<automatic-scaling> |
Facoltativo. Se non diversamente specificato, la scalabilità automatica si presume per impostazione predefinita con una classe di istanza predefinita
L'elemento Questo elemento può contenere i seguenti elementi:
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0"> <application>simple-app</application> <module>default</module> <version>uno</version> <instance-class>F2</instance-class> <automatic-scaling> <target-cpu-utilization>0.65</target-cpu-utilization> <min-instances>5</min-instances> <max-instances>100</max-instances> <max-concurrent-requests>50</max-concurrent-requests> </automatic-scaling> </appengine-web-app> |
<basic-scaling> |
Facoltativo.
L'elemento Questo elemento può contenere i seguenti elementi:
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0"> <application>simple-app</application> <module>default</module> <version>uno</version> <instance-class>B8</instance-class> <basic-scaling> <max-instances>11</max-instances> <idle-timeout>10m</idle-timeout> </basic-scaling> </appengine-web-app> |
<manual-scaling> |
Facoltativo.
L'elemento Questo elemento può contenere i seguenti elementi:
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0"> <application>simple-app</application> <module>default</module> <version>uno</version> <instance-class>B8</instance-class> <manual-scaling> <instances>5</instances> </manual-scaling> </appengine-web-app> |
Gestione temporanea degli elementi
Gran parte del lavoro svolto durante un deployment avviene localmente in una fase di preparazione chiamata gestione temporanea, in cui vengono assemblati i file JAR, vengono compilati i JSP e così via. Facoltativamente, puoi configurare determinate parti del comportamento di gestione temporanea utilizzando elementi nel file di configurazione dell'applicazione. Il deployment della maggior parte delle applicazioni viene eseguito correttamente senza configurare manualmente il comportamento della gestione temporanea. Se non viene eseguito il deployment dell'app, potresti dover configurare la gestione temporanea utilizzando le opzioni mostrate di seguito.
Elemento | Descrizione |
---|---|
<staging> |
Facoltativo. Per la maggior parte delle applicazioni non è necessario modificare il comportamento predefinito. L'elemento di gestione temporanea consente di specificare una particolare configurazione temporanea, se necessario per il deployment. Questo elemento può contenere i seguenti elementi:
Ad esempio: <staging> <delete-jsps>false</delete-jsps> </staging> |
Valore predefinito dell'opzione temporanea
I valori predefiniti per le opzioni di gestione temporanea variano a seconda che utilizzi gli strumenti basati su Google Cloud SDK, ad esempio gcloud CLI o i plug-in Maven, Gradle, Eclipse o IntelliJ basati su Google Cloud SDK.
Elemento temporaneo | Valori predefiniti basati sull'SDK di App Engine | Valori predefiniti basati su Google Cloud SDK |
---|---|---|
enable-jar-splitting |
false |
true |
jar-splitting-excludes |
NA | NA |
disable-jar-jsps |
false |
false |
enable-jar-classes |
false |
true . Questo può influire sull'ordine di caricamento della classe, quindi se la tua app dipende da un determinato ordine che utilizza la precedente impostazione predefinita di false , puoi impostarlo su false . |
delete-jsps |
false |
true |
compile-encoding |
utf-8 |
utf-8 |
Includi ed escludi la sintassi
I pattern del percorso vengono specificati utilizzando zero o più elementi <include>
e <exclude>
. In un pattern, '*'
rappresenta zero o più
caratteri nel nome di un file o di una directory, mentre **
rappresenta zero o più
directory in un percorso. I file e le directory che corrispondono ai pattern <exclude>
non verranno caricati quando esegui il deployment dell'app in App Engine. Tuttavia, questi file e directory saranno ancora accessibili all'applicazione se viene eseguita sul server di sviluppo locale.
Un elemento <include>
sostituisce il comportamento predefinito di inclusione di tutti i file. Un elemento <exclude>
si applica dopo tutti i pattern <include>
(nonché il valore predefinito se non viene fornito alcun elemento <include>
esplicito).
L'esempio seguente mostra come designare tutti i file .png
come file statici (tranne quelli nella directory data/
e in tutte le relative sottodirectory):
<static-files>
<include path="/**.png" />
<exclude path="/data/**.png" />
</static-files>
Puoi inoltre impostare le intestazioni HTTP da utilizzare quando rispondi alle richieste a queste risorse statiche.
<static-files>
<include path="/my_static-files" >
<http-header name="Access-Control-Allow-Origin"
value="http://example.org" />
</include>
</static-files>
Tipi MIME per i file statici
Per impostazione predefinita, i file statici vengono pubblicati utilizzando un tipo MIME selezionato in base all'estensione del nome file. Puoi associare tipi MIME personalizzati a estensioni di nomi file per i file statici utilizzando gli elementi mime-mapping
in web.xml
.
Timeout URLFetch
Puoi impostare una scadenza per ogni richiesta URLFetch. Per impostazione predefinita, la scadenza per un recupero è di 5 secondi.
Puoi modificare questa impostazione predefinita includendo la seguente impostazione nel file di configurazione di appengine-web.xml
. Specifica il timeout in secondi:
<system-properties>
<property name="appengine.api.urlfetch.defaultDeadline" value="10"/>
</system-properties>