コンテンツにスキップ

ミドルウェア

ミドルウェアにより、リクエストとレスポンスをインターセプトし、ページやエンドポイントがレンダリングされる直前に動的に振る舞いを注入できます。こうしたレンダリングは、ページが事前レンダリングされる場合にはビルド時におこなわれますが、オンデマンドにレンダリングされるページの場合はルートへのリクエスト時におこなわれ、クッキーやヘッダーなどの追加のSSR機能が利用できます。

また、ミドルウェアを使って、すべてのAstroコンポーネントとAPIエンドポイントで利用可能なlocalsオブジェクトを変更し、リクエスト固有の情報を各エンドポイントとページで設定・共有することもできます。このオブジェクトは、このミドルウェアがビルド時に実行される場合でも利用できます。

基本的な使い方

セクションタイトル： 基本的な使い方

  1. src/middleware.js|ts というファイルを作成します。（あるいは、src/middleware/index.js|ts を作成しても構いません。）

  2. このファイルの中で、contextオブジェクトとnext()関数を受け取るonRequest()関数をエクスポートします。これをデフォルトエクスポートにしてはいけません。

    src/middleware.js
    export function onRequest (context, next) {
        // リクエストからデータをインターセプトします
        // 必要に応じて、`locals`内のプロパティを改変します
        context.locals.title = "新しいタイトル";
    

        // Responseか`next()`の結果を返します
        return next();
    };

  3. .astroファイルの中で、Astro.localsを使ってレスポンスデータにアクセスします。

    src/components/Component.astro
    ---
    const data = Astro.locals;
    ---
    <h1>{data.title}</h1>
    <p>この{data.property}はミドルウェアで設定しました。</p>

contextオブジェクト

セクションタイトル： contextオブジェクト

contextオブジェクトには、レンダリング中に他のミドルウェア、APIルート、.astroルートで利用可能な情報が含まれています。

これはonRequest()に渡されるオプション引数で、localsオブジェクトや、レンダリング中に共有されるその他のプロパティを含む場合があります。たとえばcontextオブジェクトには、認証に使用されるクッキーを含められます。

context.localsにデータを保存する

セクションタイトル： context.localsにデータを保存する

context.localsは、ミドルウェア内で変更可能なオブジェクトです。

このlocalsオブジェクトは、リクエスト処理のプロセスを通じて受け渡されていき、APIContextとAstroGlobalのプロパティとして利用できます。これにより、ミドルウェア、APIルート、.astroページ間でデータを共有できます。ユーザーデータなど、リクエスト固有のデータを各レンダリングステップをまたいで保持する際に役立ちます。

localsには、文字列、数値、さらには関数やマップといった複雑なデータ型など、どんな型のデータでも格納できます。

src/middleware.js
export function onRequest (context, next) {
    // リクエストからデータをインターセプトします
    // 必要に応じて、`locals`内のプロパティを改変します
    context.locals.user.name = "John Wick";
    context.locals.welcomeTitle = () => {
        return "おかえりなさい " + locals.user.name;
    };


    // Responseか`next()`の結果を返します
    return next();
};

そして、任意の.astroファイル内でAstro.localsによりこの情報を利用できます。

src/pages/orders.astro
---
const title = Astro.locals.welcomeTitle();
const orders = Array.from(Astro.locals.orders.entries());
---
<h1>{title}</h1>
<p>この{data.property}はミドルウェアで設定しました。</p>
<ul>
    {orders.map(order => {
        return <li>{/* 各値を使って何かします */}</li>;
    })}
</ul>

localsは単一のAstroルートの中で生成・消滅します。ページルートがレンダリングされると、localsはもう存在せず、その後また新しいものが作成されます。複数のページリクエストをまたいで保持されるべき情報は、別の場所に保存する必要があります。

センシティブな情報を消去する例

セクションタイトル： センシティブな情報を消去する例

以下の例では、ミドルウェアを使用して「極秘情報」という文字列を「削除済み」という語に置き換えることで、変更されたHTMLをページにレンダリングできるようにします。

src/middleware.js
export const onRequest = async (context, next) => {
    const response = await next();
    const html = await response.text();
    const redactedHtml = html.replaceAll("極秘情報", "削除済み");


    return new Response(redactedHtml, {
        status: 200,
        headers: response.headers
    });
};

ミドルウェアの型

セクションタイトル： ミドルウェアの型

defineMiddleware()ユーティリティ関数をインポートして使用すると、型安全性を確保できます。

src/middleware.ts
import { defineMiddleware } from "astro:middleware";


// `context`と`next`は自動的に型付けされます
export const onRequest = defineMiddleware((context, next) => {


});

JsDocにより型を記述している場合は、MiddlewareHandlerを使用できます。

src/middleware.js
/**
 * @type {import("astro").MiddlewareHandler}
 */
// `context`と`next`は自動的に型付けされます
export const onRequest = (context, next) => {


};

Astro.locals内の情報に型を付け、.astroファイルとミドルウェアの両コードで自動補完を有効化するには、env.d.tsファイルでグローバル名前空間を宣言します。

src/env.d.ts
/// <reference path="../.astro/types.d.ts" />


declare namespace App {
    interface Locals {
        user: {
            name: string
        },
        welcomeTitle: () => string,
        orders: Map<string, object>
    }
}

これにより、ミドルウェアファイル内で自動補完が有効になり、型安全性が確保されます。

ミドルウェアを連結する

セクションタイトル： ミドルウェアを連結する

sequence()を使用して、複数のミドルウェアを指定した順序で連結できます。

src/middleware.js
import { sequence } from "astro:middleware";


async function validation(_, next) {
    console.log("validationリクエスト");
    const response = await next();
    console.log("validationレスポンス");
    return response;
}


async function auth(_, next) {
    console.log("authリクエスト");
    const response = await next();
    console.log("authレスポンス");
    return response;
}


async function greeting(_, next) {
    console.log("greetingリクエスト");
    const response = await next();
    console.log("greetingレスポンス");
    return response;
}


export const onRequest = sequence(validation, auth, greeting);

これにより、以下の順序でコンソールに出力されます。

ターミナルウィンドウ
validationリクエスト
authリクエスト
greetingリクエスト
greetingレスポンス
authレスポンス
validationレスポンス

リライト

セクションタイトル： リライト

追加： astro@4.13.0

APIContextは、Astro.rewriteと同じように動作するrewrite()メソッドを公開しています。

ページ閲覧者を新しいページにリダイレクトすることなく異なるページコンテンツを表示するには、ミドルウェア内でcontext.rewrite()を使用します。これにより新しいレンダリングフェーズがトリガーされ、ミドルウェアが再実行されます。

src/middleware.js
import { isLoggedIn } from "~/auth.js"
export function onRequest (context, next) {
  if (!isLoggedIn(context)) {
    // ユーザーがログインしていない場合、`/login`ルートをレンダリングするようにRequestを更新し、
    // ログイン成功後にユーザーをどこに送り返すかを示すヘッダーを追加します。
    // ミドルウェアは再実行されます。
    return context.rewrite(new Request("/login", {
      headers: {
        "x-redirect-to": context.url.pathname
      }
    }));
  }
  return next();
};

また、next()関数にオプションのURLパスパラメータを渡すことで、新しいレンダリングフェーズを再トリガーすることなく、現在のRequestを書き換えることができます。リライト先のパスは、文字列、URL、またはRequestとして与えます。

src/middleware.js
import { isLoggedIn } from "~/auth.js"
export function onRequest (context, next) {
  if (!isLoggedIn(context)) {
    // ユーザーがログインしていない場合、`/login`ルートをレンダリングするようにRequestを更新し、
    // ログイン成功後にユーザーをどこに送り返すかを示すヘッダーを追加します。
    // 後続のミドルウェアに新しい`context`を返します。
    return next(new Request("/login", {
      headers: {
        "x-redirect-to": context.url.pathname
      }
    }));
  }
  return next();
};

next()関数には、Astro.rewrite()関数と同じペイロードを渡せます。リライト先のパスは、文字列、URL、またはRequestとして与えます。sequence()により複数のミドルウェア関数を連結している場合、next()にパスを渡すとRequestはその場で書き換えられ、ミドルウェアは再実行されません。チェーン内の次のミドルウェア関数は、更新されたcontextをもつ新しいRequestを受け取ります。

src/middleware.js
// 現在のURLは https://example.com/blog です


// 最初のミドルウェア関数
async function first(_, next) {
  console.log(context.url.pathname) // これは"/blog"をログに出力します
  // 新しいルートであるホームページにリライトします
  // 次の関数に渡される、更新された`context`を返します
  return next("/")
}


// 現在のURLはまだ https://example.com/blog です


// 2番目のミドルウェア関数
async function second(context, next) {
  // 更新された`context`を受け取ります
  console.log(context.url.pathname) // これは"/"をログに出力します
  return next()
}


export const onRequest = sequence(first, second);

エラーページ

セクションタイトル： エラーページ

ミドルウェアは、オンデマンドレンダリングされるすべてのページに対して実行を試みます。これにはAstroのデフォルト（空白）の404ページや、カスタムの404ページが含まれます。ただし、そのコードが実行されるかどうかはアダプターによって決定されます。一部のアダプターは、プラットフォーム固有のエラーページを代わりに提供する場合があります。

ミドルウェアはまた、カスタムの500ページを含む500エラーページを提供する前にも実行を試みます。ただし、ミドルウェア自体の実行中にサーバーエラーが発生した場合を除きます。ミドルウェアが正常に実行されない場合、500ページをレンダリングするためにAstro.localsにアクセスすることはできません。

貢献する

どんなことを？

GitHub Issueを作成

チームに素早く問題を報告できます。

コミュニティ
京ICP备15031610号-99