一、代码检查工具

luacheck

安装

  1. sudo luarocks install luacheck

代码检查

  1. luacheck ./m_cache/*.lua

同时也可以在vscode中安装luacheck扩展

二、编码规范

函数命名

函数的命名同样遵循 snake_case

  1. local function is_empty()
  2. end

并且函数应该尽早的进行return

变量命名

变量需要使用局部变量，禁止使用全局变量

  1. --必须加local
  2. local test = nil

变量命名应该使用snake_case

  1. local user_name = nil

常量则需要全部大写

  1. local VERSION = '1.0'

数组

使用table.new 来预生成数组

  1. local tab_new = require "table.new"
  2. local t = tab_new(100, 0)

数组中不要出现nil,如果必须要使用空值，则使用ngx.null替代

  1. local t = {1, 2, ngx.null, 4}