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. Questa pagina utilizza il codice di esempio di codice di Endpoints Frameworks versione 2.0 per spiegare il software e i componenti di base necessari per iniziare.

Potresti voler utilizzare endpoints-skeleton-archetype o hello-endpoints-archetype descritti in Utilizzo di Apache Maven e del plug-in App Engine (basato su Google Cloud CLI) per creare un nuovo progetto Endpoints Frameworks versione 2.0.

Per comprendere meglio i passaggi necessari per eseguire il deployment di un'API di esempio utilizzando Endpoints Frameworks, consulta il tutorial Guida introduttiva a Endpoints Frameworks su App Engine.

Prima di iniziare

Accedi al tuo Google Cloud account. 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 senza costi per l'esecuzione, il test e il deployment dei workload.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Prendi nota dell'ID progetto Google Cloud perché ti servirà in seguito.

Installazione e configurazione del software richiesto

Se non hai installato Java 8, scarica Java Development Kit (JDK) da sito di Oracle e installalo.
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
- Installa Gradle.
Scarica e inizializza Google Cloud CLI.
Esegui i seguenti comandi:
1. Assicurati che gcloud CLI sia autorizzato 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 di tutti i componenti:
```
gcloud components update
```
Crea un'applicazione App Engine:
1. Imposta il progetto predefinito sull'ID progetto Google Cloud :
```
gcloud config set project YOUR_PROJECT_ID
```
  Sostituisci YOUR_PROJECT_ID con il tuo Google Cloud ID progetto. Se hai altri Google Cloud progetti e vuoi utilizzare gcloud per gestirli, consulta Gestire le configurazioni di gcloud CLI.
2. Seleziona la regione in cui vuoi creare l'applicazione App Engine. Per un elenco delle regioni, consulta Località di App Engine.
3. Crea un'applicazione App Engine. Sostituisci YOUR_PROJECT_ID con l' Google Cloud ID progetto e YOUR_REGION con la regione in cui vuoi creare l' applicazione App Engine.
```
  gcloud app create \
  --project=YOUR_PROJECT_ID \
  --region=YOUR_REGION
```

Recuperare l'esempio di 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 necessari per iniziare a creare la tua prima API.

Clona il repository di esempio sulla tua macchina locale:

 git clone https://github.com/GoogleCloudPlatform/java-docs-samples

Passa alla directory contenente l'esempio di scheletro di Endpoints Frameworks:
```
 cd java-docs-samples/appengine-java8/endpoints-v2-skeleton/
```
L'esempio ha la seguente struttura di directory:
- MyApi.java contiene una classe vuota che puoi utilizzare per iniziare a scrivere la tua API. Per un codice campione che ti aiuti a iniziare, consulta l'esempio echo.
- web.xml è un file standard utilizzato per configurare una servlet.
- appengine-web.xml definisce le informazioni necessarie per eseguire il deployment dell'API nell'ambiente standard di App Engine utilizzando 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.

Configurare i file di build

Questa sezione descrive i file pom.xml di Maven e build.gradle di Gradle inclusi nel codice campione. A parte l'inserimento dell'ID progetto in modo che possa essere utilizzato nel nome host, i file di build sono pronti per iniziare a creare l'API. Google Cloud

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.23</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 l'API.
Per eseguire il deployment del tuo progetto nell'ambiente standard di App Engine, devi disporre dell'SDK API standard di App Engine (appengine-api-sdk).
Il pacchetto standard javax.servlet è necessario per creare una servlet.
Il pacchetto standard javax.inject è necessario per supportare l'inserimento delle dipendenze.

Applica plug-in

I seguenti plug-in vengono applicati per abilitare:

<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.4.0</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.5.0</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>

Il maven-war-plugin estende il plug-in java per aggiungere il supporto per l'assemblaggio di un'applicazione web.
appengine-maven-plugin è necessario per eseguire l'API su App Engine.
Il endpoints-framework-maven-plugin fornisce attività e configurazioni per creare progetti Endpoints Frameworks.

Gradle

Dipendenze dei plug-in

Di seguito sono riportati i plug-in necessari per creare l'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.5.0'
  }
}

Il plug-in Gradle di Endpoints Frameworks viene utilizzato per generare un documento OpenAPI e per generare librerie client.
Per eseguire il deployment del progetto in App Engine, devi disporre del plug-in Gradle di App Engine.

Applica plug-in

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

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 al progetto passaggi di compilazione e build specifici per Java.
Il plug-in war estende il plug-in java per aggiungere il supporto per l'assemblaggio di un'applicazione web.
Il plug-in endpoints-framework-server fornisce il supporto lato server al plug-in Gradle di Endpoints Frameworks.
Il plug-in appengine è necessario per eseguire l'API su App Engine.

Dipendenze del 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.23'

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

La dipendenza endpoints-framework contiene le classi necessarie per creare l'API.
Per eseguire il deployment del progetto nell'ambiente standard di App Engine, devi disporre dell'SDK API standard di App Engine (appengine-api-sdk).
Il pacchetto standard javax.servlet è necessario per creare una servlet.
Il pacchetto standard javax.inject è necessario per supportare l'inserimento delle dipendenze.

Definire il nome host per il servizio

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

Devi aggiungere l'ID progetto ai file di build per configurare il nome host del servizio. Google Cloud 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 è sia il nome del servizio Cloud Endpoints sia il nome di dominio che utilizzi per inviare 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' Google Cloud ID progetto.

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 sull'ID progetto Google Cloud. Ad esempio: def projectId = 'example-project-12345'

Configurare la servlet Endpoints

La servlet Endpoints gestisce le richieste in entrata e le inoltra al servizio di backend in esecuzione su App Engine. La servlet Endpoints è necessaria per la gestione dell'API da parte di Endpoints.

Per ulteriori 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>

Configurare il deployment di 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 il riferimento 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>

Configurazione di un ambiente di sviluppo Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Prima di iniziare

Installazione e configurazione del software richiesto

Maven

Gradle

Recuperare l'esempio di scheletro di Endpoints Frameworks

Configurare i file di build

Informazioni sulla configurazione minima

Maven

Gradle

Definire il nome host per il servizio

Maven

Gradle

Configurare la servlet Endpoints

Configurare il deployment di App Engine

Passaggi successivi

Configurazione di un ambiente di sviluppo