如何在Node.js的Apollo GraphQL响应中添加code与msg字段

嘿，我之前也碰到过这种想在GraphQL里复用REST风格响应结构的需求，其实在Apollo生态里有几种很实用的方案，给你梳理一下：

这是最贴合你需求的方式——直接在GraphQL Schema里定义一个包含code、msg、data的通用响应类型，让所有查询/突变都返回这个类型，完全对齐REST的响应结构。

步骤1：定义Schema #

先写通用响应模板，再结合你的业务类型：

# 通用响应结构，适配所有业务场景
type BaseResponse {
  code: Int!       # 状态码，1=成功，2=错误等
  msg: String!     # 提示消息
  data: JSON       # 用JSON类型兼容任意业务数据，也可以换成特定类型
}

# 你的业务实体类型
type Banner {
  link: String!
  avatar: String
}

# 调整查询，返回BaseResponse而非直接返回Banner列表
type Query {
  getBanners: BaseResponse!
}

如果想要更严谨的类型检查，可以为特定业务场景定义专属响应类型，比如：

type BannerResponse {
  code: Int!
  msg: String!
  data: [Banner]! # 明确是Banner数组类型
}

type Query {
  getBanners: BannerResponse!
}

步骤2：实现Resolver #

在Resolver里处理业务逻辑，统一返回包含code、msg、data的结构：

// 示例Node.js环境的Resolver
const resolvers = {
  Query: {
    getBanners: async () => {
      try {
        // 你的业务逻辑：从数据库/接口获取Banner数据
        const banners = await fetchBannersFromDataSource();
        
        return {
          code: 1,
          msg: 'Banner获取成功',
          data: banners
        };
      } catch (error) {
        // 捕获错误时返回错误状态码和消息
        return {
          code: 2,
          msg: error.message || 'Banner获取失败',
          data: null
        };
      }
    }
  }
};

这样前端调用getBanners后，拿到的响应就会是你想要的结构：

{
  "data": {
    "getBanners": {
      "code": 1,
      "msg": "Banner获取成功",
      "data": [
        {"link": "example.com", "avatar": null},
        {"link": "example.com/16709365405930105", "avatar": "example.com/0_banner_1597917938_5116.jpg"}
      ]
    }
  }
}

如果不想改动Schema结构，可以通过Apollo Server的extensions字段携带状态码和消息，不过这个方案需要前端配合区分正常响应和错误响应：

正常响应处理 #

在Resolver里给上下文的extensions赋值：

const resolvers = {
  Query: {
    getBanners: async (_, __, { extensions }) => {
      const banners = await fetchBannersFromDataSource();
      // 把状态信息塞进extensions
      extensions.code = 1;
      extensions.msg = '获取成功';
      return banners;
    }
  }
};

错误响应处理 #

在Apollo Server配置里自定义错误格式化：

const server = new ApolloServer({
  typeDefs,
  resolvers,
  formatError: (err) => {
    // 统一错误响应结构
    return {
      code: err.extensions?.code || 2,
      msg: err.message,
      data: null
    };
  }
});

这种方式下，正常响应的code和msg会在返回结果的extensions字段里，错误响应则会在errors数组里，适合不想大幅改动现有Schema的场景。

如果有很多Resolver要统一格式，可以写一个高阶函数自动包装响应结构，减少重复代码：

写包装函数 #

// 通用响应包装器
const withResponseWrapper = (resolver) => async (...args) => {
  try {
    const data = await resolver(...args);
    return { code: 1, msg: '操作成功', data };
  } catch (error) {
    return { code: 2, msg: error.message || '操作失败', data: null };
  }
};

包装Resolver #

const resolvers = {
  Query: {
    getBanners: withResponseWrapper(async () => {
      return await fetchBannersFromDataSource();
    }),
    // 其他查询也可以用这个包装器
    getUserInfo: withResponseWrapper(async () => {
      return await fetchUserInfo();
    })
  }
};

这个方案需要配合方案1的Schema使用，能快速实现所有接口的响应结构统一。

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