コンテンツにスキップ
アプリケーションの構築設定プログレッシブウェブアプリケーション (PWA)

プログレッシブウェブアプリケーション (PWA)

プログレッシブウェブアプリケーション (PWA) は、ウェブアプリケーションの到達性とアクセシビリティに、ネイティブモバイルアプリの機能とユーザー体験を組み合わせたものです。Next.js を使用すると、複数のコードベースやアプリストアの承認を必要とせずに、すべてのプラットフォームでシームレスなアプリのような体験を提供する PWA を作成できます。

PWA では、以下のことが可能です。

  • アプリストアの承認を待たずに即座に更新をデプロイ
  • 単一のコードベースでクロスプラットフォームアプリケーションを作成
  • ホーム画面へのインストールやプッシュ通知などのネイティブのような機能を提供

Next.js で PWA を作成する

1. ウェブアプリマニフェストの作成

Next.js は、App Router を使用してウェブアプリマニフェストを作成するための組み込みサポートを提供します。静的または動的なマニフェストファイルを作成できます。

例として、app/manifest.ts または app/manifest.json ファイルを作成します。

app/manifest.ts
import type { MetadataRoute } from 'next'
 
export default function manifest(): MetadataRoute.Manifest {
  return {
    name: 'Next.js PWA',
    short_name: 'NextPWA',
    description: 'A Progressive Web App built with Next.js',
    start_url: '/',
    display: 'standalone',
    background_color: '#ffffff',
    theme_color: '#000000',
    icons: [
      {
        src: '/icon-192x192.png',
        sizes: '192x192',
        type: 'image/png',
      },
      {
        src: '/icon-512x512.png',
        sizes: '512x512',
        type: 'image/png',
      },
    ],
  }
}

このファイルには、名前、アイコン、およびユーザーのデバイス上でアイコンとしてどのように表示されるかに関する情報を含める必要があります。これにより、ユーザーは PWA をホーム画面にインストールでき、ネイティブアプリのような体験を提供できます。

さまざまなアイコンセットを作成するには、ファビコンジェネレーターなどのツールを使用し、生成されたファイルを public/ フォルダーに配置できます。

2. ウェブプッシュ通知の実装

ウェブプッシュ通知は、以下のすべてのモダンブラウザでサポートされています。

  • ホーム画面にインストールされたアプリケーションの場合、iOS 16.4 以降
  • macOS 13 以降の場合、Safari 16
  • Chromium ベースのブラウザ
  • Firefox

これにより、PWA はネイティブアプリの実行可能な代替となります。特に、オフラインサポートを必要とせずにインストールプロンプトをトリガーできます。

ウェブプッシュ通知を使用すると、ユーザーがアクティブにアプリを使用していない場合でも、再エンゲージメントを促すことができます。Next.js アプリケーションでそれらを実装する方法を次に示します。

まず、app/page.tsx にメインページコンポーネントを作成しましょう。より理解を深めるために、小さなパーツに分解します。最初に、必要なインポートとユーティリティの一部を追加します。参照されるサーバーアクションがまだ存在しなくても問題ありません。

'use client'
 
import { useState, useEffect } from 'react'
import { subscribeUser, unsubscribeUser, sendNotification } from './actions'
 
function urlBase64ToUint8Array(base64String: string) {
  const padding = '='.repeat((4 - (base64String.length % 4)) % 4)
  const base64 = (base64String + padding).replace(/-/g, '+').replace(/_/g, '/')
 
  const rawData = window.atob(base64)
  const outputArray = new Uint8Array(rawData.length)
 
  for (let i = 0; i < rawData.length; ++i) {
    outputArray[i] = rawData.charCodeAt(i)
  }
  return outputArray
}

次に、プッシュ通知の購読、購読解除、送信を管理するコンポーネントを追加しましょう。

function PushNotificationManager() {
  const [isSupported, setIsSupported] = useState(false)
  const [subscription, setSubscription] = useState<PushSubscription | null>(
    null
  )
  const [message, setMessage] = useState('')
 
  useEffect(() => {
    if ('serviceWorker' in navigator && 'PushManager' in window) {
      setIsSupported(true)
      registerServiceWorker()
    }
  }, [])
 
  async function registerServiceWorker() {
    const registration = await navigator.serviceWorker.register('/sw.js', {
      scope: '/',
      updateViaCache: 'none',
    })
    const sub = await registration.pushManager.getSubscription()
    setSubscription(sub)
  }
 
  async function subscribeToPush() {
    const registration = await navigator.serviceWorker.ready
    const sub = await registration.pushManager.subscribe({
      userVisibleOnly: true,
      applicationServerKey: urlBase64ToUint8Array(
        process.env.NEXT_PUBLIC_VAPID_PUBLIC_KEY!
      ),
    })
    setSubscription(sub)
    const serializedSub = JSON.parse(JSON.stringify(sub))
    await subscribeUser(serializedSub)
  }
 
  async function unsubscribeFromPush() {
    await subscription?.unsubscribe()
    setSubscription(null)
    await unsubscribeUser()
  }
 
  async function sendTestNotification() {
    if (subscription) {
      await sendNotification(message)
      setMessage('')
    }
  }
 
  if (!isSupported) {
    return <p>Push notifications are not supported in this browser.</p>
  }
 
  return (
    <div>
      <h3>Push Notifications</h3>
      {subscription ? (
        <>
          <p>You are subscribed to push notifications.</p>
          <button onClick={unsubscribeFromPush}>Unsubscribe</button>
          <input
            type="text"
            placeholder="Enter notification message"
            value={message}
            onChange={(e) => setMessage(e.target.value)}
          />
          <button onClick={sendTestNotification}>Send Test</button>
        </>
      ) : (
        <>
          <p>You are not subscribed to push notifications.</p>
          <button onClick={subscribeToPush}>Subscribe</button>
        </>
      )}
    </div>
  )
}

最後に、iOS デバイスにホーム画面へのインストールを指示するメッセージを表示するコンポーネントを作成します。これは、アプリがまだインストールされていない場合にのみ表示します。

function InstallPrompt() {
  const [isIOS, setIsIOS] = useState(false)
  const [isStandalone, setIsStandalone] = useState(false)
 
  useEffect(() => {
    setIsIOS(
      /iPad|iPhone|iPod/.test(navigator.userAgent) && !(window as any).MSStream
    )
 
    setIsStandalone(window.matchMedia('(display-mode: standalone)').matches)
  }, [])
 
  if (isStandalone) {
    return null // Don't show install button if already installed
  }
 
  return (
    <div>
      <h3>Install App</h3>
      <button>Add to Home Screen</button>
      {isIOS && (
        <p>
          To install this app on your iOS device, tap the share button
          <span role="img" aria-label="share icon">
            {' '}
            ⎋{' '}
          </span>
          and then "Add to Home Screen"
          <span role="img" aria-label="plus icon">
            {' '}
            ➕{' '}
          </span>.
        </p>
      )}
    </div>
  )
}
 
export default function Page() {
  return (
    <div>
      <PushNotificationManager />
      <InstallPrompt />
    </div>
  )
}

次に、このファイルが呼び出すサーバーアクションを作成しましょう。

3. サーバーアクションの実装

app/actions.ts にアクションを格納する新しいファイルを作成します。このファイルは、サブスクリプションの作成、サブスクリプションの削除、および通知の送信を処理します。

app/actions.ts
'use server'
 
import webpush from 'web-push'
 
webpush.setVapidDetails(
  '<mailto:your-email@example.com>',
  process.env.NEXT_PUBLIC_VAPID_PUBLIC_KEY!,
  process.env.VAPID_PRIVATE_KEY!
)
 
let subscription: PushSubscription | null = null
 
export async function subscribeUser(sub: PushSubscription) {
  subscription = sub
  // In a production environment, you would want to store the subscription in a database
  // For example: await db.subscriptions.create({ data: sub })
  return { success: true }
}
 
export async function unsubscribeUser() {
  subscription = null
  // In a production environment, you would want to remove the subscription from the database
  // For example: await db.subscriptions.delete({ where: { ... } })
  return { success: true }
}
 
export async function sendNotification(message: string) {
  if (!subscription) {
    throw new Error('No subscription available')
  }
 
  try {
    await webpush.sendNotification(
      subscription,
      JSON.stringify({
        title: 'Test Notification',
        body: message,
        icon: '/icon.png',
      })
    )
    return { success: true }
  } catch (error) {
    console.error('Error sending push notification:', error)
    return { success: false, error: 'Failed to send notification' }
  }
}

通知の送信は、ステップ5で作成したサービスワーカーによって処理されます。

本番環境では、サーバーの再起動後も永続的にデータを保持し、複数のユーザーのサブスクリプションを管理するために、サブスクリプションをデータベースに保存することをお勧めします。

4. VAPID キーの生成

Web Push API を使用するには、VAPIDキーを生成する必要があります。最も簡単な方法は、web-push CLI を直接使用することです。

まず、web-push をグローバルにインストールします。

ターミナル
npm install -g web-push

VAPID キーを生成するには、以下を実行します。

ターミナル
web-push generate-vapid-keys

出力をコピーし、.env ファイルにキーを貼り付けます。

NEXT_PUBLIC_VAPID_PUBLIC_KEY=your_public_key_here
VAPID_PRIVATE_KEY=your_private_key_here

5. サービスワーカーの作成

サービスワーカー用に public/sw.js ファイルを作成します。

public/sw.js
self.addEventListener('push', function (event) {
  if (event.data) {
    const data = event.data.json()
    const options = {
      body: data.body,
      icon: data.icon || '/icon.png',
      badge: '/badge.png',
      vibrate: [100, 50, 100],
      data: {
        dateOfArrival: Date.now(),
        primaryKey: '2',
      },
    }
    event.waitUntil(self.registration.showNotification(data.title, options))
  }
})
 
self.addEventListener('notificationclick', function (event) {
  console.log('Notification click received.')
  event.notification.close()
  event.waitUntil(clients.openWindow('<https://your-website.com>'))
})

このサービスワーカーは、カスタム画像と通知をサポートしています。受信プッシュイベントと通知クリックを処理します。

  • 通知用のカスタムアイコンは、icon および badge プロパティを使用して設定できます。
  • vibrate パターンは、サポートされているデバイスでカスタム振動アラートを作成するために調整できます。
  • 追加のデータは、data プロパティを使用して通知に添付できます。

サービスワーカーがさまざまなデバイスやブラウザで期待通りに動作することを確認するために、徹底的にテストすることを忘れないでください。また、notificationclick イベントリスナーの 'https://your-website.com' リンクをアプリケーションの適切な URL に更新してください。

6. ホーム画面への追加

ステップ2で定義された InstallPrompt コンポーネントは、iOS デバイスにホーム画面へのインストールを指示するメッセージを表示します。

アプリケーションをモバイルのホーム画面にインストールできるようにするには、以下が必要です。

  1. 有効なウェブアプリマニフェスト (ステップ1で作成済み)
  2. HTTPS で提供されるウェブサイト

これらの条件が満たされると、モダンブラウザはユーザーに自動的にインストールプロンプトを表示します。beforeinstallpromptでカスタムインストールボタンを提供できますが、これはクロスブラウザ・クロスプラットフォームで動作しないため（Safari iOSでは動作しません）、推奨しません。

7. ローカルでのテスト

ローカルで通知を表示できるようにするには、以下を確認してください。

  • HTTPS でローカル実行していること
    • テストには next dev --experimental-https を使用すること
  • お使いのブラウザ (Chrome、Safari、Firefox) で通知が有効になっていること
    • ローカルでプロンプトが表示されたら、通知の使用許可を承諾すること
    • ブラウザ全体で通知がグローバルに無効になっていないことを確認すること
    • それでも通知が表示されない場合は、別のブラウザを使用してデバッグしてみてください。

8. アプリケーションのセキュリティ確保

セキュリティは、あらゆるウェブアプリケーション、特に PWA にとって重要な側面です。Next.js では、next.config.js ファイルを使用してセキュリティヘッダーを設定できます。例として、

next.config.js
module.exports = {
  async headers() {
    return [
      {
        source: '/(.*)',
        headers: [
          {
            key: 'X-Content-Type-Options',
            value: 'nosniff',
          },
          {
            key: 'X-Frame-Options',
            value: 'DENY',
          },
          {
            key: 'Referrer-Policy',
            value: 'strict-origin-when-cross-origin',
          },
        ],
      },
      {
        source: '/sw.js',
        headers: [
          {
            key: 'Content-Type',
            value: 'application/javascript; charset=utf-8',
          },
          {
            key: 'Cache-Control',
            value: 'no-cache, no-store, must-revalidate',
          },
          {
            key: 'Content-Security-Policy',
            value: "default-src 'self'; script-src 'self'",
          },
        ],
      },
    ]
  },
}

これらのオプションをそれぞれ見ていきましょう。

  1. グローバルヘッダー (すべてのルートに適用)
    1. X-Content-Type-Options: nosniff: MIMEタイプスニッフィングを防ぎ、悪意のあるファイルアップロードのリスクを低減します。
    2. X-Frame-Options: DENY: サイトが iframe に埋め込まれるのを防ぎ、クリックジャッキング攻撃から保護します。
    3. Referrer-Policy: strict-origin-when-cross-origin: リクエストに含まれるリファラー情報の量を制御し、セキュリティと機能のバランスを取ります。
  2. サービスワーカー固有のヘッダー
    1. Content-Type: application/javascript; charset=utf-8: サービスワーカーが JavaScript として正しく解釈されるようにします。
    2. Cache-Control: no-cache, no-store, must-revalidate: サービスワーカーのキャッシュを防止し、ユーザーが常に最新バージョンを取得できるようにします。
    3. Content-Security-Policy: default-src 'self'; script-src 'self': サービスワーカーに厳格なコンテンツセキュリティポリシーを実装し、同一オリジンからのスクリプトのみを許可します。

Next.js でのコンテンツセキュリティポリシーの定義について詳しく学びましょう。

次のステップ

  1. PWA の機能を探る: PWA はさまざまなウェブ API を活用して、高度な機能を提供できます。アプリケーションを強化するために、バックグラウンド同期、定期的なバックグラウンド同期、または File System Access API などの機能を検討してください。PWA の機能に関するインスピレーションと最新情報については、What PWA Can Do Todayなどのリソースを参照できます。
  2. 静的エクスポート: アプリケーションがサーバーを実行せず、ファイルの静的エクスポートを使用する必要がある場合は、Next.js の設定を更新してこの変更を有効にできます。Next.js 静的エクスポートのドキュメントで詳細を確認してください。ただし、サーバーアクションから外部 API の呼び出しに移行し、定義されたヘッダーをプロキシに移動する必要があります。
  3. オフラインサポート: オフライン機能を提供するには、Next.js と一緒に Serwist を使用するという選択肢があります。彼らのドキュメントで Serwist を Next.js と統合する方法の例を見つけることができます。注意: このプラグインは現在 webpack の設定が必要です。
  4. セキュリティに関する考慮事項: サービスワーカーが適切に保護されていることを確認してください。これには、HTTPS の使用、プッシュメッセージの送信元の検証、適切なエラー処理の実装が含まれます。
  5. ユーザー体験: ユーザーのブラウザで特定の PWA 機能がサポートされていない場合でも、アプリがうまく動作するようにプログレッシブエンハンスメント技術の実装を検討してください。

次のステップ

manifest.json

manifest.json ファイルの API リファレンス。