שלד של שרת הזמנות (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 לקובץ proto (api_v3.proto). משנים את החבילה כך שתתאים לפרויקט שלכם (com.partner.mapsbooking.v3.model).
   • אם רוצים להטמיע פונקציונליות של רשימת המתנה, חוזרים על אותם השלבים עם ממשק ה-Proto של רשימת המתנה.
2. יוצרים פרויקט של אפליקציית אינטרנט בסביבת הפיתוח המשולבת (IDE) בשם booking_server_v3, ומוסיפים תמיכה ב-Maven לפרויקט הזה.
3. מניחים את קובץ ה-proto בקטע src/main/resources,מוסיפים את יחסי התלות של Jersey ו-protocol buffers runtime לקובץ 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, יוצרים חבילת Java חדשה שתתאים למזהה הקבוצה שלכם (com.partner.mapsbooking). אחזור של דוגמת הקוד מהמאגר:

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

   מניחים את הקבצים בחבילה, ופועלים לפי TODOs כדי להשלים את ההטמעה.

6. מגדירים את ה-servlet על ידי שינוי הקובץ 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