Specify dependencies in Java

You can use any Java compatible libraries with a supported Java runtime to write Cloud Functions in Java. You can use either Maven or Gradle to manage dependencies for your Java Cloud Functions.

Declaring and managing dependencies

You can declare and manage dependencies using either Maven or Gradle:

  • To manage dependencies using Maven:

    • Specify the dependencies in the <dependencies> section inside the pom.xml file of your project.

    • To manage your project's dependency on Maven itself, you can use the Maven Wrapper. If you do not use the Maven Wrapper, Cloud Functions defaults to using a recent version of Maven when running gcloud functions deploy.

  • To manage dependencies using Gradle, you specify the dependencies in the build.gradle file of your project.

The Functions Framework is a required dependency for all functions. Although Cloud Functions installs it on your behalf when the function is created, we recommend that you include it as an explicit dependency for clarity.

If your function relies on private dependencies, we recommend that you mirror functions-framework to your private registry. Include the mirrored functions-framework as a dependency to your function to avoid installing the package from the public internet.

Using the Google Cloud Client Libraries for Java

Google Cloud Client Libraries for Java provide idiomatic access to Google Cloud services. To use a library, declare it as a dependency.

Typically you only declare dependencies on the specific libraries that your function needs. For example:


<project xmlns="http://maven.apache.org/POM/4.0.0"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">


    <!-- Required for Function primitives -->

          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


Note that this build.gradle file includes a custom task to help you run functions locally. For more discussion of local testing, see Your First Function: Java.

apply plugin: 'java'

repositories {
configurations {

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'
  inputs.files(configurations.runtimeClasspath, sourceSets.main.output)
    '--target', project.findProperty('run.functionTarget') ?: '',
    '--port', project.findProperty('run.port') ?: 8080
  doFirst {
    args('--classpath', files(configurations.runtimeClasspath, sourceSets.main.output).asPath)