在 Java 中指定依附元件

您可以使用任何 Java 相容程式庫和支援的 Java 執行階段，以 Java 編寫 Cloud Run 函式。您可以使用 Maven 或 Gradle 管理 Java Cloud Run 函式的依附元件。

宣告及管理依附元件

您可以使用 Maven 或 Gradle 宣告及管理依附元件：

• 如要使用 Maven 管理依附元件，請按照下列步驟操作：

  • 在專案的 pom.xml 檔案中，於 <dependencies> 區段指定依附元件。

  • 如要管理專案對 Maven 本身的依附元件，可以使用 Maven Wrapper。如果您未使用 Maven Wrapper，Cloud Run functions 在執行 gcloud functions deploy 時，預設會使用最新版的 Maven。

• 如要使用 Gradle 管理依附元件，請在專案的 build.gradle 檔案中指定依附元件。

函式架構是所有函式的必要依附元件。雖然 Cloud Run functions 會在建立函式時代您安裝，但我們建議您將其納入明確的依附元件，以確保清楚明瞭。

如果函式依附於私有依附元件，建議您將 functions-framework 鏡像到私有登錄檔。將鏡像 functions-framework 做為函式的依附元件，避免從公開網際網路安裝套件。

使用 Java 適用的 Google Cloud 用戶端程式庫

Java 適用的 Google Cloud 用戶端程式庫提供 Google Cloud 服務的慣用存取方式。如要使用程式庫，請將其宣告為依附元件。

通常您只會針對函式需要的特定程式庫宣告依附元件。例如：

Maven

<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>

Gradle

請注意，這個 build.gradle 檔案包含自訂工作，可協助您在本機執行函式。如要進一步瞭解本機測試，請參閱「您的第一個函式：Java」。

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)
  }
}