Apache Maven 및 App Engine 플러그인 사용(Cloud SDK 기반)

이 페이지에서는 소프트웨어 프로젝트 관리 및 이해 도구인 Apache Maven을 사용하여 App Engine 프로젝트를 관리하는 방법을 설명합니다. 이 도구를 사용하면 App Engine에 배포할 WAR(웹 애플리케이션 아카이브) 파일을 빌드할 수 있습니다. Google은 Maven 3.5 이상에서 지원되는 Maven Archetype과 플러그인을 제공합니다.

Maven은 App Engine SDK에서 자바 라이브러리를 다운로드합니다. Maven을 사용하면 앱을 로컬에서 테스트하고 App Engine에 배포할 수 있습니다.

시작하기 전에

  1. Google Cloud Console을 사용하여 클라우드 프로젝트를 만들고 설정합니다.
    App Engine으로 이동
    1. 새 클라우드 프로젝트를 선택하거나 만듭니다.
    2. 프로젝트에 App Engine 애플리케이션을 만들어야 하면 안내를 따라 App Engine 애플리케이션을 배치할 리전을 선택합니다.
  2. 자바가 없으면 자바를 다운로드하여 설치하고 구성합니다.
  3. 프로젝트의 pom.xml에서 자바 컴파일러 플래그를 설정하여 자바 8 바이트코드를 지정합니다.
    자바 8
    <properties>
      <maven.compiler.source>1.8</maven.compiler.source>
      <maven.compiler.target>1.8</maven.compiler.target>
    </properties>
  4. Maven 3.5 이상이 설치되어 있어야 합니다. Maven 3.5 이상이 설치되었는지 확인하기 위해 다음 명령어를 실행합니다.
     mvn -v
  5. Maven 3.5 이상이 설치되어 있지 않으면 다음 명령어를 실행합니다.
    1. Maven 웹사이트에서 Maven 3.5 이상을 다운로드합니다.
    2. 로컬 머신에 Maven 3.5 이상을 설치합니다.

      참고: Linux 사용자는 Maven 3.5 이상을 설치하는 데 apt-get install을 사용하는 대신 Maven을 다운로드해야 할 수 있습니다.

  6. 필요한 경우 플러그인이 자동으로 Cloud SDK를 설치하므로 Cloud SDK를 설치할 필요가 없습니다.

기존 프로젝트에 App Engine Maven 플러그인 추가(선택사항)

기존 Maven 프로젝트에서 Google App Engine Maven 플러그인을 사용하려면 프로젝트 pom.xml 파일의 plugins 섹션에 다음을 추가합니다.

<plugin>
   <groupId>com.google.cloud.tools</groupId>
   <artifactId>appengine-maven-plugin</artifactId>
   <version>2.2.0</version>
</plugin>

App Engine archetype 선택

Maven Archetype을 통해 사용자는 일반적인 시나리오를 지원하는 템플릿을 사용해서 Maven 프로젝트를 만들 수 있습니다. App Engine은 이 Maven 기능을 활용하여 Maven Central에서 몇 가지 유용한 App Engine archetype을 제공합니다. 사용 중인 앱에 적합한 App Engine archetype을 선택합니다.

애플리케이션 유형 아티팩트 설명
App Engine 앱 appengine-skeleton-archetype 고유 클래스 및 리소스에 사용 가능한 빈 App Engine 프로젝트를 새롭게 생성하지만 파일 및 디렉터리가 필요합니다.
App Engine 앱 appengine-standard-archetype App Engine 표준 환경에 적합한 자바 애플리케이션을 생성합니다.
App Engine 앱 appengine-flexible-archetype App Engine 가변형 환경에 적합한 자바 애플리케이션을 생성합니다.

Maven을 사용하여 새 프로젝트 만들기

프로젝트를 만들 때 Maven에서는 프로젝트의 groupId, artifactId, versionpackage를 제공하라는 메시지가 표시됩니다.

항목 의미
groupId Maven 내에서 아티팩트를 추적하는 네임스페이스입니다. 다른 사람이 자체 Maven 프로젝트에서 내 프로젝트를 사용할 때 이 네임스페이스를 종속 항목 속성으로 지정합니다.
artifactId Maven 내에서 사용할 프로젝트 이름입니다. 다른 사람이 자체 Maven 프로젝트에서 내 프로젝트를 사용할 때 이 이름도 지정합니다.
version 프로젝트를 생성하려는 초기 Maven 버전입니다. version-SNAPSHOT을 서픽스로 붙이는 것이 좋습니다. 이렇게 하면 개발 중인 Maven 출시 버전의 플러그인을 지원할 수 있습니다. 자세한 내용은 출시 버전 플러그인 사용에 대한 Maven 가이드를 참조하세요.
package 생성 중 만들어진 자바 패키지입니다.

새로운 App Engine 앱 만들기

다음 절차에서는 appengine-skeleton-archetype을 사용하여 App Engine 애플리케이션을 만드는 방법을 설명합니다.

App Engine Maven archetype을 사용하여 App Engine 앱을 만들려면 다음 안내를 따르세요.

  1. 프로젝트를 빌드하려는 디렉토리로 이동합니다.

  2. 다음 Maven 명령어를 호출합니다.

    mvn archetype:generate -Dappengine-version=1.9.59 -Dapplication-id=[YOUR-PROJECT-ID] -Dfilter=com.google.appengine.archetypes:
    

    -Dappengine-version을 자바용 App Engine SDK의 최신 버전으로 설정하고 application-id를 클라우드 프로젝트의 ID로 설정합니다.

  3. 고유 클래스에 필요한 필수 디렉터리 구조와 파일이 포함된 빈 프로젝트를 만들려면 com.google.appengine.archetypes:appengine-skeleton-archetype에 따라 번호를 제공합니다.

  4. 기본값을 수락하여 표시된 사용 가능한 archetype 버전 목록 중에서 최신 버전을 선택합니다.

  5. Define value for property 'groupId' 메시지가 나타나면 앱에 대해 원하는 네임스페이스를 입력합니다(예: com.mycompany.myapp).

  6. Define value for property 'artifactId' 메시지가 나타나면 프로젝트 이름을 입력합니다(예: myapp).

  7. Define value for property 'version' 메시지가 나타나면 기본값을 수락합니다.

  8. Define value for property 'package' 메시지가 나타나면 선호하는 패키지 이름을 입력합니다(또는 기본값을 그대로 사용). 생성된 자바 파일은 여기에 지정된 패키지 이름을 갖게 됩니다.

  9. 선택을 확인하라는 메시지가 나타나면 기본값(Y)을 수락합니다.

  10. 프로젝트 생성이 완료될 때까지 기다린 후 현재 디렉터리를 새 프로젝트 디렉터리로 변경합니다(예: myapp/).

  11. 다음을 호출하여 프로젝트를 빌드합니다.

        mvn clean package
    
  12. 프로젝트가 빌드되기를 기다립니다. 프로젝트가 성공적으로 완료되면 다음과 비슷한 메시지가 표시됩니다.

        [INFO] --------------------------------------------------
        [INFO] BUILD SUCCESS
        [INFO] --------------------------------------------------
        [INFO] Total time: 1:16.656s
        [INFO] Finished at: 2016-08-04T16:18:24-07:00
        [INFO] Final Memory: 16M/228M
        [INFO] --------------------------------------------------
    
  13. appengine-skeleton-archetype 아티팩트를 사용하여 새로운 빈 앱을 만든 경우에는 다음 안내를 따르세요.

    1. 앱의 고유 클래스 코딩을 시작하기 전에 기본 프로젝트 레이아웃과 필요한 프로젝트 파일을 살펴봅니다. 프로젝트를 만든 디렉터리 내에는 pom.xml 파일이 포함된 myapp 하위 디렉터리와 src/main/javasrc/main/webapp/WEB-INF 하위 디렉터리가 있습니다.

      Maven 프로젝트 레이아웃

      • 사용자의 고유한 애플리케이션 자바 클래스를 src/main/java/...에 추가합니다.
      • src/main/webapp/WEB-INF/appengine-web.xml 파일을 사용하여 애플리케이션을 구성합니다.
      • src/main/webapp/WEB-INF/web.xml 파일을 사용하여 애플리케이션 배포를 구성합니다.
    2. 애플리케이션 자바 클래스를 만들고 이를 src/main/java/...에 추가합니다. 자세한 내용은 시작하기를 참조하세요.

    3. 앱 사용자에게 제공하려는 UI를 추가합니다. 자세한 내용은 애플리케이션 코드 및 UI 추가를 참조하세요.

    4. 프로젝트를 만드는 데 사용한 아티팩트에는 기본적인 src/main/webapp/WEB-INF/appengine-web.xml 구성이 자동으로 완료되어 있습니다. 그러나 고급 구성을 사용하려면 이 파일을 수정해야 할 수 있습니다. 자세한 내용은 appengine-web.xml 구성을 참조하세요.

    5. src/main/webapp/WEB-INF/web.xml 파일을 수정하여 앱 핸들러에 URL을 매핑하고 인증, 필터 등을 지정합니다. 자세한 내용은 배포 설명자를 참조하세요.

Maven 프로젝트 관리, 테스트, 배포

프로젝트 컴파일 및 빌드

Maven App Engine archetype으로 생성된 애플리케이션을 빌드하려면 다음 안내를 따르세요.

  1. 프로젝트의 기본 디렉터리로 변경합니다.

  2. Maven을 호출합니다.

    mvn clean package
    
  3. 프로젝트가 빌드되기를 기다립니다. 프로젝트가 성공적으로 완료되면 다음과 비슷한 메시지가 표시됩니다.

    BUILD SUCCESS
     Total time: 10.724s
     Finished at: 2016-08-04T16:18:24-07:00
     Final Memory: 24M/213M
    
  4. 선택적으로 다음 절차에 따라 애플리케이션을 테스트합니다.

개발 서버에서 애플리케이션 테스트

개발 단계 중에는 개발 서버에서 App Engine Maven 플러그인을 호출하여 언제든지 애플리케이션을 실행하고 테스트할 수 있습니다.

App Engine 앱을 테스트하려면 다음 안내를 따르세요.

  1. 앱을 아직 빌드하지 않았으면 빌드합니다.

    mvn clean package
    
  2. 디렉터리를 프로젝트의 최상위 수준으로 변경하고(예: myapp) Maven을 호출하여 앱을 실행합니다.

    mvn appengine:run
    

    서버가 시작되기를 기다립니다. 서버가 완전히 시작되고 애플리케이션이 실행되면 다음과 비슷한 메시지가 표시됩니다.

    [INFO] GCLOUD: INFO: Module instance default is running at http://localhost:44180/
    [INFO] GCLOUD: Jul 29, 2016 9:23:55 PM com.google.appengine.tools.development.AbstractModule startup
    [INFO] GCLOUD: INFO: The admin console is running at http://localhost:44180/_ah/admin
    [INFO] GCLOUD: Jul 29, 2016 9:23:55 PM com.google.appengine.tools.development.devappserver2.DevAppServer2Impl doStart
    [INFO] GCLOUD: INFO: Dev App Server is now running
    
  3. 브라우저에서 http://localhost:8080/으로 이동하여 앱에 액세스합니다.

  4. Ctrl+C를 눌러서 애플리케이션 및 개발 서버를 종료합니다.

로컬 테스트를 위한 포트 지정

로컬 개발 서버에서 애플리케이션을 실행할 때 기본 포트는 8080입니다. appengine-maven-plugin의 플러그인 항목을 수정하여 이 기본값을 변경할 수 있습니다. 예를 들어 애플리케이션 디렉터리의 pom.xml 파일에서 포트와 주소를 지정할 수 있습니다.

<plugins>
   <plugin>
     <groupId>com.google.cloud.tools</groupId>
     <artifactId>appengine-maven-plugin</artifactId>
     <version>2.2.0</version>
     <configuration>
       <devserver.host>0.0.0.0</devserver.host>
       <devserver.port>8181</devserver.port>
     </configuration>
  </plugin>
</plugins>

이 예시에서 <devserver.port>는 포트를 기본값 대신 8181로 설정하며 주소 0.0.0.0이 지정됩니다. 즉, 개발 서버가 로컬 네트워크에서 들어오는 요청을 리슨합니다.

devserver 프리픽스는 선택사항입니다. 대신 <port>8181</port>을 사용할 수 있습니다.

개발 서버에서 디버깅

로컬로 실행 중인 애플리케이션을 디버깅하려면 플러그인 구성에서 jvmFlags를 설정하여 기본 JVM에서 디버깅을 사용 설정합니다. 예를 들면 다음과 같습니다.

<configuration>
  <jvmFlags>
    <jvmFlag>-Xdebug</jvmFlag>
    <jvmFlag>-Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005</jvmFlag>
  </jvmFlags>
</configuration>

애플리케이션 배포

애플리케이션을 배포하려면 다음을 수행하세요.

mvn package appengine:deploy -Dapp.deploy.projectId=PROJECT_ID

PROJECT_ID를 Cloud 프로젝트의 ID로 바꿉니다. pom.xml 파일에 이미 프로젝트 ID가 지정된 경우 실행할 명령어에 -Dapp.deploy.projectId 속성을 포함하지 않아도 됩니다.

App Engine Maven 플러그인의 appengine:deploy 목표와 다른 모든 목표에는 사용자가 사용할 수 있는 관련 매개변수가 있습니다. 전체 목표 및 매개변수 목록은 App Engine Maven 플러그인 목표 및 매개변수를 참조하세요.

다음 단계