Next.jsで学ぶReact講座 90日コース | ReactのためのJavaScript基礎 - Day 8:Fetch API

React Next.jsで学ぶReact講座90日コース
スポンサーリンク
スポンサーリンク

Day 8:Fetch APIでユーザー検索アプリを作る

Fetch APIは、JavaScriptからサーバーへリクエストを送り、データを受け取るための仕組みです。この日は、公開APIからユーザー一覧を取得し、名前やメールアドレスで検索する小さなアプリを作ります。

作るアプリの流れは次のとおりです。

  • ページを開くと、公開APIからユーザー一覧をGETで取得します。
  • 取得したJSONデータをJavaScriptのオブジェクトや配列として読み取ります。
  • 検索欄に入力された文字に合うユーザーを探します。
  • 読み込み中、検索結果、該当なし、エラーの状態を画面に表示します。

1. Fetch APIとは

fetch()は、指定したURLへHTTPリクエストを送るJavaScriptの機能です。通信には時間がかかるため、fetch()はPromiseを返します。そのため、これまで学んだasyncとawaitを組み合わせて使います。(🔗 developer.mozilla.org)

// URLへGETリクエストを送り、応答を待ちます
const response = await fetch("https://example.com/data");

// 応答本文をJSONとして読み取ります
const data = await response.json();
JavaScript

responseはサーバーからの応答を表すオブジェクトです。response.json()は、応答本文をJSONとして読み取り、JavaScriptで使える値に変換します。

2. HTTPとGET・POST

HTTPは、ブラウザーやアプリとサーバーがデータをやり取りするための決まりです。リクエストには「何をしたいか」を表すメソッドがあり、代表的なものにGETとPOSTがあります。

メソッド主な用途例
GETデータを取得するユーザー一覧を取得する
POST新しいデータを送信・作成する新しいユーザーを送信する

fetch(url)は、メソッドを省略すると通常GETとしてリクエストします。POSTを送るときは、methodやheaders、bodyを指定します。

3. JSONとは

JSONは、データを文字列として保存したり、ネットワークで送受信したりするときによく使われる形式です。JavaScriptのオブジェクトと似ていますが、JSONでは文字列やプロパティ名をダブルクォートで囲みます。

{
  "id": 1,
  "name": "Leanne Graham",
  "email": "leanne@example.com"
}
JSON

APIからJSONを受け取るときは、response.json()を使います。これは非同期処理なので、awaitをつけて完了を待ちます。

// サーバーの応答本文をJSONとして読み込みます
const user = await response.json();

// JSONから変換されたオブジェクトのプロパティを使います
console.log(user.name);
JavaScript

4. HTTPステータスを確認する

HTTPステータスは、サーバーがリクエストにどう応答したかを示す番号です。

ステータス意味の例
200リクエストが成功しました
201データを作成したときなどに使われます
400リクエストの内容に問題があります
401認証が必要、または認証に失敗しました
404指定したデータやURLが見つかりません
500サーバー側でエラーが発生しました

大切な注意点として、HTTPステータスが404や500でも、fetch()が必ず失敗するとは限りません。サーバーから応答が返れば、fetch()はResponseを返すことがあります。そのため、response.okを確認します。response.okは、ステータスが成功範囲の200から299ならtrueです。(🔗 developer.mozilla.org)

// APIにリクエストを送ります
const response = await fetch("https://example.com/data");

// HTTP応答が成功範囲でなければ、エラーにします
if (!response.ok) {
  throw new Error(`HTTPエラー: ${response.status}`);
}
JavaScript

5. 練習用の公開APIを使う

今回はJSONPlaceholderという、学習や試作に使える練習用APIを利用します。https://jsonplaceholder.typicode.com/usersからユーザー 一覧を取得できます。データは練習用のサンプルであり、実際のユーザー情報を扱うサービスではありません。(🔗 jsonplaceholder.typicode.com)

取得データには、ユーザー名、メールアドレス、住所などが含まれています。このアプリでは、画面に表示する項目を名前、ユーザー名、メールアドレスに絞ります。

6. プロジェクトのファイルを作る

Day 1で作ったプロジェクトフォルダーに、次の2つのファイルを作成します。

  • index.html:ページの入力欄や表示領域を作ります。
  • app.js:API取得、検索、結果表示の処理を書きます。

index.html

<!doctype html>
<html lang="ja">
  <head>
    <!-- 文字化けを防ぐため、文字コードを指定します -->
    <meta charset="UTF-8" />

    <!-- スマートフォンでも画面幅に合わせて表示します -->
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <!-- ブラウザーのタブに表示するタイトルです -->
    <title>ユーザー検索</title>

    <!-- HTMLを読み込んだ後にJavaScriptを実行します -->
    <script src="./app.js" defer></script>
  </head>
  <body>
    <!-- ページの見出しです -->
    <h1>ユーザー検索</h1>

    <!-- 検索フォームです -->
    <form id="search-form">
      <!-- 検索文字を入力する欄です -->
      <label for="search-input">名前、ユーザー名、メールアドレスで検索</label>
      <input
        id="search-input"
        type="search"
        placeholder="例:Leanne"
        autocomplete="off"
      />

      <!-- フォーム送信ボタンです -->
      <button type="submit">検索</button>
    </form>

    <!-- 読み込み状況やエラーメッセージを表示します -->
    <p id="status" aria-live="polite">ユーザーを読み込みます。</p>

    <!-- 検索結果を表示する場所です -->
    <ul id="results"></ul>
  </body>
</html>

deferをつけると、HTMLの読み込みを進めてからJavaScriptを実行します。そのため、JavaScriptがid="search-form"などのHTML要素を探すときに、要素がまだ読み込まれていない問題を避けやすくなります。

7. APIからユーザー一覧を取得する

次にapp.jsを作り、HTMLの要素を取得します。その後、ユーザー一覧を読み込む関数を作ります。

// 検索フォーム、入力欄、状態表示、結果一覧の要素を取得します
const searchForm = document.querySelector("#search-form");
const searchInput = document.querySelector("#search-input");
const statusMessage = document.querySelector("#status");
const resultsList = document.querySelector("#results");

// APIから取得したユーザー一覧を保存する変数です
let users = [];

// ユーザー一覧をAPIから取得する非同期関数です
async function loadUsers() {
  try {
    // 読み込み開始を画面に表示します
    statusMessage.textContent = "ユーザーを読み込み中です。";

    // ユーザー一覧APIへGETリクエストを送ります
    const response = await fetch(
      "https://jsonplaceholder.typicode.com/users"
    );

    // HTTPステータスが成功範囲でなければエラーにします
    if (!response.ok) {
      throw new Error(`HTTPエラー: ${response.status}`);
    }

    // 応答本文をJSONとして読み込みます
    const data = await response.json();

    // 想定どおり配列が返ったかを確認します
    if (!Array.isArray(data)) {
      throw new Error("APIから想定外のデータが返されました");
    }

    // 取得したユーザー一覧を保存します
    users = data;

    // 初期状態では、すべてのユーザーを表示します
    renderUsers(users);

    // 読み込み完了を表示します
    statusMessage.textContent = `${users.length}人のユーザーを読み込みました。`;
  } catch (error) {
    // 通信エラーやHTTPエラーなどを画面に表示します
    statusMessage.textContent =
      "ユーザーを読み込めませんでした。時間をおいて再度お試しください。";

    // 開発中に詳しいエラーを確認できるよう、コンソールにも出します
    console.error("ユーザーの取得に失敗しました:", error);
  }
}
JavaScript

let users = []とするのは、最初は空の配列で、APIからデータを取得したあとに新しい配列を代入するためです。取得したデータを保存しておけば、検索するたびに何度もAPIへリクエストを送らず、ページ内で絞り込めます。

8. ユーザー一覧を安全に表示する

取得したユーザーを画面に表示する関数を作ります。ここでは、文字列をHTMLとして挿入するinnerHTMLではなく、要素を作ってtextContentで文字を設定します。

// ユーザー一覧を画面に表示する関数です
function renderUsers(userList) {
  // 前の検索結果をいったん消します
  resultsList.replaceChildren();

  // 検索結果が0件なら、案内メッセージを表示します
  if (userList.length === 0) {
    const emptyItem = document.createElement("li");

    // テキストとして設定し、HTMLとして解釈されないようにします
    emptyItem.textContent = "該当するユーザーはいません。";

    // メッセージを一覧に追加します
    resultsList.append(emptyItem);
    return;
  }

  // ユーザーごとに表示用の要素を作ります
  userList.forEach((user) => {
    // ユーザー1人分のli要素を作ります
    const listItem = document.createElement("li");

    // 表示に使う情報をテキストとして設定します
    listItem.textContent =
      `${user.name}(${user.username}) - ${user.email}`;

    // 作った要素を結果一覧に追加します
    resultsList.append(listItem);
  });
}
JavaScript

APIから受け取ったデータを表示するときは、HTMLとして解釈させるのではなく、通常の文字として表示するのが安全です。特に、入力や外部データを無条件にinnerHTMLへ入れるのは避けましょう。

9. 入力された文字でユーザーを検索する

検索では、名前、ユーザー名、メールアドレスのどれかに入力文字が含まれているかを確認します。filter()で該当するユーザーだけを取り出します。

// 検索文字列に合うユーザーを探す関数です
function searchUsers(keyword) {
  // 前後の空白を除き、小文字にして比較しやすくします
  const normalizedKeyword = keyword.trim().toLowerCase();

  // 検索欄が空なら、すべてのユーザーを返します
  if (normalizedKeyword === "") {
    return users;
  }

  // 名前、ユーザー名、メールアドレスのいずれかに一致するユーザーを返します
  return users.filter((user) => {
    // 各項目を小文字にして、検索文字列が含まれるかを調べます
    return (
      user.name.toLowerCase().includes(normalizedKeyword) ||
      user.username.toLowerCase().includes(normalizedKeyword) ||
      user.email.toLowerCase().includes(normalizedKeyword)
    );
  });
}
JavaScript

trim()は、入力文字列の前後にある空白を取り除きます。toLowerCase()は小文字に変換するため、英字の大文字・小文字を区別しない検索にできます。includes()は、文字列の中に指定した文字列が含まれるかを調べます。

10. 検索ボタンの処理をつなぐ

フォームが送信されたときに、検索結果を表示する処理を登録します。

// フォーム送信時の処理を登録します
searchForm.addEventListener("submit", (event) => {
  // フォーム送信によるページ再読み込みを防ぎます
  event.preventDefault();

  // 入力文字に合うユーザーを検索します
  const matchedUsers = searchUsers(searchInput.value);

  // 検索結果を画面に表示します
  renderUsers(matchedUsers);

  // 検索結果の件数を画面に表示します
  statusMessage.textContent =
    `${matchedUsers.length}人のユーザーが見つかりました。`;
});

// ページを開いたときに、APIからユーザーを読み込みます
loadUsers();
JavaScript

event.preventDefault()は、フォームを送信したときの標準動作を止めます。この例ではページを再読み込みせず、JavaScriptだけで検索結果を書き換えます。

11. 完成したapp.js

ここまでのコードをまとめると、app.jsは次のとおりです。

// 検索フォーム、入力欄、状態表示、結果一覧の要素を取得します
const searchForm = document.querySelector("#search-form");
const searchInput = document.querySelector("#search-input");
const statusMessage = document.querySelector("#status");
const resultsList = document.querySelector("#results");

// APIから取得したユーザー一覧を保存する変数です
let users = [];

// ユーザー一覧をAPIから取得する非同期関数です
async function loadUsers() {
  try {
    // 読み込み中であることを表示します
    statusMessage.textContent = "ユーザーを読み込み中です。";

    // 公開APIへGETリクエストを送ります
    const response = await fetch(
      "https://jsonplaceholder.typicode.com/users"
    );

    // HTTPエラーを確認します
    if (!response.ok) {
      throw new Error(`HTTPエラー: ${response.status}`);
    }

    // 応答をJSONとして読み込みます
    const data = await response.json();

    // APIから配列が返ったか確認します
    if (!Array.isArray(data)) {
      throw new Error("APIから想定外のデータが返されました");
    }

    // ユーザー一覧を保存します
    users = data;

    // 最初は全ユーザーを表示します
    renderUsers(users);

    // 読み込み完了を表示します
    statusMessage.textContent = `${users.length}人のユーザーを読み込みました。`;
  } catch (error) {
    // 画面にエラーの案内を表示します
    statusMessage.textContent =
      "ユーザーを読み込めませんでした。時間をおいて再度お試しください。";

    // 開発者向けに詳細をコンソールへ表示します
    console.error("ユーザーの取得に失敗しました:", error);
  }
}

// ユーザー一覧を画面に表示する関数です
function renderUsers(userList) {
  // 以前の表示を消します
  resultsList.replaceChildren();

  // 該当者がいないときの表示です
  if (userList.length === 0) {
    const emptyItem = document.createElement("li");

    // メッセージをHTMLではなくテキストとして設定します
    emptyItem.textContent = "該当するユーザーはいません。";

    // 空の結果メッセージを追加します
    resultsList.append(emptyItem);
    return;
  }

  // ユーザーごとにリスト項目を作ります
  userList.forEach((user) => {
    const listItem = document.createElement("li");

    // APIから受け取った内容をテキストとして表示します
    listItem.textContent =
      `${user.name}(${user.username}) - ${user.email}`;

    // リストに追加します
    resultsList.append(listItem);
  });
}

// 入力文字に合うユーザーを検索する関数です
function searchUsers(keyword) {
  // 空白を除き、小文字に変換します
  const normalizedKeyword = keyword.trim().toLowerCase();

  // 空欄ならすべてのユーザーを返します
  if (normalizedKeyword === "") {
    return users;
  }

  // 名前、ユーザー名、メールアドレスのいずれかで絞り込みます
  return users.filter((user) => {
    return (
      user.name.toLowerCase().includes(normalizedKeyword) ||
      user.username.toLowerCase().includes(normalizedKeyword) ||
      user.email.toLowerCase().includes(normalizedKeyword)
    );
  });
}

// フォーム送信時に検索を実行します
searchForm.addEventListener("submit", (event) => {
  // ページの再読み込みを防ぎます
  event.preventDefault();

  // 入力欄の値でユーザーを検索します
  const matchedUsers = searchUsers(searchInput.value);

  // 検索結果を画面に描画します
  renderUsers(matchedUsers);

  // 検索件数を表示します
  statusMessage.textContent =
    `${matchedUsers.length}人のユーザーが見つかりました。`;
});

// ページ読み込み後にユーザー一覧を取得します
loadUsers();
JavaScript

12. アプリを動かす

index.htmlをブラウザーで開きます。ブラウザーの開発者ツールを使うと、エラーを確認できます。

  • ページを開いた直後は「ユーザーを読み込み中です。」と表示されます。
  • 読み込みが完了すると、ユーザー一覧が表示されます。
  • 検索欄に名前の一部やメールアドレスを入力し、「検索」を押します。
  • 一致するユーザーがいない文字を入力すると、「該当するユーザーはいません。」と表示されます。

ネットワーク接続やブラウザーの設定によっては、APIへの通信が失敗することがあります。その場合は、画面のエラーメッセージと開発者ツールのConsole・Networkタブを確認してください。

13. POSTリクエストの基本

今回のアプリはユーザー一覧を取得するため、GETを使います。POSTはサーバーへデータを送信するときに使います。JSONをPOSTする場合は、送信するデータをJSON.stringify()でJSON文字列にし、Content-Typeヘッダーを指定します。JSONPlaceholderはPOSTの例も提供していますが、作成されたデータが実際にサーバーへ保存されるわけではなく、作成されたような応答を返す練習用APIです。(🔗 jsonplaceholder.typicode.com)

// 新しいユーザーを送信する非同期関数です
async function createUser() {
  // APIへ送るユーザー情報です
  const newUser = {
    name: "練習ユーザー",
    username: "practice-user",
    email: "practice@example.com",
  };

  try {
    // POSTリクエストを送ります
    const response = await fetch(
      "https://jsonplaceholder.typicode.com/users",
      {
        // GETではなくPOSTを指定します
        method: "POST",

        // JSONを送ることをヘッダーで伝えます
        headers: {
          "Content-Type": "application/json; charset=UTF-8",
        },

        // JavaScriptのオブジェクトをJSON文字列に変換して送ります
        body: JSON.stringify(newUser),
      }
    );

    // HTTPエラーを確認します
    if (!response.ok) {
      throw new Error(`HTTPエラー: ${response.status}`);
    }

    // APIから返されたJSONを読み込みます
    const createdUser = await response.json();

    // サーバーの応答を確認します
    console.log(createdUser);
  } catch (error) {
    // 通信やHTTPエラーを表示します
    console.error("ユーザーを送信できませんでした:", error);
  }
}

// 必要なときにPOST処理を呼び出します
// createUser();
JavaScript

この例では最後の呼び出しをコメントにしているため、そのまま実行してもPOSTされません。POSTや更新系のリクエストを試す際は、APIの仕様を確認してから呼び出してください。

14. GET検索とAPI検索の違い

今回のアプリでは、最初にユーザー一覧を一度だけ取得し、その後はJavaScriptのfilter()で検索します。これはブラウザー内での検索です。ユーザー数が少ない練習データなら分かりやすい方法です。

実際のサービスでデータが大量にある場合は、検索キーワードをサーバーに送って、サーバー側で検索してもらう方式が使われます。APIの仕様によって、URLのクエリパラメーターやPOSTの本文など、検索条件の送り方は異なります。

15. エラーの種類を分けて考える

API通信のエラーは、ひとまとめにせず、どの段階で起きたか考えると原因を見つけやすくなります。

  • 通信エラー:ネットワークが切れている、接続先に到達できないなどです。`fetch()`が失敗し、`catch`に進むことがあります。
  • HTTPエラー:サーバーから`404`や`500`などの応答が返ります。`response.ok`を確認します。
  • JSONの読み込みエラー:応答本文がJSONとして正しくない場合などです。`response.json()`でエラーになることがあります。
  • データ形式のエラー:通信はできても、想定していた配列やプロパティがない場合があります。必要に応じて形式を確認します。

今回の例では、tryとcatch、response.ok、Array.isArray()を使い、通信・HTTP・データ形式の問題をそれぞれ扱いやすくしています。

16. 安全面で気をつけること

APIから受け取ったデータやユーザーの入力を、HTMLとしてそのまま挿入しないでください。この例でtextContentを使っているのは、文字をHTMLとして解釈させず表示するためです。

また、APIキーやパスワードなどの秘密情報を、ブラウザーに送られるJavaScriptファイルへ直接書いてはいけません。公開されたコードや開発者ツールから見える可能性があります。秘密情報が必要なAPIでは、サーバー側で安全に扱う設計が必要です。

17. Day 8のチェックリスト

  • fetch()を使ってGETリクエストを送れます。
  • response.json()でJSONをJavaScriptのデータとして読み込めます。
  • response.okやresponse.statusでHTTP応答を確認できます。
  • POSTリクエストでmethod、headers、bodyを指定できます。
  • JSON.stringify()で、JavaScriptのオブジェクトをJSON文字列に変換できます。
  • tryとcatchで通信や読み込みのエラーを処理できます。
  • 公開APIからユーザー一覧を取得し、名前やメールアドレスで検索できます。
  • APIデータを表示するとき、textContentを使って安全に文字として扱えます。

Day 8では、API通信を「リクエストを送る」「HTTP応答を確認する」「JSONを読む」「データを検索して表示する」という段階に分けて考えました。この流れは、ReactやNext.jsでAPIを扱うときの基本です。特に、fetch()の成功だけで安心せずHTTPステータスを確認すること、通信に失敗したときの表示を用意することを習慣にしましょう。

タイトルとURLをコピーしました