【Lua篇】靜態程式碼掃描分析（一）初步介紹

一、靜態程式碼分析

        靜態程式碼分析是一種通過檢查程式碼而不是執行程式來發現原始碼中錯誤的手段。通常可以幫助我們發現常見的編碼錯誤，例如：

• 語法錯誤 

• 違反制定的標準編碼 

• 未定義的變數

• 安全性問題

        靜態程式碼分析可以通過評估編寫的程式碼來提高程式碼質量；可以穩定的執行且可以輕鬆自動化；增加了在原始碼中發現漏洞的可能性，從而提高應用安全；由於是針對原始碼掃描可以在離線的開發環境中完成。但是靜態程式碼分析並不能完全保證編寫的程式碼沒有Bug，它也有一些缺點，例如：

• 誤報問題，發現了一個不是錯誤的錯誤。

• 靜態分析的規則需要特定維護，並非總是適用。

• 系統和第三方庫可能無法分析。

   

二、為何需對Lua程式碼進行靜態分析 

        Lua指令碼語言在效能方面非常出色、語法簡單且容易上手。目前有相當多的遊戲伺服器和客戶端程式都是使用它來開發功能業務。Lua屬於解釋性語言，編寫的邏輯程式碼只有在程式執行的過程才會發現邏輯錯誤，而一些較隱藏的分支可能要經過很長時間的執行才能觸發錯誤。未發現的錯誤如果在正式環境中觸發將會產生不可預估的損失。

        如何發現更多的錯誤，除了通過更加詳細的測試外，還可以利用工具來彌補，下面列舉了一些平時常見的錯誤問題，如果使用靜態掃描分析工具是很容易發現的。

    1. 變數的作用域問題[1]，定義的變數在超出了作用域外使用。

function demo(param)
    if param then
        local var = param.smobj:get_var()
        -- do_something()
    end
    -- 宣告的`var`變數在超出作用域後訪問
    local new_var = var + 3 
end

    2. 變數的作用域問題[2]，超出作用域變數作為條件判斷

function demo(param)
    if param then
        local var = param.smobj:get_var()
        -- do_something()
    end
    if var then
        -- 永遠無法執行到，但不會報錯
        local new_var = var + 10    
        -- do_something()
    end
end

    3. 引數未定義，經常出現在程式碼複製-貼上的時候，未修改完全

function Player:set_world_pos(x, y) 
    do_something(x,y)
    if condition_false then
        log("set_world_pos x:%s, y:%s", x, y)
    end
end
function Player:set_pos(cx, cy) 
    do_something(cx, cy)
    if condition_false then
        -- 這裡是從上面拷貝，但是傳參沒有修改
        -- 程式碼不會報錯但行為已經錯了。
        log("set_pos  x:%s , y:%s", x, y)   
    end
end

    4. 變數拼寫錯誤，很常見但不易察覺。

-- 由於拼寫錯誤，這個只有在過載檔案或者熱更檔案出現
-- 出現就會導致資料丟失，所謂一個粗心導致的大錯
g_player_mng = g_plater_mng or {}
-- do_something

    5. 判空邏輯問題[1]，先使用變數，後進行空值判斷

function demo() 
    local var = self:get_value()
    local count = #var
    -- 先拿變數進行了操作，然後才判斷空值情況
    if var then     
        self:do_something()
    end
end 

    6. 判空邏輯問題[2]，判空的覆蓋不全，後面繼續使用了空值變數。

function demo() 
    local var = self:get_value()
    if var then
        count = #var
    end
    local r, b = self:get_data()
    if b then
        -- 雖然前面對var判空了
        -- 但是沒有進行處理，這裡就繼續使用了。
        table.insert(var, r)   
    end
end

    7. 類成員方法宣告寫錯，“.”、“:” 經常寫錯。

-- 寫類的成員方法的時候漏寫了self 或者 :寫成了.
function Player.set_hp(var)
    if self.mHp > var then
        self.mHp = var
    end
end 

    8. 方法呼叫時，“.”、“:” 寫錯。

function Player:demo2(param)
    -- 少傳了引數self
    self.demo()  
    -- 多傳入了引數self.dos
    self.dos:demoe(self.dos)  
end

        上面這些錯誤來自平時專案中血與淚的教訓，如果能夠通過靜態程式碼掃描工具提前發現這些錯誤，那對提高程式碼的質量是非常有幫助和有價值的事情。目前市面上可以使用騰訊的TscanCode來對程式碼掃描，支援的語言也挺多的。

        我也嘗試花幾篇文章來介紹一下如何編寫一個簡單的Lua程式碼掃描工具，主要介紹大體編寫程式碼的邏輯流程。

　　 文章來自我的公眾號，大家如果有興趣可以關注，具體掃描關注下圖。