代码规范

    既然我们玩的是 OpenResty,那么很自然的联想到,OpenResty 自身组件代码风格是怎样的呢?

    1. 没有全局变量,所有的变量均使用 local 限制作用域
    2. 提取公共函数到本地变量,使用本地变量缓存函数指针,加速下次使用
    3. 函数名称全部小写,使用下划线进行分割

    这里的第 2 条,是有争议的。当你按照这个方式写业务的时候,会有些痛苦。因为我们总是把标准 API 命名成自己的别名,不同开发协作人员,命名结果一定不一样,最后导致同一个标准 API 在不同地方变成不同别名,会给开发造成极大困惑。

    因为这个可预期的麻烦,我们没有遵循第 2 条标准,尤其是具体业务上游模块。但对于被调用的次数比较多基础模块,可以使用这个方式进行调优。其实这里最好最完美的方法,应该是 Lua 编译成 Luac 的时候,直接做 Lua Byte Code 的调优,直接隐藏这个简单的处理逻辑。

    说说我上面提及的因为风格问题造出来的坑吧。

    1. function test()
    2. -- do something
    3. function test2()

    这是我当时不记得从哪里看到的一个 Lua 风格,在被引入项目初期,自我感觉良好。可突然从某个时间点开始,新合并进来的代码无法正常工作。查看最后的代码发现原来是 test() 函数作废,被删掉,手抖没有把上面的 local 也删掉。这个隐形的 local 就作用到了下一个函数,最终导致异常。