ブログ

【SAP Fiori】複数タブ間通信をBroadcastChannel APIで実装する方法

この記事をSNSでシェア!

はじめに

SAP Fiori(SAPUI5)での開発はSPA(Single Page Application)が前提です。そのため、基本的には画面遷移も同一タブ内でスムーズに行われます。

しかし、実際の開発現場では「複数タブで同じアプリを開いており、一方のタブでのデータ更新を、他のタブにも即座に反映させたい」というケースに遭遇することがよくあるのではないでしょうか。

本記事では、こうした要件をBroadcastChannel APIを使って実装する方法を、実際のコード例とともに解説します。

対象読者

  • SAP Fiori / SAPUI5の基本的な開発経験がある方
  • Fioriの設計原則を理解しているが、実務要件との折り合いに悩んでいる方
  • クリーンなタブ間通信の実装方法を探している方

ユースケース:具体的なシナリオ

実装するシナリオ例
「一覧画面(画面A)から別タブで詳細・登録画面(画面B)を開き、画面Bで保存が完了したらタブを閉じ、画面Aのリストを自動更新したい」

このような画面間連携は、以下のような業務シーンで頻繁に発生します。

・受注一覧から「受注詳細」を別タブで開いて更新する
・マスタ一覧から「新規登録画面」を開いてデータを追加する
・ワークフロー承認画面から「詳細確認画面」を開いて承認判断を行う

SAP Fioriにおけるタブ間通信の選択肢

主な実装方法の比較

方法用途メリットデメリット
BroadcastChannel API異なるタブ/ウィンドウ間での通信シンプルな実装、リアルタイム通信可能IE非対応
LocalStorage + Storage event異なるタブ間で通信古いブラウザ対応ストレージ容量消費、設計が煩雑
EventBus(SAPUI5)同一アプリ内コンポーネント間での通信SAPUI5標準タブ間での通信不可

各手法には一長一短がありますが、SPAであるFioriアプリにおいてタブをまたいだ通信を行う場合、標準の「EventBus」では要件を満たせません。また「LocalStorage」は実装や状態管理が複雑になりがちです。

BroadcastChannel APIが適している理由

今回のユースケースでは、以下の5つの理由からBroadcastChannel APIを採用するのが最適です。

  1. シンプルなAPI: わずか数行のコードで実装が可能
  2. リアルタイム通信: イベント駆動型で即座に変更を通知
  3. メモリベース: LocalStorageを汚さない(永続化が不要な一時的なデータ連携に最適)
  4. 双方向通信: 親から子、子から親の両方向でシームレスに通信可能
  5. 複数タブ対応: 3つ以上のタブを開いていても、すべて同時に受信可能

BroadcastChannel APIの基礎知識

通信の仕組み

BroadcastChannelは「Pub/Sub(発行・購読)モデル」というシンプルな仕組みを採用しています。

  1. [タブ1:画面A] が特定のチャンネル(例: “myChannel”)を購読(サブスクライブ)して待機します。
  2. [タブ2:画面B] が同じチャンネルに向けて更新メッセージを発行(パブリッシュ)します。
  3. チャンネルを購読しているすべてのタブに、即座にメッセージが配信されます。

※実装時の注意点(同一オリジンポリシー)
本APIはセキュリティの観点から、「同一オリジン(プロトコル・ドメイン・ポートがすべて一致する環境)」間でのみ動作するという制約があります。
とはいえ、Fiori Launchpad環境下で動作するアプリ同士であれば、基本的に同じドメイン上で稼働するため、この条件は自然とクリアできますので、ご安心ください。

ブラウザ対応状況

  • Chrome 54+
  • Firefox 38+
  • Safari 15.4+
  • Edge 79+
  • × Internet Explorer(非対応)

SAP Fioriの推奨ブラウザ(Chrome, Edge, Safari)では問題なく動作します。

実装例:コード付き解説

実際に、画面A(親タブ・リスト画面)と画面B(子タブ・登録画面)での実装イメージを示します。

画面A(元画面・受信側)の実装

画面AのController(onInit など)でチャンネルをリッスンし、特定のメッセージを受信したらデータを再読み込み(ODataモデルのリフレッシュなど)させます。

// ScreenA.controller.js
sap.ui.define([
"sap/ui/core/mvc/Controller",
"sap/m/MessageToast"
], function (Controller, MessageToast) {
"use strict";
return Controller.extend("my.app.controller.ScreenA", {
    onInit: function () {
        // 'fiori_update_channel' という名前のチャンネルに参加
        this.broadcastChannel = new BroadcastChannel('fiori_update_channel');

        // メッセージの受信イベントを設定
        this.broadcastChannel.onmessage = (event) => {
            if (event.data === 'update_required') {
                // ここで画面Aのリスト更新処理などを発火
                this._refreshList();
            }
        };
    },

    _refreshList: function () {
        // ODataモデルのRefreshなど、画面更新のロジック
        this.getView().getModel().refresh();
        MessageToast.show("別タブでの更新を検知し、リストを最新化しました。");
    },

    onExit: function () {
        // メモリリークを防ぐため、Controller破棄時にチャンネルを必ず閉じる
        if (this.broadcastChannel) {
            this.broadcastChannel.close();
        }
    }
  });
});

画面B(別タブ・送信側)の実装

画面Bで保存処理(ODataのCreateなど)が成功したコールバック内で、更新要求メッセージを送信し、その後タブを閉じます。

// ScreenB.controller.js
sap.ui.define([
"sap/ui/core/mvc/Controller"
], function (Controller) {
"use strict";
return Controller.extend("my.app.controller.ScreenB", {
    onSaveSuccess: function () {
        // 処理完了後、同じチャンネル名でインスタンス化
        const channel = new BroadcastChannel('fiori_update_channel');

        // 画面Aへ更新要求メッセージを送信
        channel.postMessage('update_required');

        // リソース解放のためチャンネルを閉じる
        channel.close();

        // 現在のタブを閉じる
        window.close();
    }
  });
});

実装時の注意点

チャンネル名を決める際、汎用的すぎる名前(例:channel1)は避けるようにしましょう。
Fiori Launchpad上には複数のアプリが相乗りして稼働しているため、グローバルな名前空間を汚染し、他のアプリのチャンネル名と意図せず競合してしまうリスクがあるからです。

// ×悪い例
const channel = new BroadcastChannel("channel1");
// 〇良い例:アプリケーション固有の名前を含める
const channel = new BroadcastChannel("sap-fiori-order-management-sync");

おわりに

SAP FioriはSPAアーキテクチャを採用しているため、業務要件の都合で別タブを展開せざるを得ない場合、どうしても画面間の「状態(データ)の分断」が生じてしまいます。

従来はLocalStorageを用いた複雑なハックに頼ることもありましたが、現在ではBroadcastChannel APIを利用することで、非常にクリーンかつ安全にタブ間の状態同期を実現できるようになりました。

Fiori Launchpad環境下でのマルチアプリ連携や、複雑な業務シナリオを実装する際の「タブ間通信の強力な選択肢」として、ぜひ今後の開発に活用してみてください!

参考リンク

投稿者プロフィール

松井 律
松井 律
2021年入社、BS事業部BSグループに所属。
SAP BTPでのSide-By-Side開発に携わっています。
開発業務を通じて得たSAP BTPの技術に関する記事を投稿していければと思います。
この記事をSNSでシェア!