体系ガイド · 発展

イベントの経路と伝播を追う

capture・target・bubbleを木の経路と対応させ、targetとcurrentTarget、登録順、伝播停止による未到達を説明します。

この記事をロゲイアに質問する確認問題3問に進むこれまでの誤答を復習する

更新日

この記事の目次
  1. 到達目標:一回のclickを複数の観測点で読む
  2. 経路とlistener一覧を先に作る
  3. targetは同じでもcurrentTargetは変わる
  4. 伝播を止めても同じ登録先の全処理は消えない
  5. 実装例:呼出し先と発火対象を別々に記録する
  6. 失敗例:phaseの設定で更新処理へ届かない
  7. 演習:停止場所と更新場所を一つずつ直す
  8. この記事をロゲイアに質問する理解を確かめる

到達目標:一回のclickを複数の観測点で読む

ボタンを押したとき、ボタンのハンドラだけでなく親パネルのハンドラも動くことがあります。同じclickが別々の場所で作り直されるのではなく、イベントの経路に沿って複数のlistenerが呼ばれるためです。この章では通常の木に対するclickを扱い、capture、target、bubbleのどこで誰が動くかを追います。前提は親子関係を持つDOMと関数呼出しです。到達点は、画面に現れた更新の原因を、発火対象、実行したlistener、変更したノードへ分けて説明できることです。

対象はShadow DOMを含まない小さな木とし、既定動作やネイティブUI、listenerの中からさらに別イベントを同期発火するケースは省きます。clickという名前を付けただけで、すべてのイベントが同じbubble規則を持つわけではありません。教材ではbubbleするclickの条件を固定します。デモのDOMとイベントでは、入力の木、listener登録、対象を変更し、一段階ごとに経路と呼出し中の場所を比べてください。

経路とlistener一覧を先に作る

rootの下にpanel、その下にbuttonがあるとします。clickの対象がbuttonなら、外側から対象へ進む段階ではroot、panel、buttonという順を使い、戻る段階ではbutton、panel、rootという順になります。ただし各位置で呼ぶlistenerはcapture設定により選びます。対象要素自身のlistenerはイベントのtarget段階で扱い、その中でもcaptureとして登録したものと、それ以外のものを区別します。単に木を二回たどって全関数を二回ずつ呼ぶ処理ではありません。

同じ要素に同じ段階のlistenerが複数あれば、登録順が意味を持ちます。先に登録した処理が状態を書き換え、次の処理がその値を読むなら、順序が変わると結果も変わります。模型の入力では、listenerの登録順を固定し、実行のたびに並び替えません。また、経路がまだ決まっていない状態と、実行中のlistener一覧を分けることで、どこまでがdispatchの準備で、どこからが利用者の処理なのかを示せます。

targetは同じでもcurrentTargetは変わる

この通常の木の例では、targetは一貫してbuttonです。一方、rootのlistenerが実行中ならcurrentTargetはroot、panelのlistenerならpanelです。親へ登録した一つの処理で子のclickを扱うイベント委譲では、この違いが対象の選択に直結します。currentTargetのtextContentを書き換えてしまうと、押したラベルではなくパネル全体を置き換える可能性があります。発火対象と、今listenerを呼んでいる登録先は、同じ場合も違う場合もあります。

呼出し段階targetcurrentTarget
rootのcapturecapturebuttonroot
panelのcapturecapturebuttonpanel
buttonの非capturetargetbuttonbutton
panelの非capturebubblebuttonpanel
rootの非capturebubblebuttonroot

伝播を止めても同じ登録先の全処理は消えない

stopPropagationは、後続の経路へ進むことを止める操作です。同じ登録先でいま処理するlistener群の残りまで止めるstopImmediatePropagationとは区別します。たとえばpanelのcapture処理で伝播を止めると、buttonまで届かず、buttonの更新処理が動かない例を作れます。未到達の原因は、イベントが発生しなかったことではありません。どの経路のどの位置で停止フラグが立ったかを確認してください。今回の模型はstopPropagationだけを扱い、その範囲を表示します。

伝播停止とpreventDefaultも別です。リンクの既定動作をキャンセルすることと、親のlistenerへ届かなくすることは同じではありません。本章では既定動作を実装対象から外しているため、停止を加えてもページ遷移の成否を模倣しません。通常の木という前提が外れてShadow DOMの境界を含む場合は、targetの見え方や経路にも追加規則があります。ここで観察したtargetの一定性を、すべての文書構造へ無条件に一般化しないようにします。

実装例:呼出し先と発火対象を別々に記録する

次の独立したプログラムは、登録済みlistenerだけを固定の経路で選ぶ小さなスケジューラです。DOMのdispatchEvent全体の実装ではなく、通常の木での順序とtarget・currentTargetの違いを検査するためのものです。出力はroot → panel → button → panel → rootです。各行に保存したtargetはすべてbuttonのままで、現在の登録先だけが変わります。途中の配列を見れば、どのlistenerがどの理由で呼ばれたかを追えます。

この例に伝播停止を足す場合、外側の経路の繰返しを止める条件と、同じ位置のlistenerを走査する条件を混同しないでください。単純なreturnを最内側へ置くと、止めたい範囲と違う処理だけを抜けることがあります。listenerが共有状態へ書き込む例と、対象へ到達しなかった例を両方試し、実行しなかったlistenerについても理由を表示すると、欠けた更新の原因を説明しやすくなります。

javascript
const path = ['root', 'panel', 'button'];
const listeners = [
  {node: 'root', capture: true, name: 'root-capture'},
  {node: 'panel', capture: true, name: 'panel-capture'},
  {node: 'button', capture: false, name: 'button-target'},
  {node: 'panel', capture: false, name: 'panel-bubble'},
  {node: 'root', capture: false, name: 'root-bubble'}
];
const trace = [];
const target = path.at(-1);
const schedule = [
  ...path.map(node => ({node, capture: true})),
  ...[...path].reverse().map(node => ({node, capture: false}))
];
for (const visit of schedule) {
  for (const listener of listeners.filter(x => x.node === visit.node && x.capture === visit.capture)) {
    trace.push({listener: listener.name, target, currentTarget: visit.node});
  }
}
console.assert(trace.map(x => x.listener).join(',') ===
  'root-capture,panel-capture,button-target,panel-bubble,root-bubble');
console.assert(trace.every(x => x.target === 'button'));
console.log(trace.map(x => x.currentTarget).join(' → '));

失敗例:phaseの設定で更新処理へ届かない

親のcapture listenerで停止し、子のbuttonへ非capture listenerを登録した構成では、子の更新は実行されません。解決策は、停止を外す、対象で処理する、親の一つのlistenerへ委譲するなど、目的と経路を合わせることです。停止をどこへ置いても同じ結果になるとは考えません。目先の表示だけ直すために同じ更新を何か所にも重複登録すると、一回のclickで二回カウントする新しい不具合が生まれます。

境界例として、listenerがない対象、親のない単一要素、同じ親に複数のlistenerがある木を比較します。どれも「通常の例と違う」だけで必ずエラーとは限りません。登録先のIDが存在しない、操作カードが対象を見つけられない、といった入力不正は別に拒否します。イベントが届いたこと、ハンドラが呼ばれたこと、DOMが変わったこと、描画されたことの四つを一つの成功フラグにまとめないようにします。

演習:停止場所と更新場所を一つずつ直す

DOMとイベントの修正課題で、目的のlistenerへ届かない構成を読み、capture設定と停止位置を変更します。次に、更新対象をcurrentTargetから別の適切なノードへ変える課題へ進みます。どちらも最終表示だけでなく、呼出し順、target、currentTarget、変わったノードを照合してください。親の名前やラベル文字列を変えた回帰例でも同じ方針が成り立つことを確かめ、固定IDや固定出力に偶然依存していないかを確認します。

ノートには「発火はbutton」「panelのcaptureで停止」「buttonのlistenerは未到達」というように、観測と原因を短く分けて残します。自動再生を止め、停止フラグが立つ直前と直後を行き来すると、どの変数が変わって経路が途切れたかが分かります。最後に停止を外して再実行し、初期状態が復元されていること、前回のテキスト更新や停止フラグを持ち越していないことも確認してください。

デモで動作を確かめる

DOM操作とイベントの伝播

デモの途中状態を読み込んでいます…

読了と問題の結果を、言語ごとにこのブラウザへ保存します。

コースの順番に沿って学ぶ

CS基礎を固める · STEP 20

学習コースから次を選ぶ