Next.jsで学ぶReact講座 90日コース | React実践力を身につける - Day 27:Context API

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

Day 27:Context APIでアプリ全体の状態を共有する

Context APIを使うと、親から深い階層にあるコンポーネントへ値を共有できます。この日は、ログイン状態・ユーザー情報・テーマをContextで管理し、ページ内の複数のコンポーネントから利用します。

Contextは状態そのものを作るものではありません。useStateなどで管理している値を、Providerの内側にある子孫コンポーネントへ渡す仕組みです。React ContextはServer Componentから直接利用できないため、Next.jsではProviderをClient Componentとして作り、レイアウトから配置します。(🔗 react.dev) (🔗 nextjs.org)

1. Contextを使う場面

たとえば、ログイン中のユーザー名をヘッダーとプロフィール欄の両方に表示する場合、それぞれのコンポーネントへPropsで値を渡せます。しかし、間に多くのコンポーネントがあると、値を使わない中間コンポーネントにもPropsを渡すことになります。これがProps Drillingです。

  • ひとつのコンポーネントだけが使う状態には、まずLocal Stateを使います。
  • 近い親子や兄弟で使う状態には、PropsやStateの持ち上げを使います。
  • 離れた複数の子孫が使う状態には、Contextを検討します。

ContextにすべてのStateを入れる必要はありません。アプリの多くの場所で共有するテーマやユーザー情報など、共有範囲が広い状態に向いています。

2. 今回作るもの

今回は、次の状態を共有します。

  • ログイン状態とユーザー情報:デモ用のログイン・ログアウトを行い、ユーザー名を表示します。
  • テーマ:ライトとダークを切り替え、画面の色を変えます。
  • Provider:Contextを提供する範囲を決めます。

この例のログイン操作は、Contextの使い方を学ぶためのデモです。実際の本人確認や認可は行いません。Contextにユーザー情報を入れるだけで、保護されたページやAPIへのアクセス制御が実現するわけではありません。

3. ファイル構成

App Routerを使う場合、次のようにファイルを分けます。

my-app/
├── app/
│   ├── globals.css
│   ├── layout.js
│   └── page.js
└── components/
    ├── AppProviders.js
    ├── auth/
    │   ├── AuthContext.js
    │   ├── LoginStatus.js
    │   └── UserProfile.js
    └── theme/
        ├── ThemeContext.js
        └── ThemeToggle.js

srcフォルダーを使っているプロジェクトでは、appとcomponentsをsrcの中に置いても構いません。

4. Contextを作る

Contextは、共有する値の種類ごとに分けて作ります。ここではログイン状態とユーザー情報をAuthContext、テーマをThemeContextにします。

ログイン用Context

components/auth/AuthContext.jsを作ります。

// このファイルをClient Componentとして扱います
"use client";

// ReactのContext作成・読み取り機能を読み込みます
import { createContext, useContext } from "react";

// Providerが設定されていないことを判別するため、初期値をnullにします
const AuthContext = createContext(null);

// 認証情報を読み取るためのカスタムHookです
export function useAuth() {
  // 最も近いAuthContext.Providerの値を取得します
  const context = useContext(AuthContext);

  // Providerの外側で使った場合、原因が分かるエラーを出します
  if (context === null) {
    throw new Error("useAuthはAuthProviderの内側で使ってください。");
  }

  // ユーザー情報と操作関数を返します
  return context;
}

// Providerから使うContextをエクスポートします
export default AuthContext;
JSX

useAuth()は、各コンポーネントでuseContext(AuthContext)を直接書かずに済むようにするカスタムHookです。Providerの外側で使った場合に、分かりやすいエラーも出せます。

テーマ用Context

components/theme/ThemeContext.jsを作ります。

// このファイルをClient Componentとして扱います
"use client";

// ReactのContext作成・読み取り機能を読み込みます
import { createContext, useContext } from "react";

// Providerがない場合に判別できるよう、初期値をnullにします
const ThemeContext = createContext(null);

// テーマを読み取るためのカスタムHookです
export function useTheme() {
  // 最も近いThemeContext.Providerの値を取得します
  const context = useContext(ThemeContext);

  // Providerの外側で使った場合にエラーを出します
  if (context === null) {
    throw new Error("useThemeはThemeProviderの内側で使ってください。");
  }

  // テーマと切り替え関数を返します
  return context;
}

// Providerから使うContextをエクスポートします
export default ThemeContext;
JSX

5. Providerで状態を管理する

Providerは、Contextの値を子孫コンポーネントへ渡すコンポーネントです。ここでは、ログイン情報とテーマをそれぞれのProviderで管理します。

ログイン用Provider

components/auth/AuthProvider.jsを作ります。

// このファイルをClient Componentとして扱います
"use client";

// Reactの状態管理機能を読み込みます
import { useState } from "react";

// ログイン用Contextを読み込みます
import AuthContext from "./AuthContext.js";

// 認証情報を子孫へ提供するコンポーネントです
export default function AuthProvider({ children }) {
  // デモでは最初はログアウト状態にします
  const [user, setUser] = useState(null);

  // デモ用ユーザーでログインします
  function demoLogin() {
    // 本物の本人確認ではなく、Context学習用の値です
    setUser({
      id: "demo-user",
      name: "サンプルユーザー",
      email: "demo@example.com",
    });
  }

  // デモ用にログアウトします
  function demoLogout() {
    // ユーザー情報を空にします
    setUser(null);
  }

  // ログイン状態はユーザー情報の有無から計算します
  const isLoggedIn = user !== null;

  // Provider内の子孫に渡す値をまとめます
  const value = {
    user,
    isLoggedIn,
    demoLogin,
    demoLogout,
  };

  return (
    // Providerの内側から認証情報を利用できます
    <AuthContext.Provider value={value}>
      {children}
    </AuthContext.Provider>
  );
}
JSX

isLoggedInとuserを独立したStateにすると、片方だけ更新されて食い違う可能性があります。この例では、userがあるかどうかからログイン状態を計算しています。

テーマ用Provider

components/theme/ThemeProvider.jsを作ります。

// このファイルをClient Componentとして扱います
"use client";

// Reactの状態管理機能を読み込みます
import { useState } from "react";

// テーマ用Contextを読み込みます
import ThemeContext from "./ThemeContext.js";

// テーマを管理して子孫へ提供します
export default function ThemeProvider({ children }) {
  // 初期テーマをライトにします
  const [theme, setTheme] = useState("light");

  // 現在と反対のテーマに切り替えます
  function toggleTheme() {
    setTheme((currentTheme) =>
      currentTheme === "light" ? "dark" : "light"
    );
  }

  // Contextを通じて共有する値です
  const value = {
    theme,
    toggleTheme,
  };

  return (
    // テーマ名をクラスとして付け、子孫へContextを提供します
    <ThemeContext.Provider value={value}>
      <div className={`app-shell theme-${theme}`}>
        {children}
      </div>
    </ThemeContext.Provider>
  );
}
JSX

6. Providerをまとめてレイアウトに置く

複数のProviderをまとめるAppProvidersを作ります。

// このファイルをClient Componentとして扱います
"use client";

// 各ContextのProviderを読み込みます
import AuthProvider from "./auth/AuthProvider.js";
import ThemeProvider from "./theme/ThemeProvider.js";

// アプリで使うProviderをまとめます
export default function AppProviders({ children }) {
  return (
    // 必要なProviderでページを包みます
    <AuthProvider>
      <ThemeProvider>
        {children}
      </ThemeProvider>
    </AuthProvider>
  );
}
JSX

次にapp/layout.jsからAppProvidersを使います。レイアウト自体はサーバー側のコンポーネントのままで、Client ComponentのProviderを子として配置できます。Next.js公式ガイドでも、Providerを別のClient Componentに置き、レイアウトで利用する構成が説明されています。(🔗 nextjs.org)

// グローバルCSSを読み込みます
import "./globals.css";

// ProviderをまとめたClient Componentを読み込みます
import AppProviders from "../components/AppProviders.js";

// アプリ全体の共通レイアウトです
export default function RootLayout({ children }) {
  return (
    <html lang="ja">
      <body>
        {/* ページ内容を必要なContext Providerで包みます */}
        <AppProviders>{children}</AppProviders>
      </body>
    </html>
  );
}
JSX

Providerをルートに置くと、その内側にあるページやClient ComponentがContextを利用できます。ただし、Providerの範囲は必要な範囲に留めるのが基本です。Next.jsのガイドでも、Providerはできるだけ深い位置に配置することが勧められています。(🔗 nextjs.org)

7. ログイン状態を表示する部品を作る

components/auth/LoginStatus.jsを作ります。ログインしていない場合はデモログインボタン、ログイン後はログアウトボタンを表示します。

// このファイルをClient Componentとして扱います
"use client";

// 認証情報を読み取るHookを読み込みます
import { useAuth } from "./AuthContext.js";

// ログイン状態に応じた操作を表示します
export default function LoginStatus() {
  // Contextから必要な値と関数を取得します
  const { isLoggedIn, demoLogin, demoLogout } = useAuth();

  return (
    <section>
      <h2>ログイン状態</h2>

      {/* 状態に応じて説明を切り替えます */}
      <p>{isLoggedIn ? "ログイン中です。" : "ログアウト中です。"}</p>

      {/* 状態に応じてボタンを切り替えます */}
      {isLoggedIn ? (
        <button type="button" onClick={demoLogout}>
          デモでログアウト
        </button>
      ) : (
        <button type="button" onClick={demoLogin}>
          デモでログイン
        </button>
      )}
    </section>
  );
}
JSX

このコンポーネントは、AuthProviderへPropsを通して情報をもらっていません。useAuth()を通じて、近くのProviderから値を取得しています。

8. ユーザー情報を表示する部品を作る

components/auth/UserProfile.jsを作ります。ユーザー情報をContextから読み取り、ログイン状態に応じて表示します。

// このファイルをClient Componentとして扱います
"use client";

// 認証情報を読み取るHookを読み込みます
import { useAuth } from "./AuthContext.js";

// ユーザー情報を表示します
export default function UserProfile() {
  // Contextからユーザー情報とログイン状態を取得します
  const { user, isLoggedIn } = useAuth();

  // ログインしていない場合の表示です
  if (!isLoggedIn || user === null) {
    return (
      <section>
        <h2>ユーザー情報</h2>
        <p>デモログインするとプロフィールを表示します。</p>
      </section>
    );
  }

  // ログイン中はプロフィールを表示します
  return (
    <section>
      <h2>ユーザー情報</h2>
      <p>名前:{user.name}</p>
      <p>メールアドレス:{user.email}</p>
    </section>
  );
}
JSX

9. テーマを切り替えるボタンを作る

components/theme/ThemeToggle.jsを作ります。

// このファイルをClient Componentとして扱います
"use client";

// テーマを読み取るHookを読み込みます
import { useTheme } from "./ThemeContext.js";

// テーマ切り替えボタンです
export default function ThemeToggle() {
  // Contextから現在のテーマと切り替え関数を取得します
  const { theme, toggleTheme } = useTheme();

  return (
    <button
      type="button"
      onClick={toggleTheme}
      aria-pressed={theme === "dark"}
    >
      {/* 現在のテーマに応じて操作内容を表示します */}
      {theme === "dark" ? "ライトテーマに切り替える" : "ダークテーマに切り替える"}
    </button>
  );
}
JSX

10. ページで部品を組み合わせる

app/page.jsを作ります。ここでは共有状態を直接管理せず、Contextを利用する部品を配置します。

// 認証状態を表示する部品を読み込みます
import LoginStatus from "../components/auth/LoginStatus.js";

// ユーザー情報を表示する部品を読み込みます
import UserProfile from "../components/auth/UserProfile.js";

// テーマ切り替えボタンを読み込みます
import ThemeToggle from "../components/theme/ThemeToggle.js";

// トップページです
export default function HomePage() {
  return (
    <main className="page-content">
      <h1>Context APIの練習</h1>
      <p>複数のコンポーネントから共有状態を利用します。</p>

      {/* テーマのContextを使う部品です */}
      <section>
        <h2>テーマ</h2>
        <ThemeToggle />
      </section>

      {/* 認証Contextを使う部品です */}
      <LoginStatus />

      {/* 同じ認証Contextからユーザー情報を読み取ります */}
      <UserProfile />
    </main>
  );
}
JSX

11. CSSでテーマを表示する

app/globals.cssに、ライト・ダークテーマのスタイルを追加します。

/* ページ全体の基本設定です */
* {
  box-sizing: border-box;
}

body {
  margin: 0;
  font-family: sans-serif;
}

/* テーマの変更を画面全体へ反映する外枠です */
.app-shell {
  min-height: 100vh;
  transition: color 0.2s ease, background-color 0.2s ease;
}

/* ライトテーマの色です */
.theme-light {
  color: #202124;
  background-color: #ffffff;
}

/* ダークテーマの色です */
.theme-dark {
  color: #f5f5f5;
  background-color: #202124;
}

/* ページの幅と余白を整えます */
.page-content {
  max-width: 720px;
  margin: 0 auto;
  padding: 32px 20px;
}

/* 各機能のまとまりを見やすくします */
.page-content section {
  margin-top: 24px;
  padding: 16px;
  border: 1px solid currentColor;
  border-radius: 8px;
}

/* ボタンを押しやすくします */
button {
  padding: 10px 14px;
  cursor: pointer;
}

12. アプリの動きを確認する

  • ページを開くと、ログアウト状態とデモログインボタンが表示されます。
  • 「デモでログイン」を押すと、ログイン状態になり、プロフィールが表示されます。
  • 「デモでログアウト」を押すと、ユーザー情報が消え、ログアウト表示に戻ります。
  • テーマ切り替えボタンを押すと、背景色と文字色が変わります。
  • ログイン状態とテーマは、別々のContextで管理されていることを確認します。

13. Contextの重要なルール

useContext()は、コンポーネントの上にある最も近いProviderの値を読み取ります。Providerがない場合は、createContext()に渡した初期値が使われます。Contextの値が変わると、そのContextを使っているコンポーネントは新しい値で再レンダーされます。(🔗 react.dev)

  • Providerの内側で使う:Contextを読むコンポーネントは、対応するProviderの子孫にします。
  • 必要な値だけ共有する:無関係なフォーム入力や一時的な開閉状態まで、アプリ全体のContextに入れないようにします。
  • Contextを分ける:テーマとユーザー情報のように更新理由や利用範囲が異なる値は、分けると管理しやすくなります。
  • 値の変更で再レンダーが起きる:Providerの値を利用するコンポーネントは、Contextの更新時に再描画されます。

14. ログイン情報とセキュリティの注意

この例では、userをReactのStateで管理していますが、これは画面表示用のデモ状態です。Contextにユーザー情報を置くことは、本人確認やアクセス制御にはなりません。ブラウザー側の表示を隠すだけでは、保護すべきデータや処理を守れません。

  • 実際のログインでは、サーバー側でセッションや認証状態を検証します。
  • 保護されたデータを返すAPIや処理でも、ユーザーの権限を確認します。
  • パスワード、秘密鍵、アクセストークンなどの機密情報を、安易にContextやLocalStorageに保存しないでください。
  • 画面上の「ログイン中」という表示だけを、アクセス許可の根拠にしないでください。

ここで作ったdemoLogin()は、Contextの値が共有される流れを試すためのものです。本物の認証機能を実装するコードではありません。

15. よくあるつまずき

  • Providerの外でHookを使っている:`AppProviders`がページの親にあるか確認します。
  • Contextの値を更新できない:Contextは値を配るだけなので、Provider内に`useState`などの更新処理が必要です。
  • 状態を変更しても表示が変わらない:Providerの値を新しい値として更新しているか確認します。
  • 何でもContextに入れてしまう:その状態を本当に複数の離れたコンポーネントが共有するか見直します。
  • ログイン表示を認証だと思う:デモ表示とサーバー側の本人確認・認可は別物です。
  • Server ComponentからContextを直接読もうとする:Contextを利用するコンポーネントはClient Componentにします。

16. Day 27のチェックリスト

  • Contextが、Providerの子孫へ値を共有する仕組みだと説明できます。
  • `createContext`、Provider、`useContext`の役割を理解しています。
  • テーマとユーザー情報を別々のContextで管理できます。
  • カスタムHookを作り、Providerの外での利用を検出できます。
  • Next.jsではProviderをClient Componentにし、レイアウトから配置できます。
  • Context上のログイン表示だけでは、認証・認可にならないと理解しています。

Context APIは、アプリ内の離れたコンポーネントで同じ状態を使いたいときに役立ちます。今回の例では、テーマとログイン情報を別々のProviderで管理し、必要なコンポーネントからカスタムHookで読み取りました。共有範囲に合わせてContextを使い、実際の認証やアクセス制御は必ずサーバー側でも設計しましょう。

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