Next-auth v4如何扩展登录用户信息？自定义address字段无法获取求助

问题原因 #

你遇到的问题核心有两点：

1. 类型定义不完整：仅扩展了User接口，但NextAuth的Session和JWT接口未同步包含新增的address字段，导致类型系统与实际会话数据不匹配。
2. 自定义字段未注入会话流程：NextAuth默认只会将User对象的核心字段（如name、email、image）自动同步到JWT Token和Session中，自定义字段不会自动传递，必须通过回调手动注入。

解决方案 #

1. 完善类型定义 #

更新@types/next-auth.d.ts，同时扩展Session和JWT接口，确保类型系统能识别新增字段：

import 'next-auth';
import 'next-auth/jwt';

declare module 'next-auth' {
  interface User {
    id: string;
    name?: string | null;
    email?: string | null;
    image?: string | null;
    address?: string | null; // 自定义字段
  }

  interface Session {
    user: User; // 让Session的user字段使用扩展后的User类型
  }
}

declare module 'next-auth/jwt' {
  interface JWT {
    address?: string | null; // 让JWT Token包含自定义字段
  }
}

2. 配置回调注入自定义字段 #

虽然你希望避免使用session回调，但这是将自定义字段同步到Session的必要步骤（NextAuth无默认自动注入自定义字段的机制）。修改[...nextauth].ts的回调配置：

import NextAuth from 'next-auth';
import CredentialsProvider from 'next-auth/providers/credentials';
import { buildFeedbackPath, extractFeedback } from '../../../lib/user';
import type { NextAuthOptions } from 'next-auth';

export const authOptions: NextAuthOptions = {
  providers: [
    CredentialsProvider({
      name: 'Credentials',
      async authorize(credentials, req) {
        const filePath = buildFeedbackPath();
        const userData = extractFeedback(filePath);

        const user = userData.find((userinfo) => userinfo.email === credentials?.email);
        if (!user) {
          throw new Error('No user found!');
        }
        // 返回包含自定义字段的用户对象
        return { email: user.email, image: '11233', address: 'testr' };
      },
    }),
  ],
  callbacks: {
    // 在JWT回调中把自定义字段存入token
    async jwt({ token, user }) {
      // user仅在登录时存在，此时将address存入token
      if (user) {
        token.address = user.address;
      }
      return token;
    },
    // 在Session回调中把token里的address同步到session
    async session({ session, token }) {
      if (session.user) {
        session.user.address = token.address;
      }
      return session;
    },
  },
};

export default NextAuth(authOptions);

3. 验证服务端Session #

重新运行项目后，服务端通过unstable_getServerSession获取的session对象将包含address字段。

关键说明 #

• NextAuth的Session机制默认基于JWT，自定义字段不会自动加入会话，必须通过jwt和session回调完成数据传递。
• 类型定义必须覆盖Session和JWT接口，否则TypeScript会报错，且实际数据无法被正确识别。

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