使用lsp-zero.nvim与nvim-jdtls搭建Java开发环境-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00426/article/details/148549881

使用lsp-zero.nvim与nvim-jdtls搭建Java开发环境

lsp-zero.nvim A starting point to setup some lsp related features in neovim. 项目地址: https://gitcode.com/gh_mirrors/ls/lsp-zero.nvim

前言

在现代Neovim开发环境中，Java语言的支持一直是个挑战。本文将详细介绍如何利用lsp-zero.nvim插件与nvim-jdtls插件搭建一个功能完善的Java开发环境。这套方案不仅提供了代码补全、错误检查等基础LSP功能，还支持代码重构、测试运行和调试等高级特性。

环境准备

在开始配置前，请确保满足以下基础要求：

Java环境：JDK 17或更高版本
Python环境：Python 3.9或更高版本
Neovim配置：已配置好的Neovim环境

插件安装

需要安装的核心插件包括：

nvim-jdtls：Java语言服务器客户端
mason.nvim（可选）：用于管理LSP服务器安装
nvim-dap（可选）：调试适配器协议支持
nvim-dap-ui（可选）：调试界面
cmp-nvim-lsp（可选）：代码补全支持

配置结构

我们将采用模块化的配置方式，主要分为以下几个部分：

路径管理：处理jdtls及其相关组件的安装路径
功能开关：控制代码透镜和调试器等功能的启用
键位映射：定义Java开发专用的快捷键
服务器配置：设置jdtls的语言服务器参数

详细配置解析

1. 基础设置

首先创建一个自动命令组，用于管理所有Java相关的自动命令：

local java_cmds = vim.api.nvim_create_augroup('java_cmds', {clear = true})

2. 项目根目录识别

定义用于识别Java项目根目录的文件列表：

local root_files = {
  '.git',
  -- 其他可能的项目标识文件
  -- 'mvnw',
  -- 'gradlew',
  -- 'pom.xml',
  -- 'build.gradle',
}

3. 功能开关

通过一个表来控制各项功能的启用状态：

local features = {
  codelens = false,    -- 代码透镜功能
  debugger = false,    -- 调试器功能
}

4. 路径管理

get_jdtls_paths函数负责收集所有必要的路径信息：

local function get_jdtls_paths()
  if cache_vars.paths then
    return cache_vars.paths
  end

  local path = {}
  path.data_dir = vim.fn.stdpath('cache') .. '/nvim-jdtls'
  
  -- 获取jdtls安装路径
  local jdtls_install = require('mason-registry')
    .get_package('jdtls')
    :get_install_path()

  -- 设置平台相关配置
  if vim.fn.has('mac') == 1 then
    path.platform_config = jdtls_install .. '/config_mac'
  elseif vim.fn.has('unix') == 1 then
    path.platform_config = jdtls_install .. '/config_linux'
  end

  -- 处理调试相关bundle
  path.bundles = {}
  -- ... 详细路径处理代码
end

5. 服务器启动配置

jdtls_setup函数负责配置并启动语言服务器：

local function jdtls_setup(event)
  local jdtls = require('jdtls')
  local path = get_jdtls_paths()
  
  -- 构建启动命令
  local cmd = {
    'java',
    -- 各种JVM参数
    '-jar', path.launcher_jar,
    '-configuration', path.platform_config,
    '-data', data_dir
  }

  -- 语言服务器设置
  local lsp_settings = {
    java = {
      eclipse = { downloadSources = true },
      configuration = { updateBuildConfiguration = 'interactive' },
      -- 更多详细设置...
    }
  }

  -- 启动或附加到现有服务器
  jdtls.start_or_attach({
    cmd = cmd,
    settings = lsp_settings,
    on_attach = jdtls_on_attach,
    -- 更多配置...
  })
end

6. 键位映射

jdtls_on_attach函数定义了Java开发专用的快捷键：

local function jdtls_on_attach(client, bufnr)
  local opts = {buffer = bufnr}
  
  -- 组织导入
  vim.keymap.set('n', '<A-o>', "<cmd>lua require('jdtls').organize_imports()<cr>", opts)
  
  -- 变量提取
  vim.keymap.set('n', 'crv', "<cmd>lua require('jdtls').extract_variable()<cr>", opts)
  vim.keymap.set('x', 'crv', "<esc><cmd>lua require('jdtls').extract_variable(true)<cr>", opts)
  
  -- 更多实用快捷键...
end

调试功能配置

要启用调试功能，需要：

安装nvim-dap和nvim-dap-ui插件
安装java-debug-adapter和java-test组件
将features.debugger设为true

调试相关的配置函数：

local function enable_debugger(bufnr)
  require('jdtls').setup_dap({hotcodereplace = 'auto'})
  require('jdtls.dap').setup_dap_main_class_configs()

  -- 调试相关快捷键
  vim.keymap.set('n', '<leader>df', "<cmd>lua require('jdtls').test_class()<cr>", opts)
  vim.keymap.set('n', '<leader>dn', "<cmd>lua require('jdtls').test_nearest_method()<cr>", opts)
end