Skeleton del servidor de reservas (REST) para Java

Puedes descargar nuestro servidor REST de esqueleto si clonas el repositorio.

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

Introducción

Esta es una implementación de referencia para el servidor de reservas de la API v3 basada en lo siguiente:

  • google-protobuf
  • Jersey Web RESTful Services

Requisitos previos

Requerir instalaciones de

Comenzar

  1. Copia la interfaz de proto en un archivo proto (api_v3.proto). Modifica el paquete para que coincida con tu proyecto (com.partner.mapsbooking.v3.model).
  2. Crea un proyecto de aplicación web en tu IDE llamado reserve_server_v3, agrega compatibilidad con Maven a este proyecto.
  3. Coloca el archivo proto en src/main/resources y agrega las dependencias para Jersey y el entorno de ejecución de los búferes de protocolo al archivo pom.xml de Maven:
         <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. Ejecuta el siguiente comando en src/main a fin de generar automáticamente un archivo de origen para las clases definidas en el archivo proto:

    protoc --java_out=java resources/api_v3.proto
    • Si implementas la funcionalidad de lista de espera, también ejecuta lo siguiente: protoc --java_out=java resources/waitlist.proto

  5. Dentro de src/main/java, crea un paquete nuevo que coincida con tu groupId (com.partner.mapsbooking). Recupera el código de muestra del repositorio:

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

    coloca los archivos en tu paquete y sigue los TODO para completar la implementación.

  6. Para configurar el servlet, modifica el archivo 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. En Run Configurations (Configuración de ejecución), establece una configuración del servidor Tomcat. Agrega todos los archivos jar al directorio /WEB_INF/lib (estructura de proyecto -> artifacts -> después de seleccionar todos los archivos jar, haz clic con el botón derecho y elige "Colocar en /WEB-INF/lib").
  8. Ejecuta Tomcat para iniciar tu servidor.

Estructura final del directorio

  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