はじめに

現場でシーケンス図を書く機会があったのでメモとして残しておきます。

シーケンス図とは

シーケンス図とは「プログラムの処理の流れや概要」を設計する際に使われます。オブジェクト指向のソフトウェア設計においては、グローバルスタンダードの設計手法で、オブジェクト間の処理の流れを時系列で表していく図になります。

シーケンス図の書き方

シーケンス図は、先ほども説明した通り「プログラムの流れ」をわかりやすく図に表していくものです。なざっくり言うと、ユーザーがこの操作をしたら、この画面からこのメソッドが動いて、そのメソッドに基づいたデータが取得できて、画面に表示されるといった流れを図に表していきます。
シーケンス図にもいろんな書き方がありますが、今回は下記のシーケンス図を参考にします。

この図のプログラムの流れを説明していきます。

1.ブラウザの操作

この画像では、最初にユーザーがブラウザで商品検索をした想定です。

2.サーバーから商品を取得するメソッドが動く

商品を検索するためのメソッドが動き、サーバーがDBから商品情報を取得しにいく。

3.DBから検索結果を取得

先ほど動かしたメソッドによる取得結果を受け取る。

4.関連商品情報を外部システムから取得

こちらのシステムでは、外部システムからデータを取得するメソッドがあるみたい。
そのメソッドが動き、外部システムからデータを取得しにいく。

5.関連商品情報を取得

先ほど取得しにいったデータをサーバーが受け取る。

6.検索結果を表示

DBと外部システムから取得した結果をブラウザ(ユーザー)に返して、画面に表示する。

以上がこの画像のシーケンス図の流れになります。

シーケンス図で使う記号など

シーケンス図でよく使う記号は以下の通りです。

補足

・先ほど説明したシーケンス図は、送られるデータの詳細は書かれていませんでしたが、データを取りにいくときに必要なデータを書き込むこともあります。
例：ユーザーID、商品ID、商品名など

以上になります。
[cv:issue_marketplace_engineer]