Scrivere e annotare il codice

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

In questa pagina viene descritto come strutturare e annotare il codice di Cloud Endpoints Frameworks. Per un elenco completo di tutte le annotazioni supportate, vedi Annotazioni.

Prima di iniziare

  1. Configura il tuo ambiente di sviluppo.

  2. Clona l'esempio di framework degli endpoint scheletri:

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

  3. L'esempio di framework di endpoint scheletri si trova in:

     cd appengine-java8/endpoints-v2-skeleton/

Per spiegare come funzionano le annotazioni, questo documento utilizza l'esempio endpoints-v2-backend per mostrare le annotazioni e altri codici che devi aggiungere all'esempio endpoints-v2-skeleton per crearlo. Alla fine, l'esempio endpoints-v2-skeleton modificato si comporta come l'esempio endpoints-v2-backend, che viene utilizzato nella guida introduttiva ai framework di endpoint su App Engine.

Creazione e annotazione del codice

Per annotare il codice:

  1. Cambia le directory nella directory di origine Java del progetto, ad esempio: src/main/java/com/example/skeleton.
  2. Crea un file della classe JavaBean denominato Message.java che contenga il codice seguente:
    appengine-java8/endpoints-v2-backend/src/main/java/com/example/echo/Message.java 
    public class Message {

  private String message;

  public String getMessage() {
    return this.message;
  }

  public void setMessage(String message) {
    this.message = message;
  }
}
  3. Modifica il file MyApi.java contenuto nell'esempio dello scheletro. Modifica l'annotazione di definizione di @Api con i seguenti elementi:
    appengine-java8/endpoints-v2-backend/src/main/java/com/example/echo/Echo.java 
    @Api(
    name = "echo",
    version = "v1",
    namespace =
    @ApiNamespace(
        ownerDomain = "echo.example.com",
        ownerName = "echo.example.com",
        packagePath = ""
    ),
    // ...
)

    L'attributo version = "v1" specifica la versione dell'API di esempio. Il valore inserito diventa parte del percorso nell'URL alla tua API. Per ulteriori informazioni sulle versioni, consulta Gestione del controllo delle versioni dell'API.

  4. Aggiungi il metodo echo seguente come primo endpoint API e il metodo doEcho di supporto al tuo MyApi.java.
    appengine-java8/endpoints-v2-backend/src/main/java/com/example/echo/Echo.java 
    @ApiMethod(name = "echo")
public Message echo(Message message, @Named("n") @Nullable Integer n) {
  return doEcho(message, n);
}
    private Message doEcho(Message request, Integer n) {
  Message response = new Message();
  if (n != null && n >= 0) {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < n; i++) {
      if (i > 0) {
        sb.append(' ');
      }
      sb.append(request.getMessage());
    }
    response.setMessage(sb.toString());
  }
  return response;
}
  5. Copia tutte le importazioni da Echo.java e incollale in MyApi.java.

  6. Maven

    Crea il progetto:

    mvn clean package

    Gradle

    Crea il progetto:

    gradle clean build

Nozioni di base sulle annotazioni

Esistono tre annotazioni comunemente utilizzate nelle API di backend:

  • @Api contiene i dettagli di configurazione dell'API backend.
  • @ApiMethod contrassegna un metodo della classe che fa parte dell'API di backend. I metodi che non sono contrassegnati con @ApiMethod non vengono inclusi quando generi le librerie client e i documenti di rilevamento. L'annotazione @ApiMethod può essere utilizzata anche per sostituire la configurazione API per un metodo specifico.
  • È necessario aggiungere @Named a tutti i parametri passati ai metodi lato server, a meno che il parametro non sia un tipo di entità.

Per un elenco completo di tutte le annotazioni di Framework di endpoint, vedi Annotazioni e sintassi.

Passaggi successivi