Skip to content

draftcode/java-language-server

 
 

Repository files navigation

Language Server for Java using the Java Compiler API

Provides Java support using the Java Compiler API. Requires that you have Java 8 installed on your system.

Installation

Install from the VS Code marketplace

Features

Javadoc

Javadoc

Signature help

Signature help

Autocomplete symbols (with auto-import)

Auto import 1

Auto import 2

Autocomplete members

Autocomplete members

Go-to-definition

Goto 1

Goto 2

Find symbols

Find workspace symbols

Find document symbols

Lint

Error highlight

Type information on hover

Type hover

Code actions

Suggest import 1

Suggest import 2

Find references

Find references 1

Find references 2

Usage

VSCode will provide autocomplete and help text using:

  • .java files anywhere in your workspace
  • Java platform classes
  • External dependencies specified using pom.xml, Bazel, or settings

Settings

If VSCode doesn't detect your external dependencies automatically, you can specify your external dependencies using .vscode/settings.json

{
    "java.externalDependencies": [
        "junit:junit:jar:4.12:test", // Maven format
        "junit:junit:4.12" // Gradle-style format is also allowed
    ]
}

If all else fails, you can specify the java class path manually:

{
    "java.classPath": [
        "lib/some-dependency.jar"
    ]
}

You can generate a list of external dependencies using your build tool:

  • Maven: mvn dependency:list
  • Gradle: gradle dependencies

The Java language server will look for the dependencies you specify in java.externalDependencies in your Maven and Gradle caches ~/.m2 and ~/.gradle. You should use your build tool to download the library and source jars of all your dependencies so that the Java language server can find them:

  • Maven
    • mvn dependency:resolve for compilation and autocomplete
    • mvn dependency:resolve -Dclassifier=sources for inline Javadoc help
  • Gradle
    • gradle dependencies for compilation and autocomplete
    • Include classifier: sources in your build.gradle for inline Javadoc help, for example:
      dependencies {
          testCompile group: 'junit', name: 'junit', version: '4.+'
          testCompile group: 'junit', name: 'junit', version: '4.+', classifier: 'sources'
      }
      

Design

This extension consists of an external java process, which communicates with vscode using the language server protocol.

Java service process

The java service process uses the standard implementation of the Java compiler. When VS Code needs to lint a file, perform autocomplete, or some other task that requires Java code insight, the java service process invokes the Java compiler programatically, then intercepts the data structures the Java compiler uses to represent source trees and types.

Incremental updates

The Java compiler isn't designed for incremental parsing and analysis. However, it is extremely fast, so recompiling a single file gives good performance, as long as we don't also recompile all of its dependencies.

Logs

The java service process will output a log file to stdout, which is visible using View / Output.

Contributing

If you have npm and maven installed, you should be able to install locally using

npm install -g vsce
npm install
./scripts/install.sh

About

Java language server using the Java compiler API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 95.9%
  • TypeScript 2.8%
  • Other 1.3%