שרת הזמנות (REST) שלד ל-Java

אפשר להוריד את שרת ה-REST שלד על ידי שכפול ה-repo

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

מבוא

זוהי הטמעה של קובץ עזר עבור שרת הזמנות מסוג API v3 המבוסס על:

• -google-protobuf
• שירותי אינטרנט ב-REST

דרישות מוקדמות

דרישת התקנות של

• Apache Maven
• מהדר פרוטוקל ל-Java
• Apache Tomcat

שנתחיל?

1. מעתיקים את ממשק Proto לקובץ Proto (api_v3.proto). משנים את החבילה בהתאם לפרויקט (com.partner.mapsbooking.v3.model).
   • אם מיישמים פונקציונליות של רשימת המתנה, צריך לחזור על אותם הצעדים באמצעות ממשק אב של רשימת המתנה
2. עליך ליצור פרויקט של אפליקציית אינטרנט בסביבת הפיתוח המשולבת (IDE) שנקרא order_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 Resources/Pendinglist.proto

5. בתוך ה-src/main/Java, יוצרים חבילה חדשה שתואמת ל-groupId (com.partner.mapsbooking). אחזר את הקוד לדוגמה מה-repo:

    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. ב'הגדרות הפעלה', מגדירים תצורת שרת Tomcat. מוסיפים את כל הצנצנות לספרייה /WEB_INF/lib (מבנה הפרויקט -> חפצים -> אחרי שבוחרים את כל המאגרים, לוחצים לחיצה ימנית ובוחרים "כניסה אל /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