サーバーアダプター

公式アダプター

イディオム的な Remix アプリは、一般的にどこでもデプロイできます。なぜなら、Remix はサーバーのリクエスト/レスポンスを Web Fetch API に適応させるからです。これは、アダプターを通じて行われます。私たちはいくつかのアダプターを維持しています。

  • @remix-run/architect
  • @remix-run/cloudflare-pages
  • @remix-run/cloudflare-workers
  • @remix-run/express

これらのアダプターは、サーバーのエントリポイントにインポートされ、Remix アプリ自体では使用されません。

npx create-remix@latest で Remix App Server 以外の何かでアプリを初期化した場合は、server/index.js ファイルにこれらのアダプターのいずれかをインポートして使用していることに注意してください。

Remix App Server を組み込みで使用している場合は、この API とはやり取りしません。

各アダプターは同じ API を持っています。将来的には、デプロイしているプラットフォームに固有のヘルパーを用意するかもしれません。

コミュニティアダプター

アダプターの作成

createRequestHandler

サーバーがアプリを提供するために、リクエストハンドラーを作成します。これは、Remix アプリケーションの究極のエントリポイントです。

const {
  createRequestHandler,
} = require("@remix-run/{adapter}");
createRequestHandler({ build, getLoadContext });

以下は、express を使った完全な例です。

const {
  createRequestHandler,
} = require("@remix-run/express");
const express = require("express");
 
const app = express();
 
// 全ての動詞(GET、POST など)を処理する必要があります
app.all(
  "*",
  createRequestHandler({
    // `remix build` と `remix dev` はビルドディレクトリにファイルを書き出します。
    // そのビルドをリクエストハンドラーに渡す必要があります
    build: require("./build"),
 
    // ローダーとアクションで `context` として利用できるように、ここで何かを返します。
    // これは、Remix とサーバーの橋渡しをする場所です
    getLoadContext(req, res) {
      return {};
    },
  })
);

以下は、Architect(AWS)を使った例です。

const {
  createRequestHandler,
} = require("@remix-run/architect");
exports.handler = createRequestHandler({
  build: require("./build"),
});

以下は、簡略化された Cloudflare Workers API を使った例です。

import { createEventHandler } from "@remix-run/cloudflare-workers";
 
import * as build from "../build";
 
addEventListener("fetch", createEventHandler({ build }));

以下は、より低レベルな Cloudflare Workers API を使った例です。

import {
  createRequestHandler,
  handleAsset,
} from "@remix-run/cloudflare-workers";
 
import * as build from "../build";
 
const handleRequest = createRequestHandler({ build });
 
const handleEvent = async (event: FetchEvent) => {
  let response = await handleAsset(event, build);
 
  if (!response) {
    response = await handleRequest(event);
  }
 
  return response;
};
 
addEventListener("fetch", (event) => {
  try {
    event.respondWith(handleEvent(event));
  } catch (e: any) {
    if (process.env.NODE_ENV === "development") {
      event.respondWith(
        new Response(e.message || e.toString(), {
          status: 500,
        })
      );
    }
 
    event.respondWith(
      new Response("Internal Error", { status: 500 })
    );
  }
});