Booking Server (REST) Skeleton für Java

Sie können unseren REST-Skeleton-REST-Server 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 Buchungsserver der API-Version 3 auf der Grundlage von:

  • google-protobuf
  • RESTful-Webdienste für Jersey

Voraussetzungen

Installationen von

Erste Schritte

  1. Kopieren Sie die Proto-Schnittstelle in eine .proto-Datei (api_v3.proto). Ändern Sie das Paket entsprechend Ihrem Projekt (com.partner.mapsbooking.v3.model).
  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 die .proto-Datei unter src/main/resources, und fügen Sie der Maven-Datei src/main/resources, die Abhängigkeiten für die Jersey- und Protokollpuffer-Laufzeit 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 unter src/main den folgenden Befehl aus, um automatisch eine Quelldatei für die in der Proto-Datei definierten Klassen zu generieren:

    protoc --java_out=java resources/api_v3.proto
    • Wenn du die Wartelistenfunktion implementierst, führe auch Folgendes aus: protoc --java_out=java Resources/waitlist.proto

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

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

    Wenn Sie die Dateien unter Ihr Paket legen, 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 unter „Ausführungskonfigurationen“ eine Tomcat-Serverkonfiguration ein. Fügen Sie alle JAR-Dateien in das Verzeichnis /WEB_INF/lib ein (Projektstruktur -> Artefakte -> Nachdem Sie alle JAR-Dateien ausgewählt haben, klicken Sie mit der rechten Maustaste und wählen Sie „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