Di chuyển từ ứng dụng Java của Google App Engine sang Cloud Run bằng Jib

1. Tổng quan

Loạt lớp học lập trình này (hướng dẫn thực hành, tự học) nhằm giúp các nhà phát triển Java trên Google App Engine (Chuẩn) hiện đại hoá ứng dụng của họ bằng cách hướng dẫn họ thực hiện một loạt các hoạt động di chuyển. Bằng cách làm theo các bước này, bạn có thể cập nhật ứng dụng để dễ dàng di chuyển hơn và quyết định đóng gói ứng dụng cho Cloud Run, dịch vụ lưu trữ vùng chứa song hành với App Engine của Google Cloud và các dịch vụ lưu trữ vùng chứa khác.

Hướng dẫn này sẽ hướng dẫn bạn cách đóng gói một ứng dụng App Engine để triển khai cho dịch vụ được quản lý toàn bộ của Cloud Run bằng cách sử dụng Jib. Với Jib, bạn có thể tạo hình ảnh Docker, một nền tảng nổi tiếng trong ngành để phát triển, vận chuyển và chạy các ứng dụng trong vùng chứa.

Ngoài hướng dẫn cho bạn các bước cần thiết để chuyển từ App Engine sang Cloud Run, bạn cũng sẽ tìm hiểu cách nâng cấp một ứng dụng Java 8 App Engine lên Java 17.

Nếu ứng dụng của bạn sử dụng nhiều dịch vụ theo gói cũ của App Engine hoặc các tính năng khác của App Engine, bạn nên di chuyển khỏi các dịch vụ theo gói đó hoặc thay thế các tính năng đó trước khi chuyển sang Cloud Run. Nếu cần thêm thời gian để tìm hiểu các lựa chọn di chuyển hoặc muốn tiếp tục sử dụng các dịch vụ theo gói cũ trong thời gian này, bạn có thể tiếp tục truy cập vào các dịch vụ theo gói của App Engine cho Java 11/17 khi nâng cấp lên một môi trường thời gian chạy mới hơn. Khi ứng dụng của bạn trở nên dễ di chuyển hơn, hãy quay lại lớp học lập trình này để tìm hiểu cách áp dụng hướng dẫn cho ứng dụng của bạn.

Bạn sẽ tìm hiểu cách

  • Sử dụng Cloud Shell
  • Bật API Cloud Run, Artifact Registry và Cloud Build
  • Đóng gói ứng dụng bằng Jib và Cloud Build
  • Triển khai hình ảnh vùng chứa cho Cloud Run

Bạn cần có

Khảo sát

Bạn sẽ sử dụng hướng dẫn này như thế nào?

Chỉ đọc qua Đọc và hoàn thành bài tập

Bạn đánh giá thế nào về trải nghiệm của mình với Java?

Tân binh Trung cấp Thành thạo

Bạn đánh giá trải nghiệm sử dụng các dịch vụ của Google Cloud như thế nào?

Tân binh Trung cấp Thành thạo

2. Thông tin khái quát

Các hệ thống Nền tảng dưới dạng dịch vụ (PaaS) như App Engine và Cloud Functions mang đến nhiều tiện ích cho nhóm và ứng dụng của bạn, chẳng hạn như cho phép SysAdmins và Devops tập trung vào việc xây dựng các giải pháp. Với các nền tảng không nghiêm ngặt, ứng dụng của bạn có thể tự động mở rộng quy mô khi cần, giảm quy mô về 0 nhờ tính năng thanh toán trả tiền cho mỗi lần sử dụng để giúp kiểm soát chi phí và sử dụng nhiều ngôn ngữ phát triển phổ biến.

Tuy nhiên, tính linh hoạt của vùng chứa cũng rất hấp dẫn. Với khả năng chọn bất kỳ ngôn ngữ, thư viện và tệp nhị phân nào, vùng chứa mang đến cho bạn những lợi ích tốt nhất của cả hai thế giới: sự tiện lợi của mô hình không máy chủ cùng với tính linh hoạt của vùng chứa. Đây chính là mục tiêu của Cloud Run.

Việc tìm hiểu cách sử dụng Cloud Run không nằm trong phạm vi của lớp học lập trình này; nội dung này được đề cập trong tài liệu về Cloud Run. Mục tiêu ở đây là để bạn làm quen với cách chứa ứng dụng App Engine cho Cloud Run (hoặc các dịch vụ lưu trữ trên vùng chứa khác) trong vùng chứa. Có một vài điều bạn nên biết trước khi tiếp tục, chủ yếu là trải nghiệm người dùng của bạn sẽ hơi khác một chút.

Trong lớp học lập trình này, bạn sẽ tìm hiểu cách tạo và triển khai vùng chứa. Bạn sẽ tìm hiểu cách:

  • Đóng gói ứng dụng bằng Jib
  • Di chuyển khỏi cấu hình App Engine
  • và xác định các bước tạo bản dựng cho Cloud Build (không bắt buộc).

Việc này sẽ liên quan đến việc ngừng sử dụng một số tính năng dành riêng cho App Engine. Nếu không muốn làm theo lộ trình này, bạn vẫn có thể nâng cấp lên môi trường thời gian chạy Java 11/17 trong khi giữ lại ứng dụng trên App Engine.

3. Thiết lập/Công việc chuẩn bị

1. Thiết lập dự án

Trong hướng dẫn này, bạn sẽ dùng một ứng dụng mẫu trong kho lưu trữ appengine-java-migration-samples trên một dự án hoàn toàn mới. Đảm bảo dự án có tài khoản thanh toán đang hoạt động.

Nếu dự định di chuyển một ứng dụng App Engine hiện có sang Cloud Run, bạn có thể sử dụng ứng dụng đó để làm theo.

Chạy lệnh sau để bật các API cần thiết cho dự án của bạn:

gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com run.googleapis.com

2. Tải ứng dụng mẫu cơ sở

Sao chép ứng dụng mẫu trên máy của bạn hoặc trên Cloud Shell, sau đó chuyển đến thư mục baseline.

Mẫu này là một ứng dụng Kho dữ liệu dựa trên Servlet Java 8 nhằm triển khai trên App Engine. Làm theo hướng dẫn trong tệp README về cách chuẩn bị ứng dụng này để triển khai trên App Engine.

3. (Không bắt buộc) Triển khai ứng dụng cơ sở

Bạn chỉ cần làm những việc sau đây nếu muốn xác nhận rằng ứng dụng hoạt động trên App Engine trước khi chúng ta di chuyển sang Cloud Run.

Tham khảo các bước trong README.md:

  1. Cài đặt/Làm quen lại với CLI gcloud
  2. Khởi động CLI gcloud cho dự án của bạn bằng gcloud init
  3. Tạo dự án App Engine bằng gcloud app create
  4. Triển khai ứng dụng mẫu lên App Engine
./mvnw package appengine:deploy -Dapp.projectId=$PROJECT_ID
  1. Xác nhận ứng dụng chạy trên App Engine mà không gặp vấn đề

4. Tạo kho lưu trữ Artifact Registry

Sau khi vùng chứa ứng dụng, bạn sẽ cần đến nơi nào đó để đẩy và lưu trữ hình ảnh của mình. Bạn nên dùng Artifact Registry để thực hiện việc này trên Google Cloud.

Tạo kho lưu trữ có tên migration bằng gcloud như sau:

gcloud artifacts repositories create migration --repository-format=docker \
--description="Docker repository for the migrated app" \
--location="northamerica-northeast1"

Xin lưu ý rằng kho lưu trữ này sử dụng loại định dạng docker, nhưng có một số loại kho lưu trữ.

Tại thời điểm này, bạn đã có ứng dụng App Engine cơ sở và dự án Google Cloud đã sẵn sàng để di chuyển ứng dụng đó sang Cloud Run.

4. Sửa đổi tệp ứng dụng

Trong trường hợp ứng dụng của bạn sử dụng nhiều dịch vụ, cấu hình theo gói cũ hoặc các tính năng chỉ dành cho App Engine khác của App Engine, bạn nên tiếp tục truy cập vào các dịch vụ đó trong khi nâng cấp lên môi trường thời gian chạy mới. Lớp học lập trình này minh hoạ lộ trình di chuyển cho các ứng dụng đã sử dụng dịch vụ độc lập hoặc có thể được tái cấu trúc để thực hiện việc này.

1. Nâng cấp lên Java 17

Nếu ứng dụng của bạn đang chạy trên Java 8, hãy cân nhắc nâng cấp lên một ứng cử viên LTS mới hơn như 11 hoặc 17 để nắm bắt các bản cập nhật bảo mật và sử dụng các tính năng ngôn ngữ mới.

Bắt đầu bằng cách cập nhật các thuộc tính trong pom.xml để bao gồm những thuộc tính sau:

<properties>
    <java.version>17</java.version>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
</properties>

Thao tác này sẽ đặt phiên bản dự án thành 17, thông báo cho trình bổ trợ trình biên dịch rằng bạn muốn truy cập vào các tính năng ngôn ngữ Java 17 và muốn các lớp đã biên dịch tương thích với JVM Java 17.

2. Bao gồm cả máy chủ web

Có một số điểm khác biệt giữa App Engine và Cloud Run mà bạn nên cân nhắc khi chuyển đổi giữa các nền tảng này. Một điểm khác biệt là mặc dù môi trường thời gian chạy Java 8 của App Engine cung cấp và quản lý máy chủ Jetty cho các ứng dụng mà nó lưu trữ, nhưng Cloud Run thì không. Chúng ta sẽ sử dụng tính năng Spring Boot để cung cấp máy chủ web và vùng chứa servlet.

Thêm các phần phụ thuộc sau:

<dependencies>
<!-- ... -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
       <version>2.6.6</version>
       <exclusions>
           <!-- Exclude the Tomcat dependency -->
           <exclusion>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-tomcat</artifactId>
           </exclusion>
       </exclusions>
   </dependency>
   <!-- Use Jetty instead -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-jetty</artifactId>
       <version>2.6.6</version>
   </dependency>
<!-- ... -->
</dependencies>

Theo mặc định, Spring Boot nhúng một máy chủ Tomcat, nhưng mẫu này sẽ loại trừ cấu phần phần mềm đó và gắn bó với Jetty để giảm thiểu sự khác biệt về hành vi mặc định sau khi di chuyển. Chúng ta cũng có thể định cấu hình phiên bản Jetty để khớp với phiên bản mà App Engine cung cấp ngay từ đầu.

<properties>
    <java.version>17</java.version>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
    <jetty.version>9.4.46.v20220331</jetty.version>
</properties>

3. Thiết lập Spring Boot

Mặc dù Spring Boot có thể sử dụng lại các servlet mà không cần sửa đổi, nhưng bạn sẽ cần phải định cấu hình để có thể tìm thấy các servlet đó.

Tạo lớp MigratedServletApplication.java sau trong gói com.example.appengine:

package com.example.appengine;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@ServletComponentScan
@SpringBootApplication
@EnableAutoConfiguration
public class MigratedServletApplication {
    public static void main(String[] args) {
        SpringApplication.run(MigratedServletApplication.class, args);
    }
}

Xin lưu ý rằng điều này bao gồm chú thích @ServletComponentScan. Chú thích này sẽ tìm (trong gói hiện tại theo mặc định) mọi @WebServlets và cung cấp các @WebServlets đó như dự kiến.

4. Đóng gói ứng dụng dưới dạng tệp JAR

Mặc dù bạn có thể đóng gói ứng dụng bằng Jib bắt đầu từ một tệp war, nhưng việc này sẽ dễ dàng hơn nếu bạn đóng gói ứng dụng dưới dạng tệp JAR có thể thực thi. Việc này sẽ không yêu cầu nhiều cấu hình, đặc biệt là đối với các dự án sử dụng Maven làm công cụ xây dựng — vì đóng gói jar là hành vi mặc định.

Xoá thẻ packaging trong tệp pom.xml:

<packaging>war</packaging>

Tiếp theo, hãy thêm spring-boot-maven-plugin:

<plugins>
<!-- ... -->
  <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <version>2.6.6</version>
  </plugin>
<!-- ... -->
</plugins>

5. Di chuyển khỏi cấu hình, dịch vụ và phần phụ thuộc của App Engine

Như đã đề cập ở đầu lớp học lập trình, Cloud Run và App Engine được thiết kế để mang lại trải nghiệm người dùng khác nhau. Một số tính năng nhất định mà App Engine cung cấp sẵn (chẳng hạn như dịch vụ Cron và Task Queue (Bộ xếp hàng tác vụ)) cần được tạo lại theo cách thủ công và sẽ được đề cập chi tiết hơn trong các mô-đun sau.

Ứng dụng mẫu không sử dụng các dịch vụ theo gói cũ, nhưng người dùng có ứng dụng sử dụng các dịch vụ này có thể tham khảo các hướng dẫn sau:

Vì từ giờ trở đi, bạn sẽ triển khai lên Cloud Run, nên bạn có thể xoá appengine-maven-plugin:

<plugin>
 <groupId>com.google.cloud.tools</groupId>
 <artifactId>appengine-maven-plugin</artifactId>
 <version>2.4.1</version>
 <configuration>
   <!-- can be set w/ -DprojectId=myProjectId on command line -->
   <projectId>${app.projectId}</projectId>
   <!-- set the GAE version or use "GCLOUD_CONFIG" for an autogenerated GAE version -->
   <version>GCLOUD_CONFIG</version>
 </configuration>
</plugin>

5. Đóng gói ứng dụng

Tại thời điểm này, bạn có thể triển khai ứng dụng của mình cho Cloud Run theo cách thủ công từ mã nguồn. Đây là một lựa chọn rất phù hợp vì sử dụng Cloud Build trong nền để mang đến trải nghiệm triển khai tự động. Chúng tôi sẽ trình bày chi tiết hơn về quy trình triển khai nguồn trong các mô-đun sau.

Ngoài ra, nếu cần có nhiều quyền kiểm soát hơn đối với cách triển khai ứng dụng, bạn có thể đạt được điều đó bằng cách xác định một tệp cloudbuild.yaml trình bày rõ các bước xây dựng dự kiến của mình:

1. Xác định tệp cloudbuild.yaml

Tạo tệp cloudbuild.yaml sau đây ở cùng cấp với pom.xml:

steps:
  # Test your build
  - name: maven:eclipse-temurin
    entrypoint: mvn
    args: ["test"]
  # Build with Jib
  - name: maven:eclipse-temurin
    entrypoint: mvn
    args: [ "compile", "com.google.cloud.tools:jib-maven-plugin:3.2.1:build", "-Dimage=northamerica-northeast1-docker.pkg.dev/PROJECT_ID/migration/visitors:jib"]
  # Deploy to Cloud Run
  - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
    entrypoint: gcloud
    args: [ 'run', 'deploy', 'visitors', '--image', 'northamerica-northeast1-docker.pkg.dev/PROJECT_ID/migration/visitors:jib', '--region', 'northamerica-northeast1', '--allow-unauthenticated']

Sau khi chúng ta yêu cầu Cloud Build làm theo các bước này, công cụ này sẽ:

  1. Chạy chương trình kiểm thử bằng ./mvnw test
  2. Tạo, đẩy và gắn thẻ hình ảnh vào sổ đăng ký Cấu phần phần mềm bằng Jib
  3. Triển khai hình ảnh của bạn trong Cloud Run bằng gcloud run deploy

Xin lưu ý rằng ‘visitors' được cung cấp cho Cloud Run dưới dạng tên dịch vụ mong muốn. Cờ –allow-unauthenticated cho phép người dùng truy cập vào ứng dụng web mà không cần xác thực. Hãy nhớ thay thế PROJECT_ID bằng mã nhận dạng của dự án trong tệp cloudbuild.yaml.

Tiếp theo, hãy thêm các liên kết chính sách IAM sau đây để cho phép Tài khoản dịch vụ Cloud Build truy cập vào Artifact Registry:

export PROJECT_ID=$(gcloud config list --format 'value(core.project)')
export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)" )

gcloud projects add-iam-policy-binding $PROJECT_ID \
--member=serviceAccount:$PROJECT_NUMBER@cloudbuild.gserviceaccount.com \
--role=roles/run.admin \
--project=$PROJECT_ID
gcloud iam service-accounts add-iam-policy-binding $PROJECT_NUMBER-compute@developer.gserviceaccount.com \
--member=serviceAccount:$PROJECT_NUMBER@cloudbuild.gserviceaccount.com \
--role roles/iam.serviceAccountUser --project=$PROJECT_ID

2. Chạy quy trình xây dựng

Giờ đây, khi đã thông báo cho Cloud Build về các bước xây dựng mong muốn, bạn đã sẵn sàng triển khai bằng một lần nhấp.

Chạy lệnh sau:

gcloud builds submit

Sau khi quá trình này hoàn tất, hình ảnh vùng chứa của bạn đã được tạo, lưu trữ trong Cấu phần phần mềm và triển khai trên Cloud Run.

Khi kết thúc lớp học lập trình này, ứng dụng của bạn sẽ có giao diện giống như ứng dụng trong java17-and-cloud-run/finish.

Vậy là xong! Bạn đã di chuyển thành công một ứng dụng App Engine Java 8 sang Java 17 và Cloud Run. Giờ đây, bạn đã hiểu rõ hơn về công việc liên quan khi chuyển đổi và chọn giữa các lựa chọn lưu trữ.

6. Tóm tắt/Dọn dẹp

Xin chúc mừng! Bạn đã nâng cấp, đóng gói, di chuyển và ứng dụng của mình. Đây là phần kết thúc của hướng dẫn này!

Từ đây, bước tiếp theo là tìm hiểu thêm về CI/CD và các tính năng bảo mật chuỗi cung ứng phần mềm mà giờ đây bạn có thể triển khai bằng Cloud Build:

Không bắt buộc: Dọn dẹp và/hoặc tắt dịch vụ

Nếu bạn đã triển khai ứng dụng mẫu trên App Engine trong hướng dẫn này, hãy nhớ tắt ứng dụng để tránh bị tính phí. Khi đã sẵn sàng chuyển sang lớp học lập trình tiếp theo, bạn có thể bật lại tính năng này. Khi bị vô hiệu hoá, các ứng dụng App Engine sẽ không nhận được lưu lượng truy cập nào để tính phí. Tuy nhiên, mức sử dụng Datastore có thể phải trả phí nếu vượt quá hạn mức miễn phí. Vì vậy, hãy xoá đủ để nằm trong giới hạn đó.

Mặt khác, nếu không tiếp tục di chuyển và muốn xoá mọi thứ hoàn toàn, bạn có thể xoá dịch vụ hoặc tắt hoàn toàn dự án.

7. Tài nguyên khác

Vấn đề/phản hồi về lớp học lập trình về mô-đun di chuyển App Engine

Nếu bạn gặp vấn đề với lớp học lập trình này, trước tiên, vui lòng tìm vấn đề của bạn trước khi gửi. Đường liên kết để tìm kiếm và báo cáo vấn đề mới:

Tài nguyên di chuyển

Tài nguyên trực tuyến

Dưới đây là các tài nguyên trực tuyến có thể liên quan đến hướng dẫn này:

App Engine

Thông tin khác về Cloud

Video

Giấy phép

Tác phẩm này được cấp phép theo Giấy phép chung Ghi công 2.0 của Creative Commons.