Java용 예약 서버 (REST) 스켈레톤

저장소를 클론하여 스켈레톤 REST 서버를 다운로드할 수 있습니다.

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

소개

다음을 기반으로 하는 API v3 예약 서버의 참조 구현입니다.

  • google-protobuf
  • Jersey RESTful 웹 서비스

기본 요건

다음 설치 필요

시작하기

  1. Proto 인터페이스를 proto 파일 (api_v3.proto)에 복사합니다. 프로젝트 (com.partner.mapsbooking.v3.model)와 일치하도록 패키지를 수정합니다.
  2. IDE에서 booking_server_v3이라는 웹 애플리케이션 프로젝트를 만들고 이 프로젝트에 Maven 지원을 추가합니다.
  3. proto 파일을 src/main/resources 아래에 배치하고 Maven pom.xml 파일에 Jersey 및 프로토콜 버퍼 런타임의 종속 항목을 추가합니다. 
         <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 내에서 그룹 ID (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. 실행 구성에서 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