oracle / javavscode

Java platform support for Visual Studio Code for full featured Java development (edit-compile-debug & test cycle)
Apache License 2.0
183 stars 9 forks source link
java language-server-protocol oracle vscode-extension

Oracle Java Platform Extension for Visual Studio Code

Visual Studio Marketplace Installs Build Status License

The Oracle Java Platform extension brings full featured Java development (edit-compile-debug & test cycle) for Maven and Gradle projects to VS Code, and is available on the Visual Studio Marketplace.

Getting Started

  1. Set JDK in View | Command Palette | Preferences:Open User Settings (JSON) ... jdk: Jdkhome setting to point to JDK which Language Server will run on and projects will be compiled with. More below in section Selecting the JDK
  2. If no JDK is present in your system then extension can setup things for you. More below in section JDK Downloader
  3. Use Java: New Project... " command to start creating new project, or
  4. Open the folder with existing pom.xml for Maven or Gradle project files (build.gradle, gradle.properties). Language Server opens the project, resolves dependencies if any and performs priming build, or
  5. Simply create a new Java class file with public static void main(String[] args) method in opened folder and start coding, compiling, debugging. Works on JDK 11 and newer.

Supported Actions

In the VS Code command palette :

Project Explorer

Project Explorer provides an overview of logical project structure, groups sources together and greatly simplifies Java package structure exploration. Project Explorer is an addition to the classical workspace explorer. Use it to build, test, execute and operate your Maven and Gradle Java projects.
Project Explorer

Debugger and Launch Configurations

Language Server Java+ ... launch configuration supports debugging and running Java applications using JDK11 or newer.

  1. The launch configuration (debugger) is invoked when Run main | Debug main code lense is selected in the code.
  2. Or Java+... is selected in Run and Debug activity panel.
    Debug configurations

    Launch Configurations

    • Launch Java App - Debug or Run current Java project
    • Attach to Port & Attach to Process - Attach debugger actions. Available when Java+ ... at the bottom of drop down list is selected.
    • Select this configuration, then click the Run
    • Select either from available process or enter the port to connect to JVM running with JDWP.
    • Attach to Shared Memory is available on Windows in addtion to above mentioned Attach...

Default launch configurations provided by Language Server can modified in launch.json file.

Run Configurations panel

Program arguments, VM options, evironment variables,... can be set in Run Configuration panel a part of Explorer. The panel is sufficient for all typical use-cases Java programmer faces. Only advanced, expert scenarios may require touching of launch.json (which still takes precedence).
Run Configuration

JDK Downloader

If the system does not detect any JDK, the extension will offer a downloader and setup prompt to help you set up a JDK. This setup provides options for Oracle JDK, OpenJDK, and allows you to choose from any installed JDK on your system. Alternatively, you can manually specify the path to JDK binaries by utilizing the JDK downloader. You can also access the JDK downloader through the "Download, install, and Use JDK" option in the command palette.
JDK Downloader

Supported Refactorings

Class level refactorings as well as variable refactorings are supported in VSCode via Oracle Java Platform extension. See following screenshots:

Source Action ... context menu

Class Source Actions

Introduce refactorings available via Show Code actions light bulb

Introduce ... refactoring

More Refactorings available also using Refactor... context menu

More Refactorings

Surround with refactorings

Surrond with Refactorings

Some refactorings are two steps with like Generate Override method ... where method to be overriden is selected in 2nd step:

Override refactoring

Change Method Parameters refactoring

Change method parameters refactoring is provided using dedicated form allowing to change, add, move, remove method parameters.
Change method parameters refactoring

Move Members Refactoring

Move members refactoring provides dedicated form as well.
Move members refactoring

Some of supported refactorings:

Formatter Preferences

Easily update default formatter preferences by adjusting a simple configuration option to tailor settings according to specific needs.

Go to VSCode View | Command Palette | Preferences:Open User Settings | Extensions | Java and set Jdk › Format: Settings Path: option to the formatter preferences file.

Please refer to Java formatting preferences wiki for more info.

Organize Imports

Out of the box support for organizing imports in Java sources is available. It removes unused imports, groups imports by packages and updates your imports whenever a file is saved. In addition to the defaults, there is a rich set of configuration options.

Go to VSCode View | Command Palette | Preferences:Open User Settings | Extensions | Java and search for Jdk to set Jdk > Java > Imports: options:

And View | Command Palette | Preferences:Open User Settings | Extensions > Java > On Save: Organize Imports - Enable organize imports action on a document save

JavaDoc smart editing

When adding JavaDoc to code Oracle Java Platform extension assists by suggesting to insert preformatted and prepopulated JavaDoc comment. Type /** above method signature and IDE offers to complete the JavaDoc. The action creates JavaDoc comment with all arguments prepared.
JavaDoc Completion

Test Explorer

Oracle Java Platform extension provides Test Explorer view which allows to run all tests in a project, examine the results, go to source code and run particular test.
Test Explorer

Supported Options

Selecting the JDK

The user projects are built, run and debugged using the same JDK which runs the Oracle Java Platform extension. The JDK is being searched in following locations:

As soon as one of the settings is changed, the Language Server is restarted.

Running Language Server per VSCode workspace or for user

It is possible to run Oracle Java Platform extension per workspace (VSCode window). This allows separation of Language Server for given project as Language Server JVM is not shared for more VSCode open workspaces (projects). It is possible to change this in View | Command Palette | Preferences:Open User Settings | Jdk: Userdir. Set to local to use dedicated Language Server per workspace or set to global to have one Language Server for all VS Code workspaces.

Contributing

This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide

Security

Please consult the security guide for our responsible security vulnerability disclosure process

License

Copyright (c) 2023 Oracle and/or its affiliates.

Oracle Java Platform Extension for Visual Studio Code is licensed under Apache 2.0 License. The THIRD_PARTY_LICENSES file contains third party notices and licenses.