LoginSignup
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

@moxixii

フロントエンドアーキテクチャ - 現代のAPIリクエストデザイン

Posted at

フロントエンドアーキテクチャ - 現代のAPIリクエストデザイン

序論

「データ取得」（Data Fetching）は、サーバーまたは他のデータソースからデータを取得し、フロントエンドインターフェースで表示および操作するプロセスを指します。このプロセスは、現代のWebアプリケーションにおいて非常に重要であり、ほとんどのアプリケーションはユーザーインターフェースとバックエンドサーバーとの間で通信し、データを取得してユーザーインターフェースを更新します。データ取得は、フロントエンドアーキテクチャでユーザーインターフェースとバックエンドデータを接続する橋渡しの役割を果たし、リアルタイムで正確な情報を提供することができるようにします。

1. データ取得はなぜフロントエンドアーキテクチャで重要なのですか？

  1. 動的コンテンツの表示：現代のWebアプリケーションでは、ソーシャルメディアの投稿、ニュース、リアルタイムの通知など、動的なコンテンツをユーザーインターフェースに表示する必要があります。これらのコンテンツはサーバーから取得する必要があり、したがってデータ取得は動的コンテンツを実現するための基盤です。

  2. シングルページアプリケーション（SPA）：SPAアプリケーションでは、ユーザーがアプリケーションと対話する際にページ全体をリフレッシュするのではなく、非同期でデータを読み込んで一部のコンテンツを更新します。これにより、データ取得はSPAアーキテクチャの中核部分となります。

  3. リアルタイムの更新：一部のアプリケーションでは、データをリアルタイムで更新する必要があります。例えば、リアルタイムのコミュニケーションアプリケーションやリアルタイムのモニタリングダッシュボードなどです。データ取得はサーバーとの持続的な通信を実現し、最新のデータを迅速に取得することができます。

  4. 関心の分離：データ取得ロジックとインターフェースロジックを分離することで、コードの保守性とテスト可能性を向上させることができます。また、バックエンドとフロントエンドの開発者が独立して作業できるようにもなります。

  5. データの事前取得とキャッシュ：データ取得はコンテンツの表示だけでなく、ユーザーがブラウジングする前にデータを事前取得してキャッシュするためにも使用でき、アプリケーションの性能と応答速度を向上させることができます。

使用例：

  1. APIを使用してデータを取得：最も一般的なケースは、RESTful APIやGraphQLクエリを使用してサーバーからデータを取得することです。これらのデータにはユーザー情報、製品リスト、記事のコンテンツなどが含まれます。

  2. コンテンツの表示：データ取得は、ブログ記事、画像、動画などのコンテンツをユーザーインターフェースに表示するために使用されます。

  3. フォームの送信とデータの変更：ユーザーがフロントエンドインターフェースで送信したフォームデータをサーバーに送信し、データの作成、更新、削除を行います。

  4. リアルタイム通知とチャット：データ取得を通じてサーバーからリアルタイムで通知、メッセージ、チャットコンテンツを受信し、ユーザーが他のユーザーとリアルタイムに対話できるようにします。

  5. データ分析とレポート：大量のデータをサーバーから取得してデータ分析、可視化、レポートの生成を行います。

このように、データ取得は現代のフロントエンドアプリケーションを構築するための中核的な概念の1つです。これにより、アプリケーションはバックエンドからデータを取得し、ユーザーに提供することができ、相互作用性、リアルタイム性、豊かなユーザーエクスペリエンスを実現します。

2. ネットワークリクエストのカプセル化の重要性と、それが保守性、再利用性、テスト可能性に与える利点

ネットワークリクエストのカプセル化は重要なプラクティスであり、保守性、再利用性、テスト可能性など、多くの利点をもたらします。以下に詳細を説明します。

  1. 保守性：
    ネットワークリクエストをカプセル化することで、リクエストのロジックを一箇所にまとめることができ、コードの保守性が向上します。変更や新しい機能の追加が必要な場合、コードの各所に散在するのではなく、カプセル化された関数を更新するだけで済みます。これにより、重複したコードが減少し、バグのリスクが低減され、コードベースがより整理されます。

  2. 再利用性：
    ネットワークリクエストのロジックをカプセル化した再利用可能な関数として提供することで、複数のコンポーネントやページで共有できます。つまり、同じリクエストロジックをアプリケーションの異なる部分で使用できるため、類似したコードを繰り返し書く手間が減少します。この再利用性により、開発効率が向上し、データ取得方法の一貫性が確保されます。

  3. テスト可能性：
    カプセル化されたリクエスト関数は、単体テストを行う際により簡単にテストできます。この関数に対してテストケースを記述し、異なる状況で正しい結果が返されるかどうかを確認できます。これにより、コードの変更や新機能の追加時に、テストを通じてリクエストロジックの正確性を検証できます。潜在的な問題を防ぐためのテストを通じた検証が可能です。

  4. カップリングの低減：
    ネットワークリクエストのカプセル化により、コンポーネントと具体的なリクエスト実装との間のカップリングを低減できます。コンポーネントはリクエストの詳細について気にする必要がなく、データを取得するためにカプセル化された関数を呼び出すだけです。そのため、低レベルなリクエストライブラリやインターフェースを変更する際にも、コンポーネントのコードを変更する必要はありません。

カスタムフックの概念の導入と、どのようにリクエストロジックを再利用可能な関数として抽象化するか：

カスタムフックは、Reactのプログラミングパターンの一種であり、コンポーネントのロジックを再利用することができます。特にネットワークリクエストなどの副作用のロジックをカプセル化するのに適しています。以下はリクエストロジックを再利用可能な関数として抽象化する手順です。

  1. カスタムフックの作成：
    例として useApiRequest を考えてみましょう。カスタムフックは use

で始まる関数名を使用して作成します。内部で、データの状態、エラー状態、ロード状態、およびリクエストのロジックを定義できます。

  1. 状態の設定：
    useState を使用して、データ、ロード状態、エラー状態など、リクエストに必要なさまざまな状態を管理します。

  2. リクエスト関数の定義：
    カスタムフック内部で fetchData という関数を定義します。これはリクエストのURL、リクエストメソッド、データを受け取ります。この関数内で fetch を使用してリクエストを行い、リクエスト結果に基づいて状態を更新します。

  3. AbortController を使用したタイムアウトとキャンセル：
    リクエスト関数内で AbortController を使用してタイムアウトを設定し、リクエストのキャンセルを行います。これにより、リクエストが適切な時間内に完了しない場合に、リクエストをキャンセルできるようになります。

  4. 必要な状態と関数を返す：
    カスタムフックが終了する前に、コンポーネントで使用する必要があるすべての状態と関数を返すことを確認します。これにはデータ、ロード状態、エラー情報、およびリクエスト関数が含まれます。

  5. カスタムフックをコンポーネントで使用：
    カスタムフックをコンポーネント内で使用するには、定義した関数と状態を呼び出すだけです。これにより、コンポーネントはUIの構築に専念でき、データの取得ロジックが切り離されます。

カスタムフックを使用することで、異なるコンポーネントで同じネットワークリクエストロジックを繰り返し利用できます。これにより、コードの再利用性と保守性が向上します。この抽象化により、コンポーネントの表示ロジックに集中することができ、副作用とデータ取得ロジックを一箇所にまとめることができます。

フロントエンドのネットワークリクエスト(Frontend network request)に関わる場合、AbortController は非常に便利なツールです。これにより、リクエストが完了する前に中止（キャンセル）することができます。また、合理的な時間内で応答を受けるために、リクエストのタイムアウトを設定することは重要な手段です。以下では、AbortController の役割と原理、ネットワークリクエストのキャンセル方法、タイムアウトの設定の重要性、および AbortController を使用してリクエストのタイムアウトを実現する方法について詳しく説明します。

3. AbortController の役割と原理：
AbortController は、非同期操作を中止するためのインターフェースであり、DOM の非同期操作（Fetch リクエストなど）と組み合わせて使用されます。AbortController を使用することで、コントローラーオブジェクトを作成し、それを中止する必要のある非同期操作と関連付けることができます。操作を中止する必要がある場合、AbortController の abort() メソッドを呼び出すことで、進行中の非同期操作を中止できます。

AbortController の動作原理は次の通りです：

  1. AbortController インスタンスを作成します：AbortController インスタンスを作成することで、非同期操作を制御する能力が得られます。
  2. AbortSignal を取得します：AbortController インスタンスの signal プロパティを呼び出すことで、AbortSignal オブジェクトを取得できます。このオブジェクトは読み取り専用のプロパティであり、非同期操作が中止されたかどうかを通知します。
  3. AbortSignal を非同期操作に関連付けます：非同期操作（例: Fetch リクエスト）を開始する際、通常は signal オプションの値として取得した AbortSignal オブジェクトを関連付けます。

AbortController を使用してネットワークリクエストをキャンセルする：
ネットワークリクエストをキャンセルするために AbortController を使用する手順は次の通りです：

  1. AbortController インスタンスを作成します：const controller = new AbortController();
  2. AbortSignal オブジェクトを取得します：const signal = controller.signal;
  3. 非同期操作に AbortSignal オブジェクトを関連付けます：非同期操作を開始する際、signal オプションを渡して AbortSignal オブジェクトを関連付けます。
const controller = new AbortController();
const signal = controller.signal;

fetch('/api/xx', { signal })
  .then(response => response.json())
  .then(data => {
    // レスポンスデータの処理
  })
  .catch(error => {
    if (error.name === 'AbortError') {
      // リクエストが中止されました
    } else {
      // 他のエラー処理
    }
  });

// リクエストをキャンセルするには、controller.abort() を呼び出すだけです。

タイムアウトの設定と AbortController を使用してリクエストのタイムアウトを実現する：
タイムアウトを設定することは、応答を待つ時間を長時間にならないようにするための重要な手段です。AbortController を使用することで、簡単にリクエストのタイムアウトを実現できます。以下は実現手順です：

  1. リクエスト前に AbortController インスタンスを作成します。
  2. タイマーを開始し、指定時間後に controller.abort() を呼び出してリクエストを中止します。
const controller = new AbortController();
const signal = controller.signal;

const timeout = setTimeout(() => {
  controller.abort();
}, 10000); // 10秒のタイムアウト

fetch('/api/xx', { signal })
  .then(response => response.json())
  .then(data => {
    // レスポンスデータの処理
  })
  .catch(error => {
    if (error.name === 'AbortError') {
      // タイムアウトが発生し、リクエストが中止されました
    } else {
      // 他のエラー処理
    }
  })
  .finally(() => {
    clearTimeout(timeout); // タイムアウトタイマーをクリア
  });

AbortController を使用してネットワークリクエストをキャンセルし、タイムアウトを設定することで、非同期操作を効果的に制御し、ユーザーエクスペリエンスを向上させ、不要な待ち時間を削減できます。

ベストプラクティスと注意点

  1. 統一された API ベースパス：
  • アプリケーション内で統一された API ベースパスを定義し、各リクエストで完全な URL をハードコードするのを避けます。
  • これにより、API ベースパスを簡単に変更できるようになり、各リクエストで URL を変更する必要がありません。
  1. リクエストパラメータの設計：
  • 明確なリクエストパラメータ構造を設計し、理解しやすく、保守しやすくします。
  • リクエストパラメータを直接結合するのではなく、オブジェクトや適切なデータ構造を使用してパラメータを渡すことで、可読性と保守性を向上させます。
  1. エラーハンドリングと状態管理：
  • カスタムフック内でエラー状態を処理し、エラー情報をコンポーネントに伝えて適切な表示を行います。
  • 状態コードやエラーメッセージを使用して異なるタイプのエラーを識別し、エラーの種類に応じて適切な処理を行います。
  1. ロード状態管理：
  • リクエスト実行中にロード状態を設定し、ユーザーエクスペリエンスを向上させるために、画面上に「ロード中」の状態を表示します。
  1. リクエストメソッドと幂等性：
  • 異なるリクエストメソッドの意味を理解し、リソースの操作が幂等性の原則に従っていることを確認します（同じ操作を繰り返しても異なる結果が得られない）。
  • RESTful API の原則に従い、リクエストメソッドを適切なリソース操作にマッピングします。
  1. タイムアウトの設定と AbortController：
  • タイムアウト時間を慎重に設定し、ユーザーエクスペリエンスに悪影響を与えないように注意します。
  • リクエストの不要な待ち時間を回避するために、AbortController を使用してリクエストをキャンセルします。

一般的な落とし穴とエラーを回避する:

  1. エラーハンドリングを無視しない：
  • エラーハンドリングを無視せず、ネットワークエラーやサーバーエラーなど、リクエストが失敗する可能性のあるすべての状況に対処します。
  1. 適切な状態管理：
  • ロード状態、エラー状態、データ状態を複数の場所で分散的に管理することを避けます。状態管理のロジックをカスタムフックに統一的に置くようにします。
  1. 並行リクエストの未処理：
  • 同じコンポーネントから複数の並行リクエストが行われる場合、適切な同期や排他的な操作を確保し、競合状態を回避します。
  1. 不正なデータ構造の処理：
  • API からの返信が予期しないデータ構造である可能性に備え、エラーハンドリングと適切なデータの抽出方法を考慮に入れます。
  1. 脆弱なセキュリティ対策：
  • API リクエスト内でセンシティブな情報（トークンなど）を平文で送信しないようにし、適切なセキュリティ対策を実施します。

以上の手法やベストプラクティスを組み合わせることで、フロントエンドのネットワークリクエストを効果的に管理し、アプリケーションの信頼性とユーザーエクスペリエンスを向上させることができます。

実際のコード例

import { useState, useEffect } from 'react';

const useApiRequest = () => {
  const [data, setData] = useState(null);
  const [isLoading, setIsLoading] = useState(false);
  const [error, setError] = useState(null);

  const fetchData = async (url, method, data) => {
    setIsLoading(true);
    setError(null);
    setData(null);

    const controller = new AbortController();
    const signal = controller.signal;

    const timeoutId = setTimeout(() => {
      controller.abort();
    }, 10000); // 10 seconds timeout

    try {
      const response = await fetch(url, {
        method,
        headers: {
          'Content-Type': 'application/json',
        },
        body: JSON.stringify(data),
        signal,
      });

      clearTimeout(timeoutId);

      if (!response.ok) {
        throw new Error('Network response was not ok');
      }

      const responseData = await response.json();
      setData(responseData);
    } catch (err) {
      if (err.name === 'AbortError') {
        setError('Request timed out');
      } else {
        setError('An error occurred');
      }
    } finally {
      setIsLoading(false);
    }
  };

  return { data, isLoading, error, fetchData };
};

呼び出しの例:

// Sample
const MyComponent = () => {
  const { data, isLoading, error, fetchData } = useApiRequest();

  useEffect(() => {
    fetchData('/api/xx', 'GET');
  }, []);

  return (
    <div>
      {isLoading && <p>Loading...</p>}
      {error && <p>Error: {error}</p>}
      {data && <pre>{JSON.stringify(data, null, 2)}</pre>}
    </div>
  );
};
0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?