在Next.js应用中使用AWS Amplify v6 REST API的服务器组件配置指南

AWS Amplify是一个流行的开发平台，可以帮助开发者快速构建和部署云应用。本文将详细介绍如何在Next.js应用中使用AWS Amplify v6的REST API功能，特别是在服务器组件(Server Components)中的正确配置方法。

问题背景

在Next.js的应用路由(App Router)架构中，开发者可能会遇到在服务器组件中调用REST API时出现"API name is invalid"的错误。这个错误通常发生在尝试在服务器组件中使用客户端配置的Amplify REST API时。

解决方案

1. 客户端配置

对于客户端组件，我们可以使用标准的Amplify配置方式：

import { Amplify, ResourcesConfig } from "aws-amplify";

export const amplifyResourceConfig: ResourcesConfig = {
  Auth: {
    Cognito: {
      userPoolId: process.env.NEXT_PUBLIC_USER_POOL_ID,
      userPoolClientId: process.env.NEXT_PUBLIC_USER_POOL_CLIENT_ID,
    },
  },
  API: {
    REST: {
      PlatformCoreOldRestApi: {
        endpoint: process.env.NEXT_PUBLIC_PLATFORM_CORE_OLD_REST_API_URL,
      },
      PlatformCoreNewRestApi: {
        endpoint: process.env.NEXT_PUBLIC_PLATFORM_CORE_NEW_REST_API_URL,
      },
    },
  },
};

Amplify.configure(amplifyResourceConfig, {
  ssr: true,
  API: {
    REST: {
      headers: async () => ({
        Authorization: `Bearer ${await getCognitoAuthIDToken()}`,
      }),
    },
  },
});

2. 服务器端配置

对于服务器组件，我们需要使用不同的方法：

import { createServerRunner } from "@aws-amplify/adapter-nextjs";
import { ResourcesConfig } from "aws-amplify";

export const amplifyResourceConfig: ResourcesConfig = {
  // 同上文客户端配置
};

export const { runWithAmplifyServerContext } = createServerRunner({
  config: amplifyResourceConfig,
});

3. 服务器组件中的API调用

在服务器组件中调用REST API的正确方式：

import { fetchAuthSession } from "aws-amplify/auth/server";
import { get } from "aws-amplify/api/server";

const users = await runWithAmplifyServerContext({
  nextServerContext: { cookies },
  operation: async (contextSpec) => {
    const session = await fetchAuthSession(contextSpec);
    const token = session.tokens?.idToken?.toString();
    
    const result = await get(contextSpec, {
      apiName: "PlatformCoreOldRestApi",
      path: `/platform/people/search?email=${query}`,
      options: {
        headers: {
          Authorization: `Bearer ${token}`,
        },
      },
    }).response.then(async (res) => await res.body.json());
    
    return result;
  },
});

关键点解析

1. 上下文隔离：服务器端每个请求都需要独立的上下文，这是通过runWithAmplifyServerContext实现的。

2. 认证流程：在服务器组件中，需要显式获取认证令牌并附加到请求头中，而不能依赖客户端的自动附加机制。

3. API模块选择：必须使用aws-amplify/api/server中的API方法，而不是常规的客户端API方法。

4. 配置共享：虽然客户端和服务器端使用不同的配置方式，但基础配置(如API端点)可以共享。

最佳实践建议

1. 将Amplify配置提取到单独的文件中，便于客户端和服务器端共享。

2. 为REST API调用创建封装函数，处理错误和统一响应格式。

3. 考虑使用TypeScript接口明确定义API响应类型。

4. 在开发环境中添加详细的日志记录，帮助调试认证和API调用问题。

通过遵循上述模式，开发者可以在Next.js应用中充分利用AWS Amplify v6的REST API功能，同时在客户端和服务器端组件中都能正常工作。这种方法既保持了代码的整洁性，又确保了安全性和性能。