Buchungsserver- (REST)-Skeleton für Java

Sie können unseren REST-Skelettserver herunterladen, indem Sie das Repository klonen.

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

Einführung

Dies ist eine Referenzimplementierung für den API v3-Buchungsserver, die auf Folgendem basiert:

• google-protobuf
• Jersey RESTful Web Services

Vorbereitung

Installation von

• Apache Maven
• Protokollcompiler für Java
• Apache Tomcat

Jetzt starten

1. Kopieren Sie die Proto-Schnittstelle in eine Proto-Datei (api_v3.proto). Ändern Sie das Paket so, dass es Ihrem Projekt entspricht (com.partner.mapsbooking.v3.model).
   • Wenn Sie die Wartelistenfunktion implementieren, wiederholen Sie dieselben Schritte mit der Warteliste – Proto-Oberfläche.
2. Erstellen Sie in Ihrer IDE ein Webanwendungsprojekt mit dem Namen „booking_server_v3“ und fügen Sie diesem Projekt Maven-Unterstützung hinzu.
3. Platzieren Sie Ihre Proto-Datei unter src/main/resources und fügen Sie der Maven-Datei pom.xml Abhängigkeiten für Jersey und die Laufzeit von Protocol Buffers hinzu:

        <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. Führen Sie den folgenden Befehl unter src/main aus, um automatisch eine Quellcodedatei für die in der Protobuf-Datei definierten Klassen zu generieren:

   protoc --java_out=java resources/api_v3.proto

   • Wenn Sie die Wartelistenfunktion implementieren, führen Sie auch Folgendes aus: protoc --java_out=java resources/waitlist.proto

5. Erstellen Sie im Ordner src/main/java ein neues Paket, das Ihrer groupId entspricht (com.partner.mapsbooking). Rufen Sie den Beispielcode aus dem Repository ab:

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

   Platzieren Sie die Dateien in Ihrem Paket und folgen Sie den TODOs, um die Implementierung abzuschließen.

6. Konfigurieren Sie das Servlet, indem Sie die Datei web.xml ändern:

   <?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. Richten Sie in den Ausführungskonfigurationen eine Tomcat-Serverkonfiguration ein. Fügen Sie alle JAR-Dateien dem Verzeichnis „/WEB_INF/lib“ hinzu (Projektstruktur -> Artefakte -> Klicken Sie nach dem Auswählen aller JAR-Dateien mit der rechten Maustaste und wählen Sie „Put into /WEB-INF/lib“ (In /WEB-INF/lib einfügen) aus).
8. Führen Sie Tomcat aus, um den Server zu starten.

Endgültige Verzeichnisstruktur

  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