search

kurodakazumichi / issues

0 stars 0 forks source link

【Plant UML】導入 #28

Open kurodakazumichi opened 6 years ago

kurodakazumichi commented 6 years ago

概要

PlantUMLというテキストでUML図を作成できるツールの導入について記載する PlantUML単体でも使えるらしいが 今回はAtom上でUMLをリアルタイムに確認しながら作成できる環境を構築する。 PlantUML単体で使う場合とAtomで使う場合の導入手順は異なるっぽい(多分)

余談

plantuml.jarをダウンロードしてインストール？しろという記事があった。 【PlantUML】Mac OS XでPlantUMLを入れて使ってみる（試しにクラス図だけ書いてみました編)

AtomでPlantUML使う場合はplantuml.jarはいらない。 それを知らずにplantuml.jarをDLしたが Macで.jarファイルがダウンロードするとコンピュータを破壊する可能性があるとかなって ファイルダウンロード後、保存ができずはまる。

保存するにはブラウザ右下の「全てを表示」から該当ファイルを保存する事ができる。 という無駄な手順を踏んだが、そもそもこの作業は不要である。

kurodakazumichi commented 6 years ago

全般

AtomでPlantUMLを使う方法についてざっくりとした概要(Win Mac共通)

予めインストールするもの

必要なAtomプラグイン

plantuml-viewerの設定

基本的には以上の手順で使えるようになる。 それぞれの環境構築方法は後述する。

参考サイト

AtomとPlantUMLで爆速UMLモデリング Windowsの環境構築

Atom と PlantUML で快適シーケンス図駆動開発ライフ シーケンス図の作成やgithubを使った運用例などが記載されている

gabecoregarage ここが一番細かく環境構築や使い方を書いてるかも(全部は見てない)

kurodakazumichi commented 6 years ago

Mac

JDKが入っているか確認

java -version

としてバージョンが表示されていれば多分ある。 なければOracleのダウンロードサイトかJava SEのインストーラを取得してインストールする。

graphvizのインストール(homebrewはインストール済)

brew install graphviz

Atomのプラグインを入れる

  1. [File] > [Preference]から[+Install]を選択
  2. plantuml-viewerを検索してインストール
  3. language-plantumlを検索してインストール
  4. 以上

plantuml-viewerの設定

  1. [File] > [Preference]から[Packages]を選択
  2. [Settings]を選択
  3. CharasetにUTF-8を設定
  4. Graphviz Dot Executableに/usr/local/Cellar/graphviz/2.40.1/bin/dotを設定 (homebrewでインストールするとここに入るらしい)
  5. 以上

Atom上でCommnd + Option + Pとするとviewerが起動する

がしかし

plantuml-viewerを起動してUMLを書いてもまったく描画されず真っ黒画面 Atomを再起動したり、他に何か入れるのか？などいろいろ検索するも手がかりをつかめず うーんと悩んで諦めかけたそのとき、Atomを見たらなんか出てた。 描画が遅かっただけかもしれないが真相は闇の中。。。

kurodakazumichi commented 6 years ago

Windows

Atomプラグインインストール

Atomプラグイン設定

plantuml公式にサンプルコードあり http://plantuml.com/

kurodakazumichi commented 6 years ago

PlantUMLの使い方

拡張子.plantuml、もしくは.puのファイルを作成し そこにplantumlを記述するだけ。 viewerにリアルタイムに反映されていく。

参考ページ

https://qiita.com/ogomr/items/0b5c4de7f38fd1482a48

オンラインPlantUMLエディターというものがあった

http://sujoyu.github.io/plantuml-previewer/

kurodakazumichi commented 6 years ago

deprecation(廃止予定)

Atomの右下にdeprecationと表示されていたので調べてみた。 クリックすると詳細へ飛び、そこにはこう記載されていた。

atom.showSaveDialogSync is deprecated and will be removed soon. Please, implement ::saveAs and ::getSaveDialogOptions instead for pane items or use Pane::saveItemAs for programmatic saving.

Google先生曰く

atom.showSaveDialogSyncは廃止され、間もなく削除されます。 代わりに、ペイン項目に対して：saveAsと：getSaveDialogOptionsを実装するか、プログラム保存のためにPane :: saveItemAsを使用してください。

保存機能の何かが廃止される予定となっているようだ。