Java 用予約サーバー（REST）スケルトン

リポジトリのクローンを作成することで、スケルトン REST サーバーをダウンロードできます。

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

はじめに

これは、以下に基づく API v3 予約サーバーのリファレンス実装です。

  • google-protobuf
  • ジャージー 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 とプロトコル バッファ ランタイムの依存関係を Maven の src/main/resources, ファイルに追加します。
         <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 を選択した後、右クリックして [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