Utilizzo di Guice con i framework Cloud Endpoints

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

Google Guice è un framework di inserimento di dipendenze che puoi utilizzare con un progetto Endpoints v2 per configurare la mappatura e l'applicazione di filtri dei servlet in modo programmatico in Java, anziché in web.xml.

Per utilizzare Guice, devi aggiungere la seguente dipendenza preconfezionata al tuo pom.xml o build.gradle. Inoltre, è necessario configurare i plug-in endpoints Frameworks per Maven e Gradle per definire quali classi di servizio utilizzano i plug-in per creare documenti OpenAPI.

Maven

<dependency>
  <groupId>com.google.endpoints</groupId>
  <artifactId>endpoints-framework-guice</artifactId>
  <version>2.2.2</version>
</dependency>

Gradle

compile 'com.google.endpoints:endpoints-framework-guice:2.2.2'
endpointsServer {
  // Endpoints Framework Plugin server-side configuration
  hostname = "${projectId}.appspot.com"
  serviceClasses = ['com.example.echo.Echo']
}

Successivamente, devi aggiornare web.xml per indirizzare tutto il traffico da /_ah/api/* all'endpoint di Framework Servlet.

<filter>
    <filter-name>guiceFilter</filter-name>
    <filter-class>com.google.inject.servlet.GuiceFilter</filter-class>
</filter>

<!--
  URL Pattern /_ah/api/* instead of /* because a legacy v1 servlet uses
  the route /_ah/api/ and using /* will erronously use the legacy v1
  servlet instead of routing to your API.
-->
<filter-mapping>
    <filter-name>guiceFilter</filter-name>
    <url-pattern>/_ah/api/*</url-pattern>
</filter-mapping>

<listener>
    <listener-class>com.example.echo.EchoGuiceListener</listener-class>
</listener>

Implementa la classe listener nel progetto. A seconda del numero di servizi, dovrebbe essere simile alla seguente:

public class EchoGuiceListener extends GuiceServletContextListener {

  @Override
  protected Injector getInjector() {
    return Guice.createInjector(new EchoEndpointModule());
  }
}

La classe listener crea un nuovo iniettore che gestisce la mappatura e il filtro dei servlet, che normalmente è definita da web.xml, ma ora è definita dalla classe EchoEndpointModule definita come:

public class EchoEndpointModule extends EndpointsModule {
  @Override
  public void configureServlets() {
    super.configureServlets();

    bind(ServiceManagementConfigFilter.class).in(Singleton.class);
    filter("/_ah/api/*").through(ServiceManagementConfigFilter.class);

    Map<String, String> apiController = new HashMap<String, String>();
    apiController.put("endpoints.projectId", "YOUR-PROJECT-ID");
    apiController.put("endpoints.serviceName", "YOUR-PROJECT-ID.appspot.com");

    bind(GoogleAppEngineControlFilter.class).in(Singleton.class);
    filter("/_ah/api/*").through(GoogleAppEngineControlFilter.class, apiController);

    bind(Echo.class).toInstance(new Echo());
    configureEndpoints("/_ah/api/*", ImmutableList.of(Echo.class));
  }
}

Passaggi successivi