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

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

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

บทนำ

นี่เป็นการใช้งานอ้างอิงสำหรับเซิร์ฟเวอร์การจอง API v3 โดยอิงตามข้อมูลต่อไปนี้

• google-protobuf
• Jersey RESTful Web Services

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

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

• Apache Maven
• คอมไพเลอร์โปรโตคอลสําหรับ Java
• Apache Tomcat

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

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

   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

   วางไฟล์ไว้ในแพ็กเกจ แล้วทําตามสิ่งที่ต้องทําเพื่อติดตั้งใช้งานให้เสร็จสมบูรณ์

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. ใน 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