譯者 | 李睿

審校 | 重樓

對于開發人員來說，逐行仔細地檢查代碼并試圖掌握算法背后的復雜邏輯可能是一項繁重乏味的任務，特別是在處理大型和復雜的代碼庫時。由于大型代碼庫使得識別所有潛在的測試場景變得困難重重，因此這種方法既耗時又令人不堪重負。幸運的是，代碼圖形工具可以將這個過程實現自動化，并通過圖形方式呈現代碼，從而簡化了任務并提高整體效率。

本文將探討代碼圖的概念，它們如何增強代碼分析、簡化調試和促進影響分析，以及介紹一些能夠簡化這些任務的工具。還將討論當前代碼分析解決方案面臨的挑戰，以及使用知識圖相對于向量數據庫在代碼分析方面的優勢。

什么是代碼圖？

代碼圖直觀地表示代碼庫中的結構關系。它將函數、類和變量映射為節點，并將它們之間的關系（例如函數調用、類繼承和變量依賴）映射為邊。這種結構化表示通過使復雜的代碼庫更容易理解和導航來增強代碼分析。

代碼圖可以作為路線圖，清晰地展示代碼的不同部分如何組合在一起。為了幫助實現這一概念，一些工具能夠更輕松地實現可視化和導航代碼。例如，Visual Studio（2012-2017版）的可視化工具就使用代碼圖使用戶能夠更方便地探索代碼。

將代碼表示為圖形已在編譯器和集成開發環境（IDE）中廣泛用于各種任務。將代碼的圖形結構呈現給任何Graph ML算法都會創建SOTA結果。函數、類和變量可以是代碼庫中的節點。邊可以表示函數調用、變量使用或類繼承。例如，表示函數的節點可能有指向表示它所使用變量和它所調用函數的節點的邊。如圖1所示：

圖1 鏈接到兩個函數的代碼圖節點

代碼圖表示允許對代碼的結構和行為進行詳細的分析，從而便于完成代碼導航、影響分析和調試等任務。通過將代碼表示為圖形，捕獲了關于代碼的不同部分如何交互的復雜細節，從而使分析和理解復雜的代碼庫變得更加容易。這是如何實現的？

將代碼分為以下元素：

• 定義：定義事物（如函數、類、變量）的地方。
• 引用：這些事物被使用或調用的地方。
• 符號：代碼中元素的名稱（例如函數名和類名）。
• 文檔注釋：解釋代碼的注釋，通常以特定格式編寫。

接下來，將看到如何為給定代碼生成圖形的示例。

代碼圖如何增強代碼分析

代碼圖為代碼分析提供了幾個好處：

依賴關系可視化

使用代碼圖，開發人員或測試人員可以可視化代碼不同部分之間的依賴關系。這樣就很容易看出函數、類和模塊是如何相互依賴的。

想象一個大型的代碼庫，其中有一個函數calculate_volume，還有一個calculate_area函數，并依賴于輔助函數來獲取長度和寬度。代碼圖將清楚地說明這些依賴關系，允許開發人員快速識別潛在的問題或需要優化的領域。

簡化調試

代碼圖通過顯示函數和類如何交互來簡化調試。假設開發人員正在調試calculate_volume函數的問題。通過查看代碼圖，他們可以很快發現問題可能是由calculate_area函數（稱為calculate_volume）中的問題引起的。然后，開發人員可以將調試工作集中在calculate_area及其依賴項get_length和get_width上。

影響分析

開發人員可以快速評估代碼一部分的更改對其他部分的影響。這是因為他們可以檢查哪些函數或類依賴于他們要修改的代碼。因此，他們可以做出明智的決定。

改進代碼質量

識別和理解代碼關系有助于維護和改進代碼質量，但是如何實現呢？現在，開發人員可以找出代碼重復的地方，然后可以重構代碼以改進代碼庫。

代碼分析RAG解決方案面臨的挑戰

大型代碼庫

由于代碼量巨大，檢索增強生成（RAG）模型難以檢索相關的代碼片段。當處理一個龐大的軟件系統時，RAG模型會得到1000個代碼片段，為了選出最好的一個，可能會閱讀數百個看起來相似的代碼片段。

代碼冗余

RAG模型可能產生冗余的代碼，導致代碼重復，并可能降低效率。例如，在為某個任務生成不變代碼時，RAG模型可能會提供多個看起來相似的解決方案，而比較它們并找出最佳方案似乎非常困難。

在代碼分析中使用知識圖優于向量數據庫的優勢

對于代碼分析，知識圖與向量數據庫相比具有幾個優勢。可以通過一個例子來理解這一點。假設開發人員給出了這個提示。

• 提示：搜索有關updateInventory（）的代碼。

以下查看知識圖譜和向量數據庫將提供什么結果。

知識圖譜（Knowledge Graph）

查詢返回一個詳細的圖表，突出顯示直接或間接調用updateInventory（）的每個方法、類和服務。因此，在將結果提供給查詢之前，知識圖譜將檢查所有相關的函數、類和服務以及它們與updateInventory（）的關系，如下所示：

訂單服務（OrderService）：調用updateInventory（）來更新庫存水平。

• 退貨服務（ReturnService）：該函數用于在處理退貨時重新補貨。
• 審計服務（AuditService）：它記錄庫存更改以用于審計。
• 外部API（ExternalAPI）：該函數與外部API交互以同步庫存數據。
• 性能指標（PerformanceMetrics）：該圖表包括性能數據，顯示updateInventory（）在高峰時段存在瓶頸。

這將確保返回的結果準確可靠，因為考慮了與updateInventory（）相關的所有組件及其與它的關系。這有助于代碼圖表示準確的代碼可視化。

向量數據庫

向量數據庫對于查找相似的代碼片段很有用，但不能有效地表示詳細的場景關系。搜索返回的函數在結構和內容上都類似于updateInventory。為什么? 向量數據庫可以基于相似性搜索或歐幾里德距離提供結果。

Plain Text 
 [FunctionX] --similar_to--> [updateInventory]
 [FunctionY] --similar_to--> [updateInventory]
 [FunctionZ] --similar_to--> [updateInventory]

采用代碼圖可視化代碼

示例1

其中一個示例演示了Python中的基本函數定義和調用。它顯示了簡單的算術運算，例如乘法、加法和打印結果。

示例2

另一個示例演示了一個簡單的遞歸函數，用于計算數字的階乘，以及如何在主函數中調用它。

網上有許多代碼圖工具，您可以簡單地粘貼整個代碼。另一種選擇是使用Lucidchart手工制作圖表。

理解代碼圖工作流

可以利用一個例子來理解它。假設一個Python項目有幾個文件，包括包含函數calculate_area（）的math_utils.py和包含類Circle的shapes.py。索引步驟將提取函數和類定義及其關系，例如Circle使用calculate_area（）。代碼圖的工作流程通常包括：

步驟1：索引

在這一步驟中，源代碼文件解析代碼庫，提取相關信息，例如函數、類、變量及其關系。

步驟2：構建代碼圖

這一示例的代碼圖將包含calculate_area（）和Circle的節點，其中一條邊將Circle連接到calculate_area()，表明Circle使用calculate_area（）函數。

步驟3：查詢代碼圖

用戶可以查詢代碼圖來查找Circle類使用的所有函數。該查詢將通過檢查與函數連接的節點和實體返回一個函數列表。這可以使用圖形查詢語言（如Cypher或Gremlin）來完成。

步驟4：可視化和探索

可視化可能會顯示Circle的節點，其邊指向calculate_area()，表示依賴關系。這種可視化幫助開發人員快速識別代碼實體之間的關系。

步驟5：分析和洞察

通過分析代碼圖，可能會發現Circle類與calculate_area（）函數緊密耦合，這可能會導致維護問題。還可以確定calculate_area（）函數在代碼庫的另一部分重復。

與OpenAI交互轉換查詢

有時，還可以使用OpenAI Codex模型與查詢轉換進行交互，該模型可以針對多種代碼轉換任務進行微調，例如使用OpenAI代碼采樣重構現有代碼，并使用SQL Codex Art轉換表。例如，給定CSV文件中的數據集，編寫SQL查詢從數據集提取一些信息。

• 自動補全：OpenAI的模型可以使用機器學習補全不完整的代碼，減少開發人員的時間。
• 代碼轉換：模型可以將代碼從一種編程語言轉換為另一種編程語言，這使得在語言之間重新定位項目變得很簡單。
• CodeOpt：OpenAI公司開源了他們的代碼優化模型，從而有助于提高代碼的性能。總的來說，這節省了大量的計算資源，以換取更高的效率。
• 代碼解釋：它幫助模型將晦澀的代碼片段轉換為更簡單的單詞，這使得開發人員更容易理解和相互學習代碼。

詳盡的知識圖譜模式

知識圖模式是對數據所在位置的本質的理解。它定義了所有細節、實體之間的關系、屬性或概念，以及知識圖譜中呈現的所有內容。它提供了一種組織和連接數據的標準化方法，允許機器解釋這些信息的意義和關系。

以下利用一個關于電影的假設知識圖來理解這一點：

實體

（1）電影：表示一個電影實體。

• 屬性：片名（字符串）、上映日期（日期）、導演（人物）、類型（字符串）、評分（浮動）、票房收入（浮動）、劇情簡介（文本）

（2）人物：代表從事電影行業的人。

• 屬性：姓名（字符串），出生日期（日期），出生地點（字符串），傳記（文本），圖片（URL）

（3）類型：代表一種電影類型。

• 屬性：名稱（字符串），描述（文本）

（4）工作室：代表電影制作工作室。

• 屬性：名稱（字符串）、總部（字符串）、成立（日期）、描述（文本）、圖片（URL）

（5）獎項：表示授予電影的獎項。

• 屬性：名稱（字符串），類別（字符串），年份（日期），收件人（人物或電影）

構建代碼圖

首先，克隆FalkorDB代碼圖存儲庫。

Plain Text 
 git clone https://github.com/FalkorDB/code-graph.git

運行FalkorDB。

Plain Text 
 docker run -p 6379:6379 -it --rm falkordb/falkordb

將OpenAI API密鑰設置為環境變量。將需要它為知識圖譜生成密碼查詢，并回答與代碼圖相關的RAG問題。

Plain Text 
 export OPENAI_API_KEY=YOUR_OPENAI_API_KEY

啟動FalkorDB代碼圖工具。

Plain Text 
 npm run dev

這將在http://localhost:3000/上啟動一個服務器。可以輸入任何存儲庫的GitHub URL，它將生成代碼圖。

還可以在側邊欄中詢問有關代碼圖的問題，它將以自然語言回答。在瀏覽編程框架復雜而龐大的代碼庫時，這個功能非常有用。

未來的改進

代碼圖有很大的改進空間，特別是在加強與各種開發工具和平臺的集成方面。一個關鍵方面在于確保實時更新，使代碼圖與代碼庫中的變化保持同步。另一個重要的開發領域是擴大支持的編程語言范圍，使代碼圖更加通用，并適用于不同的開發環境。此外，利用機器學習進行預測分析和代碼推薦，在進一步提高代碼圖的實用性和有效性方面具有巨大的潛力。

這些改進可以幫助開發人員更全面地了解他們的代碼庫，使他們能夠進行更徹底的代碼分析，并最終提高整體代碼質量。

原文標題：Enhancing Code Analysis With Code Graphs，作者：Balaji Dhamodharan