Booking Server (REST) Skeleton for Java

Możesz pobrać nasz szkielet serwera REST, klonując repozytorium

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

Wprowadzenie

To referencyjna implementacja serwera rezerwacji API w wersji 3, która opiera się na:

  • google-protobuf
  • RESTful Web Services w Jersey

Wymagania wstępne

Wymagaj instalacji

Rozpocznij

  1. Skopiuj interfejs Proto do pliku proto (api_v3.proto). Zmodyfikuj pakiet tak, aby pasował do projektu (com.partner.mapsbooking.v3.model).
  2. Utwórz w IDE projekt aplikacji internetowej o nazwie booking_server_v3 i dodaj do niego obsługę Maven.
  3. Umieść plik proto w katalogu src/main/resources,a następnie dodaj do pliku Maven pom.xml zależności dotyczące pakietu Jersey i mechanizmu obsługi buforów protokołów:
         <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. Aby automatycznie wygenerować plik źródłowy dla klas zdefiniowanych w pliku proto, uruchom to polecenie w katalogu src/main:

    protoc --java_out=java resources/api_v3.proto
    • Jeśli wdrażasz listę oczekujących, wykonaj też te czynności: protoc --java_out=java resources/waitlist.proto
  5. W katalogu src/main/java utwórz nowy pakiet odpowiadający Twojemu identyfikatorowi grupy (com.partner.mapsbooking). Pobierz przykładowy kod z repozytorium:

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

    umieść pliki w pakiecie, a potem wykonaj czynności opisane w sekcji TODO, aby dokończyć implementację.

  6. Skonfiguruj serwlet, modyfikując plik 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. W sekcji Konfiguracje uruchomień skonfiguruj konfigurację serwera Tomcat. Dodaj wszystkie pliki jar do katalogu /WEB_INF/lib (struktura projektu > artefakty > po wybraniu wszystkich plików jar kliknij prawym przyciskiem myszy i wybierz „Umieść w katalogu /WEB-INF/lib”).
  8. Uruchom Tomcat, aby uruchomić serwer.

Ostateczna struktura katalogu

  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