【コード可視化実践】コード変更の影響分析 | JD Cloudテクニカルチーム

1 はじめに

前回の記事「コード視覚化の簡単な分析」では、著者はコード視覚化の基本的な実装原理を説明し、業界でのいくつかのアプリケーション シナリオを示しました。原理や技術は多岐にわたるため、著者がすべてを網羅することは困難ですが、情報伝達の偏りを軽減するために、読者が深く読むことができるよう、いくつかの情報源を示します。ただし、この記事で説明されているアプリケーション シナリオのいくつかの小さな機能ポイントについては、実装計画を詳細に分析して、小さなことから全体像を把握することができます。したがって、この記事では、コード変更の影響分析におけるコード視覚化の応用について詳しく説明し、皆様のお役に立てれば幸いです。

2. シーン

まず、2 つの一般的な開発シナリオを使用して、「コード変更の影響分析」が必要な理由を説明しましょう。

シナリオ 1 : 方法①のロジックを入り口 A のみに影響すると考えてロジックを修正し、該当するシナリオのみを返したところ、オンライン化したところ入り口 B のロジックにも影響があることが判明し、オンライン事故が発生した。

シナリオ 2 : 方法②のロジックを修正し、既知のトラフィック入口をすべて返しましたが、オンラインになってから一定時間が経過すると異常なアラームが大量に発生し、スケジュールされたタスクや MQ 消費ロジックに影響を与えることが判明しました。

その他など…

「コード変更影響分析」とは具体的には、コード変更による機能ロジック変更の影響範囲、具体的にはどのクラス、メソッド、エントランス、呼び出しトポロジが影響を受けるかをどのように認識するかということになります

3. 計画

要件に応じて、ソースコードの静的解析に基づいた実装計画を以下に示します。

4. 実装

Java8をベースにした具体的な実装計画を以下に説明します。

4.1 メソッド呼び出しトポロジの生成

  • 基本的な考え方

JGit を使用してリモート ウェアハウスをローカルにプルし、JavaParser を使用してソース コードを分析してクラス、メソッド、およびメソッド呼び出し情報を取得し、これに基づいてメソッド呼び出しトポロジ マップを構築します。

  • 実装手順

ステップ 1 : JGit を使用してリモート リポジトリをローカルにプルする

ステップ 2 : JavaParser 構成をセットアップし、プロジェクトのすべてのソース コード ファイルを解析する

ステップ 3 : すべてのクラス ファイルを走査して、クラス、メソッド、およびメソッド呼び出し情報を取得します。

ステップ 4 : プロジェクト エントリのクラスとメソッドを特定する (サンプル コードは Spring http エントリの識別のみを実装します)

ステップ 5 : エントリ メソッドを開始ノードとして使用し、メソッドと呼び出し関係に基づいてメソッド呼び出しトポロジ図を生成します。

(分析に使用されるコード例は src/main/java/com/analysis/code/example パッケージにあります)

4.2 コード変更の影響分析

  • 基本的な考え方

Git Diffで変更の影響を受けるJavaクラスファイルを取得し、変更前後のクラスファイルをソースコード解析してクラスメソッド一覧を取得し、前後の差分を比較して変更の影響を受けるメソッドノードを取得します。そして最後に、以前に生成されたメソッド トポロジ情報を結合して、変更影響トポロジ マップを取得します。

  • 実装手順

ステップ 1 : JGit を使用してブランチ変更の影響を受けるファイルを取得する

ステップ 2 : JavaParser を使用して、変更前後の Java ファイルを解析し、変更前後のクラスのメソッド リストを取得します。

ステップ 3 : シーケンスの変更 (コメントの影響を除去し、コードをフォーマットする) の前後でメソッド本体の情報を比較し、どのメソッドが変更の影響を受けるかを確認します。

ステップ 4 : メソッド トポロジを結合して、変更の影響結果を生成する

5. まとめ

変更の影響を早期に評価すればするほど、リスクの芽を摘み、より低いコストで事故を回避することが容易になります。この記事では、Git、ソースコード分析、ビジュアルチャートなどのテクノロジーを総合的に活用する「コード変更影響分析」機能の大まかな実装計画を示します。ただし、ますます複雑化するビジネス状況に対応して、この記事で説明されている機能はまだ比較的初歩的なものであり、開発者にとって真に役立つようにシナリオに基づいて強化および改良する必要があります。

6.参考

Javaパーサー

JGit-クックブック

グラフビズ

Graphviz-Java

著者: Jingdong Technology Xie Xiao

出典:JD Cloud Developer Community 転載の際は出典を明記してください

OpenAI が ChatGPT Voice Vite 5 をすべてのユーザーに無料で公開、正式にリリース オペレーターの魔法の操作: バックグラウンドでネットワークを切断、ブロードバンド アカウントを非アクティブ化、ユーザーに光モデムの変更を強制 Microsoft オープン ソースの ターミナル チャット プログラマーが ETC 残高を改ざんし、年間 260 万元以上を横領 Redis の父が使用する Pure C 言語コードは、Telegram Bot フレームワークを実装しています あなたがオープンソース プロジェクトのメンテナである場合、この種の返答にどこまで耐えることができますか? Microsoft Copilot Web AI は 12 月 1 日に正式にリリースされ、中国の OpenAI をサポートします 元 CEO 兼社長の Sam Altman 氏と Greg Brockman 氏が Microsoft に加わりました Broadcom は VMware の買収に成功したと発表しました
{{名前}}
{{名前}}

おすすめ

転載: my.oschina.net/u/4090830/blog/10150932