宣言型と命令型

宣言型プログラミングは、プログラムが達成すべきを説明します。これは、結果を達成するためのコマンドや手順を明示的に列挙することなく、望ましい結果に焦点を当てます。それに対して、命令型プログラミングは、プログラムの状態を操作するための各ステップを明示的に述べることによって、タスクを達成する方法を指定します。

命令型アプローチ

ウェブ開発の初期には、命令型アプローチが主流でした。この方法は、JavaScriptを使用してDOMを手動で更新し、変更を反映させることを含みます。

例えば、次のような2つのボタンと段落を含むインタラクティブなブロックを考えてみましょう:

  • 表示/非表示ボタン: 段落の可視性を切り替え、「アクティブ化」ボタンを有効/無効にします。
  • アクティブ化/非アクティブ化ボタン: 段落のテキストと色を「アクティブ」(緑)と「非アクティブ」(赤)の間で切り替えます。
  1. <div id="my-interactive-plugin">
  2. <button
  3. id="show-hide-btn"
  4. aria-expanded="false"
  5. aria-controls="status-paragraph"
  6. >
  7. show
  8. </button>
  9. <button id="activate-btn" disabled>activate</button>
  10. <p id="status-paragraph" class="inactive" hidden>this is inactive</p>
  11. </div>
  12. <script>
  13. const showHideBtn = document.getElementById( 'show-hide-btn' );
  14. const activateBtn = document.getElementById( 'activate-btn' );
  15. const statusParagraph = document.getElementById( 'status-paragraph' );
  16. showHideBtn.addEventListener( 'click', () => {
  17. if ( statusParagraph.hasAttribute( 'hidden' ) ) {
  18. statusParagraph.removeAttribute( 'hidden' );
  19. showHideBtn.textContent = 'hide';
  20. showHideBtn.setAttribute( 'aria-expanded', 'true' );
  21. activateBtn.removeAttribute( 'disabled' );
  22. } else {
  23. if ( statusParagraph.classList.contains( 'active' ) ) {
  24. statusParagraph.textContent = 'this is inactive';
  25. statusParagraph.classList.remove( 'active' );
  26. activateBtn.textContent = 'activate';
  27. }
  28. statusParagraph.setAttribute( 'hidden', true );
  29. showHideBtn.textContent = 'show';
  30. showHideBtn.setAttribute( 'aria-expanded', 'false' );
  31. activateBtn.setAttribute( 'disabled', true );
  32. }
  33. } );
  34. activateBtn.addEventListener( 'click', () => {
  35. if ( activateBtn.textContent === 'activate' ) {
  36. statusParagraph.textContent = 'this is active';
  37. statusParagraph.classList.remove( 'inactive' );
  38. statusParagraph.classList.add( 'active' );
  39. activateBtn.textContent = 'deactivate';
  40. } else {
  41. statusParagraph.textContent = 'this is inactive';
  42. statusParagraph.classList.remove( 'active' );
  43. statusParagraph.classList.add( 'inactive' );
  44. activateBtn.textContent = 'activate';
  45. }
  46. } );
  47. </script>

ご覧のように、各条件に対して、変更されたDOM内のすべてをJavaScriptを使用して修正する必要があり、前の状態を考慮する必要があります。

宣言型アプローチ

宣言型アプローチは、が起こるべきかに焦点を当てることでプロセスを簡素化します。UIは状態の変化に応じて自動的に更新されます。以下は、インタラクティビティAPIの宣言型アプローチを使用した類似の例です:

  1. <div id="my-interactive-plugin" data-wp-interactive="myInteractivePlugin">
  2. <button
  3. data-wp-on--click="actions.toggleVisibility"
  4. data-wp-bind--aria-expanded="state.isVisible"
  5. data-wp-text="state.visibilityText"
  6. aria-controls="status-paragraph"
  7. >
  8. show
  9. </button>
  10. <button
  11. data-wp-on--click="actions.toggleActivation"
  12. data-wp-bind--disabled="!state.isVisible"
  13. data-wp-text="state.activationText"
  14. >
  15. activate
  16. </button>
  17. <p
  18. id="status-paragraph"
  19. data-wp-bind--hidden="!state.isVisible"
  20. data-wp-class--active="state.isActive"
  21. data-wp-class--inactive="!state.isActive"
  22. data-wp-text="state.paragraphText"
  23. >
  24. this is inactive
  25. </p>
  26. </div>
  1. import { store } from '@wordpress/interactivity';
  2. const { state } = store( 'myInteractivePlugin', {
  3. state: {
  4. isVisible: false,
  5. isActive: false,
  6. get visibilityText() {
  7. return state.isVisible ? 'hide' : 'show';
  8. },
  9. get activationText() {
  10. return state.isActive ? 'deactivate' : 'activate';
  11. },
  12. get paragraphText() {
  13. return state.isActive ? 'this is active' : 'this is inactive';
  14. },
  15. },
  16. actions: {
  17. toggleVisibility() {
  18. state.isVisible = ! state.isVisible;
  19. if ( ! state.isVisible ) state.isActive = false;
  20. },
  21. toggleActivation() {
  22. state.isActive = ! state.isActive;
  23. },
  24. },
  25. } );

この宣言型の例では、UIは現在の状態に基づいて自動的に更新されます。開発者が行う必要があるのは、必要な状態、派生状態、状態を変更するアクション、およびDOMのどの部分が状態のどの部分に依存しているかを宣言することだけです。フレームワークは、DOMを常に現在の状態と同期させるために必要なすべての更新を行います。ロジックは、フレームワークによって制御される要素の数に関係なく、シンプルで保守可能なままです。

バグを見つけられますか?

命令型の例では、教育目的のために意図的にバグが導入されています。見つけられますか?簡単ではありません!

答えを見せてください!

「表示」ボタンが最初に押され、その後「アクティブ化」ボタンが押され、最後に「非表示」ボタンが押された場合、inactiveクラスがstatusParagraph.classList.add('inactive');を使用して追加されません。したがって、次回ユーザーが「表示」を押すと、段落は赤で表示されません。

この種のバグは、すべての条件を手動で制御する必要があるため、命令型コードでは非常に一般的です。一方、宣言型コードでは、フレームワークがDOMの更新を管理し、何も忘れないため、これらのバグは存在しません。

宣言型アプローチの利点

示されたように、命令型アプローチは詳細な手順とDOMの直接操作を必要とし、インタラクティビティの複雑さが増すにつれて迅速に複雑になり、保守が難しくなります。可能な状態と要素が増えるほど、追加する必要のある条件付きロジックが増え、コードが指数関数的に複雑になります。一方、宣言型アプローチは、状態を管理し、フレームワークにDOMの更新を処理させることでプロセスを簡素化します。これにより、より読みやすく、保守可能で、スケーラブルなコードが得られます。

リアクティビティ

インタラクティビティAPIは、リアクティビティを活用することで宣言型フレームワークです。リアクティブシステムでは、データの変更が自動的にユーザーインターフェースの更新をトリガーし、ビューが常にアプリケーションの現在の状態を反映することを保証します。

リアクティビティの仕組み

インタラクティビティAPIは、細かい粒度のリアクティビティシステムを使用しています。以下はその仕組みです:

  • 1. リアクティブ状態: インタラクティビティAPIでは、グローバル状態とローカルコンテキストの両方がリアクティブです。これは、これらのデータソースのいずれかが変更されると、それに依存するUIの部分が自動的に更新されることを意味します。
    • グローバル状態: これは、インタラクティブブロック全体でアクセスできるグローバルデータです。
    • ローカルコンテキスト: これは、特定の要素とその子要素に特有のローカルデータです。
    • 派生状態: 基本的な状態プロパティに加えて、依存関係が変更されると自動的に更新される計算プロパティを定義できます。
      詳細については、グローバル状態、ローカルコンテキスト、派生状態の理解ガイドを訪れて、インタラクティビティAPIでのさまざまなタイプのリアクティブ状態の扱い方を学んでください。
  • 2. アクション: これらは、通常イベントハンドラーによってトリガーされる関数で、グローバル状態またはローカルコンテキストを変更します。
  • 3. リアクティブバインディング: HTML要素は、data-wp-binddata-wp-text、またはdata-wp-classのような特別な属性を使用してリアクティブ状態値にバインドされます。
  • 4. 自動更新: アクションがグローバル状態またはローカルコンテキストを変更すると、インタラクティビティAPIは、その状態に依存するDOMのすべての部分(直接または派生状態を通じて)を自動的に更新します。

これらの概念を前の例を見直すことで分解してみましょう:

  1. const { state } = store( 'myInteractivePlugin', {
  2. state: {
  3. isVisible: false,
  4. isActive: false,
  5. get visibilityText() {
  6. return state.isVisible ? 'hide' : 'show';
  7. },
  8. // ... other derived state
  9. },
  10. actions: {
  11. toggleVisibility() {
  12. state.isVisible = ! state.isVisible;
  13. },
  14. // ... other actions
  15. },
  16. } );

このコードでは:

  • isVisibleisActiveは基本的な状態プロパティです。
  • visibilityTextisVisibleが変更されると自動的に更新される派生状態です。
  • toggleVisibilityは状態を変更するアクションです。

HTMLバインディングは次のようになります:

  1. <button
  2. data-wp-on--click="actions.toggleVisibility"
  3. data-wp-text="state.visibilityText"
  4. data-wp-bind--aria-expanded="state.isVisible"
  5. >
  6. show
  7. </button>

リアクティビティが実際にどのように機能するかは次のとおりです:

  • 1. ボタンがクリックされると、toggleVisibilityアクションがトリガーされます。
  • 2. このアクションはstate.isVisibleを更新します。
  • 3. インタラクティビティAPIはこの変更を検出し、自動的に:
    • ボタンのテキストコンテンツを更新します(data-wp-text="state.visibilityText"のため)。
    • aria-expanded属性を変更します(data-wp-bind--aria-expanded="state.isVisible"のため)。
    • isVisibleまたはvisibilityTextに依存するDOMの他の部分を更新します。

可変性と不変性

多くの他のリアクティブフレームワークとは異なり、インタラクティビティAPIは、グローバル状態またはローカルコンテキストを更新する際に不変性の使用を要求しません。オブジェクトや配列を直接変更でき、リアクティビティシステムは期待通りに機能します。これにより、多くの場合、より直感的で簡潔なコードが得られます。

例えば、次のように配列に新しいアイテムを追加できます:

  1. const { state } = store( 'myArrayPlugin', {
  2. state: {
  3. list: [ 'item 1', 'item 2' ],
  4. },
  5. actions: {
  6. addItem() {
  7. // Right:
  8. state.list.push( 'new item' );
  9. // Wrong:
  10. state.list = [ ...state.list, 'new item' ]; // Don't do this!
  11. },
  12. },
  13. } );

他のフレームワークで行うように新しい配列を作成したり、スプレッド演算子を使用したりする必要はありません。インタラクティビティAPIはこの変更を検出し、state.listに依存するUIの部分を更新します。

リアクティブな副作用

UIを自動的に更新することに加えて、インタラクティビティAPIは、data-wp-watchのようなディレクティブを使用してリアクティブデータが変更されたときに副作用を実行することを許可します。副作用は、ログ記録、API呼び出し、またはUIに直接結びついていないアプリケーションの他の部分を更新するなどのタスクに役立ちます。

次のようにdata-wp-watchを使用する例を示します:

  1. <div
  2. data-wp-interactive="myCounterPlugin"
  3. data-wp-context='{ "counter": 0 }'
  4. data-wp-watch="callbacks.logCounter"
  5. >
  6. <p>Counter: <span data-wp-text="context.counter"></span></p>
  7. <button data-wp-on--click="actions.increment">Increment</button>
  8. </div>
  1. store( 'myCounterPlugin', {
  2. actions: {
  3. increment() {
  4. const context = getContext();
  5. context.counter += 1;
  6. },
  7. },
  8. callbacks: {
  9. logCounter: () => {
  10. const context = getContext();
  11. console.log( `The counter is now: ${ context.counter }` );
  12. },
  13. },
  14. } );

この例では:

  • 1. data-wp-contextディレクティブは、値が0であるプロパティcounterを持つローカルコンテキストを追加します。
  • 2. data-wp-watchディレクティブはcallbacks.logCounterに設定されています。
  • 3. context.counterが変更されるたびに、logCounterコールバックが実行されます。
  • 4. logCounterコールバックは、現在のカウンターをコンソールにログします。

これにより、データの変更に応じて自動的に実行される宣言型の副作用を作成できます。data-wp-watchの他の使用例には、次のようなものがあります:

  • データが変更されたときにlocalStorageにデータを保存する。
  • 分析イベントを送信する。
  • アクセシビリティの目的でフォーカスを変更する。
  • ページタイトル、メタタグ、または<body>属性を更新する。
  • アニメーションをトリガーする。

結論

インタラクティビティAPIを使用し続ける中で、状態、アクション、副作用の観点で考えることを忘れないでください。データを定義し、どのように変更されるべきかを説明し、インタラクティビティAPIに残りを処理させてください。このメンタルシフトには時間がかかるかもしれませんが、特により命令型のプログラミングスタイルに慣れている場合は、これを受け入れることで、インタラクティビティAPIの真のダイナミックでインタラクティブなWordPressブロックを作成するための完全な可能性を引き出すことができます。