ReactコンポーネントでWebAPIからデータを取得し画面に表示するまで

2023年11月21日公開
!React の公式ドキュメントが更新されて得た新しい情報から記事のアップデートをしました。
https://qiita.com/diskszk/items/6549584a3843781aac79
 はじめに先日 useEffect についてまとめた記事を書きました。本記事では、こちらの記事に収まりきらなかった、useEffect を使って初回レンダリング時に WebAPI からデータを取得して表示する法方と勉強し始めの頃にハマったことを文章に起こします。
この記事では WebAPI から投稿データを取得し、リスト形式に並べてレンダリングするまでを、筆者の過去の失敗を交え解説していきます。
今回 WebAPI から何らかのデータを取得するにあたって、JSONPlaceholderというサービスを利用しました。手軽に REST API を試せるのでおすすめです。
 事前準備 型定義WebAPI から取得したデータのうち、利用する要素だけを型定義します。
export type Post = {
  id: string;
  body: string;
  title: string;
};
 fetch用関数fetch メソッドを使って https://jsonplaceholder.typicode.com/posts/?_limit=10 にあるリソースを見に行きます。posts を最大 10 件取得する関数です。

こちらの関数をこの記事の例では使いまわしていきます。
const fetchPosts = async (): Promise<Post[]> => {
  console.log("fetching-start");

  const res = await fetch(
    "https://jsonplaceholder.typicode.com/posts/?_limit=10"
  );

  console.log("fetching-finish");
  return res.json();
};
fetch　は「目的の場所に行って取ってくる」という意味があるので外部リソースから取得する時によく使われます。
 実践編 バッドパターンfetch 結果がレンダリングされません。
const PostList: React.FC = () => {
  let posts: Post[] = [];
  fetchPosts().then((data) => {
    posts = data;
  });

  return (
    <div>
      <p>データ一覧</p>
      <ul>
        {console.log("render")}
        {posts.map((post) => {
          return (
            <li key={post.id}>
              <h1>{post.title}</h1>
              <p>{post.body}</p>
            </li>
          );
        })}
      </ul>
    </div>
  );
};
みるからに酷いコードですね。.。
ですが私は昔本当にこのコードを書いていたのです。本当か疑わしくなってきました。
ブラウザで確認すると、データ一覧の下に投稿データが表示される想定でしたが 1 件も表示されません。
コードはさておき、なぜレンダリングされないのかを処理の順番を追って見ていきます。
こちらは単に非同期通信処理のハンドリングがされていないからです。

コンポーネント内での処理の順番としては次のようになります。
fetchPosts 関数を呼び出し'fetching-start'のログが吐かれ、WebAPI との通信が始まる
画面がレンダリングされる
WebAPI との通信が終わり、'fetching-finish'のログが測れる
2。のレンダリング時にはまだ投稿データの取得が完了しておらず、ローカル変数 posts は空のままなので空のデータがレンダリングされるからです。

なので useEffect を使って投稿データをローカル変数に格納し終えたら再度レンダリングしてもらうようにします。
 OK パターンあくまでも私がこれで大丈夫というコードです。動きはします。
const PostList: React.FC = () => {
  const [posts, setPosts] = useState<Post[]>([]);
  const [isLoading, setIsLoading] = useState(true);

  useEffect(() => {
    (async function () {
      const data = await fetchPosts();

      setPosts(data);
      setIsLoading(false);
    })();
  }, []);

  return (
    <div>
      {console.log("render")}
      <p>データ一覧</p>
      {isLoading && <h2>Loading...</h2>}
      <ul>
        {posts.map((post) => {
          return (
            <li key={post.id}>
              <h1>{post.title}</h1>
              <p>{post.body}</p>
            </li>
          );
        })}
      </ul>
    </div>
  );
};
レンダリングの順番をわかりやすくするために WebAPI との通信中とのことをユーザーに教える Loading 状態をコンポーネントに追加しました。
ブラウザで確認してみます。
ブラウザのリロードボタンを押すと始めに Loading... が表示されて、少しすると投稿データが表示されます。
処理の順番を追っていきます。
初回レンダリング処理が走ります
この時点で画面にレンダリングされるのは Loading..。です
初回レンダリング後に useEffect 内部の処理が始まります
const data = await fetchPosts() の行で WebAPI との通信が始まり、'fetching-start'のログが吐かれます
非同期処理なので fetchPosts()の処理が終了するまで次の処理を待ってくれます
WebAPI から投稿データを取得する処理が完了したので'fetching-finish'のログが吐かれます
React コンポーネントの useEffect に戻り、取得した投稿データをローカル変数 posts にセットします
useEffect 内で画面に表示するデータが変わったので再レンダリング処理が始まります
開発者コンソールを見てみると次のようになります。
最後の'render'が 2 回出てくるのは'posts'と'isLoading'の 2 つの変数が変更しているからですね。
 最後に改めて過去のコードを眺めると酷いもんだなと思えるようになってきたのは成長の証だと捉えて精進していきます。.。
以上です。最後まで読んでいただきありがとうございます！