OpenResty Lua 编辑器选择

一个好用趁手的编辑器可以为我们带来极大的工作效率提升,lua本身并不挑编辑器只是一个存文本. 但是如果有代码提示,方便的goto跳转,在我们理解别人的代码效率上将会有极大的提升.

我从最初的记事本编辑,vi,到后来的UE自定义语法高亮和函数列表,以及scite等寻找和尝试过能找到的绝大部分的lua编辑器. 我想在编辑器选择上面(linux下的不熟= =)应该比较有发言权.这里我主要讲我的环境是如何的。

选择过程我就不详述了,这里只讲解如果在你自己的windows上配置好ide。

下载idea并配置

idea是一个java语言非常受好评的编辑器,但是并不是只支持java.

目前通过开放的插件编写已经支持绝大部分语言且使用的非常好用顺手,相信使用过的都会深有感受的。下载地址

其中Community版本是免费的,下载完后双击安装即可.

安装完成后打开File->Settings->Plugins在其中输入emmylua点击右边的install安装并重启idea 

新建一个lua项目 在​File->Project Structure​里面配置好​modules​和​lib​,如下图.  

至此一个包含lua语法提示和调整的编辑器环境就配置好了.

有关​emmylua​的详细帮助文档看这里

插件基本用法

1.方法提示

你可以在Setting里面配置鼠标移动到方法上后一定时间自动弹出

也可以按​Ctrl+q​手动弹出,效果如下(= =目前我使用的版本文档中的换行显示还有问题)

2.快速跳转

在任何已经被定义的方法上按住Ctrl+鼠标点击该方法就可以自动打开和跳转到方法定义上面,非常方便

3.方法提示

在你输入识别的全局或者局部变量上面按点会自动出现可选方法做提示,不用记住所有的方法. 

进阶配置

由于emmylua并没有自带openresty的库函数,所以我们需要自己写函数提示,这里我提供我自己写的供你们下载和丰富.请丢到你的lualib根目录中

下面是一个简单的库函数定义示例

---语法: pid = ngx.worker.pid()
---
---语法: set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*, header_filter_by_lua*, body_filter_by_lua*, log_by_lua*, ngx.timer.*, init_by_lua*, init_worker_by_lua*
---
---这个函数返回一个Lua数字，它是当前 Nginx 工作进程的进程 ID （PID）。这个 API 比 ngx.var.pid 更有效，ngx.var.VARIABLE API 不能使用的地方（例如 init_worker_by_lua），该 API 是可以的。
---@return number
function ngx.worker.pid()
end

方法提示不一定要使用独立的文件定义,可以直接在库里面定义,如:

至于里面的含义就要去这里看和理解拉.

总之如果你的库都定义好了方法提示,在你理解源码的时候将会非常方便快速.相信我