适用于 Java 的预订服务器 (REST) 框架

您可以通过克隆代码库下载我们的框架 REST 服务器

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

简介

这是 API v3 预订服务器的参考实现，基于以下内容：

  • google-protobuf
  • Jersey RESTful Web 服务

前提条件

需要安装

开始使用

  1. 将 Proto 接口复制到 proto 文件 (api_v3.proto) 中。修改软件包以与您的项目（com.partner.mapsbooking.v3.model）匹配。
  2. 在 IDE 中创建一个名为 booking_server_v3 的 Web 应用项目，并为此项目添加 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. 在“Run Configurations”（运行配置）中，设置 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