Getting Started with Java in VS Code
This tutorial shows you how to write and run Hello World program in Java with Visual Studio Code. It also covers a few advanced features, which you can explore by reading other documents in this section.
For an overview of the features available for Java in VS Code, see Java Language Overview
If you run into any issues when following this tutorial, you can contact us by clicking the Report an issue button below.
Setting up VS Code for Java development
Coding Pack for Java
To help you set up quickly, you can install the Coding Pack for Java, which includes VS Code, the Java Development Kit (JDK), and essential Java extensions. The Coding Pack can be used as a clean installation, or to update or repair an existing development environment.
Note: The Coding Pack for Java is only available for Windows and macOS. For other operating systems, you will need to manually install a JDK, VS Code, and Java extensions.
Alternatively, if you are an existing VS Code user, you can also add Java support by installing Java Extension Pack, which includes these extensions:
- Language Support for Java(TM) by Red Hat
- Debugger for Java
- Java Test Runner
- Maven for Java
- Project Manager for Java
If JDK is not installed, the Java Extension Pack provides links to download.
You can also select which extensions you would like to install separately. The Extension Guide is provided to help you choose. You can launch the guide with the Java: Extension Guide command.
For this tutorial, the only required extensions are:
Supported Java versions
Supported versions for running VS Code for Java and supported versions for your projects are two separate concepts. To run VS Code for Java, Java SE 11 or above version is required; for projects, VS Code for Java supports projects with version 1.5 or above. For more details, refer to Configure JDK.
Installing a Java Development Kit (JDK)
Your development environment must have a Java SE Development Kit (JDK) installed. If it doesn't, you can download and install a JDK from one of these sources:
Configuring your development environment to use a JDK
Your development environment needs to know where the JDK is located. A common way to do this is setting the value of the
JAVA_HOME system environment variable to the install location of the JDK, for example,
C:\Program Files\Java\jdk-13.0.2. Or if you want to configure only VS Code to use the JDK, use the
java.home setting in VS Code's User or Workspace settings.
Settings for the JDK
To access various settings for using the JDK, bring up the Command Palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) and use the command Java: Configure Java Runtime.
The Java Extension Pack, also provides a Quick Start guide and tips for code editing and debugging. It also has a FAQ that answers some frequently asked questions. Use the command Java: Getting Started from the Command Palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)).
Creating a source code file
Create a folder for your Java program and open the folder with VS Code. Then in VS Code, create a new file and save it with the name
Hello.java. When you open that file, the Java Language Server automatically starts loading, and you should see a loading icon on the right side of the Status Bar. After it finishes loading, you will see a thumbs-up icon.
Note: If you open a Java file in VS Code without opening its folder, the Java Language Server might not work properly.
VS Code will also try to figure out the correct package for the new type and fill the new file from a template. See Create new file.
You can also create a Java project using the Java: Create Java Project command. Bring up the Command Palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) and then type
java to search for this command. After selecting the command, you will be prompted for the location and name of the project. You can also choose your build tool from this command.
Visual Studio Code also supports more complex Java projects, see Project Management.
Editing source code
You can use code snippets to scaffold your classes and methods. VS Code also provides IntelliSense for code completion, and various refactor methods.
To learn more about editing Java, see Java Editing.
Running and debugging your program
To run and debug Java code, set a breakpoint, then either press F5 on your keyboard or use the Run > Start Debugging menu item. You can also use the Run|Debug CodeLens options in the editor. After the code compiles, you can see all your variables and threads in the Run view.
The debugger also supports advanced features such as Hot Code replacement and conditional breakpoints.
For more information, see Java Debugging.
The editor also has much more capability for your Java workload.
- Editing Java explains how to navigate and edit Java in more details
- Debugging illustrates all the key features of the Java Debugger
- Testing provides comprehensive support for JUnit and TestNG framework
- Java Project Management shows you how to use a project view and work with Maven
- Spring Boot and Tomcat and Jetty demonstrate great framework support
- Java Web Apps shows how to work with Java Web App in VS Code