用 rebar 来构建、编译、测试、发布 Erlang 应用程序
轉自:http://dhq.me/build-compile-eunit-release-erlang-application-with-rebar
rebar 是一個遵循 Erlang/OTP 原則的 Erlang 項目構建工具,使用它可以減少構建標準 Erlang/OTP 項目架構配置的工作量,并且可以很容易的編譯、測試、發布 Erlang 應用程序。更強大的是,rebar 提供一種依賴管理機制,它可以使開發者很方便地通過 Git、Hg 等方式重用常見的第三方 Erlang 模塊或庫。
安裝 rebar
你可以從 https://github.com/rebar/rebar/wiki/rebar下載編譯好的版本,也可以自己下載 rebar 的源代碼,自己編譯一個:
|
1 2 3 |
|
上面編譯好之后,在當前目錄下就會生成一個名為 "rebar" 獨立的 erlang 腳本(escript),把它放在你想創建標準 Erlang/OTP 項目的目錄路徑下即可使用,或者把 rebar 放在系統目錄的 Path 下,方便在終端使用:
| 1 |
|
在終端輸入 "rebar -c" 將列出所有可執行的 rebar 命令。或者輸入 "rebar -h" 查看更多的 rebar 參數信息。
用 rebar 構建項目
創建一個名為 rebarapp 的文件夾
|
1 2 |
|
創建名為 rebarapp 項目:
| 1 |
|
rebar 會根據默認模板(template)在當前目錄下生成一個 src 文件夾,里面包含下面3個文件:
rebarapp.app.src 應用的資源描述文件,影響后面編譯生成的 rebarapp.app 里的內容
rebarapp_app.erl 應用的 Application Behaviour 代碼文件
rebarapp_sup.erl 應用的 Supervisor Behaviour 代碼文件
rebar 還內置了 gen_server、gen_fsm、application 等 Erlang/OTP 行為模式的模板,可以自動生成這些行為模式的框架代碼。這里以 gen_server 為例,給應用添加一個名為 rebarapp_server 的 gen_server 行為模式。在應用根目錄執行以下命令:
| 1 |
|
執 行完后自動會在 src 文件夾里生成一個 rebarapp_server.erl 的 gen_server 框架格式的文件,simplesrv 是 gen_server 模板的名稱(gen_fsm、application對應的是simplefsm、simpleapp),srvid 則是該 gen_server 模板的ID(gen_fsm、application對應的是fsmid、appid)。
為了測試,這里對 rebarapp_server.erl 進行修改,export 一個 hello 方法,并添加一個 cast 的消息輸出,修改后的 rebarapp_server.erl 文件內容如下:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
|
修改 rebarapp_sup.erl 的 init 函數,把 rebarapp_server 作為應用管理者 rebarapp_sup 的工作進程啟動,修改如下:
|
1 2 3 |
|
編譯應用
| 1 |
|
編譯完后,會在根目錄下生成一個 ebin 的文件夾,里面存放的是該應用的資源文件 rebarapp.app 和應用的 beam文件,也可以執行以下命令對編譯生成的應用文件進行清理:
| 1 |
|
使用 Edoc 生成應用文檔
| 1 |
|
命令執行完后,會在根目錄生成一個 doc 的文件夾,打開里面的 index.html 就可以很直觀地看到該應用的模塊 API 概覽。
eunit 測試
rebar 會根據一個名為 rebar.config 的文件里的 eunit 配置選項來對應用進行測試,rebar.config 詳細地配置選項信息可以查看官方上的 rebar.config.sample。在應用的根目錄下創建一個 rebar.config,填入以下內容:
|
1 2 3 4 5 6 7 8 9 10 |
|
上面的配置將會加載根目錄下的 test 文件夾里的文件,所以需要在根目錄下創建一個 test 文件夾:
| 1 |
|
這里 test 文件夾將存放 eunit 的測試用例,在 test 文件夾里新建一個名為 rebarapp_test.hrl 的測試用例文件,內容如下:
|
1 2 3 4 5 6 7 8 9 |
|
然后在 rebarapp_server.erl 的文件末尾加上以下測試代碼:
|
1 2 3 |
|
當然,如果有必要的話也可以在每個模塊文件上加上面測試代碼。執行以下命令進行 eunit 測試:
| 1 |
|
如果應用文件沒什么變化修改,也可以直接運行 "rebar eunit"。這時終端出現以下類似顯示,則 eunit 測試完成:
|
1 2 3 4 5 6 7 8 9 10 11 |
|
可以打開根目錄下的.eunit/index.html 查看測試報告。
發布應用
在應用根目錄下創建一個名為 rel 的文件夾,用來作為應用發布的文件夾:
|
1 2 |
|
在當前 rel 文件夾里創建一個名為 rebarapp 的獨立的 Erlang VM 節點:
| 1 |
|
修 改 rel/reltool.config 里的 lib_dirs 的值,默認是一個空列表 "[]",改為應用所在的目錄路徑 '["../../"]',不然到后面編譯發布時會報 "Missing application directory" 的錯誤出來,修改后的 reltool.config 配置內容如下所示:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
|
返回應用的根目錄,在 rebar.config 加上以下一行,把新建的 rel 文件夾放入到 rebar 可訪問的子文件夾里,作為應用內容發布文件夾:
| 1 |
|
再重新編譯下應用 rebarapp
| 1 |
|
如果報什么錯,應用 rebarapp 就可以發布了:
| 1 |
|
在終端上看到 "==> rel (generate)" 且沒報什么錯,應用 rebarapp 發布成功,并在 rel/rebarapp/bin 目錄下生成一個用來啟動應用或停止應用等操控動作的 shell 文件 rebarapp。
操控文件 rel/rebarapp/bin/rebarapp 用法:
| 1 |
|
例如:
啟動應用 rebarapp
| 1 |
|
停止應用 rebarapp
| 1 |
|
或者啟動應用 rebarapp 后返回一個 erlang shell 的控制臺
| 1 |
|
OK,在 erlang shell 的控制臺上調用 rebarapp_server:hello() 輸出一個 "Hello World!" 吧。
總結
以上是生活随笔為你收集整理的用 rebar 来构建、编译、测试、发布 Erlang 应用程序的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: C#技术分享【PDF转换成图片——11种
- 下一篇: iOS 14 新功能:地图 App 为你