PlantUML ASCII Art Diagram Generator

Overview

PlantUML を使用してテキストベースの ASCII アート図を作成します。ターミナル環境のドキュメント、README ファイル、メール、またはグラフィカル図が適さない場面での使用に最適です。

PlantUML ASCII Art とは？

PlantUML は、画像の代わりにプレーンテキスト（ASCII アート）として図を生成できます。これは以下の場面で有用です：

• ターミナルベースのワークフロー
• 画像をサポートしない Git コミット/PR
• バージョン管理が必要なドキュメント
• グラフィカルツールが利用できない環境

インストール

# macOS
brew install plantuml

# Linux (ディストリビューションによって異なります)
sudo apt-get install plantuml  # Ubuntu/Debian
sudo yum install plantuml      # RHEL/CentOS

# または JAR を直接ダウンロード
wget https://github.com/plantuml/plantuml/releases/download/v1.2024.0/plantuml-1.2024.0.jar

出力形式

フラグ	形式	説明
-txt	ASCII	純粋な ASCII 文字
-utxt	Unicode ASCII	罫線文字で強化された形式

基本的なワークフロー

1. PlantUML 図ファイルを作成

@startuml
participant Bob
actor Alice

Bob -> Alice : hello
Alice -> Bob : Is it ok?
@enduml

2. ASCII アートを生成

# 標準 ASCII 出力
plantuml -txt diagram.puml

# Unicode 強化出力（より見栄えが良い）
plantuml -utxt diagram.puml

# JAR を直接使用
java -jar plantuml.jar -txt diagram.puml
java -jar plantuml.jar -utxt diagram.puml

3. 出力を表示

出力は diagram.atxt（ASCII）または diagram.utxt（Unicode）として保存されます。

サポートされている図のタイプ

シーケンス図

@startuml
actor User
participant "Web App" as App
database "Database" as DB

User -> App : Login Request
App -> DB : Validate Credentials
DB --> App : User Data
App --> User : Auth Token
@enduml

クラス図

@startuml
class User {
  +id: int
  +name: string
  +email: string
  +login(): bool
}

class Order {
  +id: int
  +total: float
  +items: List
  +calculateTotal(): float
}

User "1" -- "*" Order : places
@enduml

アクティビティ図

@startuml
start
:Initialize;
if (Is Valid?) then (yes)
  :Process Data;
  :Save Result;
else (no)
  :Log Error;
  stop
endif
:Complete;
stop
@enduml

ステート図

@startuml
[*] --> Idle
Idle --> Processing : start
Processing --> Success : complete
Processing --> Error : fail
Success --> [*]
Error --> Idle : retry
@enduml

コンポーネント図

@startuml
[Client] as client
[API Gateway] as gateway
[Service A] as svcA
[Service B] as svcB
[Database] as db

client --> gateway
gateway --> svcA
gateway --> svcB
svcA --> db
svcB --> db
@enduml

ユースケース図

@startuml
actor "User" as user
actor "Admin" as admin

rectangle "System" {
  user -- (Login)
  user -- (View Profile)
  user -- (Update Settings)
  admin -- (Manage Users)
  admin -- (Configure System)
}
@enduml

デプロイメント図

@startuml
actor "User" as user
node "Load Balancer" as lb
node "Web Server 1" as ws1
node "Web Server 2" as ws2
database "Primary DB" as db1
database "Replica DB" as db2

user --> lb
lb --> ws1
lb --> ws2
ws1 --> db1
ws2 --> db1
db1 --> db2 : replicate
@enduml

コマンドラインオプション

# 出力ディレクトリを指定
plantuml -txt -o ./output diagram.puml

# ディレクトリ内のすべてのファイルを処理
plantuml -txt ./diagrams/

# ドット ファイル（隠しファイル）を含める
plantuml -txt -includeDot diagrams/

# 詳細出力
plantuml -txt -v diagram.puml

# 文字セットを指定
plantuml -txt -charset UTF-8 diagram.puml

Ant タスク統合

<target name="generate-ascii">
  <plantuml dir="./src" format="txt" />
</target>

<target name="generate-unicode-ascii">
  <plantuml dir="./src" format="utxt" />
</target>

より良い ASCII 図を作成するコツ

1. シンプルに保つ: 複雑な図は ASCII では見栄えが悪くなります
2. ラベルを短く: 長いテキストは ASCII の配置を崩します
3. Unicode（-utxt）を使用: 罫線文字でより良い見栄えになります
4. 共有前にテスト: 固定幅フォントでターミナルで確認します
5. 代替案を検討: 複雑な図の場合は Mermaid.js または graphviz を使用します

出力比較の例

標準 ASCII（-txt）：

     ,---.          ,---.
     |Bob|          |Alice|
     `---'          `---'
      |   hello      |
      |------------->|
      |              |
      |  Is it ok?   |
      |<-------------|
      |              |

Unicode ASCII（-utxt）：

┌─────┐        ┌─────┐
│ Bob │        │Alice│
└─────┘        └─────┘
  │   hello      │
  │─────────────>│
  │              │
  │  Is it ok?   │
  │<─────────────│
  │              │

クイックリファレンス

# ASCII でシーケンス図を作成
cat > seq.puml << 'EOF'
@startuml
Alice -> Bob: Request
Bob --> Alice: Response
@enduml
EOF

plantuml -txt seq.puml
cat seq.atxt

# Unicode で作成
plantuml -utxt seq.puml
cat seq.utxt

トラブルシューティング

問題: Unicode 文字が化けている

• 解決策: ターミナルが UTF-8 をサポートし、適切なフォントが設定されていることを確認します

問題: 図がずれて表示される

• 解決策: 固定幅フォント（Courier、Monaco、Consolas）を使用します

問題: コマンドが見つからない

• 解決策: PlantUML をインストールするか、Java JAR を直接使用します

問題: 出力ファイルが作成されない

• 解決策: ファイルのアクセス許可を確認し、PlantUML に書き込みアクセス権があることを確認します