Java 預訂伺服器 (REST) 摘要

您可以下載我們的 複製存放區以建立 skeleton REST 伺服器

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

簡介

這是 API v3 預訂伺服器的參考實作方式，內容如下：

  • google-protobuf
  • 澤西島符合 REST 樣式的網路服務

必要條件

需要安裝

開始使用

  1. 將 Proto 介面複製到 proto 檔案 (api_v3.proto)。修改 符合專案的套件 (com.partner.mapsbooking.v3.model)。
  2. 在 IDE 中建立名為 book_server_v3 的網頁應用程式專案，然後新增 支援這項專案的 Maven。
  3. 將 proto 檔案放在 src/main/resources, 下方， 澤西島和通訊協定緩衝區執行階段的依附元件到 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 資源/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 檔案來設定 localhost： 
    <?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 伺服器設定。新增全部 /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