在線代碼審查系統及方法
2023-10-24 14:54:02 2
在線代碼審查系統及方法
【專利摘要】本發明涉及代碼技術。本發明解決了現有代碼審查時代碼審查人員與代碼開發人員不能進行良好的交互而造成審查效率較低的問題，提供了一種在線代碼審查系統及方法，其技術方案可概括為：在線代碼審查系統，其特徵在於，包括交互客戶端及代碼審查系統，所述交互客戶端與代碼審查系統連接，所述代碼審查系統包括代碼審核單管理模塊、對比文件生成器模塊、版本管理工具代理模塊及批註信息管理模塊。本發明的有益效果是：提高了代碼審核的效率和效果，適用於代碼審查。
【專利說明】在線代碼審查系統及方法
【技術領域】
[0001]本發明涉及代碼技術，特別涉及在線審查代碼的技術。
【背景技術】
[0002]計算機技術和網絡迅速發展的今天，各類應用軟體，儀器設備已經融入人們的工作、學習及生活中。工作網絡化、生產自動化及服務自動化，已經成為各大中小型企業提高工作效率、減少成本及開發客戶等的主要方法，對這些企業來說軟體和設備一旦出現故障就可能造成災難性的和不可挽回的損失，因此軟體質量變得尤為重要，而代碼的質量直接影響軟體質量，代碼審查不僅能夠及時發現後期測試中難以發現的問題，還可以幫助團隊成員提高編程技能，統一編碼風格，從而提升代碼質量及代碼可維護性，保證軟體質量，即使軟體出現故障後，代碼開發人員也能及時處理，減少客戶企業的損失。
[0003]目前業內常用的代碼審核方法是通過對比工具為每個修改文件創建一個對比文件，然後將該對比文件通過某種途徑發給代碼審查人員，代碼審查人員查看對比文件來審查代碼。代碼開發人員需要上傳大量的文件以便於審核，代碼審查人員無法對修改部分的上下文顯示行數進行定製，不方便理解代碼，無法對代碼進行批註，不方便代碼開發人員理解審核人員的意圖，極大地影響了整個代碼審查的效率。
[0004]上述方案不便於代碼代碼審查人員理解代碼，不便於代碼開發人員理解代碼審查人員的意圖，不能以友好的方式完成代碼開發人員和審核人員的交互，既增加了出錯的機率，又嚴重影響了代碼審查的效率。
【發明內容】
[0005]本發明的目的就是克服目前代碼審查時代碼審查人員與代碼開發人員不能進行良好的交互而造成審查效率較低的缺點，提供一種在線代碼審查系統及方法。
[0006]本發明解決其技術問題，採用的技術方案是，在線代碼審查系統，其特徵在於，包括交互客戶端及代碼審查系統，所述交互客戶端與代碼審查系統連接，所述代碼審查系統包括代碼審核單管理模塊、對比文件生成器模塊、版本管理工具代理模塊及批註信息管理模塊；
[0007]所述交互客戶端用於提供代碼開發人員或代碼審查人員與代碼審查系統的交互接口 ；
[0008]所述代碼審核單管理模塊用於根據代碼開發人員的交互命令進行代碼審核申請單的創建及提交，根據代碼審查人員的交互命令獲取對比文件生成器模塊的對比結果及代碼審核申請單進行顯示查看，以及根據批註信息管理模塊反饋的批註信息文件與代碼審核申請單生成相應報表，所述代碼審核申請單中至少包括差異文件(patch文件)及創建差異文件的目錄對應的版本庫路徑；
[0009]所述對比文件生成器模塊用於對代碼審核申請單中的差異文件進行解析，調用版本管理工具代理模塊下載對應欲修改代碼，應用該差異文件及對應欲修改代碼，生成對比結果;
[0010]所述版本管理工具代理模塊用於提供操作版本庫的接口 ；
[0011]所述批註信息管理模塊用於根據代碼審查人員的交互創建批註信息文件，通過名稱與對應的差異文件相關聯。
[0012]具體的，所述批註信息文件包括代碼審查人員所選擇的行的行號及批註信息。
[0013]進一步的，所述代碼審核申請單中還包括代碼審查人員設置信息。
[0014]在線代碼審查方法，其特徵在於，包括以下步驟:
[0015]步驟1、代碼開發人員創建代碼審核申請單並提交，該代碼審核申請單中至少包括差異文件及創建差異文件的目錄對應的版本庫路徑；
[0016]步驟2、代碼審查人員選擇查看該代碼審核申請單，系統對該代碼審核申請單中的差異文件進行解析，並下載對應欲修改代碼，應用該差異文件及對應欲修改代碼，生成對比結果，向代碼審查人員呈現該代碼審核申請單及對比結果；
[0017]步驟3、若代碼審查人員對該對比結果進行批註，則系統創建批註信息文件，並通過名稱與該差異文件相關聯；
[0018]步驟4、系統根據代碼開發人員或代碼審查人員需要獲取代碼審核申請單及相應批註信息文件生成相應報表。
[0019]具體的，所述步驟I包括以下具體步驟:
[0020]代碼開發人員在系統中新建代碼審核申請單，上傳代碼修改後的差異文件及創建差異文件的目錄對應的版本庫路徑，並將其填入代碼審核申請單；代碼開發人員在代碼審核申請單中填入代碼審查人員，向系統提交該代碼審核申請單。
[0021]進一步的，所述步驟2包括以下步驟:
[0022]步驟201、若需要選擇查看該代碼審核申請單，系統獲取該代碼審核申請單中的差異文件及創建差異文件的目錄對應的版本庫路徑；
[0023]步驟202、解析該差異文件，並根據創建差異文件的目錄對應的版本庫路徑生成每個欲修改代碼對應文件所在版本庫的全路徑，下載該文件包；
[0024]步驟203、再次拷貝該文件包，獲得兩個文件包；
[0025]步驟204、調用補丁工具應用差異文件到其中一個文件包，生成與代碼開發人員本地相同的代碼；
[0026]步驟205、分別讀取兩個文件包的內容，通過比對算法和指定的上下文行數生成對比結果；
[0027]步驟206、向代碼審查人員呈現該代碼審核申請單及對比結果。
[0028]具體的，步驟205與步驟206之間還具有以下步驟:
[0029]步驟208、渲染對比結果頁面。所述渲染對比結果頁面的具體方法為:繪製對比結果頁面，並在客戶端顯示。
[0030]再進一步的，所述步驟3包括以下具體步驟:
[0031]若代碼審查人員需要對該對比結果進行批註，代碼審查人員選擇對比結果的某一行，對其添加批註信息；系統根據代碼審查人員選擇某一行的行號及批註信息生成相應的批註信息文件，並通過名稱與對應的差異文件關聯。
[0032]具體的，所述步驟4包括以下具體步驟:系統根據代碼開發人員或代碼審查人員需要獲取代碼審核申請單及相應批註信息文件；通過批註信息文件中的行號獲取批註信息，將其與代碼審核申請單中的差異文件相結合生成相應報表並顯示。
[0033]本發明的有益效果是，通過上述在線代碼審查系統及方法，通過對差異文件的有效利用，大大減少審查代碼過程中傳遞的代碼文件的數量和大小的同時保證了代碼審查人員能看到代碼文件修改前後的完整上下文，並可定製上下文和添加批註的功能為代碼開發人員和代碼代碼審查人員提供了更好的交互，從而大大提高了代碼審核的效率和效果。
【專利附圖】
【附圖說明】
[0034]圖1是本發明在線代碼審查系統的系統框圖。
[0035]圖2是本發明在線代碼審查方法的流程圖。
【具體實施方式】
[0036]下面結合實施例及附圖，詳細描述本發明的技術方案。
[0037]本發明在線代碼審查系統的系統框圖參見圖1。本發明在線代碼審查系統，交互客戶端及代碼審查系統，其中，交互客戶端與代碼審查系統連接，代碼審查系統包括代碼審核單管理模塊、對比文件生成器模塊、版本管理工具代理模塊及批註信息管理模塊，這裡，交互客戶端用於提供代碼開發人員或代碼審查人員與代碼審查系統的交互；代碼審核單管理模塊用於根據代碼開發人員的交互進行代碼審核申請單的創建及提交，根據代碼審查人員的交互獲取對比文件生成器模塊的對比結果及代碼審核申請單進行顯示查看，以及根據批註信息管理模塊反饋的批註信息文件與代碼審核申請單生成相應報表，所述代碼審核申請單中至少包括差異文件(patch文件)及創建差異文件的目錄對應的版本庫路徑；對比文件生成器模塊用於對代碼審核申請單中的差異文件進行解析，調用版本管理工具代理模塊下載對應欲修改代碼，應用該差異文件及對應欲修改代碼，生成對比結果；版本管理工具代理模塊用於提供操作版本庫的接口 ；批註信息管理模塊用於根據代碼審查人員的交互創建批註信息文件，通過名稱與對應的差異文件相關聯。
[0038]本發明在線代碼審查方法的流程圖參見圖2，首先代碼開發人員創建代碼審核申請單並提交，該代碼審核申請單中至少包括差異文件及創建差異文件的目錄對應的版本庫路徑，當代碼審查人員選擇查看該代碼審核申請單時，系統對該代碼審核申請單中的差異文件進行解析，並下載對應欲修改代碼，應用該差異文件及對應欲修改代碼，生成對比結果，向代碼審查人員呈現該代碼審核申請單及對比結果，若代碼審查人員對該對比結果進行批註，則系統創建批註信息文件，並通過名稱與該差異文件相關聯，最後系統根據代碼開發人員或代碼審查人員需要獲取代碼審核申請單及相應批註信息文件生成相應報表。
[0039]實施例
[0040]本發明實施例中在線代碼審查系統的系統框圖參見圖1。本例中，在線代碼審查系統，交互客戶端及代碼審查系統，其中，交互客戶端與代碼審查系統連接，代碼審查系統包括代碼審核單管理模塊、對比文件生成器模塊、版本管理工具代理模塊及批註信息管理模塊，這裡，交互客戶端用於提供代碼開發人員或代碼審查人員與代碼審查系統的交互接口 ；代碼審核單管理模塊用於根據代碼開發人員的交互命令進行代碼審核申請單的創建及提交，根據代碼審查人員的交互命令獲取對比文件生成器模塊的對比結果及代碼審核申請單進行顯示查看，以及根據批註信息管理模塊反饋的批註信息文件與代碼審核申請單生成相應報表，該代碼審核申請單中至少包括差異文件(patch文件)及創建差異文件的目錄對應的版本庫路徑，還可以包括代碼審查人員設置信息；對比文件生成器模塊用於對代碼審核申請單中的差異文件進行解析，調用版本管理工具代理模塊下載對應欲修改代碼，應用該差異文件及對應欲修改代碼，生成對比結果；版本管理工具代理模塊用於提供操作版本庫的接口 ；批註信息管理模塊用於根據代碼審查人員的交互創建批註信息文件，批註信息文件中包括代碼審查人員所選擇的行的行號及批註信息，通過名稱與對應的差異文件相關聯。
[0041]本發明實施例中在線代碼審查方法的流程圖參見圖2，其具體步驟如下:
[0042]步驟1、代碼開發人員創建代碼審核申請單並提交，該代碼審核申請單中至少包括差異文件及創建差異文件的目錄對應的版本庫路徑。
[0043]本步驟中，可以包括如下具體步驟:
[0044]步驟101、代碼開發人員在系統中新建代碼審核申請單；
[0045]步驟102、代碼開發人員上傳代碼修改後的差異文件及創建差異文件的目錄對應的版本庫路徑，並將其填入代碼審核申請單；
[0046]步驟103、代碼開發人員在代碼審核申請單中填入代碼審查人員；
[0047]步驟104、代碼開發人員向系統提交該代碼審核申請單。
[0048]步驟2、代碼審查人員選擇查看該代碼審核申請單，系統對該代碼審核申請單中的差異文件進行解析，並下載對應欲修改代碼，應用該差異文件及對應欲修改代碼，生成對比結果，向代碼審查人員呈現該代碼審核申請單及對比結果。
[0049]本步驟中，可以包括如下具體步驟:
[0050]步驟201、若需要選擇查看該代碼審核申請單；
[0051]步驟202、系統獲取該代碼審核申請單中的差異文件及創建差異文件的目錄對應的版本庫路徑；
[0052]步驟203、解析該差異文件，並根據創建差異文件的目錄對應的版本庫路徑生成每個欲修改代碼對應文件所在版本庫的全路徑，下載該文件包；
[0053]步驟204、再次拷貝該文件包，獲得兩個文件包；
[0054]步驟205、調用補丁工具應用差異文件到其中一個文件包，生成與代碼開發人員本地相同的代碼；
[0055]步驟206、分別讀取兩個文件包的內容，通過比對算法和指定的上下文行數生成對比結果；
[0056]步驟207、向代碼審查人員呈現該代碼審核申請單及對比結果。
[0057]其中，還可以在步驟206與步驟207中加入:步驟208、渲染對比結果頁面。渲染對比結果頁面的具體方法為:繪製對比結果頁面，並在客戶端顯示。
[0058]步驟3、若代碼審查人員對該對比結果進行批註，則系統創建批註信息文件，並通過名稱與該差異文件相關聯。
[0059]本步驟中，可以包括如下具體步驟:
[0060]步驟301、若代碼審查人員需要對該對比結果進行批註；
[0061]步驟302、代碼審查人員選擇對比結果的某一行，對其添加批註信息；[0062]步驟303、系統根據代碼審查人員選擇某一行的行號及批註信息生成相應的批註信息文件，並通過名稱與對應的差異文件關聯。
[0063]步驟4、系統根據代碼開發人員或代碼審查人員需要獲取代碼審核申請單及相應批註信息文件生成相應報表。
[0064]本步驟中，可以包括如下具體步驟:
[0065]步驟401、系統根據代碼開發人員或代碼審查人員需要獲取代碼審核申請單及相應批註信息文件；
[0066]步驟402、通過批註信息文件中的行號獲取批註信息，將其與代碼審核申請單中的差異文件相結合生成相應報表並顯不。
【權利要求】
1.在線代碼審查系統，其特徵在於，包括交互客戶端及代碼審查系統，所述交互客戶端與代碼審查系統連接，所述代碼審查系統包括代碼審核單管理模塊、對比文件生成器模塊、版本管理工具代理模塊及批註信息管理模塊； 所述交互客戶端，用於提供代碼開發人員或代碼審查人員與代碼審查系統的交互接口 ； 所述代碼審核單管理模塊，用於根據代碼開發人員的交互命令進行代碼審核申請單的創建及提交，根據代碼審查人員的交互命令獲取對比文件生成器模塊的對比結果及代碼審核申請單進行顯示查看，以及根據批註信息管理模塊反饋的批註信息文件與代碼審核申請單生成相應報表，所述代碼審核申請單中至少包括差異文件及創建差異文件的目錄對應的版本庫路徑； 所述對比文件生成器模塊，用於對代碼審核申請單中的差異文件進行解析，調用版本管理工具代理模塊下載對應欲修改代碼，應用該差異文件及對應欲修改代碼，生成對比結果; 所述版本管理工具代理模塊，用於提供操作版本庫的接口 ； 所述批註信息管理模塊，用於根據代碼審查人員的交互創建批註信息文件，通過名稱與對應的差異文件相關聯。
2.如權利要求1所述的在線代碼審查系統，其特徵在於，所述批註信息文件包括代碼審查人員所選擇行的行號及批註信息。
3.如權利要求1或2所述的在線代碼審查系統，其特徵在於，所述代碼審核申請單中還包括代碼審查人員設置信息。
4.在線代碼審查方法，其特徵在於，包括以下步驟: 步驟1、代碼開發人員創建代碼審核申請單並提交，該代碼審核申請單中至少包括差異文件及創建差異文件的目錄對應的版本庫路徑； 步驟2、代碼審查人員選擇查看該代碼審核申請單，系統對該代碼審核申請單中的差異文件進行解析，並下載對應欲修改代碼，應用該差異文件及對應欲修改代碼，生成對比結果，向代碼審查人員呈現該代碼審核申請單及對比結果； 步驟3、若代碼審查人員對該對比結果進行批註，則系統創建批註信息文件，並通過名稱與該差異文件相關聯； 步驟4、系統根據代碼開發人員或代碼審查人員需要獲取代碼審核申請單及相應批註信息文件生成相應報表。
5.如權利要求4所述的在線代碼審查方法，其特徵在於，所述步驟I包括以下具體步驟: 代碼開發人員在系統中新建代碼審核申請單，上傳代碼修改後的差異文件及創建差異文件的目錄對應的版本庫路徑，並將其填入代碼審核申請單；在代碼審核申請單中填入代碼審查人員；向系統提交該代碼審核申請單。
6.如權利要求4所述的在線代碼審查方法，其特徵在於，所述步驟2包括以下步驟: 步驟201、若需要選擇查看該代碼審核申請單，系統獲取該代碼審核申請單中的差異文件及創建差異文件的目錄對應的版本庫路徑； 步驟202、解析該差異文件，並根據創建差異文件的目錄對應的版本庫路徑生成每個欲修改代碼對應文件所在版本庫的全路徑，下載該文件包； 步驟203、再次拷貝該文件包，獲得兩個文件包； 步驟204、調用補丁工具應用差異文件到其中一個文件包，生成與代碼開發人員本地相同的代碼； 步驟205、分別讀取兩個文件包的內容，通過比對算法和指定的上下文行數生成對比結果; 步驟206、向代碼審查人員呈現該代碼審核申請單及對比結果。
7.如權利要求6所述的在線代碼審查方法，其特徵在於，步驟205與步驟206之間還具有以下步驟: 步驟207、渲染對比結果頁面。
8.如權利要求7所述的在線代碼審查方法，其特徵在於，所述渲染對比結果頁面的具體方法為:繪製對比結果頁面，並在客戶端顯示。
9.如權利要求4-7任一項所述的在線代碼審查方法，其特徵在於，所述步驟3包括以下具體步驟: 若代碼審查人員需要對該對比結果進行批註，代碼審查人員選擇對比結果的某一行，對其添加批註信息；系統根據代碼審查人員選擇某一行的行號及批註信息生成相應的批註信息文件，並通過名稱與對應的差異文件關聯。
10.如權利要求8所述的在線代碼審查方法，其特徵在於，所述步驟4包括以下具體步驟: 系統根據代碼開發人員或代碼審查人員需要獲取代碼審核申請單及相應批註信息文件；通過批註信息文件中的行號獲取批註信息，將其與代碼審核申請單中的差異文件相結合生成相應報表並顯示。
【文檔編號】G06Q10/06GK103677831SQ201310682031
【公開日】2014年3月26日 申請日期:2013年12月12日 優先權日:2013年12月12日
【發明者】鄧海紅 申請人:邁普通信技術股份有限公司