適用於 Java 的預訂伺服器 (REST) 基本架構

您可以複製存放區來下載我們的REST 伺服器架構

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

簡介

這是 API 第 3 版預訂伺服器的參考實作項目，適用於：

  • google-protobuf
  • Jersey RESTful Web Services

必要條件

必須安裝

開始使用

  1. 將 Proto 介面複製到 proto 檔案 (api_v3.proto) 中。修改套件，使其與專案相符 (com.partner.mapsbooking.v3.model)。
  2. 在 IDE 中建立名為 booking_server_v3 的網頁應用程式專案，並為此專案新增 Maven 支援。
  3. 將 proto 檔案放在 src/main/resources 下方，並將 Jersey 和通訊協定緩衝區執行階段的依附元件新增至 Maven pom.xml 檔案：
         <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 檔案，設定 Servlet：
    <?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 檔案後，按一下滑鼠右鍵並選擇「Put into /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