โครงกระดูกเซิร์ฟเวอร์การจอง (REST) สำหรับ Java

คุณสามารถดาวน์โหลดเซิร์ฟเวอร์ REST โครงสร้างของเราได้โดยโคลนที่เก็บ

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

บทนำ

นี่คือการใช้งานอ้างอิงสำหรับเซิร์ฟเวอร์การจอง API v3 โดยอิงตาม

  • google-protobuf
  • บริการเว็บ RESTful ของ Jersey

ข้อกำหนดเบื้องต้น

ต้องมีการติดตั้ง

เริ่มต้นใช้งาน

  1. คัดลอกอินเทอร์เฟซ Proto ลงในไฟล์ Proto (api_v3.proto) แก้ไข แพ็กเกจให้ตรงกับโปรเจ็กต์ (com.partner.mapsbooking.v3.model)
    • หากจะใช้ฟังก์ชันการทำงานของรายการรอ ให้ทำตามขั้นตอนเดียวกันกับ Waitlist Proto Interface
  2. สร้างโปรเจ็กต์เว็บแอปพลิเคชันใน IDE ชื่อ booking_server_v3 แล้วเพิ่ม การรองรับ Maven ลงในโปรเจ็กต์นี้
  3. วางไฟล์ Proto ไว้ใน src/main/resources แล้วเพิ่ม ทรัพยากร Dependency สำหรับ Jersey และรันไทม์ของ Protocol Buffer ลงในไฟล์ 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 ทั้งหมดแล้ว ให้คลิกขวาแล้วเลือก "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