자바를 사용하여 HTTP Cloud 함수 만들기 및 배포

자바를 사용하여 HTTP Cloud 함수 만들기 및 배포

이 가이드에서는 자바 런타임을 사용하여 Cloud 함수를 작성하는 과정을 안내합니다. Cloud Functions에는 다음과 같은 두 가지 유형이 있습니다.

• 표준 HTTP 요청에서 호출하는 HTTP 함수
• Pub/Sub 주제의 메시지나 Cloud Storage 버킷의 변경사항과 같이 Cloud 인프라의 이벤트에서 트리거하는 이벤트 기반 함수

이 문서에서는 간단한 HTTP 함수를 만들고 Maven 또는 Gradle을 사용하여 이를 빌드하는 방법을 보여줍니다.

자세한 내용은 HTTP 함수 작성 및 이벤트 기반 함수 작성을 참조하세요.

시작하기 전에

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Cloud Logging APIs.

   Enable the APIs

8. Google Cloud SDK를 설치하고 초기화합니다.
   참고: 명령 프롬프트가 필요하세요? Cloud Shell을 사용할 수 있습니다. Cloud Shell 명령줄 환경에는 Google Cloud CLI가 이미 포함되어 있으므로 별도로 설치할 필요가 없습니다. Google Cloud CLI는 Google Compute Engine 가상 머신에도 사전 설치되어 있습니다.
9. 다음 명령어를 사용하여 gcloud 구성요소를 업데이트하고 설치합니다.

   gcloud components update

10. 개발 환경을 준비합니다.

    자바 설정 가이드로 이동

함수 만들기

이 섹션에서는 함수를 만드는 방법을 설명합니다.

Maven

1. 로컬 시스템에 함수 코드를 저장할 디렉터리를 만듭니다.

   Linux 또는 Mac OS X:

    mkdir ~/helloworld
    cd ~/helloworld
   

   Windows:

    mkdir %HOMEPATH%\helloworld
    cd %HOMEPATH%\helloworld
   

2. 소스 디렉터리와 소스 파일을 포함하도록 프로젝트 구조를 만듭니다.

   mkdir -p ~/helloworld/src/main/java/functions
   touch ~/helloworld/src/main/java/functions/HelloWorld.java
   

3. HelloWorld.java 파일에 다음 내용을 추가합니다.

   
   package functions;
   
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import java.io.BufferedWriter;
   import java.io.IOException;
   
   public class HelloWorld implements HttpFunction {
     // Simple function to return "Hello World"
     @Override
     public void service(HttpRequest request, HttpResponse response)
         throws IOException {
       BufferedWriter writer = response.getWriter();
       writer.write("Hello World!");
     }
   }

   이 예시 함수는 'Hello World!'라는 인사를 출력합니다.

Gradle

1. 로컬 시스템에 함수 코드를 저장할 디렉터리를 만듭니다.

   Linux 또는 Mac OS X:

    mkdir ~/helloworld-gradle
    cd ~/helloworld-gradle
   

   Windows:

    mkdir %HOMEPATH%\helloworld-gradle
    cd %HOMEPATH%\helloworld-gradle
   

2. 소스 디렉터리와 소스 파일을 포함하도록 프로젝트 구조를 만듭니다.

    mkdir -p src/main/java/functions
    touch src/main/java/functions/HelloWorld.java
   

3. HelloWorld.java 파일에 다음 내용을 추가합니다.

   
   package functions;
   
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import java.io.BufferedWriter;
   import java.io.IOException;
   
   public class HelloWorld implements HttpFunction {
     // Simple function to return "Hello World"
     @Override
     public void service(HttpRequest request, HttpResponse response)
         throws IOException {
       BufferedWriter writer = response.getWriter();
       writer.write("Hello World!");
     }
   }

   이 예시 함수는 'Hello World!'라는 인사를 출력합니다.

종속 항목 지정

다음 단계에서는 종속 항목을 설정합니다.

Maven

위에서 만든 helloworld 디렉터리로 이동하고 pom.xml 파일을 만듭니다.

 cd ~/helloworld
 touch pom.xml

Maven을 사용하여 종속 항목을 관리하려면 프로젝트의 pom.xml 파일 내에서 <dependencies> 섹션에 종속 항목을 지정합니다. 이 연습에서는 다음 콘텐츠를 pom.xml 파일에 복사합니다.

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example.functions</groupId>
  <artifactId>functions-hello-world</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencies>
    <!-- Required for Function primitives -->
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <!--
          Google Cloud Functions Framework Maven plugin

          This plugin allows you to run Cloud Functions Java code
          locally. Use the following terminal command to run a
          given function locally:

          mvn function:run -Drun.functionTarget=your.package.yourFunction
        -->
        <groupId>com.google.cloud.functions</groupId>
        <artifactId>function-maven-plugin</artifactId>
        <version>0.11.0</version>
        <configuration>
          <functionTarget>functions.HelloWorld</functionTarget>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Maven 기반의 전체 샘플은 helloworld를 참조하세요.

Gradle

위에서 만든 helloworld-gradle 디렉터리로 이동하고 build.gradle 파일을 만듭니다.

 cd ~/helloworld-gradle
 touch build.gradle

Gradle을 사용하여 종속 항목을 관리하려면 프로젝트의 build.gradle 파일에 종속 항목을 지정합니다. 이 연습에서는 다음 콘텐츠를 build.gradle 파일에 복사합니다. 이 build.gradle 파일에는 함수를 로컬로 실행하는 데 도움이 되는 커스텀 작업이 포함되어 있습니다.

apply plugin: 'java'

repositories {
  jcenter()
  mavenCentral()
}
configurations {
    invoker
}

dependencies {
  // Every function needs this dependency to get the Functions Framework API.
  compileOnly 'com.google.cloud.functions:functions-framework-api:1.1.0'

  // To run function locally using Functions Framework's local invoker
  invoker 'com.google.cloud.functions.invoker:java-function-invoker:1.3.1'

  // These dependencies are only used by the tests.
  testImplementation 'com.google.cloud.functions:functions-framework-api:1.1.0'
  testImplementation 'junit:junit:4.13.2'
  testImplementation 'com.google.truth:truth:1.4.0'
  testImplementation 'org.mockito:mockito-core:5.10.0'

}

// Register a "runFunction" task to run the function locally
tasks.register("runFunction", JavaExec) {
  main = 'com.google.cloud.functions.invoker.runner.Invoker'
  classpath(configurations.invoker)
  inputs.files(configurations.runtimeClasspath, sourceSets.main.output)
  args(
    '--target', project.findProperty('run.functionTarget') ?: '',
    '--port', project.findProperty('run.port') ?: 8080
  )
  doFirst {
    args('--classpath', files(configurations.runtimeClasspath, sourceSets.main.output).asPath)
  }
}

Gradle 기반의 전체 샘플은 helloworld를 참조하세요.

자세히 알아보기: 자세한 내용은 종속 항목 지정을 참조하세요.

로컬에서 함수 빌드 및 테스트

함수를 배포하기 전에 이를 빌드하고 로컬로 테스트할 수 있습니다.

Maven

1. 다음 명령어를 실행하여 함수 빌드를 확인합니다.

   mvn compile
   

   또 다른 옵션은 mvn package 명령어를 사용하여 자바 코드를 컴파일하고, 테스트를 실행하고, 코드를 대상 디렉터리 내의 JAR 파일로 패키징하는 것입니다. Maven 빌드 수명 주기에 대한 자세한 내용은 여기를 참조하세요.

2. 다음 명령어를 사용하여 함수를 시작합니다.

   mvn function:run
   

3. 브라우저에서 http://localhost:8080을 방문하거나 다른 창에서 curl localhost:8080을 실행하여 함수를 테스트합니다.

   자세한 내용은 로컬 함수에 요청 보내기를 참조하세요.

Gradle

1. 다음 명령어를 실행하여 함수 빌드를 확인합니다.

   gradle build
   

2. 다음 명령어를 사용하여 함수를 시작합니다.

   gradle runFunction -Prun.functionTarget=functions.HelloWorld
   

3. 브라우저에서 http://localhost:8080을 방문하거나 다른 창에서 curl localhost:8080을 실행하여 함수를 테스트합니다.

   자세한 내용은 로컬 함수에 요청 보내기를 참조하세요.

함수 배포하기

함수를 배포하려면 helloworld 디렉터리(maven를 사용하는 경우) 또는 helloworld-gradle 디렉터리(gradle의 경우)에서 다음 명령어를 실행합니다.

  gcloud functions deploy java-http-function \
    --gen2 \
    --entry-point=functions.HelloWorld \
    --runtime=java17 \
    --region=REGION \
    --source=. \
    --trigger-http \
    --allow-unauthenticated

REGION을 함수를 배포할 Google Cloud 리전 이름으로 바꿉니다(예: us-west1).

선택사항인 --allow-unauthenticated 플래그를 사용하면 인증 없이 함수에 접근할 수 있습니다.

java-http-function은 함수가 Google Cloud 콘솔에서 식별되는 등록된 이름이고 --entry-point는 함수의 정규화된 클래스 이름(FQN)을 지정합니다.

자세히 알아보기: 자세한 내용은 Cloud Functions 배포를 참조하세요.

배포된 함수 테스트

1. 함수가 배포되면 gcloud functions deploy 명령어 결과에서 uri 속성을 기록하거나 다음 명령어로 검색합니다.

   gcloud functions describe java-http-function \
     --region=REGION
   

   REGION을 함수를 배포한 Google Cloud 리전의 이름으로 바꿉니다(예: us-west1).

2. 브라우저에서 해당 URL로 이동합니다. 이 함수는 'Hello World!'라는 메시지를 반환합니다.

   참고: 이 URL은 Google Cloud 콘솔에서도 찾을 수 있습니다. Cloud Functions 개요 페이지로 이동하고 함수 이름을 클릭하여 함수 세부정보 페이지를 엽니다. TRIGGER 탭을 열어 함수의 URL을 확인합니다.

함수 로그 보기

명령줄 도구를 사용하여 로그 보기

Cloud Logging UI 또는 Google Cloud CLI를 사용하여 함수의 로그를 검토할 수 있습니다.

gcloud CLI를 사용하여 함수 로그를 보려면 logs read 명령어를 사용합니다.

    gcloud functions logs read \
      --gen2 \
      --limit=10 \
      --region=REGION \
      java-http-function

REGION을 함수를 배포한 Google Cloud 리전의 이름으로 바꿉니다(예: us-west1).

다음과 유사한 결과가 출력됩니다.

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-05-29 23:09:57.708
LOG:

LEVEL: I
NAME: my-first-function
TIME_UTC: 2023-05-29 23:05:53.257
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "my--first--function-1" on port 8080.

LEVEL:
NAME: my-first-function
TIME_UTC: 2023-05-29 23:05:53.248
LOG: 2023-05-29 23:05:53.248:INFO:oejs.Server:main: Started @892ms

참고: 로그 항목이 Cloud Logging에 표시되는 데 약간의 지연이 있을 수 있습니다.

로깅 대시보드로 로그 보기

로깅 대시보드를 사용하여 함수 로그를 보려면 Cloud Functions 개요 페이지를 열고 목록에서 함수 이름을 클릭한 다음 로그 탭을 클릭합니다.

자세히 알아보기: 자세한 내용은 로그 쓰기, 보기, 응답하기를 참조하세요.