Visual studio code java

03.09.202203.09.2022 admin 0 Comments

Visual studio code java

Java in Visual Studio Code

Support for Java in Visual Studio Code is provided through a wide range of extensions. Combined with the power of core VS Code, these extensions give you a lightweight and performant code editor that also supports many of the most common Java development techniques.

This article will give you an overview of different capabilities of Visual Studio Code for Java developers. For a quick walkthrough of editing, running, and debugging a Java program with Visual Studio Code, use the Java Getting Started Tutorial button below.

Overview

VS Code provides essential language features such as code completion, refactoring, linting, formatting, and code snippets along with convenient debugging and unit test support. VS Code also integrates with tooling and frameworks such as Maven, Tomcat, Jetty, and Spring Boot. Leveraging the power of Visual Studio Code, Java developers get an excellent tool for both quick code editing and also the full debugging and testing cycle. It’s a great choice for your Java work if you’re looking for a tool which:

Install Visual Studio Code for Java

To help you set up quickly, we recommend you use the Coding Pack for Java, which is the bundle of VS Code, the Java Development Kit (JDK), and a collection of suggested extensions by Microsoft. The Coding Pack can also be used to fix 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.

If you have already installed VS Code and want to add Java support to it, we recommend using the Extension Pack for Java, a collection of extensions suggested by Microsoft:

Alternatively, you can add Java language support to VS Code by installing the popular Java extensions by yourself.

There are also other popular Java extensions you can pick for your own needs, including:

Thanks to the great Java community around VS Code, the list doesn’t end there. You can search for more Java extensions easily within VS Code:

This document describes some of the key features included in those Java extensions.

Getting started

NOTE: If you are using VS Code on Windows and want to take advantage of the Windows Subsystem for Linux, see Developing in WSL.

Install a Java Development Kit (JDK)

A Java Development Kit (JDK) is a software development environment used for developing Java applications. In order to run Java within Visual Studio Code, you need to install a JDK. The Extension Pack for Java supports Java version 1.5 or above.

We recommend you to consider installing the JDK from one of these sources:

Note: If you have multiple JDKs installed and need to use a specific JDK version for your projects, see Configure Runtime for Projects. To enable Java preview features, see How can I use VS Code with new Java versions.

For developers new to Java or new to VS Code, we do provide some tips in our extensions. Once you’ve installed the Extension Pack for Java, you can see the tips using the Java: Tips for Beginners command from the Command Palette in VS Code.

Open the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) and type «java tips» to select the command.

Working with Java source files

You can use VS Code to read, write, run, and debug Java source file(s) without creating a project. VS Code for Java supports two modes, lightweight and standard. Lightweight mode is ideal for scenarios that only deal with source file(s). If you want to work with a full-scale project, standard mode will be required. You can easily switch from lightweight mode to standard mode, when needed. To learn more, see Lightweight Mode.

Working with Java projects

There are three things you must understand to work with Java in VS Code:

VS Code Workspaces

In Visual Studio Code, a «Workspace» means a collection of one or more filesystem folders (and their children) and all of the VS Code configurations that take effect when that «Workspace» is open in VS Code. There are two kinds of «Workspaces» in VS Code, «folder workspaces» and «multi-root workspaces».

A «folder workspace» is presented by VS Code when you open a filesystem folder (directory) in VS Code.

A «multi-root workspace» can refer to multiple folders (directories) from disparate parts of the file system and VS Code displays the contents of the folder(s) of the workspace together in the File Explorer. To learn more, see Multi-root Workspaces.

Java projects in VS Code

In contrast to IDEs such as IntelliJ IDEA, NetBeans, or Eclipse, the concept of a «Java project» is provided entirely by extensions, and is not a core concept in the base VS Code. When working with «Java projects» in VS Code, you must have the necessary extensions installed to work with those project files.

For example, Maven, Eclipse, and Gradle Java projects are supported through Language Support for Java™ by Red Hat, by utilizing M2Eclipse, which provides Maven support, and Buildship, which provides Gradle support through the Eclipse JDT Language Server.

With Maven for Java, you can generate projects from Maven Archetypes, browse through all the Maven projects within your workspace, and execute Maven goals easily from an embedded explorer. Projects can also be created and managed with the Project Manager for Java extension.

Visual Studio Code also supports working with standalone Java files outside of a Java project, described in the Getting Started with Java tutorial.

VS Code Workspaces that contain Java projects

Assuming the necessary Java extensions are installed, opening a VS Code workspace that contains Java artifacts will cause those extensions to understand those artifacts and present options for working with them.

More details about Java project support can be found in Java Project Management in Visual Studio Code and Java Build Tools.

Editing

Code Navigation

Java in Visual Studio Code also supports source code navigation features such as search for symbol, Peek Definition, and Go to Definition. The Spring Boot Tools extension provides enhanced navigation and code completion support for Spring Boot projects.

One of the key advantages of VS Code is speed. When you open your Java source file or folder, within a few seconds, with the help of Lightweight Mode, you will be able to navigate your code base with the Outline view, as well as commands such as Go to Definition and Go to Reference. This is especially useful when you open a project for the first time.

Code Completion

IntelliSense is a general term for language features, including intelligent code completion (in-context method and variable suggestions) across all your files and for both built-in and third-party modules. VS Code supports code completion and IntelliSense for Java through Language Support for Java™ by Red Hat. It also provides AI-assisted IntelliSense called IntelliCode by putting what you’re most likely to use at the top of your completion list.

For more details, see Java Code Navigation and Editing. VS Code also supports a range of Refactoring and Linting features.

Debugging

Debugger for Java is a lightweight Java Debugger based on Java Debug Server. It works with Language Support for Java™ by Red Hat to allow users to debug Java code within Visual Studio Code.

Although it’s lightweight, the Java debugger supports advanced features such as expression evaluation, conditional breakpoints, and Hot Code Replace. For more debugging-related information, visit Java Debugging.

Testing

With the support from the Test Runner for Java extension, you can easily run, debug, and manage your JUnit and TestNG test cases.

For more about testing, read Testing Java.

Spring Boot, Tomcat, and Jetty

To further improve your Java productivity in VS Code, there are extensions for most popular frameworks and tools, such as Spring Boot, Tomcat, and Jetty, created by the community.

See Application Servers to learn more about support for Tomcat and Jetty, as well as other application servers with VS Code.

Spring Boot support is provided by Pivotal. There are also the Spring Initializr Java Support and Spring Boot Dashboard extensions provided by Microsoft, to further improve your experience with Spring Boot in Visual Studio Code.

See Spring Boot with VS Code to learn more about Spring Boot support in VS Code, and also Deploy to Azure Web Apps or Deploy to Azure Spring Apps to learn more about deploying Spring apps to Azure from VS Code.

Next steps

Learn more about Java in VS Code:

Read on to find out more about Visual Studio Code:

Java in Visual Studio Code

Overview

Install Visual Studio Code for Java

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.

If you have already installed VS Code and want to add Java support to it, we recommend using the Extension Pack for Java, a collection of extensions suggested by Microsoft:

Alternatively, you can add Java language support to VS Code by installing the popular Java extensions by yourself.

There are also other popular Java extensions you can pick for your own needs, including:

Thanks to the great Java community around VS Code, the list doesn’t end there. You can search for more Java extensions easily within VS Code:

This document describes some of the key features included in those Java extensions.

Getting started

NOTE: If you are using VS Code on Windows and want to take advantage of the Windows Subsystem for Linux, see Developing in WSL.

Install a Java Development Kit (JDK)

We recommend you to consider installing the JDK from one of these sources:

Note: If you have multiple JDKs installed and need to use a specific JDK version for your projects, see Configure Runtime for Projects. To enable Java preview features, see How can I use VS Code with new Java versions.

Open the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) and type «java tips» to select the command.

Working with Java source files

Working with Java projects

There are three things you must understand to work with Java in VS Code:

VS Code Workspaces

A «folder workspace» is presented by VS Code when you open a filesystem folder (directory) in VS Code.

Java projects in VS Code

Visual Studio Code also supports working with standalone Java files outside of a Java project, described in the Getting Started with Java tutorial.

VS Code Workspaces that contain Java projects

More details about Java project support can be found in Java Project Management in Visual Studio Code and Java Build Tools.

Editing

Code Navigation

Code Completion

For more details, see Java Code Navigation and Editing. VS Code also supports a range of Refactoring and Linting features.

Debugging

Debugger for Java is a lightweight Java Debugger based on Java Debug Server. It works with Language Support for Java™ by Red Hat to allow users to debug Java code within Visual Studio Code.

Testing

With the support from the Test Runner for Java extension, you can easily run, debug, and manage your JUnit and TestNG test cases.

For more about testing, read Testing Java.

Spring Boot, Tomcat, and Jetty

To further improve your Java productivity in VS Code, there are extensions for most popular frameworks and tools, such as Spring Boot, Tomcat, and Jetty, created by the community.

See Application Servers to learn more about support for Tomcat and Jetty, as well as other application servers with VS Code.

Next steps

Learn more about Java in VS Code:

Read on to find out more about Visual Studio Code:

Java in Visual Studio Code

Overview

Install Visual Studio Code for Java

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.

If you have already installed VS Code and want to add Java support to it, we recommend using the Extension Pack for Java, a collection of extensions suggested by Microsoft:

Alternatively, you can add Java language support to VS Code by installing the popular Java extensions by yourself.

There are also other popular Java extensions you can pick for your own needs, including:

Thanks to the great Java community around VS Code, the list doesn’t end there. You can search for more Java extensions easily within VS Code:

This document describes some of the key features included in those Java extensions.

Getting started

NOTE: If you are using VS Code on Windows and want to take advantage of the Windows Subsystem for Linux, see Developing in WSL.

Install a Java Development Kit (JDK)

We recommend you to consider installing the JDK from one of these sources:

Note: If you have multiple JDKs installed and need to use a specific JDK version for your projects, see Configure Runtime for Projects. To enable Java preview features, see How can I use VS Code with new Java versions.

Open the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) and type «java tips» to select the command.

Working with Java source files

Working with Java projects

There are three things you must understand to work with Java in VS Code:

VS Code Workspaces

A «folder workspace» is presented by VS Code when you open a filesystem folder (directory) in VS Code.

Java projects in VS Code

Visual Studio Code also supports working with standalone Java files outside of a Java project, described in the Getting Started with Java tutorial.

VS Code Workspaces that contain Java projects

More details about Java project support can be found in Java Project Management in Visual Studio Code and Java Build Tools.

Editing

Code Navigation

Code Completion

For more details, see Java Code Navigation and Editing. VS Code also supports a range of Refactoring and Linting features.

Debugging

Debugger for Java is a lightweight Java Debugger based on Java Debug Server. It works with Language Support for Java™ by Red Hat to allow users to debug Java code within Visual Studio Code.

Testing

With the support from the Test Runner for Java extension, you can easily run, debug, and manage your JUnit and TestNG test cases.

For more about testing, read Testing Java.

Spring Boot, Tomcat, and Jetty

To further improve your Java productivity in VS Code, there are extensions for most popular frameworks and tools, such as Spring Boot, Tomcat, and Jetty, created by the community.

See Application Servers to learn more about support for Tomcat and Jetty, as well as other application servers with VS Code.

Next steps

Learn more about Java in VS Code:

Read on to find out more about Visual Studio Code:

Managing Java Projects in VS Code

The Project Manager for Java extension helps you to manage your Java projects and their dependencies. It also helps you to create new Java projects, packages, and classes. To get the complete Java language support in Visual Studio Code, you can install the Extension Pack for Java, which includes the Project Manager for Java extension.

For details on how to get started with the extension pack, you can review the Getting Started with Java tutorial.

Projects view

The Java Projects view helps you view your Java projects and their dependencies, and provides entry points for project management tasks.

In the overflow button of the navigation bar, there are more options to use. For example, you can switch between hierarchical view and flat view.

You can find buttons next to the nodes in the Explorer, which provide useful shortcuts for some actions.

There are also many useful features in each node’s context menu, you can right-click on the node in Explorer to toggle it out.

Create a new Java project

You can create a new Java project by clicking the + button in the navigation bar, or through the command: Java: Create Java Project. in Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ). During creation, VS Code will facilitate installing required extension(s) per your project type, if the extension(s) weren’t already installed.

Import Java projects

You can directly import existing Java projects and modules to your workspace through File > Open Folder. (Make sure the opened folder contains your build tool scripts, for example, pom.xml or build.gradle ). VS Code for Java will detect your projects and import them automatically.

When you add a new module into your projects, you can trigger the command Java: Import Java projects in workspace to import them to your workspace. This command helps to import new projects into the workspace without the need to reload the VS Code window.

Export to JAR

Configure Runtime for Projects

Note: You can set one of them to default by adding «default»: true to the entry. The default JDK will be used for your unmanaged folders (with out build tools).

To see which JDKs are used for your projects, you can trigger the command Java: Configure Java Runtime in Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ). This command opens a view displaying the runtime information for your projects:

Change JDK for Maven and Gradle projects

If you want to change the JDK version for your Maven or Gradle projects, you need to update it in your build scripts ( pom.xml or build.gradle ). You can click to see how to make such changes. Click will navigate to the build script file of the project.

Change JDK for unmanaged folders

To change the JDK for unmanaged folders (with out any build tools), you can click the button. It will list all the JDKs and you can select one for your unmanaged folders.

Download JDKs

If you want to download a new JDK, you can click the download link, or trigger the command Java: Install New JDK in Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ). It will open a new view guiding you to download JDKs.

Configure classpath for unmanaged folders

The Project Management for Java extension provides a user interface to configure the classpath for unmanaged folders. The classpath can be set manually in the classpath configuration page. You can open it by executing the Java: Configure Classpath command from the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ).

In some rare cases, you may need to clean the Java workspace by executing the Java: Clean Java Language Server Workspace command from the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) to let the language server rebuild your dependencies.

Dependency management

Add a Maven dependency

For Maven project, you can add a dependency by clicking the + icon next to Maven Dependencies node in project view.

Manage dependencies for unmanaged folder

If your project is an unmanaged folder without any build tools. You can manage the dependencies by clicking the + icon or the — icon on the Referenced Libraries node or the items under it.

You can also manage the dependencies in the classpath configuration page. See: Configure classpath for unmanaged folder

Include libraries

The libraries to reference are described using a set of glob patterns.

The referenced libraries are then watched by VS Code, and the project will be refreshed if there is a change to any of these dependent files.

Exclude some libraries

If you want to exclude some libraries from the project, you can expand java.project.referencedLibraries to use include/exclude fields and add an exclude glob pattern:

In the example above, any binary JAR files in the library/sources folder are ignored as the project’s external dependencies.

Attach source jars

By default, a referenced .jar will try to search -sources.jar under the same directory, and attach it as source if one match is found.

If you want to manually specify a JAR file as a source attachment, you can provide a key-value map in the sources field:

In this way, bar-src.jar is attached to bar.jar as its source.

Lightweight Mode

VS Code for Java supports two modes, lightweight and standard. With lightweight mode, only source files and JDK are resolved by the language server; with standard mode, imported dependencies are resolved and the project is built by the language server. Lightweight mode works best when you need a quick-start and lightweight environment to work with your source files, for example, reading source code, navigating among source code and JDK, viewing outline and Javadoc, and detecting and fixing syntax errors. Also, code completion is supported within the scope of source files and JDK.

Lightweight mode doesn’t resolve imported dependencies nor build the project, so it does not support running, debugging, refactoring, linting, or detecting semantic errors. For these features to be available, you need to switch your workspace from lightweight mode to standard mode.

You can control which mode to launch with by configuring java.server.launchMode with the options below:

The language status item indicates which mode the current workspace is in using different icons.

Clicking the language status item switches to standard mode.

Build Status

When you edit Java source code in Visual Studio Code, the Java language server is building your workspace to provide you with the necessary language features. You can see the detailed build task status and watch what is happening behind the scene by clicking the language status item in the Status bar. You can also select the check details link when a notification shows the language server is opening Java projects to see the build task status.

Additional resources

There are several Visual Studio Code extensions to support different build systems for Java. Below are extensions for several popular build systems.

If you run into any problems when using the features above, you can contact us by filing an issue.

Next steps

Read on to find out more about:

Java in Visual Studio Code

Overview

Install Visual Studio Code for Java

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.

If you have already installed VS Code and want to add Java support to it, we recommend using the Extension Pack for Java, a collection of extensions suggested by Microsoft:

Alternatively, you can add Java language support to VS Code by installing the popular Java extensions by yourself.

There are also other popular Java extensions you can pick for your own needs, including:

Thanks to the great Java community around VS Code, the list doesn’t end there. You can search for more Java extensions easily within VS Code:

This document describes some of the key features included in those Java extensions.

Getting started

NOTE: If you are using VS Code on Windows and want to take advantage of the Windows Subsystem for Linux, see Developing in WSL.

Install a Java Development Kit (JDK)

We recommend you to consider installing the JDK from one of these sources:

Note: If you have multiple JDKs installed and need to use a specific JDK version for your projects, see Configure Runtime for Projects. To enable Java preview features, see How can I use VS Code with new Java versions.

Open the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) and type «java tips» to select the command.

Working with Java source files

Working with Java projects

There are three things you must understand to work with Java in VS Code:

VS Code Workspaces

A «folder workspace» is presented by VS Code when you open a filesystem folder (directory) in VS Code.

Java projects in VS Code

Visual Studio Code also supports working with standalone Java files outside of a Java project, described in the Getting Started with Java tutorial.

VS Code Workspaces that contain Java projects

More details about Java project support can be found in Java Project Management in Visual Studio Code and Java Build Tools.

Editing

Code Navigation

Code Completion

For more details, see Java Code Navigation and Editing. VS Code also supports a range of Refactoring and Linting features.

Debugging

Debugger for Java is a lightweight Java Debugger based on Java Debug Server. It works with Language Support for Java™ by Red Hat to allow users to debug Java code within Visual Studio Code.

Testing

With the support from the Test Runner for Java extension, you can easily run, debug, and manage your JUnit and TestNG test cases.

For more about testing, read Testing Java.

Spring Boot, Tomcat, and Jetty

To further improve your Java productivity in VS Code, there are extensions for most popular frameworks and tools, such as Spring Boot, Tomcat, and Jetty, created by the community.

See Application Servers to learn more about support for Tomcat and Jetty, as well as other application servers with VS Code.

Next steps

Learn more about Java in VS Code:

Read on to find out more about Visual Studio Code:

Java extensions for Visual Studio Code

Thanks to the great Java community around Visual Studio Code, you can use a wide range of extensions to enhance your Java development experience.

Tip: To learn how to install and manage your extensions, refer to the general VS Code extension documentation.

In this topic, we recommend a list of popular extensions helpful for different Java development scenarios.

Fundamental Java development

If you are looking for core Java development experience on Visual Studio Code (including Java code auto-completion, running / debugging / testing Java applications, Java project management, etc.), we recommend the Extension Pack for Java. This extension pack contains a list of popular Java extensions for fundamental Java development:

To get started with this extension pack, you can visit Getting Started with Java tutorial.

You can also install the SonarLint extension that detects quality and security issues in your code.

Spring Boot extensions

Spring Boot is an open source, microservice-based Java web framework that is very popular among Java developers. There are great extensions provided by Pivotal and Microsoft for Spring Boot development.

We recommend installing the Spring Boot Extension Pack that contains the following extensions:

More Spring Boot related information can be found at the Spring Boot page.

Gradle for Java

Visual Studio Code offers support Gradle support via the Gradle for Java extension. To learn more how to use this extension, visit the Gradle section on Build Tools page.

Application Servers (Tomcat / Jetty / etc.)

Community Server Connectors is an excellent extension for application servers such as Tomcat and Jetty.

To learn more about how to work with Java application servers on Visual Studio Code, refer to the Application Server page.

MicroProfile / Quarkus

Support for Eclipse MicroProfile and Quarkus are provided via the following extensions:

Keymaps for other Java IDEs

There are some extensions from the community for developers who might be used to the keyboard shortcuts from other Java IDEs.

Keymap extensions apply keyboard shortcuts from other IDEs or editors on to VS Code so you don’t have to retrain your fingers to new keyboard shortcuts.

Remote development and container support

We’d also like to recommend a couple of other extensions that are useful for remote and container development scenarios.

Azure on Visual Studio Code

The Azure extensions for Visual Studio Code provide seamless integration with Azure and the cloud. There are a few Azure extensions we’d like to recommend.

Team development

Internet of Things

General tools

Visit Azure Extensions to find more Azure extensions.

Search for other Java extensions

If the extensions above do not meet your requirement, you can also search for other Java related extensions within Visual Studio Code. Here are the steps:

We also appreciate contributions to any of our existing extensions and we hope you’ll create new Java extensions if you don’t find what you’re looking for in the Marketplace.

Java build tools in VS Code

This document is an overview of how to work with your Java build tools in Visual Studio Code. It covers the Maven for Java and Gradle for Java extensions as well as other tools.

If you run into any issues when using the features below, you can contact us by entering an issue.

Maven

Maven is a software tool that helps you manage Java projects and automate application builds. The Maven for Java extension for Visual Studio Code provides fully integrated Maven support, allowing you to explore Maven projects, execute Maven commands, and perform the goals of build lifecycle and plugins. We recommend installing the Extension Pack for Java, which includes Maven support and other important Java development features.

Exploring Maven project

Once a Maven project is loaded, the extension will be activated and it will automatically scan for pom.xml files in your workspace and displays all Maven projects and their modules in the side bar.

Resolve unknown type

The Maven extension also supports searching Maven Central to resolve unknown types in your source code. You can do this by selecting the Resolve unknown type link shown on hover.

Working with POM.xml

The extension provides code snippets and auto completion for adding Maven dependencies based on local Maven repositories. See how easy it is to add a new dependency to your pom.xml with those convenient features.

The extension also enables you to generate effective POM.

You can also add dependencies through the project view, which calls the same Maven command.

Furthermore, VS Code also supports showing dependencies in a tree view, which allows you to inspect all dependencies in your project at a single place and check for potential issues.

Execute Maven commands and goals

By right-clicking each Maven project in the Explorer, you can conveniently run Maven goals.

The extension also preserves the history of goals for each project, so you can quickly rerun the previous command, which is useful when you’re running a long custom goal.

There are two ways to rerun a goal:

You can also specify your favorite commands in settings for future execution.

For each plug-in you use with your project, the extension also provides you an easy way to access the goals within each plugin.

To debug Maven goals, right-click on a goal and start debugging. The Maven extension will call the Java debugger with the right parameters. This is a handy, time-saving feature.

Generate project from Maven Archetype

There are several ways to create a Maven project:

From the Maven Explorer, select the + Create Maven Project button.

Open the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ), search for Create Java Project command.

Right-click on a target folder and select Create Maven Project.

Gradle

VS Code supports Gradle Java project (not including Android) via the Gradle for Java extension. The extension provides a visual interface for your Gradle build, you can use this interface to view Gradle Tasks and Project dependencies, or run Gradle Tasks as VS Code Tasks. The extension also offers a better Gradle build file authoring experience including syntax highlighting, error reporting, and auto-completion.

Working with Gradle tasks

When you open a Gradle project in VSCode, you can find some useful Gradle views by clicking the Gradle Side Bar item. Gradle Projects view lists all the Gradle projects found in the workspace. You can view, run, or debug Gradle tasks here.

When there are many Gradle tasks in the workspace, it might be hard to find a specific task. The extension offers a Pinned Tasks view to help you pin your favorite tasks so that you can easily find them in a separate view. You can also see recently executed tasks in the Recent Tasks view.

Viewing Gradle dependencies

In the Gradle Projects view, you can find a Dependencies item under each Gradle project item. It includes all the dependencies in your specified configuration, you can easily check the dependency status of your project.

Managing Gradle Daemons

The Gradle Daemons view shows the daemon status of the current workspace. It lists all the running Gradle daemons in the same version as the workspace. You can choose to stop a specific one or all the daemons in this view.

Authoring build files

The extension provides some useful authoring features on the Gradle build files.

When opening a Groovy Gradle file, the extension will analyze the Gradle file and provide semantic tokens information, providing more precise highlighting results.

In the Outline view, the extension provides the document symbols of the opened Gradle file, which can help you to navigate to any part of the file easily.

If there is any syntax error (missing characters, type not found, etc.) in the opened Gradle file, you can find them in the Problems view.

The extension supports basic auto completions for a Gradle file, when you’re trying to type Gradle closures or properties in a Gradle script, the extension will suggest available closures or properties for you.

When you are trying to declare a new dependency, the extension will provide a dependency candidate list for you.

Additional resources

Visit the GitHub Repo of the Maven extension for additional configurations and a troubleshooting guide.

In addition to Maven, there’s also a Bazel extension if you use Bazel to build and test your project.

Next steps

Read on to find out more about:

Running and debugging Java

Visual Studio Code allows you to debug Java applications through the Debugger for Java extension. It’s a lightweight Java debugger based on Java Debug Server, which extends the Language Support for Java™ by Red Hat.

Here’s a list of supported debugging features:

The Java debugger is an open-source project, which welcomes contributors to collaborate through GitHub repositories:

If you run into any issues when using the features below, you can contact us by entering an issue.

Install

To get the complete Java language support in Visual Studio Code, you can install the Extension Pack for Java, which includes the Debugger for Java extension.

For details on how to get started with the extension pack, you can review the Getting Started with Java tutorial.

Configure

By default, the debugger will run out-of-box by automatically finding the main class and generating a default launch configuration in memory to launch your application.

If you would like to customize and persist your launch configuration, you can select the create a launch.json file link in the Run and Debug view.

Run and Debug

The debugger extension provides multiple ways to run and debug your Java application.

Run from CodeLens

You will find Run|Debug on the CodeLens of your main() function.

Run from Editor menu

Another way to start debugging is to select Run Java or Debug Java menu from the top editor title bar.

Run from pressing F5

Debugging single files

In addition to support for debugging Java projects managed by build tools, VS Code also supports for debugging single Java files without any project.

Debug session inputs

The default Debug Console in VS Code doesn’t support inputs. If your program need inputs from a terminal, you can use the Integrated Terminal ( ⌃` (Windows, Linux Ctrl+` ) ) within VS Code or an external terminal to launch it. You can also use the user setting java.debug.settings.console to configure a global console for all Java debug sessions.

Breakpoints

The Debugger for Java supports various breakpoints, such as line breakpoints, conditional breakpoints, data breakpoints, logpoints.

With the help of expression evaluation, the debugger also supports conditional breakpoint. You can set your breakpoint to break when expression evaluates to true.

You can have the debugger break when a variable changes its value. Note that the data breakpoint can only be set inside a debug session. This means you need to launch your application and break on a regular breakpoint first. You can then pick a field in the VARIABLES view and set a data breakpoint.

Logpoints is also supported by Java Debugger. Logpoints allow you to send output to Debug Console without editing code. They’re different from breakpoints because they don’t stop the execution flow of your application.

Expression evaluation

The debugger also lets you evaluate expressions in the WATCH window as well as the Debug Console.

Hot Code Replace

Another advanced feature the debugger supports is ‘Hot Code’ replacement. Hot Code Replace (HCR) is a debugging technique whereby the Debugger for Java transmits the class changes over the debugging channel to another Java Virtual Machine (JVM). HCR facilitates experimental development and fosters iterative trial-and-error coding. With this new feature, you can start a debugging session and change a Java file in your development environment, and the debugger will replace the code in the running JVM. No restart is required, which is why it’s called «hot». Below is an illustration of how you can use HCR with Debugger for Java in VS Code.

You may use the debug setting java.debug.settings.hotCodeReplace to control how to trigger Hot Code Replace. The possible setting values are:

Step filtering

Step filter is supported by the extension to filter out types that you do not want to see or step through while debugging. With this feature, you can configure the packages to filter within your launch.json so they could be skipped when you step through.

Configuration options

There are many options and settings available to configure the debugger. For example, configuring the JVM arguments and environment variables is easily done with launch options.

Consult the documentation for the Language Support for Java™ by Red Hat extension for help with setting up your project.

For many commonly used setups, there are samples available in VS Code Java Debugger Configuration. The document explains how the Java debugger automatically generates configurations for you, and if you need to modify them, how to do so with Main class, different arguments, environment, attaching to other Java processes, and usage of more advanced features.

Launch

Attach

User settings

Troubleshooting

If you encounter issues when using the debugger, a detailed troubleshooting guide can be found in the vscode-java-debug GitHub repository.

Common issues explained include:

Feedback and questions

You can find the full list of issues at the vscode-java-debug repository. You can submit a bug or feature suggestion and participate in the community driven vscode-java-debug Gitter channel.

Next steps

Read on to find out about:

Frequent Asked Questions

Thanks for your interest in Java on Visual Studio Code! This FAQ will hopefully answer some of the questions you may have.

Are these Java extensions open source?

Yes. All the Java Extensions provided by Red Hat, Microsoft, and Pivotal are open source, as well as most extensions supported by the community. You can find their corresponding repositories on GitHub from the Marketplace pages.

Are there any other features coming to Java on Visual Studio Code?

Definitely. We use GitHub issues to track incoming requests and planned work for each of our extensions. Currently we’re working on adding more refactoring and linting features to enhance the editing productivity, as well as some performance improvements to make it even faster.

Most of our work is collected from and prioritized by customer feedback. If you’re interested in providing your thoughts, you can go directly to our project repositories to submit a new issue to share your thoughts.

We do have limited capacity within the team and we’d really like to encourage more contributions from the great Java community. If you’re passionate about your idea and would like to help fellow Java developers, you’re welcome to join us! Some areas worth considering including Gradle support, code analysis and test coverage tools, profiler, and additional framework support including DropWizard, JavaFX, JPA, Play, Akka, OSGi.

Can I use keyboard shortcuts from other IDE?

Sure. Keymap extensions in VS Code modify the VS Code shortcuts to match those of other editors. You can find IntelliJ IDEA Keybindings, Eclipse Keymap as well as keymaps for other popular editors in Keymaps category of extensions in the Marketplace.

Where can I find the latest progress of Java support on Visual Studio Code?

You can follow us on the Java at Microsoft blog, which will keep you updated on our progress.

While you’re using Java within VS Code, you may also see a Release Notes section after you update the Extension Pack for Java. The notes will give you an overview on the notable updates included in the extensions.

How can I use Visual Studio Code with new Java versions?

Thanks to the upstream update from JDT, you can now build your project up to Java 14 with VS Code as well. To use the experimental/preview language features, you need to modify your project settings.

Note: If you are modifying a project that was already opened in VS Code, you may need to force clean the workspace and reload. To do so, run command Java: Clean Java Language Server Workspace.

How can I use it behind a corporate proxy?

When using the Java Language Support (redhat.java) extension behind a corporate proxy, you might need to let the Java Language server know how to connect to the Internet, in order to download build runtimes, Java dependencies, and their sources through that proxy.

This is done by configuring the java.jdt.ls.vmargs setting in VS Code preferences (all on one line):

Will this be available for Visual Studio?

Currently we don’t plan to extend the Java support to Visual Studio. There are already great IDEs for Java and we’re focusing on VS Code to provide a lightweight experience in a polyglot editor.

Does VS Code Java support other display languages?

Currently we support Chinese in addition to English for a few extensions including Debugger for Java, Test Runner for Java, Maven for Java, Project Manager for Java. To learn how to switch the VS Code display language, see Display Languages.

You can contribute to the extension repositories if you’re interested in additional display language support.

How to troubleshoot and contribute to the Java Language Server

You can visit the Java for Visual Studio Code wiki to find answers regarding:

Testing Java with Visual Studio Code

Testing Java in Visual Studio Code is enabled by the Test Runner for Java extension. It’s a lightweight extension to run and debug Java test cases.

Overview

The extension supports the following test frameworks:

The Test Runner for Java works with the Language Support for Java™ by Red Hat and Debugger for Java extensions to provide the following features:

Requirements

Project Setup

Note: If you have already setup your Java test framework in your project, you can skip to the Features section.

Enable testing and adding test framework JARs to your project

Starting with Test Runner for Java version 0.34.0, you can enable a test framework for your unmanaged folder project (a project without any build tools) with just a few steps in the Testing Explorer:

Note: Currently this feature only supports unmanaged folders that do not contain any testing dependencies.

JUnit 4

Maven

Add following configuration into your pom.xml :

Gradle

Make sure following lines are added in your build.gradle :

Unmanaged folder

You can check the official JUnit Wiki for more information about how to setup JUnit 4.

JUnit 5

The JUnit 5 team provides a collection of sample projects with different build tools. Check the junit5-sample repository if your project uses Maven or Gradle as your build tool.

Unmanaged folder

TestNG

Maven

Add following configuration into your pom.xml :

Gradle

Make sure following lines are added in your build.gradle :

Unmanaged folder

Features

Run/Debug test cases

The Test Runner for Java extension will generate shortcuts (the green play button) on the left side of the class and method definition. To run the target test cases, select the green play button. You can also right-click on it to see more options.

Testing Explorer

The Testing Explorer is a tree view to show all the test cases in your workspace. You can select the beaker button on the left-side Activity bar of Visual Studio Code to open it. You can also run/debug your test cases and view their test results from there.

Customize test configurations

Currently the supported configurations are:

More details can be found on the vscode-java-test Wiki.

View test results

After running/debugging the test cases, the state of the related test items will be updated in both editor decorations and the Testing Explorer.

You can trigger the command Test: Peek Output to peek the results view. You can select the links in the stack trace to navigate to the source location.

Generate tests

If you trigger this source action from your main source code (test subject), you will be asked the test class’s fully qualified name and the methods you want to test. The extension will then generate the test code for you:

If you trigger the source action from your test source code, you will be asked which kinds of test methods you want to add. Including the lifecycle methods and the test method:

Test navigation

You can also find the command in the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) by searching for Java: Go to Test.

VS Code testing commands

There are other testing commands (for example, Run Tests in Current File) that can be found by searching for ‘Test:’ in the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ).

VS Code testing settings

There are VS Code settings specific to testing that can be found by searching for ‘testing’ in the Settings editor ( ⌘, (Windows, Linux Ctrl+, ) ).

If you meet any problem when using the extension, you can review the FAQ and our issue list to check if there is an answer to your problem.

Contributing and feedback

If you are interested in providing feedback or contributing directly to the code base, please read Contributing to Test Runner for Java, which covers the following:

Next steps

Read on to find out about:

Working with GUI applications in VS Code

You can develop Java GUI applications in Visual Studio Code easily. To achieve that, you need to install the Extension Pack for Java, which includes all the required extensions to develop Java GUI applications.

If you run into any issues when using the features below, you can contact us by entering an issue.

Develop JavaFX applications

Create a new JavaFX project

You can create a new JavaFX application with just a few steps in VS Code:

Run the JavaFX application

Note: The following guidance only works for projects managed by Maven.

More JavaFX examples

More JavaFX project examples can be found in the openjfx samples repository, which covers different project structures (such as Gradle and unmanaged folder projects). There is documentation on each sample to describe how to run the program.

Develop AWT applications

By default, the types from the Abstract Window Toolkit (AWT) are hidden. You may notice that code completions are not working when you are developing an AWT application. To enable completions, you can open the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) and then select the command Java: Help Center. Go to the Student section and select Enable AWT Development.

You can use the sample code below to run a simple Java AWT application in VS Code.

Develop Swing applications

Swing application development is supported by default. You can directly write your Swing application code without any setup.

You can find more Swing samples in the Oracle Swing documentation.

Visual studio code java

Java in Visual Studio Code

Install Visual Studio Code for Java

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.

If you have already installed VS Code and want to add Java support to it, we recommend using the Extension Pack for Java, a collection of extensions suggested by Microsoft:

Install the Extension Pack for Java

Alternatively, you can add Java language support to VS Code by installing the popular Java extensions by yourself.

There are also other popular Java extensions you can pick for your own needs, including:

Thanks to the great Java community around VS Code, the list doesn’t end there. You can search for more Java extensions easily within VS Code:

This document describes some of the key features included in those Java extensions.

NOTE: If you are using VS Code on Windows and want to take advantage of the Windows Subsystem for Linux, see Developing in WSL.

Install a Java Development Kit (JDK)

We recommend you to consider installing the JDK from one of these sources:

Note : If you have multiple JDKs installed and need to use a specific JDK version for your projects, see Configure Runtime for Projects. To enable Java preview features, see How can I use VS Code with new Java versions.

Open the Command Palette ( kb(workbench.action.showCommands) ) and type «java tips» to select the command.

Working with Java source files

Working with Java projects

There are three things you must understand to work with Java in VS Code:

VS Code Workspaces

A «folder workspace» is presented by VS Code when you open a filesystem folder (directory) in VS Code.

Java projects in VS Code

Visual Studio Code also supports working with standalone Java files outside of a Java project, described in the Getting Started with Java tutorial.

VS Code Workspaces that contain Java projects

More details about Java project support can be found in Java Project Management in Visual Studio Code and Java Build Tools.

For more details, see Java Code Navigation and Editing. VS Code also supports a range of Refactoring and Linting features.

Debugger for Java is a lightweight Java Debugger based on Java Debug Server. It works with Language Support for Java™ by Red Hat to allow users to debug Java code within Visual Studio Code.

With the support from the Test Runner for Java extension, you can easily run, debug, and manage your JUnit and TestNG test cases.

For more about testing, read Testing Java.

Spring Boot, Tomcat, and Jetty

To further improve your Java productivity in VS Code, there are extensions for most popular frameworks and tools, such as Spring Boot, Tomcat, and Jetty, created by the community.

See Application Servers to learn more about support for Tomcat and Jetty, as well as other application servers with VS Code.

Learn more about Java in VS Code:

Read on to find out more about Visual Studio Code:

Navigate and edit Java source code

Visual Studio Code is a source code editor first and foremost with rich editing features. In this document, we will go through a few Java-specific features, which are helpful when working with Java.

If you run into any issues when using the features below, you can contact us by entering an issue.

Code navigation

With the Outline view, you can conveniently navigate the members within the current file. Projects view also provide a great overview of your project. As a Java editor, it also supports Call Hierarchy, Type Hierarchy, Definition Navigation, Search Types in Workspace, etc.

Search for symbols

You can search for symbols in the current file or workspace to navigate your code more quickly.

Search for symbols in the workspace

Search for symbols in current file

To search for a symbol in the current file, use Quick Open ( ⌘P (Windows, Linux Ctrl+P ) ) then enter the ‘@’ command, then enter the name of the symbol you’re looking for. A list of potential matches will appear and be filtered as you type. Choose from the list of matches to navigate to its location.

Peek Definition

You can take a quick look at how a symbol was defined by using the Peek Definition feature. This feature displays a few lines of code near the definition inside a peek window, so you can take a look without navigating away from your current location.

Go to Definition

You can also quickly navigate to where a symbol is defined by using the Go to Definition feature.

Go to Super Implementation

You can keep track of class implementations and overriding methods by clicking the Go to Super Implementation link on hover.

Call Hierarchy

A Call Hierarchy view shows all calls from or to a function and allows you to drill into callers of callers and call of calls. Right-click on a function and select Peek > Peek Call Hierarchy.

You can also right-click in a function body and pick Show Call Hierarchy.

Type Hierarchy

A Type Hierarchy view shows the inheritance relationships between Java Objects. You can right-click on a type and pick Show Type Hierarchy.

Folding regions

Folding regions allows you to fold or unfold code snippet to better view the source code.

Smart Selection

With Smart Selection (semantic selection), you can expand or shrink the selection range based on the semantic information of the caret position in your source code.

Semantic Highlighting

Syntax highlighting is an important feature that allows you to read code more efficiently. With the help of Semantic Highlighting, VS Code can provide more accurate source code coloring based on symbol information from the Java language service.

Below is just one example, left is the behavior after enabling semantic highlighting and right is the one with only syntax highlighting.

You can learn more about the details of Java semantic highlighting on the Java Language Support extension wiki.

Navigating code with Spring Boot

The Spring Boot Tools extension provides enhanced navigation and code completion support for Spring Boot projects.

To learn more about Spring Boot support with Visual Studio Code, read Spring Boot in Visual Studio Code.

Code editing

Editing code is also easy with IntelliSense for smart code completions and signature details. You can use code snippets as well as various code actions such as generating Getters/Setters and organizing imports to further boost your productivity.

Java support in Visual Studio Code detects issues within your code automatically, and provides you with Quick Fix suggestions.

For more details about refactoring and code actions, see Refactoring and Source Actions.

IntelliSense

Code completion in Visual Studio Code for Java is provided by Language Support for Java™ by Red Hat. The extension is powered by the same Java development tools (JDT) behind Eclipse, so you can expect the same level of support.

In addition, there’s also AI-assisted IntelliSense called IntelliCode. It saves you time by putting what you’re most likely to use at the top of your completion list. IntelliCode recommendations are based on thousands of open-source projects on GitHub each with over 100 stars, so it’s trained on the most common usages from high-quality projects. When combined with the context of your code, the completion list is tailored to promote those practices. Here’s IntelliCode for Java in action.

IntelliCode works well with popular Java libraries and frameworks like Java SE and Spring. It will help you whether you are doing monolithic web apps or modern microservices.

Create new file

Code snippets

Visual Studio Code supports a wide range of popular Java code snippets to make you more productive, such as class/interface, syserr, sysout, if/else, try/catch, static main method. Using information from Java language server, it also provides a preview of the code snippet during the selection.

Managing Java Projects in VS Code

For details on how to get started with the extension pack, you can review the Getting Started with Java tutorial.

Projects view

The Java Projects view helps you view your Java projects and their dependencies, and provides entry points for project management tasks.

In the overflow button of the navigation bar, there are more options to use. For example, you can switch between hierarchical view and flat view.

You can find buttons next to the nodes in the Explorer, which provide useful shortcuts for some actions.

There are also many useful features in each node’s context menu, you can right-click on the node in Explorer to toggle it out.

Create a new Java project

Import Java projects

Export to JAR

Configure Runtime for Projects

Note: You can set one of them to default by adding «default»: true to the entry. The default JDK will be used for your unmanaged folders (with out build tools).

Change JDK for Maven and Gradle projects

Change JDK for unmanaged folders

To change the JDK for unmanaged folders (with out any build tools), you can click the button. It will list all the JDKs and you can select one for your unmanaged folders.

Download JDKs

Configure classpath for unmanaged folders

Dependency management

Add a Maven dependency

For Maven project, you can add a dependency by clicking the + icon next to Maven Dependencies node in project view.

Manage dependencies for unmanaged folder

If your project is an unmanaged folder without any build tools. You can manage the dependencies by clicking the + icon or the — icon on the Referenced Libraries node or the items under it.

You can also manage the dependencies in the classpath configuration page. See: Configure classpath for unmanaged folder

Include libraries

The libraries to reference are described using a set of glob patterns.

The referenced libraries are then watched by VS Code, and the project will be refreshed if there is a change to any of these dependent files.

Exclude some libraries

If you want to exclude some libraries from the project, you can expand java.project.referencedLibraries to use include/exclude fields and add an exclude glob pattern:

In the example above, any binary JAR files in the library/sources folder are ignored as the project’s external dependencies.

Attach source jars

By default, a referenced .jar will try to search -sources.jar under the same directory, and attach it as source if one match is found.

If you want to manually specify a JAR file as a source attachment, you can provide a key-value map in the sources field:

In this way, bar-src.jar is attached to bar.jar as its source.

Lightweight Mode

You can control which mode to launch with by configuring java.server.launchMode with the options below:

The language status item indicates which mode the current workspace is in using different icons.

Clicking the language status item switches to standard mode.

Build Status

Additional resources

There are several Visual Studio Code extensions to support different build systems for Java. Below are extensions for several popular build systems.

If you run into any problems when using the features above, you can contact us by filing an issue.

Next steps

Read on to find out more about:

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 entering an issue.

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.

Installing extensions

If you are an existing VS Code user, you can also add Java support by installing the Extension Pack for Java, which includes these extensions:

The Extension Pack for Java 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: Tips for Beginners from the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) to launch the guide.

You can also install extensions separately. The Extensions Guide is provided to help you. You can launch the guide with the Java: Extensions Guide command.

For this tutorial, the only required extensions are:

Installing and setting up a Java Development Kit (JDK)

To use Java within Visual Studio Code, you need to install a Java Development Kit (JDK) on your local environment. JDK is a software development environment used for developing Java applications.

Supported Java versions

The Extension Pack for Java supports Java version 1.5 or above.

Note: To configure JDKs for your projects, see Configure Runtime for Projects. To enable Java preview features, see How can I use VS Code with new Java versions.

Installing a Java Development Kit (JDK)

If you have never installed a JDK before and need to install one, we recommend you to choose from one of these sources:

Creating a source code file

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 option in the editor. After the code compiles, you can see all your variables and threads in the Run and Debug view.

The debugger also supports advanced features such as Hot Code Replace and conditional breakpoints.

For more information, see Java Debugging.

More features

The editor also has many more capabilities to assist with your Java workload.

Java Web Apps with Visual Studio Code

This tutorial shows you how to create a Java web application with Visual Studio Code. You’ll learn how to run, debug, and edit the Java web app locally and eventually on the cloud.

Scenario

A simple Spring Boot Getting Started web app

Before you begin

Before running and deploying this sample, you must have the Java SE Development Kit (JDK) and Apache Maven build tools on your local development environment. If you don’t have, please install them.

Download and install the Extension Pack for Java, which has JDK 11 included.

Note: The JAVA_HOME environment variable must be set to the install location of the JDK to complete this tutorial.

Download Apache Maven version 3 or greater:

Install Apache Maven for your local development environment:

Download and test the Spring Boot app

Note: You can install Visual Studio Code from https://code.visualstudio.com and Git from https://git-scm.com.

From within VS Code, open any of the Java files within the complete folder (for example src\main\java\hello\Application.java ). If you don’t have the Java language extensions installed for VS Code, you will be prompted to install the Microsoft Extension Pack for Java. Follow the instructions and reload VS Code after the installation.

You can learn more about how VS Code launches your application in Debugging Launch Configurations. Press F5 again to launch the debugger.

Test the web app by browsing to http://localhost:8080 using a web browser. You should see the following message displayed: «Greetings from Spring Boot!».

Make a change

Let’s now edit HelloController.java to change «Greetings from Spring Boot!» to something else like «Hello World». VS Code provides a great editing experience for Java, check out Navigating and edit Java to learn about VS Code’s editing and code navigation features.

Click the Restart button on the top of the editor to relaunch the app and see result by reloading the browser.

Debug the application

Set a breakpoint ( F9 ) in the application source code, and reload your browser to hit the breakpoint.

If you would like to learn more about debugging Java with VS Code, you can read Java Debugging.

Congratulations, you have your first Spring Boot web app running locally! Read on to learn how to host it in the cloud.

Deploy Web Apps to the cloud

We just built a Java web application and ran it locally. Now you will learn how to deploy from Visual Studio Code and run it on Azure in the cloud.

If you don’t have an Azure subscription, you can sign up for a free Azure account. Create your free Azure account

Install the Azure App Service extension

The Azure App Service extension is used to create, manage, and deploy to Azure App Service with key features including:

To install the Azure App Service extension, open the Extensions view ( ⇧⌘X (Windows, Linux Ctrl+Shift+X ) ) and search for azure app service to filter the results. Select the Microsoft Azure App Service extension. For a more command-line Maven-centric experience, you can also check out the Maven plugin for Azure App Service Linux tutorial.

Create a new Web App on Azure

Once the extension is installed, you can take the following steps to create a new Web App on Azure.

Build and deploy to a Web App

To sign in to Azure, run Azure: Sign In from the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ). You can then sign in to your account using the Device Login flow. Select Copy & Open to open your default browser.

Paste in the access code and continue the sign in process.

Once you have signed in, you can open the command prompt or terminal window and build the project using Maven commands. This will generate a new war or jar artifact in the target directory.

After building the project, open the target directory in VS Code Explorer. Right-click on the artifact and choose Deploy to Web App, and follow the prompts to choose the Web App for your deployment.

Open the Output window in VS Code to view the deployment logs. Once the deployment is completed, it will print out the URL for your Web App. Click the link to open it in a browser, you can see the web app running on Azure!

Note: For more advanced features of App Service, you can check out the Azure App Service extension.

Connect with data services

Azure Cosmos DB is a globally distributed database service that allows developers to work with data using a variety of standard APIs, such as SQL, MongoDB, Cassandra, Graph, and Table.

The Spring Boot Starter makes it easy to store data in and retrieve data from your Azure Cosmos DB with SQL API.

Create an Azure Cosmos DB entity on Azure

Config your project

Run and debug the application

You can press F5 to run your application. To check the result, open Azure portal and access your Cosmos DB. Click Data Explorer, and next choose Documents. You will see data being shown if it is successfully written into Cosmos DB. You can also browse your data entries in Cosmos DB with Azure Databases extension.

After setting a breakpoint ( F9 ) in your source code, refresh your browser to hit the breakpoint. Details about debugging can be found in Java Debugging

Alternatively, you can also use Maven to package and run your project as steps below:

Navigate to the directory azure-spring-boot and run the command.

Navigate to the directory azure-documentdb-spring-boot-sample and run the command.

Extension Pack for Java

Microsoft

Extension Pack for Java

Extension Pack for Java is a collection of popular extensions that can help write, test and debug Java applications in Visual Studio Code. Check out Java in VS Code to get started.

Extensions Included

By installing Extension Pack for Java, the following extensions are installed:

Other Recommendations

You can do more with VS Code. Here are some more recommendations that could help.

Spring

Spring Tools 4 (ST4) is also available in Visual Studio Code. It understands Spring so you can navigate Spring code at the level of beans, routes, etc. It can also show live information of the running Spring Boot applications. Check out the ST4 website to see a complete list of its features.

To use ST4, install 📦 Spring Boot Extension Pack. Please also check out the User Guide to make the most of it.

Eclipse MicroProfile

The 📦 Extension Pack for MicroProfile is a collection of extensions that can help develop your Java microservices using Eclipse MicroProfile. You can quickly generate a MicroProfile project and utilize development tools for runtimes such as Open Liberty and Quarkus.

Quarkus

📦 Quarkus Tools for Visual Studio Code is a feature-packed extension tailored for Quarkus application development within Visual Studio Code. You can quickly get started by using the extension’s project generation and project debugging feature. The extension also provides amazing language features (completion, hover, validation etc.) for your project’s application.properties file.

Containers and Microservices

You can use 📦 Docker extension to build docker images and work with image registries.

📦 Kubernetes extension provides an explorer view to manage clusters and the nodes inside. It also provides advanced syntax support for editing Kubernetes manifest files.

Tomcat and Jetty

Both 📦 Tomcat and 📦 Jetty extension are available. They provide dedicated views to help work with your favorite web servers.

Linting

The 📦 SonarLint extension lets you detect bugs and vulnerabilities as you write code in VS Code. The extension will simply run in the background and highlight code that poses a quality or security concern.

At the same time, 📦 CheckStyle is also available.

Questions & Issues

Each extension mentioned above is a separate open-source project and has its own repository. To make things easier, simply 🙋 open an issue in this repository. The new issue will be triaged and redirected.

Frequent Asked Questions

Thanks for your interest in Java on Visual Studio Code! This FAQ will hopefully answer some of the questions you may have.

Are these Java extensions open source?

Are there any other features coming to Java on Visual Studio Code?

Can I use keyboard shortcuts from other IDE?

Where can I find the latest progress of Java support on Visual Studio Code?

You can follow us on the Java at Microsoft blog, which will keep you updated on our progress.

How can I use Visual Studio Code with new Java versions?

Thanks to the upstream update from JDT, you can now build your project up to Java 14 with VS Code as well. To use the experimental/preview language features, you need to modify your project settings.

Note: If you are modifying a project that was already opened in VS Code, you may need to force clean the workspace and reload. To do so, run command Java: Clean Java Language Server Workspace.

How can I use it behind a corporate proxy?

This is done by configuring the java.jdt.ls.vmargs setting in VS Code preferences (all on one line):

Will this be available for Visual Studio?

Currently we don’t plan to extend the Java support to Visual Studio. There are already great IDEs for Java and we’re focusing on VS Code to provide a lightweight experience in a polyglot editor.

Does VS Code Java support other display languages?

You can contribute to the extension repositories if you’re interested in additional display language support.

How to troubleshoot and contribute to the Java Language Server

You can visit the Java for Visual Studio Code wiki to find answers regarding:

Как настроить Visual Studio Code для C, C++, Java, Python

Visual Studio Code — популярный редактор кода, бесплатный и с открытым исходным кодом. Но я уверен: каждый из нас, кто пытался настроить Visual Studio Code для разработки приложений на C++, Java или Python, прошел через стадию: “О Боже! Почему нельзя как-нибудь попроще?” Я сам пробовал настроить VS Code пару раз и в итоге закончил тем, что использовал CodeBlocks. 🙁

Прочитав много документации, посмотрев ряд роликов на YouTube и потратив несколько дней на саму настройку VS Code, я пишу эту статью, чтобы все это не пришлось проделывать уже вам!

Сегодня я покажу, как настроить среду разработки для спортивного программирования на C++, Java и Python в VS Code с нуля. Мы также посмотрим, какие расширения больше всего пригодятся, чтобы начать работу с VS Code. В конечном счете, ваша среда разработки будет выглядеть примерно так:

1. Устанавливаем Visual Studio Code

Скачайте последнюю версию Visual Studio Code с официального сайта. Рекомендуется загрузить системный установщик ( System Installer), но если у вас нет прав администратора, то пользовательский установщик ( User Installer) тоже подойдет. Выполните все обычные шаги по установке и обязательно проставьте все следующие чекбоксы:

Если у вас уже установлен VS Code, но вы все равно хотите начать с чистого листа, следуйте этим инструкциям, чтобы полностью удалить VS Code.

2. Настраиваем расширения

Ниже приведен список расширений, которые нам понадобятся для правильной настройки VS Code. Откройте VS Code и перейдите на панель расширений ( Ctrl + Shift + X), которая находится на левой панели инструментов, и начните загружать друг за другом следующие расширения:

Расширения, перечисленные ниже, необязательны для дальнейшей настройки, но я рекомендую вам обратить на них внимание, посмотреть, заинтересуют ли они вас, и если нет, то перейти к следующему разделу.

Чтобы выбрать тему, нажмите Ctrl + Shift + P. Откроется палитра команд. Осуществите поиск по слову “ theme” и выберите опцию Color Theme. Чтобы настроить иконки, можете выбрать опцию File Icon Theme.

Расширения для тех, кто интересуется FrontEnd-фреймворками для веб-разработки, такими как Angular и React:

3. Настраиваем внешний вид редактора

Итак, мы уже установили VS Code и несколько расширений. Теперь мы готовы настраивать среду разработки. Я создал шаблон для спортивного программирования в VS Code и загрузил его в свой профиль на Github.

Перейдите по этой ссылке и загрузите шаблон себе на компьютер. Распакуйте его в любое место по вашему выбору. После этого откройте получившуюся папку в VS Code. Вы должны увидеть что-то вроде этого:

Пройдитесь по файлам main.cpp, Main.java и main.py и посмотрите на записанный в них образец кода. По сути, шаблонный код, предоставленный в образцах для каждого из этих трех языков, принимает входящие данные из файла input.txt и обеспечивает вывод в файл output.txt. Для каждой программистской задачи, которую вы хотите решить, просто создайте копию этого шаблона и напишите свой код в функции solve().

Теперь создадим ту разбивку экрана, которую вы могли видеть на самом первом изображении в этой статье. Эта разбивка позволяет сразу видеть как ввод, так и вывод вашего кода, что делает ее очень удобной в использовании.

Готово! Мы настроили внешний вид редактора. А теперь давайте запускать код.

4. Запускаем код!

Для запуска нашего кода мы будем использовать расширение Code Runner, потому что ручная настройка VS Code для каждого языка — весьма сложная задача и потребует много затрат времени и сил.

Прежде чем использовать это расширение, нам нужно настроить его так, чтобы оно работало через терминал, иначе мы не сможем обеспечить консольный ввод нашего кода. Эти шаги очень важно проделать в точности:

Выполните следующие действия, чтобы добавить флаг:

Наконец-то всё настроено для запуска ваших программ на C++, Java и Python.

Откройте файл main.cpp. Нажмите правую кнопку мыши и выберите опцию Run Code. Попробуйте напечатать что-нибудь в функции solve(), чтобы проверить, происходит ли у вас вывод в файл output.txt или нет.

Следуйте той же процедуре с файлами Main.java и main.py. Расширение Code Runner возьмет на себя выполнение каждого из них.

Я надеюсь, что эта статья помогла вам настроить Visual Studio Code. Счастливого программирования!

Java on Azure Spring Apps

Note: Azure Spring Apps is the new name for the Azure Spring Cloud service.

This tutorial shows you how to create a Java web application with Visual Studio Code. You’ll learn how to run, debug, and edit the Java web app locally and then on a fully managed Microservices platform built for Java workloads: Azure Spring Apps.

Scenario

We will deploy a simple Spring Boot Getting Started web app to Azure Spring Apps.

Azure Spring Apps makes it easy to deploy Spring Boot microservice applications to Azure without any code changes. The service manages the infrastructure of Spring Apps applications so developers can focus on their code. Other benefits include:

Before you begin

Before running and deploying this sample, you must have the Java SE Development Kit (JDK) version 11 or above and Apache Maven build tools on your local development environment. If you don’t already have them, install these tools first.

Note: The JAVA_HOME environment variable must be set to the install location of the JDK to complete this tutorial.

Download Apache Maven version 3 or greater:

Install Apache Maven for your local development environment:

Download and test the Spring Boot app

Note: You can install Visual Studio Code from https://code.visualstudio.com and Git from https://git-scm.com.

You can learn more about how VS Code launches your application in Debugging Launch Configurations. Press F5 again to launch the debugger.

Test the web app by browsing to http://localhost:8080 using a web browser. You should see the following message displayed: «Greetings from Spring Boot!».

Make a change

Let’s now edit HelloController.java to change «Greetings from Spring Boot!» to something else like «Hello World». VS Code provides a great editing experience for Java, check out Editing and Navigating Code to learn about VS Code’s editing and code navigation features.

Select the Restart button on the top of the editor to relaunch the app and see result by reloading the browser.

Debug the application

Set a breakpoint ( F9 ) in the application source code, and reload your browser to hit the breakpoint.

If you would like to learn more about debugging Java with VS Code, you can read Java Debugging.

Congratulations, you have your first Spring Boot web app running locally! Read on to learn how to host it in the cloud.

Deploy to Azure Spring Apps

We just built a Java web application and ran it locally. Now you will learn how to deploy from Visual Studio Code and run it on Azure Spring Apps.

Install the Azure Spring Apps extension

The Azure Spring Apps extension is used to create, manage, and deploy to Azure Spring Apps with key features including:

To install the Azure Spring Apps extension, open the Extensions view ( ⇧⌘X (Windows, Linux Ctrl+Shift+X ) ) and search for azure spring apps to filter the results. Select the Microsoft Azure Spring Apps extension. For a command-line experience, you can also check out the Azure Spring Apps quickstart with Azure CLI.

Sign in to your Azure subscription

The deploy process uses the Azure Account extension (installed along with the Spring Cloud extension as a dependency) and you need to sign in with your Azure subscription.

If you don’t have an Azure subscription, you can sign up for a free Azure account.

Paste in the access code and continue the sign in process.

Create an app on Azure Spring Apps

Once you are signed in to your Azure account and you have your app open in Visual Studio Code, select the Azure icon in the Activity Bar to open the Azure Explorer and you will see the Azure Spring Apps panel.

Right-click on your subscription and select Create Service in Portal. Finish the following steps on the Azure Portal to create an Azure Spring Apps service instance.

After the service instance is created, refresh the Azure Explorer to display the new service instance. Right-click on the service instance and select Create App. Type the app name, select the Java version, and then press Enter to start creating. The app will be ready in a few minutes.

Build and deploy the app

You can open the command prompt or terminal window and build the project using Maven commands. The build will generate a new war or jar artifact in the target directory.

Right-click on the App in Azure Explorer, select Deploy, and pick your built Jar file when prompted.

You can watch the deployment status on the bottom right. Once done, select Access Public Endpoint to test the app running on Azure and Yes when prompted to assign a public endpoint. Be aware that only Spring Boot fat Jar is supported, learn more about apps on Azure Spring Apps.

Scale the app

You can easily scale the app by right-clicking on the Instance count under Scale Settings and selecting Edit. Type «2» and press Enter to scale the app.

Stream your application logs

Expand the App Instances node, right-click the instance you want to see logs, and select Start Streaming Logs.

The Visual Studio Code output window opens with a connection to the log stream.

Java refactoring and Source Actions

List of Supported Code Actions

Refactoring

The goal of the Java program refactoring is to make system-wide code changes without affecting behavior of the program. The Java Language Support for VS Code provides many easily accessible refactoring options.

Invoke refactoring

Refactoring commands are available from the context menu of the editor. Select the element you want to refactor, right-click to open the context menu, and choose Refactor. :

Then you will see all the available refactoring options.

Assign to variable

Assigns an expression to a local variable or a field.

Example

Before

After

It can also be used to assign a parameter to a new field for unused parameter(s) in a constructor.

Convert anonymous to nested class

Converts an anonymous inner class to a member class.

Example

Before

After

Convert to anonymous class creation

Converts lambda expression to anonymous class creation.

Example

The variable runnable is assigned with a lambda expression. Let’s convert it to an anonymous class creation.

Before

After

Convert to enhanced for loop

Converts the simple for loop to for-each style.

Example

Before

After

After the extraction, you can also perform a rename in the same transaction.

Inline constant

Replaces a constant reference with its defined value.

Examples

Before

After

Inline local variable

Replaces redundant variable usage with its initializer.

Examples

Let’s replace the variable isMac directly to the boolean expression.

Before

After

Inline method

Replaces calls to the method with the method’s body.

Example

Before

After

Invert conditions

Inverts the boolean expression in the conditions.

Example

Let’s invert the boolean expression in the if statement.

Before

After

Invert local variable

Inverts the local boolean variable.

Example

Before

After

Moves the selected elements and corrects all references to the elements (also in other files). Available actions are:

Example

Before

After

Move refactoring on a static method if it is used more in another class than in its own class.

Move a class to another package. Currently, move refactoring is not supported from the File Explorer.

Move an inner class to new a new file.

Rename

Default shortcut: F2

Renames the selected element and corrects all references to the elements (also in other files).

Example

Let’s rename the class Foo to Bar

Before

After

Rename refactoring is also supported from the File Explorer for folders and files. After requesting the change, a preview of impacted files will be provided and you can decide how to apply those changes.

Change resolved type to var type

Uses var to declare local variables.

Example

Before

After

Change var type to resolved type

Uses the resolved type to declare local variables.

Example

Before

After

Source Actions

Source Actions could be used to generate common code structures and recurring elements. Some of them are Quick Fixes that help you fix code issues on the fly.

Generate constructors

Add a constructor for the class.

Generate delegate methods

Override/implement methods

With this Source Action, all the candidates are presented to you with a checklist. You can then decide what to override or implement.

Organize imports

You can use this Source Action to clean up your imports. It can also deal with ambiguous imports, in that case, a dropdown list will be presented for you to pick the right one. The code line with the unresolved type is also presented to you to help you decide.

Generate getters and setters

You can bulk generate getters and setters for all new member variables. If the class has more than one field, the Source Action will prompt a Quick Pick for you to select the target fields to use to generate the accessor methods.

Generate hashCode() and equals()

hashCode() and equals() can be generated with default implementations. All the non-static member variables are listed, and you can customize the generated code using the check list.

There are two options for you to customize the generated code:

Generate toString()

There is a new Source Action to generate the toString() method. Customization is possible with a check list of all the member variables.

Change modifiers to final where possible

Adds final modifier to all the variables and parameters in the current source file.

Example

Before

After

Fix non-accessible reference

This Quick Fix helps you fix non-accessible reference.

Create non-existing package

When your package name doesn’t match the folder name, you have the options to either change the package name in your source code, or move the folder in the file system (even when the destination folder doesn’t exist yet).

Other Code Actions supported

The list of Code Actions supported by VS Code keeps growing and only listed the most popular ones above. Other notable supported actions include (but not limited to):

Java on Visual Studio Code Update – November 2020

Welcome to the update of Java on Visual Studio Code for November. In this update, we are excited to announce a new wizard for Java runtime configuration. Back to September, we published a blog clarifying: 1) Java 11 as minimum version of JDK is only required for running VS Code for Java; 2) VS Code continuously supports projects with JDK version 1.5 or above. In that blog, we also shared how to configure JDKs for your project and for running VS Code for Java respectively, which requires you to manually configure two settings in ‘settings.json’ file. Although the manual approach works, we are aware that improvements in overall experience are still needed, which results in the implementation of Java Runtime Configuration Wizard.

Java Runtime Configuration Wizard

Java runtime configuration wizard is part of Java Extension Pack. Make sure you have the extension pack installed. As a side note, we strongly recommend installing the extension pack or Coding Pack for Java for your Java development on VS Code. For details, please check here.

Load project into workspace

Click menu: Files->Open Folder… or Files->Open Workspace… to load project into workspace. When you see a thumbs up icon on status bar, your project is loaded.

Open the wizard

Ctrl+Shift+P to launch command palette and then use command “Java: Configure Java Runtime” to launch the wizard.

Configure project JDK

Project JDKs tab on the wizard configures JDK for project. When your project uses Maven or Gradle, WorkSpace Overview lists the language version set by the build tool; Maven/Gradle Projects lists all eligible JDKs installed in your environment per the language version and also allows you to specify a JDK for your project.

Configure JDK for running VS Code for Java

Java Tooling Runtime tab allows you to specify runtime to run VS Code’s Java language tools, a.k.a. the Java Language Server. The tab only lists Java 11 or above JDKs installed in your environment, as required by the language server. Please, remember to reload VS Code to make change effective.

Install JDK

Installed JDKs tab lists all JDKs in your environment found by the wizard.

To facilitate installing new JDK when needed, Install A JDK section offers multiple options.

Other Enhancements

Automatically infer selection range from cursor position

Language Support for Java(TM) by Red Hat is able to infer selection range from cursor position now. As a result, expressions can be extracted and proposed by VS Code automatically for refactoring.

Support exporting JAR through custom task

Project manager for Java now supports exporting JAR through custom task, which allows you to have fine-grained control on how JAR can be exported for your project.

You can configure custom task by clicking menu: Terminal->Configure Tasks… and then selecting the exporting JAR task for your project. You can run custom task by clicking menu: Terminal->Run Task…, selecting Java, and then selecting the exporting JAR task.

Try it out

Please don’t hesitate to give it a try! Your feedback and suggestions are very important to us and will help shape our product in future.

redhat-developer/vscode-java

Use Git or checkout with SVN using the web URL.

Work fast with our official CLI. Learn more.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.md

Language support for Java ™ for Visual Studio Code

Provides Java ™ language support via Eclipse ™ JDT Language Server, which utilizes Eclipse ™ JDT, M2Eclipse and Buildship.

To launch and debug your Java programs, it’s recommended you install Java Debug Extension for Visual Studio Code.

See the changelog for the latest release. You might also find useful information in the project Wiki.

Setting the JDK

Java Tooling JDK

The following part is only kept for the universal version without embedded JRE.

The tooling JDK will be used to launch the Language Server for Java. And by default, will also be used to compile your projects.

The path to the Java Development Kit can be specified by the java.jdt.ls.java.home setting in VS Code settings (workspace/user settings). If not specified, it is searched in the following order until a JDK meets current minimum requirement.

If you need to compile your projects against a different JDK version, it’s recommended you configure the java.configuration.runtimes property in your user settings, eg:

The default runtime will be used when you open standalone Java files.

The following commands are available:

Supported VS Code settings

The following settings are supported:

java.home : Deprecated, please use ‘java.jdt.ls.java.home’ instead. Absolute path to JDK home folder used to launch the Java Language Server. Requires VS Code restart.

java.jdt.ls.vmargs : Extra VM arguments used to launch the Java Language Server. Requires VS Code restart.

java.trace.server : Traces the communication between VS Code and the Java language server.

java.configuration.updateBuildConfiguration : Specifies how modifications on build files update the Java classpath/configuration. Supported values are disabled (nothing happens), interactive (asks about updating on every modification), automatic (updating is automatically triggered).

java.configuration.maven.userSettings : Path to Maven’s user settings.xml.

java.referencesCodeLens.enabled : Enable/disable the references code lenses.

java.implementationsCodeLens.enabled : Enable/disable the implementations code lenses.

java.signatureHelp.enabled : Enable/disable signature help support (triggered on ( ).

java.contentProvider.preferred : Preferred content provider (see 3rd party decompilers available in vscode-java-decompiler).

java.import.gradle.enabled : Enable/disable the Gradle importer.

Specify the Gradle distribution used by the Java extension:

java.import.gradle.arguments : Arguments to pass to Gradle.

java.import.gradle.jvmArguments : JVM arguments to pass to Gradle.

java.import.gradle.user.home : setting for GRADLE_USER_HOME.

java.import.maven.enabled : Enable/disable the Maven importer.

java.autobuild.enabled : Enable/disable the ‘auto build’.

java.maxConcurrentBuilds : Set max simultaneous project builds.

java.completion.enabled : Enable/disable code completion support.

java.completion.guessMethodArguments : When set to true, method arguments are guessed when a method is selected from as list of code assist proposals.

java.completion.filteredTypes : Defines the type filters. All types whose fully qualified name matches the selected filter strings will be ignored in content assist or quick fix proposals and when organizing imports. For example ‘java.awt.*’ will hide all types from the awt packages.

java.completion.favoriteStaticMembers : Defines a list of static members or types with static members.

java.completion.importOrder : Defines the sorting order of import statements.

java.progressReports.enabled : [Experimental] Enable/disable progress reports from background processes on the server.

java.format.enabled : Enable/disable the default Java formatter.

java.format.settings.url : Specifies the url or file path to the Eclipse formatter xml settings.

java.format.settings.profile : Optional formatter profile name from the Eclipse formatter settings.

java.format.comments.enabled : Includes the comments during code formatting.

java.foldingRange.enabled : Enable/disable smart folding range support. If disabled, it will use the default indentation-based folding range provided by VS Code.

java.maven.downloadSources : Enable/disable download of Maven source artifacts as part of importing Maven projects.

java.selectionRange.enabled : Enable/disable Smart Selection support for Java. Disabling this option will not affect the VS Code built-in word-based and bracket-based smart selection.

java.project.outputPath : A relative path to the workspace where stores the compiled output. Only effective in the WORKSPACE scope. The setting will NOT affect Maven or Gradle project.

java.project.referencedLibraries : Configure glob patterns for referencing local libraries to a Java project.

java.completion.maxResults : Maximum number of completion results (not including snippets). 0 (the default value) disables the limit, all results are returned. In case of performance problems, consider setting a sensible limit..

java.configuration.runtimes : Map Java Execution Environments to local JDKs.

java.sources.organizeImports.starThreshold : Specifies the number of imports added before a star-import declaration is used, default is 99.

java.sources.organizeImports.staticStarThreshold : Specifies the number of static imports added before a star-import declaration is used, default is 99.

java.imports.gradle.wrapper.checksums : Defines allowed/disallowed SHA-256 checksums of Gradle Wrappers.

java.import.gradle.java.home : Specifies the location to the JVM used to run the Gradle daemon.

java.project.resourceFilters : Excludes files and folders from being refreshed by the Java Language Server, which can improve the overall performance. For example, [«node_modules»,».git»] will exclude all files and folders named ‘node_modules’ or ‘.git’. Defaults to [«node_modules»,».git»].

java.references.includeAccessors : Include getter, setter and builder/constructor when finding references. Default to true.

java.configuration.maven.globalSettings : Path to Maven’s global settings.xml.

java.eclipse.downloadSources : Enable/disable download of Maven source artifacts for Eclipse projects.

java.recommendations.dependency.analytics.show : Show the recommended Dependency Analytics extension.

java.references.includeDecompiledSources : Include the decompiled sources when finding references. Default to true.

java.project.sourcePaths : Relative paths to the workspace where stores the source files. Only effective in the WORKSPACE scope. The setting will NOT affect Maven or Gradle project.

java.typeHierarchy.lazyLoad : Enable/disable lazy loading the content in type hierarchy. Lazy loading could save a lot of loading time but every type should be expanded manually to load its content.

java.settings.url : Specifies the url or file path to the workspace Java settings. See Setting Global Preferences

java.quickfix.showAt : Show quickfixes at the problem or line level.

java.configuration.workspaceCacheLimit : The number of days (if enabled) to keep unused workspace cache data. Beyond this limit, cached workspace data may be removed.

Semantic Highlighting fixes numerous syntax highlighting issues with the default Java Textmate grammar. However, you might experience a few minor issues, particularly a delay when it kicks in, as it needs to be computed by the Java Language server, when opening a new file or when typing. Semantic highlighting can be disabled for all languages using the editor.semanticHighlighting.enabled setting, or for Java only using language-specific editor settings.

Read the troubleshooting guide for collecting informations about issues you might encounter.

Report any problems you face to the project.

This is an open source project open to anyone. Contributions are extremely welcome!

For information on getting started, refer to the CONTRIBUTING instructions.

Also, you can contribute your own VSCode extension to enhance the existing features by following the instructions here.

Java in Visual Studio Code

Overview

Install Visual Studio Code for Java

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.

If you have already installed VS Code and want to add Java support to it, we recommend using the Extension Pack for Java, a collection of extensions suggested by Microsoft:

Alternatively, you can add Java language support to VS Code by installing the popular Java extensions by yourself.

There are also other popular Java extensions you can pick for your own needs, including:

Thanks to the great Java community around VS Code, the list doesn’t end there. You can search for more Java extensions easily within VS Code:

This document describes some of the key features included in those Java extensions.

Getting started

NOTE: If you are using VS Code on Windows and want to take advantage of the Windows Subsystem for Linux, see Developing in WSL.

Install a Java Development Kit (JDK)

We recommend you to consider installing the JDK from one of these sources:

Note: If you have multiple JDKs installed and need to use a specific JDK version for your projects, see Configure Runtime for Projects. To enable Java preview features, see How can I use VS Code with new Java versions.

Open the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) and type «java tips» to select the command.

Working with Java source files

Working with Java projects

There are three things you must understand to work with Java in VS Code:

VS Code Workspaces

A «folder workspace» is presented by VS Code when you open a filesystem folder (directory) in VS Code.

Java projects in VS Code

Visual Studio Code also supports working with standalone Java files outside of a Java project, described in the Getting Started with Java tutorial.

VS Code Workspaces that contain Java projects

More details about Java project support can be found in Java Project Management in Visual Studio Code and Java Build Tools.

Editing

Code Navigation

Code Completion

For more details, see Java Code Navigation and Editing. VS Code also supports a range of Refactoring and Linting features.

Debugging

Debugger for Java is a lightweight Java Debugger based on Java Debug Server. It works with Language Support for Java™ by Red Hat to allow users to debug Java code within Visual Studio Code.

Testing

With the support from the Test Runner for Java extension, you can easily run, debug, and manage your JUnit and TestNG test cases.

For more about testing, read Testing Java.

Spring Boot, Tomcat, and Jetty

To further improve your Java productivity in VS Code, there are extensions for most popular frameworks and tools, such as Spring Boot, Tomcat, and Jetty, created by the community.

See Application Servers to learn more about support for Tomcat and Jetty, as well as other application servers with VS Code.

Next steps

Learn more about Java in VS Code:

Read on to find out more about Visual Studio Code:

Using VS Code to Debug Java Applications

September 28, 2017 Xiaokai He

For Java developers on Visual Studio Code, the Language Support for Java™ by Red Hat extension has been great for providing language features such as IntelliSense and project support. At the same time, we’ve also heard feedback that users would also like Java debugging. Today, we’re excited to announce our ongoing collaboration with Red Hat and enabling Java developers to debug Java applications with a new lightweight Debugger for Java based on Java Debug Server.

To help Java developers to get started with VS Code quickly, we also created an Extension Pack for Java which includes both the Language Support for Java™ by Red Hat and Debugger for Java extensions so you won’t need to search for them individually. This is just the start to creating a modern workflow for Java and we’ll be adding more features and extensions to the Extension Pack for Java in the future.

Getting started

You also install the Extension Pack for Java directly from this blog post:

After reloading VS Code, open a folder that contains a Java project and follow below steps:

Supported features

In this release, we support the following features:

Next Steps

Feedback

Please share your feedback and ask questions to help us improve. You can contact us on Gitter.

Spring Boot in Visual Studio Code

Visual Studio Code is an ideal lightweight development environment for Spring Boot application developers and there are several useful VS Code extensions including:

We recommend installing the Spring Boot Extension Pack that includes all of the extensions above.

If you run into any issues when using the features below, you can contact us by opening an issue.

Prerequisites

To develop a Spring Boot application in Visual Studio Code, you need to install the following:

Note: More information about how to get started can be found at Getting Started with Java tutorial.

Create the project

The Spring Initializr extension allows you to search for dependencies and generate new Spring Boot projects.

Once you have the extension installed, open the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) and type Spring Initializr to start generating a Maven or Gradle project and then follow the wizard.

Edit the project

The Spring Initializr extension allows you to add dependencies after generating a new Spring Boot project.

Develop the application

The extension supports the following features:

To learn how to use these features, you can visit this detailed usage guide.

Below is an example showing live application information.

Run the application

In addition to using F5 to run your application, there’s the Spring Boot Dashboard extension, which lets you view and manage all available Spring Boot projects in your workspace as well as quickly start, stop, or debug your project.

Develop Java Service Fabric applications with Visual Studio Code

The Service Fabric Reliable Services extension for VS Code makes it easy to build Java Service Fabric applications on Windows, Linux, and macOS operating systems.

This article shows you how to build, deploy, and debug a Java Service Fabric application using Visual Studio Code.

Service Fabric Java applications can be developed on Windows machines, but can be deployed onto Azure Linux clusters only. Debugging Java applications is not supported on Windows.

Prerequisites

This article assumes that you have already installed VS Code, the Service Fabric Reliable Services extension for VS Code, and any dependencies required for your development environment. To learn more, see Getting Started.

Download the sample

To clone the repository to your development machine, run the following command from a terminal window (command window on Windows):

Open the application in VS Code

Build the application

Press (Ctrl + Shift + p) to open the Command Palette in VS Code.

Search for and select the Service Fabric: Build Application command. The build output is sent to the integrated terminal.

Deploy the application to the local cluster

After you have built the application, you can deploy it to the local cluster.

Deploying Java applications to the local cluster is not supported on Windows machines.

From the Command Palette, select the Service Fabric: Deploy Application (Localhost) command. The output of the install process is sent to the integrated terminal.

To remove the application from the cluster, select the Service Fabric: Remove Application command from the Command Palette. The output of the uninstall process is sent to the integrated terminal. You can use Service Fabric Explorer to verify that the application has been removed from the local cluster.

Debug the application

When debugging applications in VS Code, the application must be running on a local cluster. Breakpoints can then be added to the code.

Debugging Java applications is not supported on Windows machines.

To prepare the VotingDataService and the Voting application for debugging, complete the following steps:

Update the Voting/VotingApplication/VotingDataServicePkg/Code/entryPoint.sh file. Comment out the command on line 6 (use ‘#’) and add the following command to the bottom of the file:

Update the Voting/VotingApplication/ApplicationManifest.xml file. Set the MinReplicaSetSize and the TargetReplicaSetSize attributes to «1» in the StatefulService element:

Click the Debug icon in the Activity Bar to open the debugger view in VS Code. Click the gear icon at the top of the debugger view and select Java from the dropdown environment menu. The launch.json file opens.

In the launch.json file, set the port value in the configuration named Debug (Attach) to 8001. Save the file.

Deploy the application to the local cluster by using the Service Fabric: Deploy Application (Localhost) command. Verify that the application is running in Service Fabric Explorer. Your application is now ready to be debugged.

To set a breakpoint, complete the following steps:

In Explorer, open the /Voting/VotingDataService/src/statefulservice/VotingDataService.java file. Set a breakpoint on first line of code in the try block in the addItem method (line 80).

Make sure you set breakpoints on executable lines of code. For example breakpoints set on method declarations, try statements, or catch statements will be missed by the debugger.

To begin debugging, click the Debug icon in the Activity Bar, select the Debug (Attach) configuration from the debug menu, and click the run button (green arrow).

To end the debugging session, click the plug icon on the Debug toolbar at the top of VS Code.

When you’ve finished debugging, you can use the Service Fabric: Remove Application command to remove the Voting application from your local cluster.

Getting Started with Java in VS Code

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 entering an issue.

Setting up VS Code for Java development

Coding Pack for Java

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.

Installing extensions

If you are an existing VS Code user, you can also add Java support by installing the Extension Pack for Java, which includes these extensions:

You can also install extensions separately. The Extensions Guide is provided to help you. You can launch the guide with the Java: Extensions Guide command.

For this tutorial, the only required extensions are:

Installing and setting up a Java Development Kit (JDK)

To use Java within Visual Studio Code, you need to install a Java Development Kit (JDK) on your local environment. JDK is a software development environment used for developing Java applications.

Supported Java versions

The Extension Pack for Java supports Java version 1.5 or above.

Note: To configure JDKs for your projects, see Configure Runtime for Projects. To enable Java preview features, see How can I use VS Code with new Java versions.

Installing a Java Development Kit (JDK)

If you have never installed a JDK before and need to install one, we recommend you to choose from one of these sources:

Creating a source code file

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.

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

The debugger also supports advanced features such as Hot Code Replace and conditional breakpoints.

For more information, see Java Debugging.

More features

The editor also has many more capabilities to assist with your Java workload.

Java on Visual Studio Code Update – September 2020

Welcome to Java on Visual Studio Code Update. In September, we launched a new VS Code installer called Coding Pack for Java. In this edition, we would like to focus on best practices of setting development environment. Regardless of whether you just want to explore or have already been using VS Code for projects or studies, we believe you all will benefit from these practices. Let’s start.

Your development environment

When use VS Code, the first thing you have to know is what your development environment consists of. For Java development, your environment consists of VS Code, extensions, and JDK. While VS Code provides you the best in class editing experience, more features are offered through extensions, for example, code completion, debugging, testing, building, project management, etc. VS Code has a broad ecosystem, where you can find all kinds of extensions to meet your specific needs. You can visit VS Code Marketplace to explore further.

Coding Pack for Java

To use VS Code for Java development, a very first thing is to set up your environment. Best practice #1: using Coding Pack for Java, if on Windows or MacOS, when set up for first time, upgrade, or even repair an existing environment. The pack will install VS Code, AdoptOpenJDK and Extension Pack, a collection of essential extensions recommended by Microsoft, and also configure them automatically. When installation completes, you immediately have an integrated environment for your Java projects. The pack supports incremental updates by checking your environment firstly and only installs required pieces.

The pack won’t modify your existing project setting, so you don’t have to worry using it will break your existing projects.

Configuring JDK

There are two JDK concepts involved in your development environment, JDK to run VS Code for Java (boot JDK) and JDK to build your project (project JDK). In VS Code, you can configure them separately. While boot JDK requires Java 11 or above version, project JDK supports any major version above Java 1.5. If Coding Pack is used, setting boot JDK has already been taken care by it.

Best practice #2: if encounter a JDK issue for running VS Code for Java, always checking VS Code setting: “java.home” to make sure it points to a JDK with Java 11 or above version. You can access the setting by clicking menu “File->Preferences->Settings”, searching “java.home” on “User” tab, and then opening the setting.

Best practice #3: configuring your project JDK using VS Code setting: “java.configuration.runtimes”. You can access the setting by clicking menu “File->Preferences->Settings”, searching “java.configuration.runtimes” on “User” tab, and then opening the setting. You can set multiple JDK versions, and VS Code will pick the best version per your default or project’s source level. For more details on how to set, please refer to Configure JDK.

Extension Pack

If you are on Linux or just want to manually install VS Code, JDK and extensions instead of using Coding Pack for Java, best practice #4: installing Extension Pack instead of installing extensions individually. You can find Extension Pack from VS Code Marketplace by searching “Java extension pack”, or when you first time open a “.java” file using VS Code, there will be a pop up message on bottom right corner of window for you to accept installing Extension Pack.

Extension Guide

There are wide variety of extensions for VS Code. If you want to quickly extend your environment beyond Extension Pack, such as adding more framework support, application server support, or utility functions, best practice #5: leveraging Extension Guide. The guide provides you a wizard like experience for recommending and installing extension per your specific needs. You can launch the guide by clicking menu “View->Command Palette…” and then type “Java: Extension Guide” in the palette.

More to know

If you have followed our advices, a clean and properly set environment is already there at your disposal. If not yet, you can always come back to use them to upgrade or repair your environment. Here, we would like to share a couple of additional notes before you dive into your projects.

Try it out

Please don’t hesitate to give it a try! Your feedback and suggestions are very important to us and will help shape our product in future.

Краткое руководство. Создание функции Java в Azure с помощью Visual Studio Code

Из этой статьи вы узнаете, как создать функцию Java, которая отвечает на HTTP-запросы, используя Visual Studio Code. После тестирования кода в локальной среде его необходимо развернуть в бессерверной среде Функций Azure.

Если вы не хотите использовать Visual Studio Code в качестве средства разработки, ознакомьтесь с аналогичными руководствами для разработчиков Java:

Выполнение этого краткого руководства предполагает небольшую дополнительную плату в несколько центов США в учетной записи Azure.

Настройка среды

Перед началом работы убедитесь, что выполнены следующие предварительные требования.

Учетная запись Azure с активной подпиской. Создайте учетную запись бесплатно.

Apache Maven 3.0 или более поздней версии.

Создание локального проекта

В этом разделе показано, как использовать Visual Studio Code, чтобы создать локальный проект Функций Azure на Java. Далее в этой статье вы опубликуете код функции в Azure.

Щелкните значок Azure на панели действий. Затем в области Рабочая область (локальная) нажмите кнопку + и выберите пункт Создать функцию в раскрывающемся списке. В ответ на запрос выберите вариант Создать проект.

Выберите расположение каталога для рабочей области проекта и нажмите кнопку Выбрать. Нужно либо создать новую папку, либо выбрать пустую папку для рабочей области проекта. Не выбирайте папку проекта, которая является частью рабочей области.

Введите следующие сведения по соответствующим запросам:

Используя эти сведения, Visual Studio Code создает проект функций Azure с триггером HTTP. Файлы локального проекта можно просмотреть в Explorer. Дополнительные сведения о созданных файлах см. в разделе Созданные файлы проекта.

Локальное выполнение функции

Visual Studio Code интегрируется с Azure Functions Core Tools, чтобы перед публикацией в Azure можно было запустить этот проект на локальном компьютере разработки.

Чтобы запустить функцию локально, нажмите клавишу F5 или щелкните значок воспроизведения. На панели Терминал отобразятся выходные данные из Core Tools. Ваше приложение запускается в панели Терминал. Отобразится URL-адрес конечной точки активируемой HTTP-запросом функции, которая выполняется локально.

При возникновении проблем с запуском в Windows убедитесь, что в качестве терминала по умолчанию для Visual Studio Code не используется оболочка WSL.

В поле Ввести текст запроса вы увидите значение текста запроса < "name": "Azure" >. Нажмите клавишу ВВОД, чтобы отправить это сообщение запроса в свою функцию.

При выполнении функции локально и возврате ответа в Visual Studio Code отобразится уведомление. Сведения о выполнении функции отображаются на панели Терминал.

Убедившись, что функция выполняется правильно на локальном компьютере, опубликуйте проект в Azure с помощью Visual Studio Code.

Вход в Azure

Прежде чем публиковать приложение, необходимо войти в Azure.

При появлении запроса в браузере выберите учетную запись Azure и войдите в нее с помощью учетных данных. Если вы создаете новую учетную запись, вы можете выполнить вход после ее создания.

Выполнив вход, можно закрыть новое окно браузера. Подписки, принадлежащие учетной записи Azure, отображаются на боковой панели.

Создание приложения-функции в Azure

В этом разделе показано, как создать приложение-функцию и связанные ресурсы в подписке Azure.

Щелкните значок Azure на панели действий. Затем в области Ресурсы щелкните значок + и выберите вариант Создать приложение-функцию в Azure.

Введите следующие сведения по соответствующим запросам:

prompt	Выбор
Выбор подписки	Выберите подписку, которую нужно использовать. Эта подсказка не отобразится, если в области Ресурсы отображается только одна подписка.
Ввод глобально уникального имени для приложения-функции	Введите имя, допустимое в пути URL-адреса. Имя, которое вы вводите, проверяется, чтобы убедиться, что оно уникально в функциях Azure.
Выбор стека среды выполнения	Выберите версию языка, которая запускалась локально.
Выбор расположения для новых ресурсов	Для повышения производительности выберите регион рядом с вами.

Расширение показывает на панели Azure: журнал действий состояние отдельных ресурсов по мере их создания в Azure.

После завершения создания в вашей подписке будут созданы приведенные ниже ресурсы Azure. Имена ресурсов основаны на имени приложения-функции.

После создания приложения-функции и применения пакета развертывания отобразится уведомление.

По умолчанию ресурсы Azure, необходимые для приложения функции, создаются на основе указанного имени приложения функции. По умолчанию они также создаются в той же новой группе ресурсов, что и приложение-функция. Если необходимо настроить имена этих ресурсов или повторно использовать существующие ресурсы, вам нужно опубликовать проект с дополнительными параметрами создания.

Развертывание проекта в Azure

Развертывание в существующем приложении-функции всегда перезаписывает содержимое этого приложения в Azure.

После завершения развертывания выберите Просмотреть выходные данные, чтобы просмотреть результаты создания и развертывания, включая созданные ресурсы Azure. Если вы пропустили уведомление, щелкните значок колокольчика в правом нижнем углу, чтобы снова просмотреть его.

Запуск функции в Azure

При выполнении функции в Azure и возврате ответа в Visual Studio Code отобразится уведомление.

Очистка ресурсов

При переходе к следующему шагу и добавлении привязки очереди службы хранилища Azure к функции, вам потребуется сохранить все ресурсы, чтобы использовать их в будущем.

В противном случае выполните следующие действия, чтобы удалить приложение-функцию и связанные с ним ресурсы и избежать дополнительных расходов.

На вкладке Обзор выберите именованную ссылку рядом с полем Группа ресурсов.

На странице Группа ресурсов просмотрите список включенных ресурсов и убедитесь, что именно их нужно удалить.

На странице Resource group (Группа ресурсов) просмотрите список включенных ресурсов и убедитесь, что именно их требуется удалить.

Выберите Удалить группу ресурсов и следуйте инструкциям.

Удаление может занять несколько минут. После этого на несколько секунд появится уведомление. Кроме того, можно выбрать значок колокольчика в верхней части страницы, чтобы просмотреть уведомление.

Дополнительные сведения о затратах на использование Функций см. в статье Оценка затрат на план потребления.

Дальнейшие действия

С помощью Visual Studio Code вы создали приложение-функцию с простой функцией, активируемой HTTP-запросом. В следующей статье показано, как расширить эту функцию путем подключения к службе хранилища Azure. Дополнительные сведения о подключении к другим службам Azure см. в статье Подключение функций к службам Azure с помощью привязок.

Language Support for Java(TM) by Red Hat

Red Hat

Language support for Java ™ for Visual Studio Code

Provides Java ™ language support via Eclipse ™ JDT Language Server, which utilizes Eclipse ™ JDT, M2Eclipse and Buildship.

Quick Start

Features

To launch and debug your Java programs, it’s recommended you install Java Debug Extension for Visual Studio Code.

See the changelog for the latest release. You might also find useful information in the project Wiki.

Setting the JDK

Java Tooling JDK

The following part is only kept for the universal version without embedded JRE.

The tooling JDK will be used to launch the Language Server for Java. And by default, will also be used to compile your projects.

Project JDKs

If you need to compile your projects against a different JDK version, it’s recommended you configure the java.configuration.runtimes property in your user settings, eg:

The default runtime will be used when you open standalone Java files.

Available commands