TypeScript通用DynamoDB操作函数封装类型报错求助

问题分析 #

你遇到的类型错误源于Command泛型参数的不匹配：直接使用Command<any, T, any>没有对齐DynamoDB客户端的特定类型约束，导致middlewareStack的类型校验失败——DynamoDB的Command要求中间件栈必须包含identifyOnResolve属性，而泛型参数的任意性破坏了这个约束。

解决方案 #

通过明确约束Command的泛型参数与DynamoDB客户端的输入输出类型对齐，同时修正函数返回值的类型定义，即可解决该问题。

步骤1：导入必要的类型 #

从AWS SDK包中导入DynamoDB客户端的类型和Command基类：

import { DynamoDBClient, ServiceInputTypes, ServiceOutputTypes } from "@aws-sdk/client-dynamodb";
import { Command } from "@aws-sdk/smithy-client";

步骤2：重构通用操作函数 #

调整queryDb函数的泛型约束，确保Command与DynamoDB客户端的类型完全匹配，同时处理错误场景的返回类型：

const client = new DynamoDBClient({
  // 你的客户端配置，例如 region: "us-east-1"
});

const queryDb = async <T extends ServiceOutputTypes>(
  command: Command<ServiceInputTypes, T, ServiceOutputTypes>
): Promise<T | undefined> => {
  try {
    return await client.send(command);
  } catch (err) {
    console.error("数据库操作异常:", err);
    // 可选：重新抛出错误让调用方处理，此时返回类型改为 Promise<T>
    // throw err;
    return undefined;
  }
};

步骤3：修改业务函数调用 #

在原有的查询和写入函数中，指定正确的输出类型泛型：

import { QueryCommand, QueryCommandOutput, PutItemCommand, PutItemCommandOutput } from "@aws-sdk/client-dynamodb";

export const getResultFromDb = async (): Promise<QueryCommandOutput | undefined> => {
  const command = new QueryCommand({
    TableName: "your-table-name",
    // 你的查询参数
    KeyConditionExpression: "id = :id",
    ExpressionAttributeValues: { ":id": { S: "sample-id" } }
  });

  return queryDb<QueryCommandOutput>(command);
};

// 优化：替换any为具体的类型接口
interface DbItem {
  id: string;
  content: string;
}

export const addItemToDb = async (data: DbItem): Promise<PutItemCommandOutput | undefined> => {
  const command = new PutItemCommand({
    TableName: "your-table-name",
    Item: {
      id: { S: data.id },
      content: { S: data.content }
    }
  });

  return queryDb<PutItemCommandOutput>(command);
};

关键说明 #

1. 类型对齐：使用ServiceInputTypes和ServiceOutputTypes确保Command的类型与DynamoDBClient完全兼容，解决中间件栈的类型冲突。
2. 泛型约束：T extends ServiceOutputTypes限制输出类型必须是DynamoDB支持的合法输出类型，避免无效类型传入。
3. 错误处理：根据业务需求选择错误处理方式——要么返回undefined并调整返回类型，要么重新抛出错误让调用方捕获处理。

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