鍍金池/ 教程/ Java/ 代碼規(guī)范
定時(shí)任務(wù)
函數(shù)的參數(shù)
超時(shí)
一個(gè) openresty 內(nèi)存“泄漏”問題
獲取 uri 參數(shù)
局部變量
sleep
灰度發(fā)布
TIME_WAIT
代碼覆蓋率
連接池
CentOS 平臺(tái)安裝
稀疏數(shù)組
如何只啟動(dòng)一個(gè) timer 工作?
變量的共享范圍
break,return 關(guān)鍵字
Nginx
SQL 注入
如何引用第三方 resty 庫
不同階段共享變量
獲取請求 body
動(dòng)態(tài)生成的 lua-resty-redis 模塊方法
動(dòng)態(tài)加載證書和 OCSP stapling
repeat 控制結(jié)構(gòu)
編碼為 array 還是 object
Nginx 靜態(tài)文件服務(wù)
執(zhí)行階段概念
Lua 函數(shù)
日期時(shí)間函數(shù)
健康監(jiān)測
與其他 location 配合
for 控制結(jié)構(gòu)
函數(shù)定義
HTTPS 時(shí)代
點(diǎn)號(hào)與冒號(hào)操作符的區(qū)別
String 庫
文件操作
OpenResty 最佳實(shí)踐
<code>ngx.shared.DICT</code> 非隊(duì)列性質(zhì)
使用動(dòng)態(tài) DNS 來完成 HTTP 請求
代碼規(guī)范
什么是 JIT?
Windows 平臺(tái)安裝
正確的記錄日志
LuaNginxModule
不用標(biāo)準(zhǔn)庫
C10K 編程
控制結(jié)構(gòu)
請求中斷后的處理
Lua 環(huán)境搭建
Test::Nginx 能指定現(xiàn)成的 nginx.conf,而不是自動(dòng)生成一個(gè)嗎
Lua 基礎(chǔ)數(shù)據(jù)類型
動(dòng)態(tài)限速
PostgresNginxModule
簡單API Server框架
API 測試
location 匹配規(guī)則
虛變量
單元測試
防止 SQL 注入
select + set_keepalive 組合操作引起的數(shù)據(jù)讀寫錯(cuò)誤
阻塞操作
全動(dòng)態(tài)函數(shù)調(diào)用
Web 服務(wù)
典型應(yīng)用場景
Nginx 新手起步
TLS session resumption
輸出響應(yīng)體
調(diào)用代碼前先定義函數(shù)
module 是邪惡的
怎樣理解 cosocket
模塊
Socket 編程發(fā)展
如何對(duì) Nginx Lua module 添加新 api
如何在后臺(tái)開啟輕量級(jí)線程完成定時(shí)任務(wù)?
如何定位問題
table 庫
json 解析的異常捕獲
如何安裝火焰圖生成工具
lua 中如何 continue
if 是邪惡的
為什么我們的域名不能被解析
抵制使用 module() 定義模塊
測試
body 在 location 中的傳遞
Lua 入門
子查詢
pipeline 壓縮請求數(shù)量
如何發(fā)起新 HTTP 請求
Lua 簡介
緩存失效風(fēng)暴
Ubuntu 平臺(tái)安裝
日志輸出
緩存
Lua 面向?qū)ο缶幊?/span>
Nginx 陷阱和常見錯(cuò)誤
Redis 接口的二次封裝(發(fā)布訂閱)
日志
訪問有授權(quán)驗(yàn)證的 Redis
正則表達(dá)式
lock
熱裝載代碼
調(diào)用 FFI 出現(xiàn) &quot;table overflow&quot;
數(shù)據(jù)合法性檢測
禁止某些終端訪問
控制結(jié)構(gòu) if-else
調(diào)試
與 Docker 使用的網(wǎng)絡(luò)瓶頸
PostgresNginxModule 模塊的調(diào)用方式
用 do-end 整理你的代碼
FFI
什么時(shí)候使用
簡介
環(huán)境搭建
Mac OS X 平臺(tái)安裝
火焰圖
負(fù)載均衡
while 型控制結(jié)構(gòu)
如何定位 openresty 崩潰 bug
使用 Nginx 內(nèi)置綁定變量
判斷數(shù)組大小
請求返回后繼續(xù)執(zhí)行
Redis 接口的二次封裝
KeepAlive
反向代理
協(xié)議無痛升級(jí)
數(shù)學(xué)庫
元表
Vanilla 介紹
HelloWorld
LuaCjsonLibrary
持續(xù)集成
代碼靜態(tài)分析
網(wǎng)上有大量對(duì) Lua 調(diào)優(yōu)的推薦,我們應(yīng)該如何看待?
script 壓縮復(fù)雜請求
非空判斷
性能測試
函數(shù)返回值
API 的設(shè)計(jì)
kong 介紹
表達(dá)式
不支持事務(wù)
LuaRestyDNSLibrary 簡介

代碼規(guī)范

其實(shí)選擇 OpenResty 的同學(xué),應(yīng)該都是對(duì)執(zhí)行性能、開發(fā)效率比較在乎的,而對(duì)于代碼風(fēng)格、規(guī)范等這些 小事 不太在意。作為一個(gè)從 Linux C/C++ 轉(zhuǎn)過來的研發(fā),腳本語言的開發(fā)速度,接近 C/C++ 的執(zhí)行速度,在我輕視了代碼規(guī)范后,一個(gè) BUG 的發(fā)生告訴我,沒規(guī)矩不成方圓。

既然我們玩的是 OpenResty,那么很自然的聯(lián)想到,OpenResty 自身組件代碼風(fēng)格是怎樣的呢?

lua-resty-string 的 string.lua

local ffi = require "ffi"
local ffi_new = ffi.new
local ffi_str = ffi.string
local C = ffi.C
local setmetatable = setmetatable
local error = error
local tonumber = tonumber

local _M = { _VERSION = '0.09' }

ffi.cdef[[
typedef unsigned char u_char;

u_char * ngx_hex_dump(u_char *dst, const u_char *src, size_t len);

intptr_t ngx_atoi(const unsigned char *line, size_t n);
]]

local str_type = ffi.typeof("uint8_t[?]")

function _M.to_hex(s)
    local len = #s * 2
    local buf = ffi_new(str_type, len)
    C.ngx_hex_dump(buf, s, #s)
    return ffi_str(buf, len)
end

function _M.atoi(s)
    return tonumber(C.ngx_atoi(s, #s))
end

return _M

代碼雖短,但我們可以從中獲取很多信息:

  1. 沒有全局變量,所有的變量均使用 local 限制作用域
  2. 提取公共函數(shù)到本地變量,使用本地變量緩存函數(shù)指針,加速下次使用
  3. 函數(shù)名稱全部小寫,使用下劃線進(jìn)行分割
  4. 兩個(gè)函數(shù)之間距離兩個(gè)空行

這里的第 2 條,是有爭議的。當(dāng)你按照這個(gè)方式寫業(yè)務(wù)的時(shí)候,會(huì)有些痛苦。因?yàn)槲覀兛偸前褬?biāo)準(zhǔn) API 命名成自己的別名,不同開發(fā)協(xié)作人員,命名結(jié)果一定不一樣,最后導(dǎo)致同一個(gè)標(biāo)準(zhǔn) API 在不同地方變成不同別名,會(huì)給開發(fā)造成極大困惑。

因?yàn)檫@個(gè)可預(yù)期的麻煩,我們沒有遵循第 2 條標(biāo)準(zhǔn),尤其是具體業(yè)務(wù)上游模塊。但對(duì)于被調(diào)用的次數(shù)比較多基礎(chǔ)模塊,可以使用這個(gè)方式進(jìn)行調(diào)優(yōu)。其實(shí)這里最好最完美的方法,應(yīng)該是 Lua 編譯成 Luac 的時(shí)候,直接做 Lua Byte Code 的調(diào)優(yōu),直接隱藏這個(gè)簡單的處理邏輯。

有關(guān)更多代碼細(xì)節(jié),其實(shí)我覺得主要還是多看寫的漂亮的代碼,一旦看他們看的順眼、形成習(xí)慣,那么就很自然能寫出風(fēng)格一致的代碼。規(guī)定的條條框框死記硬背總是很不爽的,所以多去看看春哥開源的 resty 系列代碼,順手品一品一下不同組件的玩法也別有一番心得。

說說我上面提及的因?yàn)轱L(fēng)格問題造出來的坑吧。

local
function test()
    -- do something
end

function test2()
    -- do something
end

這是我當(dāng)時(shí)不記得從哪里看到的一個(gè) Lua 風(fēng)格,在被引入項(xiàng)目初期,自我感覺良好??赏蝗粡哪硞€(gè)時(shí)間點(diǎn)開始,新合并進(jìn)來的代碼無法正常工作。查看最后的代碼發(fā)現(xiàn)原來是 test() 函數(shù)作廢,被刪掉,手抖沒有把上面的 local 也刪掉。這個(gè)隱形的 local 就作用到了下一個(gè)函數(shù),最終導(dǎo)致異常。