Go语言自动补全插件gocode的使用

简介

gocode是一个为Go编程语言设计的自动补全守护进程，主要用于集成到源代码编辑器(如vim、neovim和emacs)中。它提供上下文敏感的自动补全功能。

作为守护进程，gocode采用客户端/服务器架构以提高缓存效率，典型情况下自动补全响应时间仅需30毫秒。

安装配置

基本要求

1. 需要正确安装Go编译器环境并设置个人工作区($GOPATH)。确保$GOPATH/bin在$PATH环境变量中。

export GOPATH=$HOME/goprojects
export PATH=$PATH:$GOPATH/bin

1. 获取gocode：

go get -u github.com/nsf/gocode

Windows用户建议使用：

go get -u -ldflags -H=windowsgui github.com/nsf/gocode

Vim配置

手动安装

1. 安装官方Go vim脚本(位于$GOROOT/misc/vim)
2. 安装gocode vim脚本：

vim/update.sh

或创建符号链接：

#!/bin/sh
cd "${0%/*}"
ROOTDIR=`pwd`
mkdir -p "$HOME/.vim/autoload"
mkdir -p "$HOME/.vim/ftplugin/go"
ln -s "$ROOTDIR/autoload/gocomplete.vim" "$HOME/.vim/autoload/"
ln -s "$ROOTDIR/ftplugin/go/gocomplete.vim" "$HOME/.vim/ftplugin/go/"

1. 确保vim启用文件类型插件，在.vimrc中添加：

filetype plugin on

1. 使用<C-x><C-o>进行自动补全

使用Vundle安装

在.vimrc中添加：

Plugin 'nsf/gocode', {'rtp': 'vim/'}

然后运行:PluginInstall更新插件。

使用vim-plug安装

在.vimrc中添加：

Plug 'nsf/gocode', { 'rtp': 'vim', 'do': '~/.vim/plugged/gocode/vim/symlink.sh' }

然后运行:PlugInstall更新插件。

Neovim配置

手动安装

步骤与Vim类似，但使用gocode/nvim目录中的脚本，配置文件位于~/.config/nvim/init.vim。

使用Vundle安装

在init.vim中添加：

Plugin 'nsf/gocode', {'rtp': 'nvim/'}

然后运行:PluginInstall更新插件。

使用vim-plug安装

在init.vim中添加：

Plug 'nsf/gocode', { 'rtp': 'nvim', 'do': '~/.config/nvim/plugged/gocode/nvim/symlink.sh' }

然后运行:PlugInstall更新插件。

Emacs配置

1. 安装auto-complete-mode
2. 将gocode源码中的emacs/go-autocomplete.el复制到emacs的load-path目录
3. 在.emacs中添加：

(require 'go-autocomplete)
(require 'auto-complete-config)
(ac-config-default)

MacOSX用户可能需要添加：

(when (memq window-system '(mac ns))
  (exec-path-from-shell-initialize)
  (exec-path-from-shell-copy-env "GOPATH"))

配置选项

使用gocode set命令配置选项：

gocode set                  # 列出所有选项和值
gocode set <option>         # 显示选项值
gocode set <option> <value> # 设置选项值

主要选项包括：

• propose-builtins - 是否包含内置类型、函数和常量(默认false)
• lib-path - 添加包搜索路径
• autobuild - 自动构建过期包(默认false)
• package-lookup-mode - 包查找模式(go或gb，默认go)
• unimported-packages - 尝试自动导入标准库包(默认false)
• ignore-case - 是否区分大小写(默认false)

调试

如果出现问题，可以手动启动调试模式：

gocode close
gocode -s -debug

这将显示堆栈跟踪、错误信息和自动补全请求的详细信息。

注意事项

• 建议始终使用最新的git版本
• 使用go install而非go build构建本地源码树