Configurazione di un ambiente di sviluppo

Questa pagina descrive come configurare l'ambiente di sviluppo per creare ed eseguire il deployment dell'API di backend utilizzando Cloud Endpoints Frameworks per l'ambiente standard di App Engine. In questa pagina viene usato l'esempio di codice Endpoints Framework 2.0 scheletro per spiegare il software di base e i componenti necessari per iniziare.

Ti consigliamo di utilizzare endpoints-skeleton-archetype o hello-endpoints-archetype descritti in Utilizzo di Apache Maven e del plug-in App Engine (basato sull'interfaccia a riga di comando di Google Cloud) per creare un nuovo progetto Endpoints Frameworks 2.0.

Per comprendere meglio i passaggi necessari per il deployment di un'API di esempio con Endpoint Frameworks, guarda il tutorial Iniziare a utilizzare gli endpoint con App Engine.

Prima di iniziare

  1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
  2. Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

  4. Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  5. Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.

  6. Prendi nota dell'ID progetto Google Cloud perché è necessario in seguito.

Installazione e configurazione del software richiesto

  1. Se non hai installato Java 8, scarica Java Development Kit (JDK) dal sito di Oracle e installalo.
  2. Installa Maven o Gradle:

    Maven

    1. Scarica Apache Maven versione 3.3.9 o successive
    2. Installa e configura Maven per l'ambiente di sviluppo locale.

    Gradle

  3. Scarica e inizializza l'interfaccia a riga di comando di Google Cloud.
  4. Esegui i seguenti comandi:
    1. Assicurati che l'interfaccia a riga di comando gcloud sia autorizzata ad accedere ai tuoi dati e servizi su Google Cloud:
      gcloud auth login
    2. Utilizza le credenziali predefinite dell'applicazione:
      gcloud auth application-default login
    3. Installa il componente app-engine-java di Google Cloud SDK:
      gcloud components install app-engine-java
    4. Esegui l'aggiornamento all'ultima versione di Google Cloud SDK e a tutti i componenti:
      gcloud components update
  5. Crea un'applicazione App Engine:
    1. Imposta il progetto predefinito sul tuo ID progetto Google Cloud:
      gcloud config set project YOUR_PROJECT_ID

      Sostituisci YOUR_PROJECT_ID con l'ID progetto di Google Cloud. Se hai altri progetti Google Cloud e vuoi utilizzare gcloud per gestirli, consulta la sezione Gestire le configurazioni dell'interfaccia a riga di comando gcloud.

    2. Seleziona l'area geografica in cui vuoi creare la tua applicazione App Engine. Consulta la pagina Località di App Engine per un elenco di aree geografiche.
    3. Creare un'applicazione App Engine. Sostituisci YOUR_PROJECT_ID con l'ID progetto Google Cloud e YOUR_REGION con l'area geografica in cui vuoi creare l'applicazione App Engine.
        gcloud app create \
        --project=YOUR_PROJECT_ID \
        --region=YOUR_REGION
      

Recupero dello schema scheletro di Endpoints Frameworks

L'esempio di scheletro di Endpoints Frameworks versione 2.0 contiene gli script di build necessari per Maven e Gradle. Contiene anche i file richiesti per iniziare a creare la tua prima API.

  1. Clona il repository di esempio sul tuo computer locale:

     git clone https://github.com/GoogleCloudPlatform/java-docs-samples
    
  2. Passa alla directory contenente l'esempio di scheletro di Endpoints Frameworks:

     cd java-docs-samples/appengine-java8/endpoints-v2-skeleton/
    

    L'esempio ha la struttura di directory seguente:

    Scheletro di esempio per i layout di Endpoints Frameworks

    • MyApi.java contiene una classe vuota che puoi utilizzare per iniziare a scrivere l'API. Per iniziare, consulta l'esempio di eco per trovare un codice di esempio.

    • web.xml è un file standard che viene utilizzato per configurare un servlet.

    • appengine-web.xml definisce le informazioni necessarie per il deployment dell'API nell'ambiente standard di App Engine mediante Java 8.

    • pom.xml contiene le informazioni sul progetto e sulla configurazione utilizzate da Maven per creare il progetto ed eseguire il deployment dell'API in App Engine.

    • build.gradle contiene le informazioni sul progetto e sulla configurazione utilizzate da Gradle per creare il progetto ed eseguire il deployment dell'API in App Engine.

Configurazione dei file di build

In questa sezione vengono descritti i file Maven pom.xml e Gradle build.gradle inclusi nel codice di esempio. Ad eccezione dell'inserimento dell'ID progetto Google Cloud in modo che possa essere utilizzato nel nome host, i file di build sono pronti per iniziare a creare l'API.

Informazioni sulla configurazione minima

Questa sezione descrive la configurazione minima necessaria nel file di build.

Maven

Dipendenze minime

Di seguito sono riportate le dipendenze minime richieste in pom.xml per iniziare:

<dependencies>
  <!-- Compile/runtime dependencies -->
  <dependency>
    <groupId>com.google.endpoints</groupId>
    <artifactId>endpoints-framework</artifactId>
    <version>2.2.2</version>
  </dependency>
  <dependency>
    <groupId>com.google.appengine</groupId>
    <artifactId>appengine-api-1.0-sdk</artifactId>
    <version>2.0.5</version>
  </dependency>
  <dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>3.1.0</version>
    <type>jar</type>
    <scope>provided</scope>
  </dependency>
  <dependency>
    <groupId>javax.inject</groupId>
    <artifactId>javax.inject</artifactId>
    <version>1</version>
  </dependency>
</dependencies>

  • La dipendenza endpoints-framework contiene le classi necessarie per creare la tua API.
  • <ph type="x-smartling-placeholder">appengine-api-sdk</ph>
  • Per creare un servlet è necessario il pacchetto standard javax.servlet.
  • Il pacchetto standard javax.inject è necessario per supportare l'inserimento di dipendenze.

Applicare i plug-in

Per abilitarli, vengono applicati i seguenti plug-in:

<build>
  <!-- for hot reload of the web application-->
  <outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-war-plugin</artifactId>
      <version>3.3.2</version>
      <configuration>
        <webResources>
          <resources>
            <directory>${basedir}/src/main/webapp/WEB-INF</directory>
            <filtering>true</filtering>
            <targetPath>WEB-INF</targetPath>
          </resources>
        </webResources>
      </configuration>
    </plugin>
    <plugin>
      <groupId>com.google.cloud.tools</groupId>
      <artifactId>appengine-maven-plugin</artifactId>
      <version>2.4.2</version>
      <configuration>
        <!-- deploy configuration -->
        <projectId>GCLOUD_CONFIG</projectId>
        <version>GCLOUD_CONFIG</version>
      </configuration>
    </plugin>
    <plugin>
      <groupId>com.google.cloud.tools</groupId>
      <artifactId>endpoints-framework-maven-plugin</artifactId>
      <version>2.1.0</version>
      <configuration>
        <!-- plugin configuration -->
        <!--
        You must replace YOUR_PROJECT_ID with your
        Google Cloud Project Id
      -->
      <hostname>YOUR_PROJECT_ID.appspot.com</hostname>
    </configuration>
  </plugin>
</plugins>
</build>
  • maven-war-plugin estende il plug-in java per aggiungere supporto per l'assemblaggio di un'applicazione web.
  • Per eseguire l'API su App Engine è necessario appengine-maven-plugin.
  • Il endpoints-framework-maven-plugin fornisce attività e configurazioni per creare progetti Endpoints Frameworks.

Gradle

Dipendenze plug-in

Di seguito sono riportati i plug-in necessari per creare la tua API:

buildscript {
  repositories {
    mavenCentral()
  }

  dependencies {
    classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:2.1.0'
    classpath 'com.google.cloud.tools:appengine-gradle-plugin:2.4.3'
  }
}

Applicare i plug-in

I seguenti plug-in vengono applicati per abilitarli nello script di build di Gradle:

apply plugin: 'java'
apply plugin: 'war'
apply plugin: 'com.google.cloud.tools.endpoints-framework-server'
apply plugin: 'com.google.cloud.tools.appengine'

  • Il plug-in java aggiunge compilazione specifica al linguaggio Java e build al tuo progetto.
  • Il plug-in war estende il plug-in java per aggiungere il supporto dell'assemblaggio di un'applicazione web.
  • Il plug-in endpoints-framework-server fornisce il supporto lato server al plug-in Endpoints Frameworks Gradle.
  • Il plug-in appengine è necessario per eseguire l'API su App Engine.

Dipendenze progetto

Il progetto utilizza le seguenti dipendenze:

dependencies {
    compile 'com.google.endpoints:endpoints-framework:2.2.2'
    compile 'com.google.appengine:appengine-api-1.0-sdk:2.0.5'

    compile 'javax.inject:javax.inject:1'
    compileOnly 'javax.servlet:javax.servlet-api:3.1.0'
}

Definizione del nome host per il servizio

Endpoints Frameworks utilizza nomi compatibili con DNS per identificare in modo univoco i servizi. Poiché gli ID progetto Google Cloud sono garantiti in modo univoco a livello globale, devi utilizzare il tuo ID progetto Google Cloud come parte del nome del servizio API.

Devi aggiungere il tuo ID progetto Google Cloud ai file di build per configurare il nome host del tuo servizio. Il nome host deve avere il seguente formato:

YOUR_PROJECT_ID.appspot.com

Quando esegui il deployment dell'API in App Engine, viene creata automaticamente una voce DNS con un nome nel formato YOUR_PROJECT_ID.appspot.com. Il nome host corrisponde sia al nome del servizio Cloud Endpoints sia al nome di dominio utilizzato per inviare le richieste all'API.

Maven

  <plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>endpoints-framework-maven-plugin</artifactId>
    <version>2.1.0</version>
    <configuration>
      <!-- plugin configuration -->
      <!--
      You must replace YOUR_PROJECT_ID with your
      Google Cloud Project Id
    -->
    <hostname>YOUR_PROJECT_ID.appspot.com</hostname>
  </configuration>
</plugin>

Nel campo hostname, sostituisci YOUR_PROJECT_ID con l'ID progetto di Google Cloud.

Gradle

// You must replace YOUR_PROJECT_ID with your Google Cloud Project Id
def projectId = 'YOUR_PROJECT_ID'

endpointsServer {
  // Endpoints Framework Plugin server-side configuration
  hostname = "${projectId}.appspot.com"
}

Imposta la variabile projectID sul tuo ID progetto Google Cloud. Ad esempio: def projectId = 'example-project-12345'

Configurazione del servlet di endpoint

Il servlet di endpoint gestisce le richieste in entrata e le inoltra al servizio di backend in esecuzione su App Engine. Il servlet di endpoint è necessario per la gestione degli endpoint da parte dell'API.

Per maggiori informazioni su web.xml, consulta Il descrittore di deployment: web.xml.

<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
    <!-- Wrap the backend with Endpoints Frameworks v2. -->
    <servlet>
        <servlet-name>EndpointsServlet</servlet-name>
        <servlet-class>com.google.api.server.spi.EndpointsServlet</servlet-class>
        <init-param>
            <param-name>services</param-name>
            <param-value>com.example.skeleton.MyApi</param-value>
        </init-param>
    </servlet>
    <!-- Route API method requests to the backend. -->
    <servlet-mapping>
        <servlet-name>EndpointsServlet</servlet-name>
        <url-pattern>/_ah/api/*</url-pattern>
    </servlet-mapping>
</web-app>

Configurazione del tuo deployment App Engine

Il file appengine-web.xml viene utilizzato per definire la configurazione dell'ambiente standard di App Engine quando viene eseguito il deployment dell'API. Per ulteriori informazioni, consulta i riferimenti a appengine-web.xml.

<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
    <runtime>java8</runtime>
    <threadsafe>true</threadsafe>

    <system-properties>
        <property name="java.util.logging.config.file" value="WEB-INF/logging.properties"/>
    </system-properties>
</appengine-web-app>

Passaggi successivi