حجز هيكل عظمي لخادم (REST) لـ Java

يمكنك تنزيل خادم REST الهيكلي من خلال نسخ الملحق.

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

المقدمة

هذا تنفيذ مرجعي لخادم حجز الإصدار 3 من واجهة برمجة التطبيقات استنادًا إلى:

• google-protobuf
• خدمات الويب للطفل جيرسي

المتطلبات الأساسية

تثبيت عمليات التثبيت

• 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/primary/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/primary لإنشاء ملف مصدر تلقائيًا للصفوف المحدّدة في ملف Proto:

   protoc --java_out=java resources/api_v3.proto
   

   • في حال تنفيذ وظيفة قائمة الانتظار، نفِّذ أيضًا ما يلي: protoc --java_out=java resource/renewlist.proto

5. داخل src/primary/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. في عمليات ضبط التشغيل، عليك ضبط إعدادات خادم Tomcat. يمكنك إضافة جميع الأواني إلى الدليل /WEB_INF/lib (بنية المشروع -&gt؛ العناصر -& gt;
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