初學編程，你寫的是死代碼嗎？如何判斷和清理，一招搞定~

做爲開發者的你平時工做時是怎麼判斷並清理死代碼的？也許你猜到了這篇文章要講什麼。

是的，咱們是有一些清理死代碼的好方法推薦給你……在認真考慮了各類自動化工具之餘，咱們還但願可以遍歷全部的代碼，分析每個 .erl 和 .hrl 文件，並輸出全部能夠刪除和/或重構代碼的候選列表。

本文介紹的這款工具 Hank 能夠幫助你肯定哪些是死代碼。

Hank 與其餘現有工具的區別

你可能想問：「爲何我要選擇 Hank？這類的工做能夠經過 linter 解決！」

答案是：不，Hank 與 linter 不一樣。

關於代碼的 linting，咱們使用 Elvis，它會審覈咱們的 Erlang 代碼風格，好比函數命名、嵌套層級、每一行的長度、變量命名約定等等。

這些不屬於 Hank 的工做範圍。

Xref 是一種交叉引用工具，可用於查找函數、模塊、應用程序以及發行版本之間的依賴關係。它會分析函數的定義和函數的調用，並警告咱們源代碼中已定義、但從未使用過的函數。

這些也不屬於 Hank 的工做範圍。

那麼 Dialyzer 呢？Dialyzer 是一種靜態分析工具，可識別軟件差別，例如成功類型的錯誤，以及因爲編程錯誤而變得無效或沒法訪問的代碼，以及沒必要要的測試等。它的分析基於的是成功類型的概念。

Hank 不依賴於規範，也不評估函數參數/返回中的「語義」

Hank 的功能

那麼，Hank 究竟有哪些功能？

Hank 會檢測並警告你代碼庫中能夠被刪除，或者能夠根據規則重構的代碼。

它適用於整個項目（與 Elvis 不一樣，後者只能處理單個文件），源代碼（與 Xref 不一樣，後者只能處理已編譯的代碼），以及單個項目（與 Dialyzer 不一樣，後者將分析整個系統，包括 OTP 以及依賴項）。

如何使用 rebar3_hank

你只須要將下列代碼添加到rebar.config（項目或全局的~/.config/rebar3/rebar.config）：

{plugins, [rebar3_hank]}.

而後運行：

rebar3 hank

接下來就是見證奇蹟的時刻！

跳過規則

在某些狀況下，你可能須要跳過某些規則，好比正在開發的庫，你能夠在其中定義供其餘使用的 hrl 或模塊。

在這種狀況下，你可能須要忽略一些規則（例如single_use_hrl_attributes）。

使用 Xref 也會發生相似的狀況。

爲此，hank 能夠忽略模塊級別的規則：

% ignoring all the rules for this module
-hank ignore


% or ignoring specific rules
-hank [single_use_hrl_attributes]

或者，在 rebar.config 中添加如下配置：

{hank, [{ignore, [
   {"test/*.erl", unused_ignored_function_params}
]}]}.

規則

如下是咱們建立好的規則，你能夠直接在 Hank 中使用。

unused_ignored_function_params

隨着函數的不斷髮展，之前的某些參數可能已再也不使用了。最簡單的解決方案可能就是忽略它們，而後忘掉這個問題。

Hank 會檢測出全部函數中被忽略的參數，並告知你能夠刪除這些參數，並重構函數的調用，這樣就可讓代碼更加簡潔。

例如，在分析這個模塊時……

-module(my_module).


-export([external_fun/1]).


external_fun(X) ->
    multi_fun(X,rand:uniform(), undefined).


%% A multi-clause function with unused 3rd param
multi_fun(undefined, _, _) ->
    ok;
multi_fun(Arg1, Arg2, _Arg3) when is_binary(Arg1) ->
    Arg2;
multi_fun(Arg1, _, _) ->
    Arg1.

Hank 的輸出結果爲：

$ rebar3 hank
===> Looking for code to kill with fire...
===> The following pieces of code are dead and should beremoved:
src/my_module.erl:9: Param #3 is not used at 'multi_fun/3'

爲了不這種警告，你能夠刪除未使用的參數。

single_use_hrls

有時，你會將一些代碼放入應該在多個模塊之間共享的頭文件中，但最終你只編寫了一個使用該頭文件的模塊。在這種狀況下，最好將頭文件的內容直接放入模塊內。Hank 有這樣的一個規則！

假設有一個文件 header.hrl：

-define(APP_HEADER, "this is a header from an app that willbe used in just one module").
-define(SOME_MACRO(A), A).


-module(app_include_lib).


-include("header.hrl").


-export([my_function/0]).


my_function() ->
  % those are only usedhere!
 ?SOME_MACRO(?APP_HEADER).

Hank 的輸出結果爲：

$ rebar3 hank
===> Looking for code to kill with fire...
===> The following pieces of code are dead and should beremoved:
header.hrl:0: This header file is only included at:src/app_include_lib.erl

將這個 hrl 文件的內容直接放入使用該文件的模塊中，就不會再看到這則警告了。

single_use_hrl_attrs

有時，狀況會更微妙。有時，整個文件並不是僅在一個模塊中使用，可能在許多模塊之間共享。可是某些屬性並不是如此，例如宏或記錄，它們在頭文件中定義，但僅在單個模塊中使用。Hank 有一條規則，建議你將這些屬性放在模塊內，以減小沒必要要的共享內容。

對於上述文件，假設 hrl 包含在另外一個文件中：

-module(app_include_lib_2).

-include("header.hrl").

Hank 的輸出結果爲：

$ rebar3 hank
===> Looking for code to kill with fire...
===> The following pieces of code are dead and should beremoved:
include/header.hrl:2: ?SOME_MACRO/1 is used only at src/app_include_lib.erl

unused_hrls

有時，狀況會更加惡劣，有的 hrl 文件可能沒有包含在任何模塊中。Hank 會檢測到它們，並告知你能夠將其徹底刪除，由於實際上它們沒有任何做用。

添加一個未包含在任何模塊中的 header_2.hrl 文件，Hank 的輸出結果爲：

$ rebar3 hank
===> Looking for code to kill with fire...
===> The following pieces of code are dead and should beremoved:
include/header_2.hrl:0: This file is unused

unused_macros

Hank 還有一條規則，它將檢測項目中未使用的宏。這些宏可能定義在了源代碼中的任何文件中，可是從未使用。所以，這些宏都是沒有必要的，能夠刪除。

unused_record_fields

這個規則很重要。根據這個規則，Hank 會發現某些記錄聲明帶有字段定義（甚至爲它們提供默認值），但從未使用過。Hank 認爲訪問或寫入記錄字段就是在使用它。

你能夠經過這個警告，刪除記錄中未使用的字段，從而減少記錄的大小。

可擴展性

咱們很是注重該項目的可擴展性，任何人均可以經過實現 hank_rule 的行爲來編寫本身的項目規則。

可是，若是你以爲新規則具備普遍適用性的話，能夠貢獻到 rebar3_hank 的 GitHub 社區！你能夠查看未解決的議題，並隨時建立新的議題！

測試 Hank 的威力

爲了讓你瞭解 Hank 的功能，咱們決定在一個很大的代碼庫中對其進行測試。

咱們決定嘗試使用 Erlang / OTP。因爲這個項目主要由各類庫組成，所以咱們必須限制應用哪些規則，以避免產生一些虛假的結果。咱們使用瞭如下配置：

{hank, [
    {ignore,["**/test/**"]}, %% Just "production" code, no tests
    {rules, [
       unused_ignored_function_params,
        unused_hrls,
        unused_macros,
       unused_record_fields
    ]}
]}.

咱們知道會找到大量警告，可是最終的結果仍是超出了預期。Hank 找到了 OTP 生產代碼中的 4000 多條死代碼。

雖然說並非全部收到警告的代碼都應該被刪除，可是經過這個例子，你也看出了 Hank 的威力。如下是 Hank 輸出的警告……

記錄中未使用的字段

Hank 找到了 130 多個包含未使用字段的記錄，例如 erl_tidy 或 remote_logger。

未使用的宏

Hank 在 OTP 中發現了 1000 多個未使用的宏，其中大多數出如今 megaco 應用程序的大型模塊中，還有一些出如今其餘宏中，好比 xmerl_uri。

未使用的參數

Hank 還發現了 2000 多個函數帶有未使用的參數。其實有些不是真正的錯誤，但有些值得仔細檢查。

好比這個例子（https://github.com/erlang/otp/blob/6378a0c825db64df91e01ee39e3a268f4ba050b7/lib/inets/src/http_lib/http_uri.erl#L257-L266），該參數從未使用過第一個參數。

參考連接：https://tech.nextroll.com/blog/dev/2021/01/06/erlang-rebar3-hank.html

 若是你正在自學編程，正在敲代碼，不防和咱們一塊兒交流學習，避免走不少彎路~

咱們給你提供：

一、海量學習大禮包免費領取

二、同行之間的交流學習

三、多年編程經驗大佬在線教學、解答問題

四、如何獲取——《+Q裙：1151395975免費領取》