本文へジャンプ

リアクティビティーの探求

Vue の最も特徴的な機能の 1 つは、控えめなリアクティビティーシステムです。コンポーネントの状態はリアクティブな JavaScript オブジェクトで構成されています。状態を変更すると、ビュー (View) が更新されます。状態管理はシンプルで直感的ですが、よくある落とし穴を避けるために、仕組みを理解することも重要です。このセクションでは Vue のリアクティビティーシステムのより低レベルの詳細について、いくつか掘り下げていきます。

リアクティビティーとは?

最近この用語がプログラミングでよく出てくるようになりましたが、人々がそれについて話すとき、何を意味しているのでしょうか?リアクティビティーとは、宣言的な方法で変化に対応できるようにするプログラミングパラダイムです。よく挙げられる典型的な例として Excel のスプレッドシートが挙げられます:

ABC
0
1
1
2
2
3

ここでセル A2 は = A0 + A1 という数式で定義されているので(A2 をクリックして数式を表示または編集できます)、スプレッドシートには 3 が表示されます。これは驚くことではありません。ですが A0 や A1 を更新すると、A2 も自動的に更新されることに気がつくでしょう。

JavaScript は通常このようには動作しません。JavaScript で同等のものを書こうとすると:

js
let A0 = 1
let A1 = 2
let A2 = A0 + A1

console.log(A2) // 3

A0 = 2
console.log(A2) // 3 のまま

A0 を変更しても、A2 は自動的に変化しません。

では、JavaScript でこれを行うにはどうしたらよいでしょうか?まず、A2 を更新するコードを再実行するために、それを関数でラップしてみましょう:

js
let A2

function update() {
  A2 = A0 + A1
}

次に、いくつかの用語を定義する必要があります:

  • update() 関数はプログラムの状態を変更するため、副作用(side effect、略してエフェクト) を発生させます。

  • A0A1 はエフェクトの依存関係と見なされ、それらの値はエフェクトを実行するために使用されます。エフェクトは依存関係との関係において 購読者(subscriber) と言われます。

必要なのは A0A1依存関係)が変わるたびに update()エフェクト)を呼び出せるマジックメソッドです:

js
whenDepsChange(update)

この whenDepsChange() 関数には、以下のようなタスクがあります:

  1. 変数が読み込まれたときの追跡。例えば A0 + A1 という式を評価するときに、A0A1 の両方が読み込まれます。

  2. 実行中のエフェクトがあるときに変数が読み込まれた場合、その変数の購読者にエフェクトを実行します。例: update() が実行されているときに A0A1 が読み込まれるので、最初の呼び出し以降は update()A0A1 の両方の購読者になります。

  3. 変数が変更されたときの検知。例:A0 に新しい値が代入されたとき、再実行のため購読者であるエフェクトすべてに通知します。

Vue におけるリアクティビティーの仕組み

私たちは、この例のようなローカル変数の読み書きを実際に追跡することはできません。バニラ(素の)JavaScript にはそのような仕組みがないのです。できるのは、オブジェクトのプロパティの読み書きを傍受(インターセプト)することです。

JavaScript でプロパティにアクセスを傍受する方法は 2 つあります: getter / settersProxy です。Vue 2 では、ブラウザのサポートの制限により、getter / setter のみを使用していました。Vue 3 では、Proxy はリアクティブオブジェクトに、getter / setters は ref に使用されています。以下は、動作を説明する疑似コードです:

js
function reactive(obj) {
  return new Proxy(obj, {
    get(target, key) {
      track(target, key)
      return target[key]
    },
    set(target, key, value) {
      target[key] = value
      trigger(target, key)
    }
  })
}

function ref(value) {
  const refObject = {
    get value() {
      track(refObject, 'value')
      return value
    },
    set value(newValue) {
      value = newValue
      trigger(refObject, 'value')
    }
  }
  return refObject
}

TIP

ここと以下のコードスニペットは、核となるコンセプトをできるだけシンプルに説明することを目的としているため、多くの詳細は省略され、エッジケースも無視されています。

これは基礎のセクションで説明したいくつかのリアクティブオブジェクトの制限を説明するものです:

  • リアクティブオブジェクトのプロパティをローカル変数に割り当てたり分割代入した場合、その変数へのアクセスや代入は、ソースオブジェクトの get / set プロキシートラップをトリガーしなくなるため、非リアクティブになります。この「切断」は変数バインディングにのみ影響することに注意してください。変数がオブジェクトのような非プリミティブな値を指している場合、オブジェクトの変更は依然としてリアクティブです。

  • reactive() から返されたプロキシーはオリジナルと同じように動作しますが、=== 演算子を用いてオリジナルと比較すると、異なる固有性を持つことになります。

track() の内部では、現在実行中のエフェクトがあるかどうかをチェックします。ある場合は、追跡されているプロパティの購読者であるエフェクト(Set に格納)を検索し、実行中のエフェクトを Set に追加します:

js
// これは、エフェクトの実行直前に設定されます。
// これについては後ほど扱います。
let activeEffect

function track(target, key) {
  if (activeEffect) {
    const effects = getSubscribersForProperty(target, key)
    effects.add(activeEffect)
  }
}

エフェクトの購読は、グローバルなデータストラクチャ WeakMap<target, Map<key, Set<effect>> に格納されます。もし、あるプロパティに対して購読するエフェクトの Set が見つからなかった場合(初めて追跡された場合)、Set が作成されます。要するに、これが getSubscribersForProperty() 関数が行うことです。説明の簡略化のため、詳細は割愛します。

trigger() 内部では再びプロパティの購読者であるエフェクトを検索しています。ですが、今回は探す代わりにエフェクトを呼び出しています:

js
function trigger(target, key) {
  const effects = getSubscribersForProperty(target, key)
  effects.forEach((effect) => effect())
}

では、whenDepsChange() 関数に話を戻しましょう:

js
function whenDepsChange(update) {
  const effect = () => {
    activeEffect = effect
    update()
    activeEffect = null
  }
  effect()
}

ここでは実際のアップデートを実行する前に、エフェクト自身に現在のアクティブなエフェクトをセットするために素の update 関数をラップしています。これにより、アップデート中に track() を呼び出し、現在のアクティブなエフェクトを特定することができます。

この時点で、依存関係を自動的に追跡し、依存関係が変更されるたびに再実行するエフェクトを作成しました。これを リアクティブエフェクト(Reactive Effect) と呼びます。

Vue はリアクティブエフェクトを作成するための API を提供しています: watchEffect()。実際、この例にある魔法のような whenDepsChange() とかなり似た動きをすることに気づくかもしれません。これで、実際の Vue の API を使って最初のサンプルを作り直すことができます:

js
import { ref, watchEffect } from 'vue'

const A0 = ref(0)
const A1 = ref(1)
const A2 = ref()

watchEffect(() => {
  // A0 と A1 を追跡
  A2.value = A0.value + A1.value
})

// エフェクトをトリガー
A0.value = 2

ref の変更のためにリアクティブエフェクトを使用するのはあまり気持ちのいい使い方ではありません。実際、算出プロパティを使う方がより宣言的です:

js
import { ref, computed } from 'vue'

const A0 = ref(0)
const A1 = ref(1)
const A2 = computed(() => A0.value + A1.value)

A0.value = 2

内部的には、computed がリアクティブエフェクトを使って無効化や再計算を管理しています。

では、一般的で便利なリアクティブエフェクトの例とは何でしょうか?そう、DOM の更新です!単純な"リアクティブレンダリング"を実装するには、次のようにします:

js
import { ref, watchEffect } from 'vue'

const count = ref(0)

watchEffect(() => {
  document.body.innerHTML = `count is: ${count.value}`
})

// DOM を更新
count.value++

実際、これは Vue のコンポーネントが状態と DOM を同期させる方法にかなり近いです。各コンポーネントのインスタンスは、DOM をレンダリングして更新するためのリアクティブエフェクトを作成します。もちろん、Vue コンポーネントは innerHTML よりもずっと効率的な方法で DOM を更新しています。これについてはレンダリングメカニズムで説明されています。

ref()computed()watchEffect() API はすべて Composition API の一部です。これまで Vue で Options API だけを使用していた方は、Composition API が Vue のリアクティブシステムの仕組みに近いことに気がつくでしょう。実際、Vue 3 では、Options API は Composition API の上に実装されています。コンポーネントインスタンス(this)のすべてのプロパティへのアクセスは、リアクティビティー追跡のための getter / setter をトリガーし、watchcomputed などのオプションは、内部的に Composition API と同等のものを呼び出します。

ランタイムとコンパイルタイムのリアクティビティーの比較

Vue のリアクティビティーシステムは、主にランタイムベースです:追跡とトリガーは、すべてコードがブラウザーで直接実行されている間に行われます。ランタイム中のリアクティビティーの長所は、ビルドステップなしで動作すること、そしてエッジケースが少ないことです。一方で、JavaScript の構文の制限に制約されることになり、Vue の ref のような値コンテナーの必要性につながります。

Svelte のような一部のフレームワークは、コンパイル時のリアクティビティーを実装することで、そのような制限を克服することを選択しています。リアクティビティーをシミュレートするためにコードを分析および変換します。コンパイルステップにより、フレームワークは JavaScript 自体のセマンティクスを変更できます。例えば、依存関係の解析やローカル定義された変数へのアクセスに関するエフェクトトリガーを実行するコードを暗黙のうちに注入できます。欠点は、このような変換にはビルドステップが必要であり、また JavaScript のセマンティクスを変更するということは、本質的には「JavaScript のように見えるが別のものにコンパイルされる言語を作成すること」になります。

Vue チームは、Reactivity Transform という実験的な機能を通じてこの方向性を模索しましたが、最終的にはこういった理由で、このプロジェクトには適していないだろうと判断しました。

リアクティビティーのデバッグ

Vue のリアクティビティーシステムが依存関係を自動的に追跡するのは素晴らしいことですが、場合によっては、何が追跡されているのか、あるいは何がコンポーネントの再レンダリングを引き起こしているのかを正確に把握したいと時があるかもしれません。

コンポーネントデバッグフック

コンポーネントのレンダリング時にどの依存関係が使われているか、どの依存関係が更新のトリガーになっているかは、renderTrackedonRenderTrackedrenderTriggeredonRenderTriggered ライフサイクルフックを使ってデバッグすることができます。どちらのフックも、調べたい依存関係の情報を含むデバッガーイベントを受け取ります。依存関係を対話的に調査するために、コールバックの中に debugger ステートメントを置くことをお勧めします:

vue
<script setup>
import { onRenderTracked, onRenderTriggered } from 'vue'

onRenderTracked((event) => {
  debugger
})

onRenderTriggered((event) => {
  debugger
})
</script>
js
export default {
  renderTracked(event) {
    debugger
  },
  renderTriggered(event) {
    debugger
  }
}

TIP

コンポーネントデバッグフックは開発モードでのみ動作します。

デバッグイベントオブジェクトの型は下記の通りです:

ts
type DebuggerEvent = {
  effect: ReactiveEffect
  target: object
  type:
    | TrackOpTypes /* 'get' | 'has' | 'iterate' */
    | TriggerOpTypes /* 'set' | 'add' | 'delete' | 'clear' */
  key: any
  newValue?: any
  oldValue?: any
  oldTarget?: Map<any, any> | Set<any>
}

算出プロパティのデバッグ

computed() の第 2 引数に onTrackonTrigger のコールバック関数オブジェクトを渡すことで、算出プロパティをデバッグすることができます:

  • onTrack はリアクティブなプロパティや ref が依存関係として追跡されるときに呼ばれます。
  • onTrigger は依存関係の変更によってウォッチャーのコールバック関数がトリガーされたときに呼ばれます。

どちらのコールバックも、コンポーネントデバッグフックと同じフォーマットでデバッガーイベントを受信します:

js
const plusOne = computed(() => count.value + 1, {
  onTrack(e) {
    // count.value が依存関係として追跡されたときにトリガーされます
    debugger
  },
  onTrigger(e) {
    // count.value が変更されたときにトリガーされます
    debugger
  }
})

// plusOne にアクセスすると、onTrack がトリガーされる
console.log(plusOne.value)

// count.value を変更すると、onTrigger がトリガーされる
count.value++

TIP

算出プロパティの onTrackonTrigger オプションは開発モードでのみ動作します。

ウォッチャーのデバッグ

computed() と同様にウォッチャーも onTrackonTrigger オプションをサポートしています:

js
watch(source, callback, {
  onTrack(e) {
    debugger
  },
  onTrigger(e) {
    debugger
  }
})

watchEffect(callback, {
  onTrack(e) {
    debugger
  },
  onTrigger(e) {
    debugger
  }
})

TIP

ウォッチャーの onTrackonTrigger オプションは開発モードでのみ動作します。

外部の状態システムとの統合

Vue のリアクティビティーシステムは、プレーンな JavaScript オブジェクトをリアクティブなプロキシーに綿密に変換することで機能します。外部の状態管理システムと統合する場合(例えば、外部のソリューションもプロキシーを使用する場合)、この変換は不要になることがあり、時には望ましくないことになります。

Vue のリアクティビティーシステムを外部の状態管理ソリューションと統合する一般的な方法は、外部の状態を shallowRef で保持することです。shallow ref は .value プロパティにアクセスしたときのみリアクティブになり、内部の値はそのまま残されます。外部の状態が変化したら、更新をトリガーするために ref の値を置き換えます。

イミュータブルなデータ

undo/redo 機能(元に戻す/やり直す機能)を実装する場合、ユーザーが編集するたびにアプリケーションの状態のスナップショットを取得したいと思うかもしれません。ですが、ステートツリーが大きい場合、こういった機能に対しては Vue のミュータブル(変更可能)なリアクティビティーシステムは適していません。更新があるたびにステートオブジェクト全体をシリアライズすると、CPU とメモリー両方のコストがかかる可能性があるためです。

イミュータブルなデータ構造は、ステートオブジェクトを決して変更させないことでこれを解決します。変更の代わりに、古いオブジェクトと同じ、変化のない部分を共有する新しいオブジェクトを作成するのです。JavaScript でイミュータブルなデータを使用する方法はさまざまありますが、Vue で Immer を使用すると、ミュータブルな構文を維持しつつ、より人に分かりやすい状態でイミュータブルなデータを使用できるため、おすすめです。

Immer と Vue は、簡単なコンポーザブルを介して統合できます:

js
import produce from 'immer'
import { shallowRef } from 'vue'

export function useImmer(baseState) {
  const state = shallowRef(baseState)
  const update = (updater) => {
    state.value = produce(state.value, updater)
  }

  return [state, update]
}

Playground で試す

ステートマシン

ステートマシンは、アプリケーションが取りうるすべての状態と、ある状態から別の状態に移行するためのすべての方法を記述するためのモデルです。単純なコンポーネントには過剰かもしれませんが、複雑な状態遷移をより堅牢で管理しやすくするのに役立ちます。

JavaScript で最も人気のあるステートマシンの実装の 1 つとして XState があります。ここに XState と統合したコンポーザブルがあります:

js
import { createMachine, interpret } from 'xstate'
import { shallowRef } from 'vue'

export function useMachine(options) {
  const machine = createMachine(options)
  const state = shallowRef(machine.initialState)
  const service = interpret(machine)
    .onTransition((newState) => (state.value = newState))
    .start()
  const send = (event) => service.send(event)

  return [state, send]
}

Playground で試す

RxJS

RxJS は、非同期イベントストリームを扱うためのライブラリーです。VueUse ライブラリーは、RxJS ストリームと Vue のリアクティブシステムを接続するための @vueuse/rxjs アドオンを提供します。

シグナルとの関連

他のたくさんのフレームワークでも、Vue の Composition API の ref に似たリアクティビティープリミティブを「シグナル」という用語で導入しています:

基本的に、シグナルは Vue の ref と同じ種類のリアクティビティープリミティブです。これは、アクセス時の依存関係の追跡と、変更時の副作用のトリガーを提供する値コンテナーです。このリアクティビティープリミティブベースのパラダイムは、フロントエンドの世界においては特に新しい概念ではなく、10 年以上前の Knockout observablesMeteor Tracker のような実装に遡ることができます。Vue の Options API や React の状態管理ライブラリーである MobX も同じ原理に基づいていますが、オブジェクトプロパティの裏側にあるプリミティブを隠しています。

シグナルとして認定されるために必要な特性ではありませんが、今日、この概念はきめ細かいサブスクリプションを通じて更新が実行されるレンダリングモデルと一緒に議論されることがよくあります。仮想 DOM を使用しているため、Vue は現在、コンパイラーに依存して同様の最適化を実現しています。しかし、仮想 DOM に依存せず、Vue の組み込みのリアクティビティーシステムをより活用する、Solid にインスパイアされた新しいコンパイル戦略(Vapor モード)も模索しています。

API 設計のトレードオフ

Preact と Qwik のシグナルの設計は Vue の shallowRef に非常に似ています。3 つとも .value プロパティを介してミュータブルなインターフェースを提供しています。Solid と Angular のシグナルについて考察してみます。

Solid のシグナル

Solid の createSignal() API 設計は、読み取りと書き込みの分離に重点を置いています。シグナルは読み取り専用のゲッターと、独立したセッターとして公開されます:

js
const [count, setCount] = createSignal(0)

count() // 値にアクセス
setCount(1) // 値を更新

count シグナルはセッターなしでも受け渡せることに注意してください。これは、セッターが明示的に公開されない限り、状態が決して変更されないことを保証しています。この安全性の保証が、より冗長な構文を正当化するかどうかは、プロジェクトの要件や個人の好みによりますが、この API スタイルを好む場合は、Vue でも簡単に再現できます:

js
import { shallowRef, triggerRef } from 'vue'

export function createSignal(value, options) {
  const r = shallowRef(value)
  const get = () => r.value
  const set = (v) => {
    r.value = typeof v === 'function' ? v(r.value) : v
    if (options?.equals === false) triggerRef(r)
  }
  return [get, set]
}

Playground で試す

Angular のシグナル

Angular はダーティーチェックを廃止し、リアクティビティープリミティブの独自の実装を導入することで、いくつかの根本的な変化を遂げようとしています。Angular のシグナル API は以下のような感じです。

js
const count = signal(0)

count() // 値にアクセス
count.set(1) // 新しい値を設定
count.update((v) => v + 1) // 前回の値を元に更新

この API も、Vue で簡単に再現できます:

js
import { shallowRef } from 'vue'

export function signal(initialValue) {
  const r = shallowRef(initialValue)
  const s = () => r.value
  s.set = (value) => {
    r.value = value
  }
  s.update = (updater) => {
    r.value = updater(r.value)
  }
  return s
}

Playground で試す

Vue の ref と比較して、Solid や Angular のゲッターベースの API スタイルは、Vue のコンポーネント内で使用する場合にいくつかの興味深いトレードオフを提供します:

  • ().value よりわずかに簡潔ですが、値を更新する場合は冗長になります。
  • ref のアンラップはないので、値にアクセスするには常に () が必要です。これにより、値へのアクセスはどこでも一貫したものになります。これはまた、シグナルをそのままコンポーネントの props として渡せることを意味します。

これらの API スタイルが自分に合うかどうかは、ある程度主観的なものです。ここでの目標は、これらの異なる API 設計間の根本的な類似性とトレードオフを示すことです。また、Vue は柔軟であり、既存の API に縛られないことも示したいです。必要であれば、より具体的なニーズに合わせて独自のリアクティビティープリミティブ API を作成できます。

リアクティビティーの探求が読み込まれました