اسکلت سرور رزرو (REST) ​​برای جاوا

شما می‌توانید با کپی کردن مخزن ، اسکلت سرور REST ما را دانلود کنید.

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

مقدمه

این یک پیاده‌سازی مرجع برای سرور رزرو API نسخه ۳ بر اساس موارد زیر است:

  • گوگل-پروتوباف
  • سرویس‌های وب RESTful جرسی

پیش‌نیازها

نیاز به نصب

شروع کنید

  1. رابط Proto را در یک فایل proto (api_v3.proto) کپی کنید. بسته را برای مطابقت با پروژه خود (com.partner.mapsbooking.v3.model) تغییر دهید.
  2. یک پروژه وب اپلیکیشن در IDE خود با نام booking_server_v3 ایجاد کنید، پشتیبانی Maven را به این پروژه اضافه کنید.
  3. فایل proto خود را در مسیر src/main/resources قرار دهید، وابستگی‌های Jersey و بافرهای پروتکل زمان اجرا را به فایل 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. در Run Configurations، پیکربندی سرور 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