ebug用來追蹤代碼的運行流程,通常在程序運行過程中出現異常,啟用Debug模式可以分析定位異常發生的位置,以及在運行過程中參數的變化。通常我們也可以啟用Debug模式來跟蹤代碼的運行流程去學習三方框架的源碼。
所以學習下如何在Intellij IDEA中使用好Debug,主要包括如下內容:
一、Debug開篇
首先看下IDEA中Debug模式下的界面。
如下是在IDEA中啟動Debug模式,進入斷點后的界面,我這里是Windows,可能和Mac的圖標等會有些不一樣。就簡單說下圖中標注的8個地方:
在設置里勾選Show debug window on breakpoint,則請求進入到斷點后自動激活Debug窗口
如果你的IDEA底部沒有顯示工具欄或狀態欄,可以在View里打開,顯示出工具欄會方便我們使用。可以自己去嘗試下這四個選項。
在菜單欄Run里有調試對應的功能,同時可以查看對應的快捷鍵。
二、基本用法&快捷鍵
Debug調試的功能主要對應著圖一中4和5兩組按鈕:
1、首先說第一組按鈕,共8個按鈕,從左到右依次如下:
2、第二組按鈕,共7個按鈕,從上到下依次如下:
更新程序,On 'Update' actions,執行更新操作時所做的事情,一般選擇'Update classes and resources',即更新類和資源文件。
一般配合熱部署插件會更好用,如JRebel,這樣就不用每次更改代碼后還要去重新啟動服務。如何激活JRebel,在最后章節附上。
下面的On frame deactivation,在IDEA窗口失去焦點時觸發,即一般你從idea切換到瀏覽器的時候,idea會自動幫你做的事情,一般可以設置Do nothing,頻繁切換會比較消耗資源的。
[圖2.3]
三、變量查看
在Debug過程中,跟蹤查看變量的變化是非常必要的,這里就簡單說下IDEA中可以查看變量的幾個地方,相信大部分人都了解。
1、如下,在IDEA中,參數所在行后面會顯示當前變量的值。
2、光標懸停到參數上,顯示當前變量信息。點擊打開詳情如圖3.3。我一般會使用這種方式,快捷方便。
3、在Variables里查看,這里顯示當前方法里的所有變量。
4、在Watches里,點擊New Watch,輸入需要查看的變量。或者可以從Variables里拖到Watche里查看。
如果你發現你沒有Watches,可能在下圖所在的地方。
四、計算表達式
在前面提到的計算表達式如圖4.1的按鈕,Evaluate Expression (Alt + F8) 。可以使用這個操作在調試過程中計算某個表達式的值,而不用再去打印信息。
1、按Alt + F8或按鈕,或者,你可以選中某個表達式再Alt + F8,彈出計算表達式的窗口,如下,回車或點擊Evaluate計算表達式的值。
這個表達式不僅可以是一般變量或參數,也可以是方法,當你的一行代碼中調用了幾個方法時,就可以通過這種方式查看查看某個方法的返回值。
2、設置變量,在計算表達式的框里,可以改變變量的值,這樣有時候就能很方便我們去調試各種值的情況了不是。
五、智能步入
想想,一行代碼里有好幾個方法,怎么只選擇某一個方法進入。之前提到過使用Step Into (Alt + F7) 或者 Force Step Into (Alt + Shift + F7)進入到方法內部,但這兩個操作會根據方法調用順序依次進入,這比較麻煩。
那么智能步入就很方便了,智能步入,這個功能在Run里可以看到,Smart Step Into (Shift + F7),如圖5.1
按Shift + F7,會自動定位到當前斷點行,并列出需要進入的方法,如圖5.2,點擊方法進入方法內部。
如果只有一個方法,則直接進入,類似Force Step Into。
六、斷點條件設置
通過設置斷點條件,在滿足條件時,才停在斷點處,否則直接運行。
通常,當我們在遍歷一個比較大的集合或數組時,在循環內設置了一個斷點,難道我們要一個一個去看變量的值?那肯定很累,說不定你還錯過這個值得重新來一次。
1、在斷點上右鍵直接設置當前斷點的條件,如圖6.1,我設置exist為true時斷點才生效。
2、點擊View Breakpoints (Ctrl + Shift + F8),查看所有斷點。
Java Line Breakpoints 顯示了所有的斷點,在右邊勾選Condition,設置斷點的條件。
勾選Log message to console,則會將當前斷點行輸出到控制臺,如圖6.3
勾選Evaluate and log,可以在執行這行代碼是計算表達式的值,并將結果輸出到控制臺。
3、再說說右邊的Filters過濾,這些一般情況下不常用,簡單說下意思。
Instance filters:實例過濾,輸入實例ID(如圖6.5中的實例ID),但是我這里沒有成功,不知道什么原因,知道的朋友留個言。
Class filters:類過濾,根據類名過濾,同樣沒有成功....
Pass count:用于循環中,如果斷點在循環中,可以設置該值,循環多少次后停在斷點處,之后的循環都會停在斷點處。
4、異常斷點,通過設置異常斷點,在程序中出現需要攔截的異常時,會自動定位到異常行。
如圖6.6,點擊+號添加Java Exception Breakpoints,添加異常斷點。然后輸入需要斷點的異常類,如圖6.7,之后可以在Java Exception Breakpoints里看到添加的異常斷點。
我這里添加了一個NullPointerException異常斷點,如圖6.8,出現空指針異常后,自動定位在空指針異常行。
七、多線程調試
一般情況下我們調試的時候是在一個線程中的,一步一步往下走。但有時候你會發現在Debug的時候,想發起另外一個請求都無法進行了?
那是因為IDEA在Debug時默認阻塞級別是ALL,會阻塞其它線程,只有在當前調試線程走完時才會走其它線程。可以在View Breakpoints里選擇Thread,如圖7.1,然后點擊Make Default設置為默認選項。
切換線程,在圖7.2中Frames的下拉列表里,可以切換當前的線程,如下我這里有兩個Debug的線程,切換另外一個則進入另一個Debug的線程。
八、回退斷點
在調試的時候,想要重新走一下流程而不用再次發起一個請求?
1、首先認識下這個方法調用棧,如圖8.1,首先請求進入DemoController的insertDemo方法,然后調用insert方法,其它的invoke我們且先不管,最上面的方法是當前斷點所在的方法。
2、斷點回退
所謂的斷點回退,其實就是回退到上一個方法調用的開始處,在IDEA里測試無法一行一行地回退或回到到上一個斷點處,而是回到上一個方法。
回退的方式有兩種,一種是Drop Frame按鈕(圖8.2),按調用的方法逐步回退,包括三方類庫的其它方法(取消Show All Frames按鈕會顯示三方類庫的方法,如圖8.3)。
第二種方式,在調用棧方法上選擇要回退的方法,右鍵選擇Drop Frame(圖8.4),回退到該方法的上一個方法調用處,此時再按F9(Resume Program),可以看到程序進入到該方法的斷點處了。
但有一點需要注意,斷點回退只能重新走一下流程,之前的某些參數/數據的狀態已經改變了的是無法回退到之前的狀態的,如對象、集合、更新了數據庫數據等等。
九、中斷Debug
想要在Debug的時候,中斷請求,不要再走剩余的流程了?
有些時候,我們看到傳入的參數有誤后,不想走后面的流程了,怎么中斷這次請求呢(后面的流程要刪除數據庫數據呢....),難道要關閉服務重新啟動程序?嗯,我以前也是這么干的。
確切的說,我也沒發現可以直接中斷請求的方式(除了關閉服務),但可以通過Force Return,即強制返回來避免后續的流程,如圖9.1。
點擊Force Return,彈出Return Value的窗口,我這個方法的返回類型為Map,所以,我這里直接返回 results,來強制返回,從而不再進行后續的流程。或者你可以new HashMap<>()。
十、附:JRebel激活
目前本人一直使用JRebel做熱部署工具,效果還算理想,修改Java代碼或者xml等配置文件都能熱更新。偶爾服務開久了,或更改的文件較多時,熱更新沒有生效,需要重新啟動服務。
這里只是簡單說下我在網上看到的一種免費獲得永久使用權的方式(非破解),不確定這種方式什么時候不能用。
【本文目標】
本文目標是指導如何使用REMIX完成一次智能合約交易調試。
【前置條件】
學習過Solidity語言,需要進行調試。
【技術收獲】
1). 使用REMIX進行單步調試
2). REMIX的Debugger界面介紹
【實操課程列表】
第一課 如何在WINDOWS環境下搭建以太坊開發環境
第二課 如何實現以太坊最簡智能合約“Hello World”的運行
第四課 以太坊開發框架Truffle從入門到實戰
第六課 技術小白如何開發一個DAPP區塊鏈應用(以寵物商店為例)
第七課 技術小白如何在45分鐘內發行通證(TOKEN)并上線交易
第八課 如何調試以太坊官網的智能合約眾籌案例
第九課 如何在Remix環境下進行Solidity代碼單步調試
第十課 Solidity語言編輯器REMIX指導大全
【說明】未列出的課程為知識普及的非實操類課程,所有區塊鏈文章參考“區塊鏈入口”專欄。
REMIX有2種方式啟動調試。
新建一個智能合約文件”Donation.sol”,復制以下代碼:
contract Donation { address owner; event fundMoved(address _to, uint _amount); modifier onlyowner { if (msg.sender == owner) _; } address[] _giver; uint[] _values; function Donation() { owner = msg.sender; } function donate() payable { addGiver(msg.value); } function moveFund(address _to, uint _amount) onlyowner { uint balance = this.balance; uint amount = _amount; if (_amount <= this.balance) { if (_to.send(_amount)) { fundMoved(_to, _amount); } else { throw; } } else { throw; } } function addGiver(uint _amount) internal { _giver.push(msg.sender); _values.push(_amount); } }
2.1 從用戶界面開始
RUN運行環境選擇JavaScript VM ,它用于模擬客戶自定義環境,開始點擊Create按鈕執行智能合約:
智能合約創建
設置′value′的值為10,單位選擇ether,點擊Donate 表示從當前賬號捐贈10個ETH給該智能合約。
交易轉移
Remix顯示交易相關的一些信息。在終端輸出器,此次交易被記錄,點擊”Debug”按鈕可開始調試。
2.2 從調試器開始
在”Debugger”控制面板進入,在對應的編輯框輸入transaction hash / block number、transaction index信息也可以開始會話。
面板進入
作為例子,運行“donate”函數后,點擊終端輸出器對應LOG的Detail按鈕展開交易信息,復制hash信息值輸入編輯框,點擊PLAY按鈕,即可進入Debug調試流程。
此效果等同于點擊交易信息的“Debug”按鈕。
Transation信息
調試器允許查看交易合約執行的詳細信息。它使用左側的編輯器顯示執行時源碼的位置。
交易控制面板顯示當前交易合約的基礎信息。導航欄包括7個按鈕用于交易的單步調試。
調試器按鈕
從左到右的按鈕名稱:
1,step over back
2,step back
3, step into
4,step over forward
5,jump to the previous breakpoint
6,jump out
7, jump to the next breakpoint
下面有11個面板用于顯示執行的詳細信息。
結果面板
3.1 Instructions面板
本案例運行交易的Instructions信息
Instructions面板顯示當前高亮顯示的運行合約的匯編語言。
注意:當該面板隱藏時,滑動條的運行粒度是一個course的,即使在多EVM環境構建,也只會在語法邊界停止;當該面板顯示時,才可能逐步進入到構建函數內部,即使對應相同的語句。
3.2 Solidity Locals面板
Solidity Locals
Solidity Locals面板顯示當前上下文環境的局部變量值。
3.3 Solidity State面板
Solidity State
Solidity State面板顯示的是當前執行合約的狀態變量。
3.4 Low level面板
其他低層級面板
以下面板顯示本次執行的低層次信息:
? Stack 堆棧
? Storages Changes 存儲改變
? Memory 內存
? Call Data 調用數據
? Call Stack 調用堆棧
? Return Value 返回值,只有當運行到RETURN原語才顯示
? Full Storages Changes 全存儲改變,只有在執行末尾才顯示所有改變的合約變化存儲
3.5 交易回滾(Reverted Transaction)
交易回滾
一個交易合約可以回滾,例如因為GAS超限,程序拋出 throw語句或者低層次的異常。
在這種場景下,識別異常和定位異常的代碼位置是非常重要的。
當執行拋出異常時,Remix將告警。warning 按鈕將在異常發生前跳轉到最后的執行原語。
需要說明的是,智能合約交易的執行是事件級別的,就是無法如C++一樣在運行中改變變量值,只能一次執行完畢。調試器記錄了執行的原語記錄,所以可以前進和回滾。對于回滾,就像影片回滾放映一樣,非常酷炫。
3.6 Breakpoints斷點和單步調試
導航欄的5,7按鈕按鈕用于回滾到前一個斷點和執行到下一個斷點。
在左側編輯框的行數處單擊即可增加和刪除斷點。
作為樣例,在18行和20行雙擊,設置2個斷點,在Run面板的moveFund輸入框內輸入參數,給第二個賬號轉移0.0005個ETH。點擊”MoveFund”執行該交易函數。
"0x14723a09acff6d2a60dcdf7aa4aff308fddc160c",500000000000000
合約交易執行成功后,點擊終端輸出器中的Debug按鈕,點擊調試面板的“Jump to the next breakpoint”程序會運行到第一個斷點處。
執行到第一個斷點
再點擊“Jump to the next breakpoint”按鈕一次,直接運行到20行第二個斷點處。
點擊”Jump out”函數跳出該函數,運行完成后可以看到第二個賬號余額發生了改變,增加了0.0005個ETH。
點擊展開Detail,可以看到EVENT事件記錄的參數信息。
執行結果
3.7 切換賬號調用存量合約
REMIX在“Environment”采用“Injected WEB3”的方式下,切換賬號會導致智能合約呈現消失。
此時可以通過調用合約地址的方式把合約和命令復原回來。
例如我有一個部署在ropsten的智能合約,地址為"0xbb7695fe978176cbe86d27b9e2b4e9eff1a04f82",恢復方法如下圖所示:記得輸入合約地址框不要加"" 哦。
1),REMIX調試英文官網文檔
2), SOLIDITY語言官網中文版