Booking Server (REST) Skeleton pour Java

Vous pouvez télécharger notre squelette de serveur REST en clonant le dépôt.

git clone https://maps-booking.googlesource.com/java-maps-booking-rest-server-v3-skeleton

Introduction

Il s'agit d'une implémentation de référence pour le serveur de réservation de la version 3 de l'API, basée sur:

  • google-protobuf
  • Services Web RESTful Jersey

Conditions préalables

Nécessite des installations de

Commencer

  1. Copiez l'interface Proto dans un fichier proto (api_v3.proto). Modifiez le package pour qu'il corresponde à votre projet (com.partner.mapsbooking.v3.model).
  2. Créez un projet d'application Web dans votre IDE nommé "booking_server_v3" et ajoutez la compatibilité Maven à ce projet.
  3. Placez votre fichier proto sous src/main/resources,,puis ajoutez les dépendances pour Jersey et Protocol Buffers au fichier Maven src/main/resources, :
         <dependencyManagement>
         <dependencies>
             <dependency>
                 <groupId>org.glassfish.jersey</groupId>
                 <artifactId>jersey-bom</artifactId>
                 <version>${jersey.version}</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
         </dependencies>
     </dependencyManagement>

     <dependencies>
         <dependency>
             <groupId>org.glassfish.jersey.containers</groupId>
             <artifactId>jersey-container-servlet-core</artifactId>
         </dependency>
         <dependency>
             <groupId>org.glassfish.jersey.media</groupId>
             <artifactId>jersey-media-json-jackson</artifactId>
             <version>2.27</version>
         </dependency>
         <dependency>
             <groupId>com.google.protobuf</groupId>
             <artifactId>protobuf-java</artifactId>
             <version>3.5.1</version>
         </dependency>
         <dependency>
             <groupId>io.grpc</groupId>
             <artifactId>grpc-protobuf</artifactId>
             <version>1.11.0</version>
         </dependency>
     </dependencies>

     <properties>
         <java.version>1.8</java.version>
         <jersey.version>2.23.2</jersey.version>
     </properties>

  4. Exécutez la commande suivante sous src/main afin de générer automatiquement un fichier source pour les classes définies dans le fichier proto:

    protoc --java_out=java resources/api_v3.proto
    • Si vous implémentez la fonctionnalité de liste d'attente, exécutez également la commande suivante : protoc --java_out=java resources/waitlist.proto

  5. Dans src/main/java, créez un package correspondant à votre groupId (com.partner.mapsbooking). Récupérez l'exemple de code du dépôt:

     git clone https://maps-booking.googlesource.com/java-maps-booking-rest-server-v3-skeleton

    placez les fichiers sous votre package, suivez les instructions de la section À FAIRE pour terminer l'implémentation.

  6. Configurez votre servlet en modifiant le fichier web.xml :
    <?xml version="1.0" encoding="UTF-8"?>
<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_4_0.xsd"
         version="4.0">

    <servlet>
        <servlet-name>Booking Rest Server</servlet-name>
        <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
        <init-param>
            <param-name>jersey.config.server.provider.packages</param-name>
            <param-value>com.partner.mapsbooking</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>Booking Rest Server</servlet-name>
        <url-pattern>/mapsbooking/*</url-pattern>
    </servlet-mapping>
</web-app>
  7. Dans la section "Run Configurations" (Configurations d'exécution), définissez la configuration du serveur Tomcat. Ajoutez tous les fichiers JAR au répertoire /WEB_INF/lib (structure du projet -> artefacts -> Après avoir sélectionné tous les fichiers JAR, effectuez un clic droit et choisissez "Put into /WEB-INF/lib").
  8. Exécutez Tomcat pour démarrer votre serveur.

Structure finale du répertoire

  src
  |---main
      |---java
          |---com.partner.mapsbooking
              |---rest
                  |---BookingService.java
                  |---BookingExceptionMapper.java
                  |---Error.java
              |---authentication
                  |---AuthenticationService.java
                  |---RestAuthenticationFilter.java
              |---v3.model
                  |---ApiV3.java
                  |---Waitlist.java
      |---resources
          |---api_v3.proto
          |---waitlist.proto
  |---test