אפשר להוריד את שרת ה-REST של השלד שלנו על ידי שכפול המאגר
git clone https://maps-booking.googlesource.com/java-maps-booking-rest-server-v3-skeleton
מבוא
זהו יישום ייחוס לשרת הזמנות של API v3 שמבוסס על:
דרישות מוקדמות
דרישה להתקנות של
תחילת העבודה
- מעתיקים את ממשק ה-Proto לקובץ proto (api_v3.proto). משנים את החבילה כך שתתאים לפרויקט שלכם (com.partner.mapsbooking.v3.model).
- אם רוצים להטמיע פונקציונליות של רשימת המתנה, חוזרים על אותם השלבים עם ממשק ה-Proto של רשימת המתנה.
- יוצרים פרויקט של אפליקציית אינטרנט בסביבת הפיתוח המשולבת (IDE) בשם booking_server_v3, ומוסיפים תמיכה ב-Maven לפרויקט הזה.
- מניחים את קובץ ה-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>
-
מריצים את הפקודה הבאה בקטע src/main כדי ליצור באופן אוטומטי קובץ מקור של הכיתות שמוגדרות בקובץ ה-proto:
protoc --java_out=java resources/api_v3.proto
- אם מטמיעים פונקציונליות של רשימת המתנה, צריך להריץ גם את הפקודה הבאה: protoc --java_out=java resources/waitlist.proto
-
בתוך src/main/java, יוצרים חבילת Java חדשה שתתאים למזהה הקבוצה שלכם (com.partner.mapsbooking). אחזור של דוגמת הקוד מהמאגר:
git clone https://maps-booking.googlesource.com/java-maps-booking-rest-server-v3-skeleton
מניחים את הקבצים בחבילה, ופועלים לפי TODOs כדי להשלים את ההטמעה.
- מגדירים את ה-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>
- ב-Run Configurations, מגדירים הגדרת שרת Tomcat. מוסיפים את כל קובצי ה-jar לספרייה /WEB_INF/lib (מבנה הפרויקט -> ארטיפקטים -> אחרי שבוחרים את כל קובצי ה-jar, לוחצים לחיצה ימנית ובוחרים באפשרות 'הוספה ל-/WEB-INF/lib').
- מריצים את 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