劉劍英 宮嵐
摘 要:針對Java系統(tǒng)再工程的需求,利用Microsoft Office軟件中強大的VBA工具,設計開發(fā)一款適合部門內(nèi)部使用,主要用戶為SE及PG為主的開發(fā)人員的Java源代碼分析軟件。系統(tǒng)以Java程序級代碼分析為主,根據(jù)程序的各種引用調(diào)用關(guān)系,生成樹狀結(jié)構(gòu)圖,展示代碼結(jié)構(gòu),建立結(jié)構(gòu)圖與代碼的鏈接,實現(xiàn)代碼的快速定位查找,方便開發(fā)人員查看代碼、理解程序結(jié)構(gòu),降低了對既存Java應用系統(tǒng)維護的風險和成本。
關(guān)鍵詞:VBA;Java;源代碼分析;再工程;結(jié)構(gòu)圖
中圖分類號:TP311 文獻標識碼:A
Abstract:In order to solve Java system reengineering needs,using the powerful VBA of the microsoft office software,design and develop of Java language source code analysis system that suitable for internal use and major users for SE and PG based developer.System to Java program level code analysis,call relationships based on various references to the program,spanning tree structure diagram,display code structure,establish a link to the structure diagram and code,to achieve the rapid positioning of the code to find,facilitate developers to view the code,understanding program structure,reduce the risk and cost of existing Java application system maintenance.
Keywords:VBA;Java;source code analysis;reengineering;structure diagram
1 引言(Introduction)
Java是一種可以撰寫跨平臺應用程序、面向?qū)ο蟮某绦蛟O計語言,目前是嵌入式開發(fā)、互聯(lián)網(wǎng)開發(fā)、云計算和移動互聯(lián)網(wǎng)開發(fā)的主流編程語言。經(jīng)過20多年的發(fā)展,目前擁有全球最大的開發(fā)者專業(yè)社群[1]。
目前Java相關(guān)的工作有很多是對現(xiàn)有系統(tǒng)進行的再工程,如升級、維護、改造、云平臺轉(zhuǎn)換等。市場上的Java源代碼分析軟件多以系統(tǒng)級的大型軟件為主,功能強大但費用高昂,適合中小企業(yè)及開發(fā)人員個人使用的Java源代碼分析軟件則很難找到。本系統(tǒng)是專門面向中小型企業(yè)設計、開發(fā)的Java語言源代碼分析軟件,主要用戶是以SE及PG為主的開發(fā)人員,幫助系統(tǒng)開發(fā)和維護人員快速準確的理解既存系統(tǒng)的源程序,讓軟件開發(fā)人員把主要精力放在解決業(yè)務問題本身,而不是浪費在理解前人寫的代碼上。
2 關(guān)鍵技術(shù)(Key technology)
2.1 開發(fā)平臺
系統(tǒng)以Microsoft Office作為開發(fā)平臺,利用Microsoft Office軟件中強大的VBA工具進行設計開發(fā)。應用時只需要系統(tǒng)安裝Microsoft Office即可,無需單獨的開發(fā)和運行環(huán)境。
2.2 關(guān)鍵技術(shù)
VBA(Visual Basic for Applications)是Visual Basic的一種宏語言,是Microsoft開發(fā)出來在其桌面應用程序中執(zhí)行通用自動化(OLE)任務的編程語言,主要用其來擴展Windows的應用程序功能。VBA作為VB的一個子集,可以說是一種應用程式視覺化的Basic腳本,其語言結(jié)構(gòu)與VB相似,集成開發(fā)環(huán)境IDE幾乎相同[2]。
3 系統(tǒng)主要功能(Main function of the system)
本系統(tǒng)基于軟件靜態(tài)分析,以Java程序級代碼分析為主,不對整個系統(tǒng)進行分析,不實際運行代碼,不查找代碼中存在的結(jié)構(gòu)性錯誤、安全漏洞等問題,也不進行詞法分析、語法分析、語義分析、控制流及數(shù)據(jù)流分析、內(nèi)存泄漏分析等復雜功能的開發(fā)。系統(tǒng)主要根據(jù)程序的各種引用調(diào)用關(guān)系,生成樹狀結(jié)構(gòu)圖,展示代碼結(jié)構(gòu),建立鏈接,實現(xiàn)代碼的快速定位查找,方便開發(fā)人員查看代碼、理解程序結(jié)構(gòu)。
根據(jù)業(yè)務功能分析,系統(tǒng)功能主要分為六個模塊:系統(tǒng)啟動及關(guān)閉模塊、源代碼讀入及統(tǒng)計模塊、源代碼寫入模塊、語法顏色高亮顯示模塊、樹狀結(jié)構(gòu)模塊、創(chuàng)建鏈接模塊,系統(tǒng)功能模塊圖如圖1所示。
(1)配置管理模塊
系統(tǒng)啟動時讀入配置文件,根據(jù)配置文件的內(nèi)容決定Excel文檔中Java代碼的語法高亮顯示顏色。用戶可以通過設定窗口自定義配置內(nèi)容,在系統(tǒng)關(guān)閉的時候系統(tǒng)會將用戶的自定義內(nèi)容保存到配置文件中。
(2)源代碼讀入模塊
實現(xiàn)對Java源文件內(nèi)容的讀取,并在讀取的過程中統(tǒng)計代碼的總行數(shù)、空白行數(shù)、注釋行數(shù)、有效行數(shù)及程序中使用的package、import等信息,以及判定源代碼的方法、變量、標簽等的位置并設置標志位。
(3)源代碼寫入模塊
主要實現(xiàn)新建Excel文檔,插入Sheet頁,將源代碼寫入Excel文檔,以及文檔的保存等功能。
(4)語法顏色高亮顯示模塊
語法顏色高亮顯示模塊主要實現(xiàn)Java關(guān)鍵字、Java系統(tǒng)類高亮表示、注釋行高亮表示、自定義方法高亮表示、標簽高亮表示、括號成對高亮表示等功能。
(5)樹狀結(jié)構(gòu)模塊
樹狀結(jié)構(gòu)模塊根據(jù)源代碼的各種引用調(diào)用關(guān)系,生成樹狀視圖,展示代碼的結(jié)構(gòu)。
(6)創(chuàng)建鏈接模塊
創(chuàng)建樹狀視圖各節(jié)點與源代碼的鏈接,實現(xiàn)代碼的快速定位查找,方便開發(fā)者查看代碼。系統(tǒng)還根據(jù)代碼創(chuàng)建標簽,建立代碼中自定義方法的定義位置和調(diào)用位置的鏈接,方便查找代碼。
4 系統(tǒng)設計與實現(xiàn)(Design and implementation)
主程序設計。首先系統(tǒng)從計算機中讀取Java源文件,讀取模式為逐行讀入,每讀入一行代碼即分析該代碼行是否為空白行、注釋行等信息,并判斷代碼行中是否包含用戶自定義的方法等信息,并添加標志位,系統(tǒng)將代碼行及標志位記入臨時數(shù)組中,直到Java源文件讀取結(jié)束。
讀取源文件結(jié)束后,系統(tǒng)根據(jù)臨時數(shù)組中的數(shù)據(jù)將代碼逐行寫入Excel文檔中,然后系統(tǒng)根據(jù)標志位等信息生成樹狀結(jié)構(gòu)圖,并建立樹狀視圖各節(jié)點與源代碼的鏈接,最后系統(tǒng)逐行逐詞判斷是否Java關(guān)鍵字、Java系統(tǒng)類、括號等信 息并設置語法顏色高亮顯示等信息。主程序流程如圖2所示。
以下為系統(tǒng)部分關(guān)鍵代碼。
(1)系統(tǒng)啟動后讀入配置文件,并根據(jù)配置文件加載系統(tǒng)所需的環(huán)境變量。
5 結(jié)論(Conclusion)
本Java語言源代碼分析系統(tǒng)短小精干、實用性強,是一款適合部門內(nèi)部或個人使用的小型工具軟件,而不是一個巨大的復雜的系統(tǒng)。軟件通過對Java語言既存系統(tǒng)程序代碼的分析,幫助系統(tǒng)開發(fā)工程師和系統(tǒng)維護人員快速準確的理解既存系統(tǒng)的Java源程序,讓軟件工程師把主要精力放在解決軟件開發(fā)項目本身的業(yè)務問題,不必再浪費時間反復閱讀前人所寫的代碼,大大降低了對既存Java應用系統(tǒng)維護的風險和維護成本。
參考文獻(References)
[1] 錢宇虹.基于Java平臺的多語言混合編程[J].軟件工程師,2014(11):39-41.
[2] 布倫[美].Excel專業(yè)開發(fā)MicrosoftExcel及VBA應用開發(fā)權(quán)威指南(第2版)[M].北京:電子工業(yè)出版社,2013.
[3] John Green[美],等.Excel 2007 VBA參考大全(修訂版)[M].北京:人民郵電出版社,2013.
[4] Excel Home.Excel 2010應用大全[M].北京:人民郵電出版社,2011.
[5] Excel Home.別怕,Excel VBA其實很簡單[M].北京:人民郵電出版社,2012.
[6] 沃肯巴赫[美].Excel 2010高級VBA編程寶典[M].北京:清華大學出版社,2012.