邁出加入 Apache IoTDB 社區的第一步!(訂閱郵件、調試代碼)

不少想參與項目開發的同窗由於沒有人領路,不知道哪些任務適合本身,對於如何參與到項目中也是一頭霧水。今天就來介紹一下如何參與開發,本文主要目標是幫助你們如何加入社區。html

今天的內容主要包括:訂閱郵件列表,尋找 issue,編譯源碼,調試服務器代碼。java

訂閱郵件列表

Apache 項目的主要溝通方式是郵件列表,咱們項目開發者的郵件列表爲 dev@iotdb.apache.org , 只要訂閱了這個郵件列表,就能接收到其餘人往這個郵箱裏發的郵件,一樣,你向這裏發的郵件別人也會接收到,相似一個延遲稍微高一些的微信羣。linux

訂閱方式是用郵箱往 dev-subscribe@iotdb.apache.org 發一封郵件,主題內容隨意,能夠寫 subscribe。接下來會受到一封確認郵件,確認郵件裏有一個連接,往這個確認連接再回一封郵件就訂閱成功了。git

訂閱後的第一件事就是發個自我介紹啦,能夠介紹一下本身的姓名、地區、公司、熟悉的語言、技術棧等等。github

你們不用把郵件列表當作那麼嚴肅的地方,其實這裏邊能夠討論任何和項目有關的,包括舉辦meetup、反饋 bug、分享設計思路,或者剛入門但願別人給介紹一些入門的任務項等,都是能夠的。apache

剛來對待郵件列表的態度就是:不怕犯錯,不怕說錯,熱情發言。windows

尋找合適的 issue

平時用的是 jira。服務器

https://issues.apache.org/jira/projects/IOTDB/issues微信

此外 github 的 issue 也能夠。函數

若是不知道哪些功能適合本身,能夠來郵件列表裏問,或者問我也能夠。

編譯源碼

git clone https://github.com/apache/incubator-iotdb.git

接下來須要將 thrift/target/generated-sources/thrift 、 antlr/target/generated-sources/antlr4 、thrift-sync/target/generated-sources/thrift 目錄標記成項目源代碼,讓 IDE 識別。

以 IDEA 標記 antlr 目錄爲例:

到此爲止,代碼中應該就沒有飄紅的了。

調試服務器代碼

第一次調試 IoTDB,能夠從兩個模塊入手,服務器(server)和命令行工具(cli )。

首先啓動服務器,主類 IoTDB,debug 模式啓動。

接下來給 TSServiceImpl 類的 executeStatement 打個斷點,Cli 裏寫的語句都會發送給服務器,而服務器的線程就經過這個 rpc 函數處理語句了。

接下來啓動命令行工具。主類爲 Cli (mac、linux)或 WinCli (windows)。啓動以後會報缺乏參數,這個時候能夠在箭頭處選 Cli,而後 Edit Configuration

把類 javadoc 裏的幾個參數設置到 Program arguments 裏,點擊 Apply,OK。

而後就能夠 run 啓動 Cli 了(若是想調試客戶端,能夠 debug 模式啓動)。啓動以後能夠在 run 的控制檯裏輸入一個命令,這裏以建立存儲組爲例,輸入完回車,客戶端進程就開始等待服務器返回結果了。

這時候會自動跳轉到服務器進程的 debugger 裏,就能夠正式調試了。

另一種適合學習代碼的是跑測試用例,每一個模塊都有對應的測試用例,普通的 UT 命名都對應了(測試的類名+Test),集成測試的後綴是 IT。

總結

邁出第一步以後,就能夠對照設計文檔看代碼啦,http://iotdb.apache.org/zh/SystemDesign/Architecture/Architecture.html 。接下來會介紹 IoTDB 的設計原理、源碼解析等內容。歡迎關注!

本文分享自微信公衆號 - IoTDB漫遊指南(Apache-IoTDB)。
若有侵權,請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」,歡迎正在閱讀的你也加入,一塊兒分享。

相關文章
相關標籤/搜索