Overview of Java Extension Configuration

The Java extension pack for Visual Studio Code, primarily maintained by Red Hat, relies on the Java Language Server (JDT.LS) to provide intelligence features. Proper configuration of the workspace settings ensures optimal performance, correct JDK usage, and tailored editor behavior. The following sections detail critical settings, command palette actions, and workspace setup strategies.

Core Runtime and Environment Settings

Defining the correct Java Development Kit (JDK) is the first step. The extension allows specifying the JDK used to run the language server itself, separate from the project's runtime.

• java.home: Points to the JDK installation directory used by the extension. On Windows systems, ensure backslashes are escaped.
• java.jdt.ls.java.home: Specifically overrides the embedded JRE for launching the language server process. This is useful if the server requires a specific Java version distinct from the project.
• java.jdt.ls.vmargs: Passes additional arguments to the JVM running the language server. This is critical for tuning memory allocation.

Example configuration for a Linux environment with increased memory:

{
    "java.home": "/usr/lib/jvm/java-17-openjdk-amd64",
    "java.jdt.ls.vmargs": "-XX:+UseG1GC -Xmx2G -Xms512m"
}

Build Tool Integration

The extension automatically detects Maven and Gradle projects. You can fine-tune how dependencies and build configurations are handled.

• java.import.maven.enabled / java.import.gradle.enabled: Toggles the automatic importers for respective build tools.
• java.import.gradle.wrapper.enabled: Prioritizes the Gradle Wrapper defined in the project over a global installation.
• java.maven.downloadSources: When enabled, automatically attaches source code jars for Maven dependencies, improving navigation and documentation lookup.
• java.configuration.updateBuildConfiguration: Determines how the server reacts to changes in build files (e.g., pom.xml). Options include interactive, automatic, or disabled.

Editor Behavior and Code Assistance

Customize the coding experience regarding formatting, completions, and visual aids.

Formatting and Save Actions

Control how code is styled automatically.

{
    "java.format.enabled": true,
    "java.format.onType.enabled": true,
    "java.saveActions.organizeImports": true
}

• java.format.settings.url: Allows pointing to an external Eclipse XML formatter profile for team consistency.
• java.saveActions.organizeImports: Automatically cleans up unused imports and orders them upon saving the file.

Completion and Intelligence

• java.completion.enabled: Master switch for IntelliSense.
• java.completion.guessMethodArguments: If true, automatically fills in parameter names when selecting a method from the completion list.
• java.completion.filteredTypes: Hides specific packages from completion suggestions to reduce noise (e.g., internal sun packages).
• java.referencesCodeLens.enabled: Displays inline references count above class/method definitions.

Code Generation Preferences

When using quick fixes to generate methods like toString(), hashCode(), or equals(), the output style can be configured.

• java.codeGeneration.hashCodeEquals.useJava7Objects: Utilizes java.util.Objects helpers for cleaner code generation (requires Java 7+).
• java.codeGeneration.toString.template: Defines the string pattern for generated toString methods.
• java.codeGeneration.insertionLocation: Controls where new generated members are placed relative to the cursor (e.g., afterCursor, lastMember).

Server Launch Modes

The extension supports different operational modes to balance performance and functionality.

• Standard: Full feature set encluding debugging, testing, and refactoring. Higher memory usage.
• LightWeight: Syntax server only. Provides basic navigation and syntax error checking without loading full project dependencies. Ideal for large monorepos.
• Hybrid: Starts in LightWeight mode for speed, then upgrades to Standard mode in the background.

Configuration example to force Lightweight mode:

{
    "java.server.launchMode": "LightWeight"
}

Workspace Configuration Setup

Settings can be applied globally or per workspace. For project-specific configurations, create a .vscode directory at the root of your project folder.

1. Create a folder named .vscode inside your project root.
2. Create a file named settings.json within that folder.
3. Add the desired configuration keys. Workspace settings override user settings.

This approach ensures that team members sharing the repository inherit the same Java environment settings without manual configuration.

Command Palette and Keybindings

Several operations are accessible via the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) or default keybindings.

• java.projectConfiguration.update: Refreshes the project configuration manually.
• java.workspace.compile: Triggers a full workspace compilation.
• java.clean.workspace: Clears the language server cache to resolve persistent indexing issues.
• java.open.logs: Opens the log files for troubleshooting extension errors.

Commonly used keyboard shortcuts include:

• Shift + Alt + U: Update project configuration.
• Ctrl + Shift + V: Organize imports and add missing imports auotmatically.
• Shift + Alt + B: Force compilation of the workspace.

For advanced troubleshooting, commands like java.action.showTypeHierarchy allow visualizing class relationships directly within the editor.