【ITニュース解説】Your architecture diagram is lying: I tested both ways of writing it as code

システム開発において、システムの全体像や各部分の関係性を表す「アーキテクチャ図」は非常に重要である。しかし、多くの現場で、このアーキテクチャ図が常に最新の状態に保たれていないという深刻な問題がある。システムは常に変化し続ける生き物のようなもので、新しい機能が追加されたり、古い部分が修正されたりすると、その都度、図も更新されなければならない。だが現実には、図は一度作成されてPNGなどの画像ファイルとして保存されると、コードの変更に合わせて更新されることはほとんどない。特に、開発者が深夜に緊急でサービスを修正・リリースするような状況では、視覚的なエディタを開いて図の箱を動かすような手間はまずかけられないのが実情だ。このような状況が続くと、現場のエンジニアは最新のシステム構造を理解できなくなり、開発効率の低下やトラブルの原因にもなりかねない。

この問題に対処するため、「Architecture as Code（コードとしてのアーキテクチャ）」という新しい考え方が注目されている。これは、アーキテクチャ図を画像ファイルとして手動で描くのではなく、テキスト形式のコードとして記述し、そこから自動で図を生成するというアプローチだ。コードで管理することで、通常のプログラムコードと同じように、バージョン管理システムで変更履歴を追跡したり、複数の開発者で共同作業したりすることが可能になる。

最近、Web上で動作するクローズドなC4モデルのエディタが話題になったが、これはリポジトリでの管理や自己ホスト、パフォーマンス計測などができないという制約があった。そこで筆者は、開発者が自分で管理・実行できる2つの代替ツールを実際にテストし、その効果を検証した。

一つ目のツールは「Structurizr CLI」である。これは、特定のドメイン固有言語（DSL）を使って記述された一つのファイル（.dslファイル）から、C4モデルの3つの主要なレベルの図をわずか1秒で生成できるコマンドラインインターフェース（CLI）ツールだ。C4モデルとは、システムを異なる視点と粒度で表現するためのモデリング手法であり、主に以下の3つのレベルで構成される。「コンテキスト（Context）」レベルは、システムと外部のユーザーやシステムとの関わりを大まかに示す。「コンテナ（Containers）」レベルは、システム内部の主要なコンポーネント（Webサーバー、データベースなど）とそれらの関係を示す。「コンポーネント（Components）」レベルは、さらに細かく、各コンテナ内部のモジュールやサービスの関係を示す。Structurizr CLIを使えば、これらの詳細な図をテキストファイルから素早く生成し、常に最新の状態に保つことができる。

二つ目のツールは「C4-PlantUML」である。このツールもStructurizr CLIと同様に、テキスト形式の記述からC4モデルの図を生成できる。大きな特徴は、PlantUMLという人気の高いテキストベースの作図ツールと組み合わせて使用するため、特別なインストール作業なしに利用できる点だ。多くの開発環境でPlantUMLがサポートされているため、手軽に導入できるメリットがある。しかし、その手軽さの代償として、Structurizr CLIのDSLファイルと比較して、図を生成するためのモデル記述のサイズが約3倍になるという課題がある。モデルが大きくなると、その記述をメンテナンスする手間も増える可能性がある。

これらの「コードとしてのアーキテクチャ」のアプローチを導入することで、開発プロセスに様々なメリットがもたらされる。具体的には以下の4つのレビューゲートがアンロックされる。

まず、「差分（diff）」の確認が可能になる。コードで記述されたアーキテクチャモデルは、通常のソースコードと同じように、変更があった場合に何が変わったかを簡単に比較できる。これにより、システムの変更点が図に正しく反映されているかを確認しやすくなる。

次に、「プルリクエスト（PR）レビュー」が実現される。新しい機能の追加や既存システムの変更を行う際、そのアーキテクチャ変更もコードとしてプルリクエストに含めることができる。他の開発者が変更内容をレビューし、設計の意図や影響範囲を議論することで、より堅牢で一貫性のあるアーキテクチャを維持できる。

さらに、「バージョン管理（versioning）」が可能になる。アーキテクチャの記述がコードとして管理されるため、Gitなどのバージョン管理システムを利用して、過去の任意の時点のアーキテクチャ状態を追跡したり、必要に応じて以前のバージョンに戻したりできる。これは、システムの進化の歴史を記録し、将来の変更に役立つ貴重な情報となる。

そして、「継続的インテグレーション（CI）」への組み込みが可能になる。CIとは、コードの変更がリポジトリにコミットされるたびに自動でビルドやテストを行う仕組みだ。アーキテクチャ図の生成もCIパイプラインに組み込むことで、コードが変更されるたびに最新の図が自動的に生成・更新されるようにできる。これにより、図が古くなるという問題を根本的に解決し、常に最新のシステムドキュメントを維持できる。

Structurizr CLIとC4-PlantUMLのどちらを選ぶかは、プロジェクトの規模や開発チームの状況、既存のツールスタックに依存する。Structurizr CLIは、より簡潔な記述で複雑なC4モデルを生成できるため、大規模なシステムやC4モデルを深く活用したい場合に有利だ。一方、C4-PlantUMLは、既存のPlantUML環境との親和性が高く、手軽に導入できるため、小規模なプロジェクトや既存のPlantUMLユーザーには魅力的な選択肢となるだろう。

システムアーキテクチャをコードとして扱うことで、開発者は常に最新かつ正確なシステム図を参照できるようになり、結果として開発効率の向上、エラーの削減、そしてチーム間のコミュニケーション改善に大きく貢献する。これは、システムエンジニアを目指す者にとって、今後必須となるであろう重要なスキルと知識である。