メインコンテンツへスキップ
見出し画像

【実践編】クラス図・シーケンス図からコードを起こす方法!設計図をTypeScriptに変換する手順🌱

    前回の記事では、処理の流れを可視化する「シーケンス図の書き方」について整理しました✨

    これで「クラス図(構造の地図)」と「シーケンス図(処理のシナリオ)」の描画ができるようになりましたが、

    「図は描けたけど、ここからどうやって実際のプログラム(コード)に直せばいいの?🤔」

    と疑問に思った方も多いのではないでしょうか?

    そこで今回は、クラス図とシーケンス図の2つを見ながら、実際のTypeScriptコードへ落とし込む具体的な手順をまとめてみました💡

    1. 役割分担 : 2つの図から何を起こす? 🧩

    まず、2つの設計図からコードの何を読み取るのか、役割分担を整理してみましょう!

    クラス図(classDiagram)

    • 👉 コードの「骨組み・構造(枠組み)」 を作ります。

    • クラス名、プロパティ(データ)、アクセス修飾子(+ や -)、継承(extends)や利用関係などの「型やクラスの定義」を起こします。

    シーケンス図(sequenceDiagram)

    • 👉 メソッドの「中身(具体例な処理手順・ロジック)」 を書き込みます。

    • 「誰が・どの順番で・どのメソッドを呼んで・何を返すのか」という動的なロジックを起こします。


    2. 2ステップでコードを起こしてみよう! 💻

    📋 今回使う設計図の例(ECサイトの決済処理)

    【クラス図】

    classDiagram
        class Product {
            +name: string
            +price: number
        }
    
        class Order {
            -id: string
            -status: string
            +pay(payment: PaymentSystem) void
        }
    
        class PaymentSystem {
            +charge(amount: number) boolean
        }
    
        Order --> Product : 利用
        Order --> PaymentSystem : 利用
    画像

    【シーケンス図】

    sequenceDiagram
        autonumber
        actor User as ユーザー
        participant Order as 注文(Order)
        participant Payment as 決済システム(PaymentSystem)
    
        User ->>+ Order: 1. pay(payment) を呼び出す
        Order ->>+ Payment: 2. charge(amount) でカード決済
        Payment -->>- Order: 3. 決済結果(true/false)を返す
        Order -->>- User: 4. 「決済完了」を出力
    画像

    🛠️ ステップ①:クラス図から「型の骨組み(構造)」を作る

    まずはクラス図だけを見て、型やクラスの「外枠」をそのままコードに書き起こします。

    • + は public、- は private にする

    • Order --> Product なので Order の中に Product[ ] を持たせる

    // ① Product クラスの枠組み
    class Product {
      constructor(
        public name: string,
        public price: number
      ) {}
    }
    
    // ② PaymentSystem クラスの枠組み
    class PaymentSystem {
      charge(amount: number): boolean {
        // まだ中身は空っぽ(枠組みだけ)
        return true;
      }
    }
    
    // ③ Order クラスの枠組み
    class Order {
      private status: string = 'unpaid';
    
      constructor(
        public id: string,
        private items: Product[]
      ) {}
    
      // メソッドの定義(引数と戻り値の型を設定)
      pay(payment: PaymentSystem): void {
        // ここに処理を書いていく!
      }
    }

    🛠️ ステップ②:シーケンス図から「メソッドの中身(処理手順)」を書き込む

    次に、シーケンス図の「矢印の順番」を見ながら、pay( ) メソッドの中に具体的な処理を埋めていきます!

    1. User ->> Order: pay( ) 👉 pay メソッドの開始

    2. Order ->> Payment: charge(amount) 👉 PaymentSystem の charge メソッドを呼び出す

    3. Payment -->> Order: 成功/失敗 👉 結果(boolean)を変数で受け取る

    4. Order -->> User: メッセージ 👉 結果に応じてステータス更新&ログ出力

    【完成した TypeScript コード】

    class PaymentSystem {
      charge(amount: number): boolean {
        console.log(`${amount}円のカード決済を実行中…💳`);
        return true; // 決済成功と仮定
      }
    }
    
    class Order {
      private status: string = 'unpaid';
    
      constructor(
        public id: string,
        private items: Product[]
      ) {}
    
      // 合計金額を計算するヘルパーメソッド
      private getTotalAmount(): number {
        return this.items.reduce((sum, item) => sum + item.price, 0);
      }
    
      // ★ シーケンス図から起こした処理の中身!
      pay(payment: PaymentSystem): void {
        if (this.status !== 'unpaid') {
          console.log('すでに決済済みです');
          return;
        }
    
        // 1. 金額を計算して決済システムを呼び出す(Order ->> Payment)
        const totalAmount = this.getTotalAmount();
        const isSuccess = payment.charge(totalAmount);
    
        // 2. 戻り値によって処理を分岐(Payment -->> Order)
        if (isSuccess) {
          this.status = 'pending'; // 発送待ちへ
          console.log(`注文 ${this.id} の決済が完了しました!📦`);
        } else {
          console.log('決済に失敗しました❌');
        }
      }
    }

    3. 今回のまとめ 🌷

    1. クラス図は「宣言(プロバティ・メソッド・クラス構造)」を起こすのに使う

    2. シーケンス図は「メソッドの具体例な処理ロジック(中身)」を起こすのに使う

    3. 「外枠を作る ➔ 中身を埋める」の2ステップで考えるとスムーズ!

    設計図があると、「何からコードを書けばいいんだろう…」と迷うことがなくなり、パズルを組み立てるように楽しくプログラミングができます✨

    みなさんも設計図を描いたら、ぜひこの手順でコードに落とし込んでみてくださいね!

     
     

    arisa

     
     
    フロントエンドエンジニアを目指して、TypeScriptと基本情報の勉強中。学んだことや「なるほど!」と思ったことを忘れないよう、noteにアウトプットしていきます🌱 同じようにプログラミングや資格勉強をしている方と繋がれたら嬉しいです!よろしくお願いします✨

    あなたへのおすすめ