Setting Up a Java Development Environment

This tutorial shows how to prepare your local machine for Java development, including developing Java apps that run on Google Cloud. Follow these steps to install Java and relevant tools.

Objectives

Install a JDK (Java Development Kit).
Install a build automation tool.
Install the gcloud CLI.
(Optional) Install an IDE or editor.
(Optional) Install IDE Google Cloud plugin.
Install the Cloud Client Libraries for Java.

Install a JDK (Java Development Kit)

You may choose any Java distribution of your choice by ensuring that the following environment variables are set:

JAVA_HOME: Points to the base of the JDK installation.
PATH: Includes $JAVA_HOME/bin.

Eclipse Temurin is the recommended OpenJDK (Java Development Kit) distribution for use with Google Cloud. Temurin is open-source licensed, Java SE TCK-certified, and tested to ensure production-quality performance and security.

(Recommended) Installing Temurin

Temurin's installation instructions vary by operating system.

Binaries are available for download.
For Docker containers, use the official 'eclipse-temurin' image.

If you are using Compute Engine boot images, you can use the following installation scripts.

CentOS/RHEL/Rocky

Determine the major version of CentOS/RHEL/Rocky Linux:

eval "$(grep VERSION_ID /etc/os-release)"
eval "$(grep ^ID= /etc/os-release)"
OLD_IFS=$IFS
IFS='.'
read -ra split_version <<< "$VERSION_ID"
IFS=$OLD_IFS
MAJOR_VERSION=$split_version

Create the Adoptium source repo file, `/etc/yum.repos.d/adoptium.repo`:

sudo tee /etc/yum.repos.d/adoptium.repo << EOM
[Adoptium]
name=Adoptium
baseurl=https://packages.adoptium.net/artifactory/rpm/$ID/$MAJOR_VERSION/\$basearch
enabled=1
gpgcheck=1
gpgkey=https://packages.adoptium.net/artifactory/api/gpg/key/public
EOM

Update package lists:
```
sudo yum update -y
```
Install Temurin:
```
sudo yum install -y temurin-17-jdk
```
Verify installation:
```
java -version
```

Debian/Ubuntu

Install the public repo GPG key. If you are using Ubuntu 16.4, pass the key through gpg --dearmor before saving to file. (ex: sudo wget ... | gpg --dearmor | sudo tee ...)
```
sudo mkdir -p /etc/apt/keyrings
sudo wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public |
  sudo tee /etc/apt/keyrings/adoptium.asc
```

Determine the name of the Linux distribution, and create the source list file, /etc/apt/sources.list.d/adoptium.list:

eval "$(grep VERSION_CODENAME /etc/os-release)"
sudo tee /etc/apt/sources.list.d/adoptium.list << EOM
deb [signed-by=/etc/apt/keyrings/adoptium.asc] https://packages.adoptium.net/artifactory/deb $VERSION_CODENAME main
EOM

Update package lists:
```
sudo apt update -y
```
Install Temurin:
```
sudo apt install -y temurin-17-jdk
```
Verify installation:
```
java -version
```

SLES

Install the public repository GPG key:

sudo mkdir -p /etc/zypp/keyrings
sudo wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public |
  sudo tee /etc/zypp/keyrings/adoptium.asc
sudo rpm --import /etc/zypp/keyrings/adoptium.asc

Determine the version of SLES, and register the Adoptium repository:

eval "$(grep VERSION_ID /etc/os-release)"
sudo zypper ar -f "https://packages.adoptium.net/artifactory/rpm/opensuse/$VERSION_ID/$(uname -m)" adoptium

Update package lists:
```
sudo zypper update -y
```
Install Temurin:
```
sudo zypper install -y temurin-17-jdk
```
Verify installation:
```
java -version
```

Windows

To install Temurin, run PowerShell version 3.0 or higher as an administrator with the following commands.

Download Temurin. The Invoke-WebRequest command in the instructions below requires PowerShell 3.0 or newer.

$JdkVersion = 17
$JdkUrl = "https://api.adoptium.net/v3/binary/latest/$JdkVersion/ga/windows/x64/jdk/hotspot/normal/eclipse?project=jdk"
$JdkExtractionPath = "C:\temurin-$JdkVersion-jdk"
$JdkDownload = "$JdkExtractionPath.zip"
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]'Tls12'
Invoke-WebRequest -Uri $JdkUrl -OutFile $JdkDownload
Expand-Archive $JdkDownload -DestinationPath $JdkExtractionPath -Force

Set the JAVA_HOME and Path variables:

pushd $JdkExtractionPath
$JdkPath = (Get-ChildItem).FullName
popd
[System.Environment]::SetEnvironmentVariable('JAVA_HOME', $JdkPath, 'Machine')

(Optional) Refresh your session's `$env:Path` value. Otherwise, start a new session:

$MachinePath = [System.Environment]::GetEnvironmentVariable('Path', 'Machine')
$UserPath = [System.Environment]::GetEnvironmentVariable('Path', 'User')
$env:Path = "$MachinePath;$UserPath"

Verify installation:
```
java -version
```

Install a build automation tool

Apache Maven, Gradle, and SBT are package management options that can help build Java app dependencies quickly and consistently across platforms.

Install the gcloud CLI

The gcloud CLI is a set of tools for Google Cloud. It contains gcloud, gsutil, and bq, which you can use to access Compute Engine, Cloud Storage, BigQuery, and other products and services from the command line. You can run these tools interactively or in your automated scripts.

(Optional) Install an IDE or editor

Popular editors (in no particular order) used to develop Java apps include, but are not limited to:

Visual Studio Code
IntelliJ IDEA and/or Webstorm by JetBrains
Eclipse by Eclipse Foundation
Atom by GitHub

These editors (sometimes with the help of plugins) give you everything from syntax highlighting, intelli-sense, and code completion to fully integrated debugging capabilities.

(Optional) Install an IDE plugin

For access to helpful functions within your editor, check out the following plugins:

Install the Cloud Client Libraries for Java

Use the Cloud Client Libraries for Java to integrate with Google Cloud services, such as Datastore and Cloud Storage. You can install the package for an individual API, such as BigQuery, as shown in the following example.

If you are using Maven, add the following to your pom.xml file. For more information about BOMs, see The Google Cloud Platform Libraries BOM.

<!--  Using libraries-bom to manage versions.
See https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM -->
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.20.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-bigquery</artifactId>
  </dependency>
</dependencies>

If you are using Gradle, add the following to your dependencies:

implementation platform('com.google.cloud:libraries-bom:26.22.0')

implementation 'com.google.cloud:google-cloud-bigquery'

If you are using sbt, add the following to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-bigquery" % "2.31.2"

If you're using Visual Studio Code, IntelliJ, or Eclipse, you can add client libraries to your project using the following IDE plugins:

The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.

Set up authentication

To run the client library, you must first set up authentication.

Use the client library

View on GitHub Feedback

// Imports the Google Cloud client library
import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Dataset;
import com.google.cloud.bigquery.DatasetInfo;

public class QuickstartSample {
  public static void main(String... args) throws Exception {
    // Instantiate a client. If you don't specify credentials when constructing a client, the
    // client library will look for credentials in the environment, such as the
    // GOOGLE_APPLICATION_CREDENTIALS environment variable.
    BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();

    // The name for the new dataset
    String datasetName = "my_new_dataset";

    // Prepares a new dataset
    Dataset dataset = null;
    DatasetInfo datasetInfo = DatasetInfo.newBuilder(datasetName).build();

    // Creates the dataset
    dataset = bigquery.create(datasetInfo);

    System.out.printf("Dataset %s created.%n", dataset.getDatasetId().getDataset());
  }
}

Configure endpoints for the client library

If you use APIs that support regional endpoints, use endpoints to configure which server to send requests to. For example, with the Google.Cloud.Dataproc.V1 API, you might configure a client endpoint. You can read more about regional endpoints for Dataproc here. Be sure to replace MY-PROJECT with your project name and us-central1 with the region appropriate for your configuration in the following example:

ClusterControllerSettings settings =
     ClusterControllerSettings.newBuilder()
        .setEndpoint("us-central1-dataproc.googleapis.com:443")
        .build();
 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create(settings)) {
   String projectId = "MY-PROJECT";
   String region = "us-central1";
   Cluster cluster = Cluster.newBuilder().build();
 }

What's next

(Optional) Use the Maven or Gradle plugin for App Engine

If you are developing in the App Engine standard or flexible environment, you can use plugins for both Apache Maven and Gradle build tools that provide convenient functions for developing, testing, and deploying your apps directly.

For App Engine standard environments

Use the Maven App Engine plugin or Gradle plugin for App Engine standard environments.

For App Engine flexible environments

Use the Maven App Engine plugin or Gradle plugin for App Engine flexible environments.

More resources

Browse the documentation for Google Cloud products.
Clone the Java samples repository from GitHub.