開始使用:設定開發環境

瞭解如何設定建構環境,以用於應用程式開發及部署至 Google App Engine 標準。系統支援的 Java 開發和建構環境為 IntelliJ IDEA、Eclipse、Apache Maven 和 Gradle。

這份指南將說明如何執行下列操作:

  • 安裝 Google Cloud SDK 指令列工具。
  • 為 Eclipse、IntelliJ、Gradle 和 Maven 安裝及設定 App Engine 外掛程式。
  • 建立新的 App Engine 專案。

安裝需要的 SDK

  1. 如果您尚未安裝 Java SE 8 SDK,請安裝 Java SE 8 Development Kit (JDK)

  2. 安裝最新版本的 Google Cloud SDK。

    安裝 Google Cloud SDK

  3. 安裝 App Engine Java 元件:

    gcloud components install app-engine-java
    
  4. 授權使用者帳戶:

    gcloud auth application-default login
    
  5. 如果選擇建立服務帳戶,請執行 gcloud auth activate-service-account --key-file=your_key.json。詳情請參閱授權 Cloud SDK 工具一文。

設定開發環境

Eclipse

事前準備

  1. Install Eclipse IDE for Java EE Developers, version 4.7 or later:

    Download Eclipse

  2. If you have the Google Plugin for Eclipse installed, complete the migrating from GPE procedures.

安裝外掛程式:

  1. Drag the install button into your running Eclipse workspace:

    Drag to your running Eclipse workspace.

    Or from inside Eclipse, select Help > Eclipse Marketplace... and search for Google Cloud Tools for Eclipse.

  2. Restart Eclipse when prompted.

IntelliJ

事前準備

  1. 確認您的本機系統已安裝下列軟體:

安裝外掛程式:

  1. 從 IDEA 內開啟 [File] > [Setting]。或是在 Mac OS X 中開啟 [IntelliJ IDEA] > [Preferences]。
  2. 從導覽窗格中選取 [Plugins],然後搜尋「Cloud Code」。
  3. 按一下 [Install]
  4. 選擇 [Restart] 來重新啟動 IDE。
  5. 設定專案 JDK:
    1. 開啟 [File] > [Project Structure]。或是在 Mac OS X 中開啟 [IntelliJ IDEA] > [Project Structure]。
    2. 選擇 [Project Settings] > [Project]。
    3. 如果缺少專案 JDK,請按一下 [New...],然後選擇 JDK。

Gradle

  1. 安裝 Gradle v3.4.1 或以上版本

  2. 安裝 Git

Maven

  1. 從 Maven 網站下載 Maven 3.5。

  2. 在您的本機電腦上安裝 Maven 3.5。

建立新的 App Engine 專案

Eclipse

  1. Click the Google Cloud Platform toolbar button .

  2. Select Create New Project > Google App Engine Standard Java Project.

  3. Enter a Project name and (optionally) a Java package.

  4. To create a Maven-based App Engine project, check Create as Maven Project and enter a Maven Group ID and Artifact ID.

  5. Click Next.

  6. Select any libraries you need in the project.

  7. Click Finish.

The wizard generates a native Eclipse project, with a simple servlet, that you can run and deploy from the IDE.

IntelliJ

  1. 依序選擇 [File] > [New] > [Project] 以顯示「New Project」對話方塊。

  2. 在左側面板中選擇 [Java]。

  3. 在「Additional Libraries and Frameworks」區段中,為您的環境勾選「Google App Engine」方塊。

  4. 選取您要加入至應用程式類別路徑的其他資料庫。預設選取 Servlet API。

  5. 按一下 [Next]

  6. 輸入專案名稱

  7. 如果不想保留預設的專案位置,請輸入專案位置

  8. 如果不想保留預設值,請更新 [More Settings] 區段中的各欄位。

  9. 按一下 [Finish]。

Gradle

  1. 建立新目錄。

  2. 初始化所建立目錄中的新專案:

    gradle init --type java-library;
    mkdir -p src/main/webapp/WEB-INF;
    rm src/main/java/Library.java src/test/java/LibraryTest.java
    

    Gradle 將建立基本架構目錄結構,其中包含在最終 rm 指令中移除的兩個空白類別。

  3. 將以下內容加到您的 build.gradle 檔案中,以新增 App Engine Gradle 工作、Maven 存放區、App Engine Gradle 外掛程式、依附元件與工作設定:

    buildscript {      // Configuration for building
      repositories {
        jcenter()      // Bintray's repository - a fast Maven Central mirror & more
        mavenCentral()
      }
      dependencies {
        classpath 'com.google.cloud.tools:appengine-gradle-plugin:1.+' // Latest 1.x.x release
        classpath 'org.akhikhl.gretty:gretty:+'
      }
    }
    
    repositories {   // repositories for JARs you access in your code
      maven {
        url 'https://maven-central.storage.googleapis.com'             // Google's mirror of Maven Central
      }
    
    //maven {
    //  url 'https://oss.sonatype.org/content/repositories/snapshots' // SNAPSHOT repository if needed
    //}
    
      jcenter()
      mavenCentral()
    }
    
    apply plugin: 'java'
    apply plugin: 'war'
    apply plugin: 'org.akhikhl.gretty'
    apply plugin: 'com.google.cloud.tools.appengine'
    
    dependencies {
      providedCompile 'javax.servlet:javax.servlet-api:3.1.0'
      providedCompile 'com.google.appengine:appengine:+'
    // Add your dependencies here.
    
    }
    
    gretty {
        httpPort = 8080
        contextPath = '/'
        servletContainer = 'jetty9'  // What App Engine Flexible uses
    }
    
    appengine {
    
      deploy {   // deploy configuration
        stopPreviousVersion = true  // default - stop the current version
        promote = true              // default - & make this the current version
      }
    
    }
    
    group = 'com.example.appengine'   // Generated output GroupId
    version = '1.0-SNAPSHOT'          // Version in generated output
    
    sourceCompatibility = 1.8
    targetCompatibility = 1.8

Maven

如要建立 App Engine 應用程式:

  1. 建立新目錄。

  2. 初始化所建立目錄中的新專案:

     mvn archetype:generate -Dappengine-version=1.9.59 -Djava8=true -DCloudSDK_Tooling=true -Dapplication-id=your-app-id -Dfilter=com.google.appengine.archetypes:
    
    1. -Dappengine-version 設定為 Java 適用的 App Engine SDK 的最新版本,並將 application-id 設定為 GCP 專案的 ID。

    2. 設定 -Djava8=true 以在 Java 8 執行階段中部署專案。

    3. 設定 -DCloudSDK_Tooling=true 以使用 Cloud SDK 工具。

  3. 系統提示您選擇原型時,請針對 App Engine 架構原型選擇值 2。這樣會建立包含所需目錄結構與檔案的空白專案。

  4. 系統提示輸入版本時,請按 ENTER 來選取預設的最新版本。

  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' 時,請提供您的偏好套件名稱 (或接受預設值)。產生的 Java 檔案會使用您在這裡指定的套件名稱。

  9. 系統提示您確認選擇時,請接受預設值 (Y)。

  10. 等待專案產生完畢。然後將目錄變更為新的專案目錄,例如 myapp/

  11. 將 Cloud SDK 式外掛程式新增至專案的 pom.xml 檔案。

    <build>
        <plugins>
           [...]
              <plugin>
                <groupId>com.google.cloud.tools</groupId>
                <artifactId>appengine-maven-plugin</artifactId>
                <version>1.3.1</version>
                <configuration>
                    <project>your-project-ID-goes-here</project>
                    <version>1</version>
                </configuration>
              </plugin>
           [...]
        </plugins>
    </build>
    
  12. 在外掛程式設定中指定目標 Google Cloud Platform 專案 ID 與服務和版本

後續步驟

現在,您已設定好開發環境,可以開始開發 Java 應用程式並將其部署至 App Engine 了。