搭建Vim为自定义的PHP开发工具的一些技巧

这篇文章主要介绍了搭建Vim为自定义的PHP开发工具的一些技巧,Vim和Emacs被公认为是世界上最强大最具人气的代码编辑器,需要的朋友可以参考下

虽然 vim 本质上只是一个编辑器。但只要配合一些适当的插件, vim 也能变成一个全功能的 IDE 。笔者使用 vim 已经有挺长一段时间了,经过反复的试验,配置了一个高效的 PHP 开发环境,实为居家旅行、谋财害命、杀人越货必备之良品。

安装 vim

鉴于大多数读者都是使用Windows 环境,所以本文就以 Windows 作为运行环境。不过由于 vim 出色的跨平台特性,配置文件只需简单修改就可以在 Linux 版本的 vim 中使用。

目前 vim 的最新版本是 7.2 ,如果没有特别原因建议安装最新的版本。

下载地址: http://www.vim.org/download.php#pc

下载文件: ftp://ftp.vim.org/pub/vim/pc/gvim72.exe

安装时 不要装到带有空格、中文的目录中 ,其他保持默认即可。笔者的安装目录是 c:/apps/office/vim ,后文也以此为准。为了叙述方便,笔者用 $VIM 来表示 vim 的安装目录。例如您的 vim 安装在 d:/vim/ 中,那 $VIM 就代表 d:/vim/ 。

开始配置 vim

我们对 vim 的配置分为几个步骤。

修改 _vimrc 后自动生效

打开 $VIM 目录,可以看到其中有一个 _vimrc 文件,用 vim 打开此文件,删除所有内容后,在最后插入两行:

" autoload _vimrc

autocmd! bufwritepost _vimrc source %

上述命令让我们通过 vim 编辑 _vimrc 文件并保存时,可以自动载入 _vimrc 文件,使得我们对 vim 的定制可以立即生效(无需重启 vim )。

使 vim 中文化

在 _vimrc 顶部增加下列文本:

  1. " disable VI's compatible mode..
  2. set nocompatible
  3. " set encoding=utf-8
  4. set fileencodings=ucs-bom,utf-8,gbk,default,latin1
  5. " use chinese help
  6. set helplang=cn

上述代码的作用是禁用 vi 兼容模式(原始的 vi 功能太少了,没必要考虑兼容)、按照 utf-8 、 gbk 的顺序来检测文件编码,并设置帮助为中文。不过设置 set helplang=cn 并不能马上看到中文帮助,我们还得下载中文帮助文件。

下载地址: http://vimcdoc.sourceforge.net/

下载文件: vimcdoc-1.6.0.tar.gz

得到中文帮助文件压缩包后,将压缩包中 doc 子目录的所有文件复制到 $VIM/vimfiles/doc 目录中。此时再输入 :help 命令就可以看到中文帮助了。

中文帮助还是 7.1 版的,不过不影响我们使用。

设置字体

选择 vim 菜单的“编辑” -> “选择字体”,就可以为 vim 指定喜欢的显示字体了。笔者使用的是 Consolas 字体,大小设置为 9pt 。这个设置显示代码非常漂亮,不过中文就有点变形了。

设置好后,输入命令 :set guifont 可以查看到当前的字体设置,将该设置写入 _vimrc 文件。

  1. "set gui options
  2. if has("gui_running")
  3. set guifont=Consolas:h9
  4. endif

上述代码中的 if … endif 是一个条件判断结构。指示只有当我们使用图形界面版的 vim 时才设置字体。

为编辑 PHP 代码进行基本设置

现在用 vim 打开 .php 文件看上去是很难看的,别说代码高亮,连行号都没有显示。所以还要给 _vimrc 添加以下内容:

  1. " Enable syntax highlight
  2. syntax enable
  3. " Show line number
  4. set nu
  5. " show matching bracets
  6. set showmatch
  7. " Basic editing options
  8. set expandtab
  9. set shiftwidth=2
  10. au FileType html,python,vim,javascript setl shiftwidth=2
  11. au FileType html,python,vim,javascript setl tabstop=2
  12. au FileType java,php setl shiftwidth=4
  13. au FileType java,php setl tabstop=4
  14. set smarttab
  15. set lbr
  16. set tw=0
  17. "Auto indent
  18. set ai
  19. " Smart indet
  20. set si
  21. " C-style indeting
  22. set cindent
  23. " Wrap lines
  24. set wrap

上述设置启用了格式化高亮、行号显示,以及括号匹配、自动缩进等编辑功能,对于大多数情况都可以获得理想的编辑体验。不过此时对 .php 文件的支持还不完善,需要下载专门的 php 插件。

下载地址: http://www.vim.org/scripts/script.php?script_id=1571

下载文件: php.tar.gz

将其中的 php.vim 复制到 $VIM/vimfiles/syntax 目录中即可。

设置喜欢的配色方案

默认的配色方案相信没几个人会喜欢,可以通过下面的网址查看配色方案并下载(有几百个哦)。

下载网址: http://www.cs.cmu.edu/~maverick/VimColorSchemeTest/index-c.html

这个网址列出了 300 多个配色方案以及实际的显示效果,点击方案名称即可下载到一个 .vim 文件。将该文件放入 $VIM/vimfiles/colors 目录,然后在 _vimrc 中添加:

" set color schema

colorscheme oceandeep

这两行代码需要加到 if has("gui_running") … endif 代码块中,例如:

  1. if has("gui_running")
  2. set guifont=Consolas:h9
  3. " set color schema
  4. colorscheme oceandeep
  5. endif

设置后显示效果就漂亮多了 :-) ­

更多有用的编辑设置

虽然不是专门针对编辑 .php 文件的设置,但这些选项可以让 vim 更好用,所以建议加上:

  1. " Sets how many lines of history VIM har to remember
  2. set history=400
  3. " Set to auto read when a file is changed from the outside
  4. set autoread
  5. " Have the mouse enabled all the time:
  6. set mouse=a
  7. " Do not redraw, when running macros.. lazyredraw
  8. set lz
  9. " set 7 lines to the curors - when moving vertical..
  10. set so=7
  11. " The commandbar is 2 high
  12. set cmdheight=2
  13. " Change buffer - without saving
  14. set hid
  15. " Ignore case when searching
  16. " set ignorecase
  17. set incsearch
  18. " Set magic on
  19. set magic
  20. " No sound on errors.
  21. set noerrorbells
  22. set novisualbell
  23. set t_vb=
  24. " How many tenths of a second to blink
  25. set mat=4
  26. " Highlight search things
  27. set hlsearch
  28. " Turn backup off
  29. set nobackup
  30. set nowb
  31. set noswapfile
  32. " smart backspace
  33. set backspace=start,indent,eol
  34. " switch buffers with Tab
  35. map <C-Tab> :bn<CR>
  36. map <S-Tab> :bp<CR>

经过一番改造,我们的 vim 已经可以很顺手地编辑 .php 文件了。不过要打造 php 开发环境还有很多工作要做呢。

打造 PHP IDE

IDE 左侧是目录导航,中间是编辑区域,而右侧则是方法列表,用于在已经打开的文件中快速跳转。在编辑区域按下 CTRL+X 键,还会显示已打开文件的列表。

其他诸如自动补全、代码模板等功能,都应有尽有。看过了漂亮的截图,我们就来一步步打造 PHP IDE 吧。

用 NERDTree 实现目录导航

在进行 PHP 应用开发时,同时编辑多个文件是很正常的事情。所以必须有一个方便的目录导航工具,以便在目录结构间快速切换,找到需要编辑的文件。

vim 中提供该类功能的插件很多,比较知名的有 project 、 winmanager 等。但笔者个人认为最好用的还是 The NERD Tree 这个插件。 NERDTree 不但可以显示完整的目录树结构,还可以将任何一个目录设置为根目录。并且提供了目录导航的书签功能,可谓非常方便。

下载地址: http://www.vim.org/scripts/script.php?script_id=1658

下载文件: NERD_tree.zip

解压缩时,要把压缩包中的目录结构完整的解压缩到 $VIM/vimfiles 目录中。完成后,应该分别找到 $VIM/vimfiles/doc/NERD_tree.txt 文件和 $VIM/vimfiles/plugin/NERD_tree.vim 文件。然后在 vim 中输入命令 :helptags $VIM/vimfiles/doc ,将 NERDTree 的帮助文档添加到 vim 中。

最后在 _vimrc 添加如下内容:

" NERDTree

map <F10> :NERDTreeToggle<CR>

重启 vim 后,按下 F10 键,就可以在左侧看到一个目录树了。在目录树窗口中按下 ? 键可以查看详细的帮助信息。

最常用的操作键有:

此外在目录树窗口中输入目录 :Bookmark 收藏名 还可以将光标所在目录添加到收藏夹中。下次使用 :BookmarkToRoot 收藏名 可以直接转到该目录,并且以该目录作为根目录。更多命令可以参考 NERDTree 的帮助文档。

用 taglist 实现代码导航

解决了目录和文件导航问题,我们还要为代码之间的跳转提供辅助手段, taglist 就是这样一个插件。 taglist 可以列出已打开文件中定义的类、函数、常量,甚至变量。

下载地址: http://www.vim.org/scripts/script.php?script_id=273

下载文件: taglist_45.zip

压缩包需要完整解压缩到 $VIM/vimfiles 目录,并且用 :helptags $VIM/vimfiles/doc 命令索引 taglist 插件的帮助文档。 taglist 插件需要依赖 ctags 程序才能工作。目前常用的 ctags 版本是 Exuberant Ctags 。

下载地址: http://ctags.sourceforge.net/

下载文件: ec57w32.zip

只需要把压缩包中的 ctags.exe 复制到 $VIM/vim72 目录中即可。 ctags.exe 应该和 gvim.exe 在一个目录。

最后在 _vimrc 添加下列内容,设置好 taglist 插件:

  1. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  2. " => Plugin configuration
  3. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  4. " taglist
  5. let Tlist_Auto_Highlight_Tag = 1
  6. let Tlist_Auto_Open = 1
  7. let Tlist_Auto_Update = 1
  8. let Tlist_Close_On_Select = 0
  9. let Tlist_Compact_Format = 0
  10. let Tlist_Display_Prototype = 0
  11. let Tlist_Display_Tag_Scope = 1
  12. let Tlist_Enable_Fold_Column = 0
  13. let Tlist_Exit_OnlyWindow = 0
  14. let Tlist_File_Fold_Auto_Close = 0
  15. let Tlist_GainFocus_On_ToggleOpen = 1
  16. let Tlist_Hightlight_Tag_On_BufEnter = 1
  17. let Tlist_Inc_Winwidth = 0
  18. let Tlist_Max_Submenu_Items = 1
  19. let Tlist_Max_Tag_Length = 30
  20. let Tlist_Process_File_Always = 0
  21. let Tlist_Show_Menu = 0
  22. let Tlist_Show_One_File = 0
  23. let Tlist_Sort_Type = "order"
  24. let Tlist_Use_Horiz_Window = 0
  25. let Tlist_Use_Right_Window = 1
  26. let Tlist_WinWidth = 40
  27. let tlist_php_settings = 'php;c:class;i:interfaces;d:constant;f:function'

在vim中检查php语法格式

打开你的_vimrc,将如下配置写入并保存。

“检查当前文件代码语法(php){{{

  1. function! CheckSyntax()
  2. if &filetype!=”php”
  3. echohl WarningMsg | echo “Fail to check syntax! Please select the right file!” | echohl None
  4. return
  5. endif
  6. if &filetype==”php”
  7. ” Check php syntax
  8. setlocal makeprg=\”php\”\ -l\ -n\ -d\ html_errors=off
  9. ” Set shellpipe
  10. setlocal shellpipe=>
  11. ” Use error format for parsing PHP error output
  12. setlocal errorformat=%m\ in\ %f\ on\ line\ %l
  13. endif
  14. execute “silent make %”
  15. set makeprg=make
  16. execute “normal :”
  17. execute “copen”
  18. endfunction
  19. map <F6> :call CheckSyntax()<CR>
  20. “}}}

然后我们按下F6就可以执行啦~~ 注意

  1. if &filetype!=“php”
  2. echohl WarningMsg | echo “Fail to check syntax! Please select the right file!” | echohl None
  3. return
  4. endif

这一段,是规定了必须是.php格式的文件,所以不要拿成错文件来试哦