TypeScript开发AWS Lambda时提取JSON请求值遇类型报错如何解决

报错根因 #

所有报错本质源于两个特性：

• AWS Lambda中API Gateway触发的event.body类型为string | undefined：无请求body时为undefined，有body时是JSON序列化后的字符串，而非直接的JS对象
• TypeScript严格类型校验不允许隐式处理可能为undefined的值，也不允许直接将字符串类型断言为结构对象

原有方案报错说明 #

• 方案1：语法错误，TypeScript可选链运算符为?.，单独的?不属于合法语法，因此识别为变量名抛出Cannot find name 'as'错误
• 方案2：类型不兼容，string | undefined和User接口属于完全无重叠的类型，TypeScript禁止直接跨类型断言
• 方案3：未处理undefined场景，JSON.parse()的入参要求为string类型，直接传入可能为undefined的event.body不符合类型要求

可行解决方案 #

1. 极简快速实现（适合开发调试）

先判断event.body是否存在，排除undefined场景后再解析JSON并做类型断言：

import type { APIGatewayProxyEvent, APIGatewayProxyResult } from "aws-lambda";

export interface User {
  username: string;
  password: string;
}

export const handler = async (event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult> => {
  // 排除body为空的场景
  if (!event.body) {
    return {
      statusCode: 400,
      body: JSON.stringify({ message: "缺少请求体参数" })
    };
  }

  // 解析JSON后断言为User类型
  const newUser = JSON.parse(event.body) as User;

  // 后续可正常调用 newUser.username、newUser.password 进行业务逻辑处理
  return {
    statusCode: 200,
    body: JSON.stringify({ message: "注册成功" })
  };
};

注意：如果未安装AWS Lambda类型定义，可执行npm i -D @types/aws-lambda安装

2. 生产级严谨实现（带运行时校验）

TypeScript类型校验仅在编译阶段生效，若请求传入不符合结构的JSON，运行时仍会出现异常，建议增加运行时校验逻辑：

import type { APIGatewayProxyEvent, APIGatewayProxyResult } from "aws-lambda";

export interface User {
  username: string;
  password: string;
}

export const handler = async (event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult> => {
  // 校验body是否存在
  if (!event.body) {
    return {
      statusCode: 400,
      body: JSON.stringify({ message: "请求体不能为空" })
    };
  }

  // 校验JSON格式合法性
  let body: unknown;
  try {
    body = JSON.parse(event.body);
  } catch (err) {
    return {
      statusCode: 400,
      body: JSON.stringify({ message: "请求体不是合法的JSON格式" })
    };
  }

  // 校验字段是否符合User结构要求
  const isUser = (val: unknown): val is User => {
    return (
      typeof val === "object" &&
      val !== null &&
      "username" in val &&
      "password" in val &&
      typeof (val as User).username === "string" &&
      typeof (val as User).password === "string"
    );
  };

  if (!isUser(body)) {
    return {
      statusCode: 400,
      body: JSON.stringify({ message: "请求体缺少必填字段username/password，或字段类型错误" })
    };
  }

  // 此时body已经被类型收窄为User，可直接安全使用
  const newUser = body;
  return {
    statusCode: 200,
    body: JSON.stringify({ message: "注册成功" })
  };
};

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