Скелет сервера бронирования (REST) ​​для Java

Вы можете скачать наш базовый REST-сервер , клонировав репозиторий.

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

Введение

Это эталонная реализация сервера бронирования API v3, основанная на:

  • google-protobuf
  • Веб-сервисы Jersey RESTful

Предварительные требования

Требуется установка

Начать

  1. Скопируйте Proto Interface в proto-файл (api_v3.proto). Измените пакет в соответствии с вашим проектом (com.partner.mapsbooking.v3.model).
  2. Создайте в своей IDE проект веб-приложения с именем booking_server_v3 и добавьте в него поддержку Maven.
  3. Разместите ваш proto-файл в папке src/main/resources, добавьте зависимости для Jersey и среды выполнения Protocol Buffers в файл pom.xml 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. Выполните следующую команду в папке src/main , чтобы автоматически сгенерировать исходный файл для классов, определенных в proto-файле:

    protoc --java_out=java resources/api_v3.proto
    • При реализации функции списка ожидания также выполните следующую команду: protoc --java_out=java resources/waitlist.proto

  5. Внутри папки src/main/java создайте новый пакет, соответствующий вашему groupId (com.partner.mapsbooking). Пример кода можно найти в репозитории:

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

    Разместите файлы в своем пакете и следуйте инструкциям в списке задач (TODO) , чтобы завершить реализацию.

  6. Настройте свой сервлет, изменив файл 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. В разделе «Настройки запуска» настройте конфигурацию сервера Tomcat. Добавьте все JAR-файлы в каталог /WEB_INF/lib (структура проекта -> артефакты -> После выбора всех JAR-файлов щелкните правой кнопкой мыши и выберите «Поместить в /WEB-INF/lib»).
  8. Запустите Tomcat, чтобы запустить сервер.

Окончательная структура каталогов 

  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