在Next.js App Router中使用iron-session的适配问题求助

问题背景 #

在Next.js App Router项目中使用iron-session时，官方仅提供Pages Router的示例（通过withIronSessionApiRoute包裹路由），但App Router要求路由以POST/GET独立函数形式编写，无法直接复用原有封装逻辑，需要手动适配。

适配步骤 #

1. 保留基础会话配置

继续使用原有的sessionOptions配置（可放在lib/session.js中），环境变量读取逻辑与Pages Router一致：

// lib/session.js
export const sessionOptions = {
  password: process.env.IRON_SESSION_PASSWORD,
  cookieName: 'your-session-cookie-name',
  cookieOptions: {
    secure: process.env.NODE_ENV === 'production',
  },
};

2. 封装会话操作工具

App Router没有withIronSessionApiRoute封装，直接使用iron-session提供的getIronSession工具封装会话的获取与保存逻辑：

// lib/iron-session.js
import { getIronSession } from 'iron-session';
import { sessionOptions } from './session';

export async function getSession(req, res) {
  return getIronSession(req, res, sessionOptions);
}

3. 编写App Router风格的API路由

以登录接口为例，在app/api/login/route.js中编写独立的POST函数，通过封装工具获取并操作会话：

// app/api/login/route.js
import { Octokit } from "octokit";
import { getSession } from "lib/iron-session";

const octokit = new Octokit();

export async function POST(request) {
  // 解析请求体
  const { username } = await request.json();
  // 获取会话对象
  const session = await getSession(request, new Response());

  try {
    const {
      data: { login, avatar_url },
    } = await octokit.rest.users.getByUsername({ username });

    const user = { isLoggedIn: true, login, avatarUrl: avatar_url };
    // 写入会话数据
    session.user = user;
    await session.save();
    
    // 返回响应，会话Cookie会自动随Response设置
    return new Response(JSON.stringify(user), { status: 200 });
  } catch (error) {
    return new Response(JSON.stringify({ message: error.message }), { status: 500 });
  }
}

4. 在Server Components中读取会话

在App Router的Server Component中，通过headers()和cookies()工具构造模拟的req/res对象，实现会话读取：

// app/profile/page.js
import { getSession } from "lib/iron-session";
import { headers, cookies } from "next/headers";

export default async function ProfilePage() {
  // 构造模拟req对象用于会话读取
  const req = {
    headers: Object.fromEntries(headers()),
    cookies: Object.fromEntries(cookies().entries()),
  };
  // 读取会话无需实际设置响应头，构造空res对象即可
  const res = { setHeader: () => {} };

  const session = await getSession(req, res);
  const user = session.user;

  if (!user?.isLoggedIn) {
    return <div>请先登录</div>;
  }

  return (
    <div>
      <h1>欢迎，{user.login}</h1>
      <img src={user.avatarUrl} alt="头像" width={50} />
    </div>
  );
}

核心差异说明 #

• Pages Router通过withIronSessionApiRoute自动注入req.session；App Router需手动调用getIronSession获取会话对象。
• App Router的API路由使用独立的POST/GET函数，请求体解析通过request.json()完成，响应需手动创建Response对象。
• Server Component中需通过headers()和cookies()工具构造模拟请求对象，用于会话读取。

内容的提问来源于stack exchange，提问作者chrisroode