eclipse.jdt.ls

Языковой сервер Eclipse JDT

Языковой сервер Eclipse JDT — это реализация протокола языкового сервера, специфичная для языка Java, и его можно использовать с любым редактором, поддерживающим этот протокол, для обеспечения хорошей поддержки языка Java. Сервер основан на:

• Eclipse LSP4J, привязка Java для протокола языкового сервера,
• Eclipse JDT, обеспечивающий поддержку Java (завершение кода, ссылки, диагностика...),
• M2Eclipse, обеспечивающий поддержку Maven,
• Buildship, обеспечивающий поддержку Gradle.

Функции

• Поддерживает компиляцию проектов Java версий от 1.8 до 22.
• Поддержка проекта Maven pom.xml
• Поддержка проектов Gradle (с экспериментальной поддержкой импорта проектов Android)
• Поддержка автономных файлов Java
• Отчеты о синтаксических ошибках и ошибках компиляции по мере ввода
• Завершение кода
• Javadoc зависает
• Организовать импорт
• Введите поиск
• Действия с кодом (быстрые исправления, действия с исходным кодом и рефакторинг)
• Схема кода
• Складывание кода
• Навигация по коду
• Кодовая линза (ссылки/реализации)
• Форматирование кода (по типу/выбору/файлу)
• Фрагменты кода
• Highlights (смысловое выделение)
• Семантический отбор
• Диагностические теги
• Иерархия вызовов
• Иерархия типов
• Поддержка обработки аннотаций (автоматически для проектов Maven)
• Автоматическое разрешение исходного кода для классов в банках с координатами Maven
• Расширяемость

Требования

Для работы языкового сервера требуется среда выполнения Java 17 (как минимум). Это должно быть установлено либо в переменной среды JAVA_HOME , либо в пути пользователя.

Установка

Существует несколько вариантов установки eclipse.jdt.ls:

• Загрузите и извлеките сборку с сайта http://download.eclipse.org/jdtls/milestones/.
• Загрузите и извлеките сборку моментального снимка с http://download.eclipse.org/jdtls/snapshots/.
• В некоторых дистрибутивах Linux вы можете использовать менеджер пакетов. Найдите в репозиториях пакетов jdtls или eclipse.jdt.ls .
• Соберите его из исходного кода. Клонируйте репозиторий с помощью git clone и создайте проект с помощью JAVA_HOME=/path/to/java/17 ./mvnw clean verify . При желании добавьте -DskipTests=true , чтобы обойти тесты. Эта команда создает сервер в папке ./org.eclipse.jdt.ls.product/target/repository .

Некоторые редакторы или расширения редакторов включают в себя eclipse.jdt.ls или содержат логику для его установки. В этом случае вам нужно всего лишь установить расширение редактора. Например, для Visual Studio Code вы можете установить пакет расширений для Java, а он позаботится обо всем остальном.

Запуск из командной строки

Если вы собрали eclipse.jdt.ls из исходного кода, cd в ./org.eclipse.jdt.ls.product/target/repository . Если вы загрузили сборку вехи или моментального снимка, извлеките содержимое.

Чтобы запустить сервер в активном терминале, настройте следующую команду, как описано ниже, и запустите ее:

java 
	-Declipse.application=org.eclipse.jdt.ls.core.id1 
	-Dosgi.bundles.defaultStartLevel=4 
	-Declipse.product=org.eclipse.jdt.ls.core.product 
	-Dlog.level=ALL 
	-Xmx1G 
	--add-modules=ALL-SYSTEM 
	--add-opens java.base/java.util=ALL-UNNAMED 
	--add-opens java.base/java.lang=ALL-UNNAMED 
	-jar ./plugins/org.eclipse.equinox.launcher_1.5.200.v20180922-1751.jar 
	-configuration ./config_linux 
	-data /path/to/data

1. Выберите значение для -configuration : это путь к каталогу конфигурации вашей платформы. Для Linux используйте ./config_linux . Для Windows используйте ./config_win . Для Mac/OS X используйте ./config_mac .
2. Измените имя файла jar в -jar ./plugins/... чтобы оно соответствовало версии, которую вы создали или скачали.
3. Выберите значение для -data : абсолютный путь к вашему каталогу данных. eclipse.jdt.ls хранит в себе информацию, специфичную для рабочей области. Оно должно быть уникальным для каждой рабочей области/проекта.

Если вы хотите отладить сам eclipse.jdt.ls, добавьте -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=1044 сразу после java и убедитесь, что на порту 1044 больше ничего не работает. Если вы хотите отладку с начала выполнения, измените suspend=n на suspend=y , чтобы JVM ждала вашего отладчика перед запуском сервера.

Запуск из командной строки с помощью скрипта-обертки

Также доступен скрипт-оболочка Python, который делает запуск eclipse.jdt.ls более удобным (нет необходимости манипулировать параметрами Java и т. д.). Пример использования описан ниже. Для сценария требуется Python 3.9.

./org.eclipse.jdt.ls.product/target/repository/bin/jdtls 
	-configuration ~ /.cache/jdtls 
	-data /path/to/data

Все показанные параметры Java будут установлены сценарием-оболочкой. Обратите внимание, что параметры -configuration указывают на папку пользователя, чтобы гарантировать, что папка конфигурации в org.eclipse.jdt.ls.product/target/repository/config_* останется нетронутой.

Настройка разработки

См. раздел «Содействие»

Управление типами подключения

Сервер языка Java поддерживает сокеты, именованные каналы и стандартные потоки серверного процесса для связи с клиентом. Клиент может сообщить предпочтительные методы подключения, настроив переменные среды или, альтернативно, используя свойства системы (например, -DCLIENT_PORT=... ).

• Чтобы использовать простой сокет , перед запуском сервера установите следующие переменные среды или системные свойства:

  • CLIENT_PORT : порт сокета для подключения.
  • CLIENT_HOST : имя хоста для подключения. Если не установлено, по умолчанию используется localhost .

  Соединение будет использоваться для входа и выхода.

• Чтобы использовать стандартные потоки (stdin, stdout) серверного процесса, не устанавливайте ни одну из вышеуказанных переменных среды, и сервер вернется к стандартным потокам.

Для сокетов и именованных каналов ожидается, что клиент создаст соединения и дождется подключения сервера.

Обратная связь

• Сообщите об ошибке в GitHub Issues.
• Присоединяйтесь к обсуждению на нашем канале Mattermost
• Напишите нам в Твиттере другие отзывы.

Клиенты

Этот репозиторий содержит только реализацию сервера. Вот некоторые известные клиенты, использующие этот сервер:

• vscode-java: расширение для кода Visual Studio.
• ide-java: расширение для Atom
• ycmd: сервер завершения и понимания кода для нескольких клиентов.
• Oni: современное модальное редактирование на базе Neovim.
• LSP Java: клиент Java LSP для Emacs.
• Eclipse Theia: Theia — это облачная и настольная среда IDE, реализованная на TypeScript.
• Eclipse IDE JDT.LS: расширение для Eclipse IDE.
• coc-java: расширение для coc.nvim
• MS Paint IDE: IDE для программирования в MS Paint.
• nvim-jdtls: расширение для Neovim.
• multilspy из Monitors4codegen: независимый от языка LSP-клиент на Python с библиотечным интерфейсом. Предназначен для создания приложений на основе языковых серверов.
• OpenSumi: платформа, которая помогает быстро создавать продукты Cloud или Desktop IDE.

Сборки непрерывной интеграции

Наш CI-сервер публикует двоичные файлы сервера по адресу http://download.eclipse.org/jdtls/snapshots/.

Репозитории P2 доступны по адресу http://download.eclipse.org/jdtls/snapshots/repository/.

Сборки Milestone доступны по адресу http://download.eclipse.org/jdtls/milestones/.

Лицензия

EPL 2.0, см. файл ЛИЦЕНЗИИ.