如何在AWS Amplify默认后端中按创建日期排序listTodos查询结果

Amplify默认生成的listTodos查询底层对应DynamoDB全表扫描，默认按主键id排序，本身不支持自定义排序参数，直接给默认查询加排序参数无效，核心原因是没有提前创建支撑排序的全局二级索引（GSI），后端也没有生成对应排序能力的查询接口。

实现步骤 #

1. 修改GraphQL Schema定义索引 #

DynamoDB的排序能力仅在同一个分区键下生效，要实现全量Todos按创建时间排序，需要先定义GSI：
如果你使用Amplify v6+版本，在amplify/backend/api/<你的API名>/schema.graphql中修改Todo模型如下：

type Todo @model {
  id: ID!
  title: String!
  content: String
  email: String
  coverImage: String
  images: [String]
  page: Int
  language: String
  dateAndLocation: String
  # 固定分区键，所有Todo记录该字段默认值为"todo"，保证所有数据落在同一索引分区
  entity: String! = "todo"
  createdAt: AWSDateTime!
  updatedAt: AWSDateTime!

  # 定义按创建时间排序的全局二级索引
  @@index(
    name: "todosByCreatedAt"
    queryField: "listTodosByCreatedAt"
    partitionKey: "entity"
    sortKeyFields: ["createdAt"]
  )
}

如果你使用旧版本Amplify，字段级索引写法如下：

type Todo @model {
  id: ID!
  title: String!
  content: String
  email: String
  coverImage: String
  images: [String]
  page: Int
  language: String
  dateAndLocation: String
  entity: String! = "todo"
  createdAt: AWSDateTime! @index(
    name: "todosByCreatedAt"
    queryField: "listTodosByCreatedAt"
    sortKeyFields: ["createdAt"]
  )
  updatedAt: AWSDateTime!
}

如果不需要全表排序，仅需要按某个维度分组后排序（比如查询同一个邮箱下的所有todo按创建时间排序），不需要加entity固定字段，直接将分组字段（如email）设为索引分区键、createdAt设为排序键即可。

2. 部署Schema变更 #

在项目根目录执行部署命令，等待云端资源创建完成：

amplify push -y

部署完成后，Amplify会自动在src/graphql/queries.js中生成对应的listTodosByCreatedAt查询方法，你也可以手动写查询语句：

export const listTodosByCreatedAt = /* GraphQL */ `
  query ListTodosByCreatedAt(
    $entity: String!
    $sortDirection: ModelSortDirection
    $filter: ModelTodoFilterInput
    $limit: Int
    $nextToken: String
  ) {
    listTodosByCreatedAt(
      entity: $entity
      sortDirection: $sortDirection
      filter: $filter
      limit: $limit
      nextToken: $nextToken
    ) {
      items {
        id
        title
        content
        email
        coverImage
        images
        page
        language
        dateAndLocation
        createdAt
        updatedAt
      }
      nextToken
    }
  }
`;

3. 调用查询时传入排序参数 #

调用接口时，分区键传固定值"todo"，通过sortDirection指定排序方向即可：

import { API } from 'aws-amplify';
import { listTodosByCreatedAt } from './graphql/queries';

// 查询按创建时间倒序排列的Todo列表（最新创建的在前）
const res = await API.graphql({
  query: listTodosByCreatedAt,
  variables: {
    entity: "todo",
    sortDirection: "DESC", // 传ASC则为从最早到最新排序
    // filter、limit、nextToken等参数和原有listTodos用法完全一致
    limit: 20
  }
});

之前尝试的方案无效原因说明 #

• 直接给默认listTodos加sortDirection参数：默认list查询是全表扫描逻辑，后端没有定义排序参数的接收逻辑，传参不会生效
• 仅在前端配置queryField和sortKeyFields：没有在Schema中定义对应索引，云端不会生成对应的查询接口，也没有DynamoDB索引支撑排序能力，前端传参无法被后端识别

注意事项 #

• 全局二级索引会额外占用DynamoDB存储，个人项目、中小流量场景基本在免费额度覆盖范围内，不会产生额外成本
• 如果数据量超过10GB，不建议用固定分区键做全表排序，会出现DynamoDB分区热点问题，这种场景建议结合业务查询场景设计分区键，避免单分区数据量过大

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