如何在Dart中按日期对对象进行排序？

如果使用内置的.sort()方法没得到正确结果，通常是比较函数逻辑有误，或者日期字段的类型处理不当，以下是针对不同场景的解决方案：

场景1：对象的日期字段为DateTime类型 #

假设你有一个包含日期属性的对象，比如：

class Todo {
  final String content;
  final DateTime createTime;

  Todo(this.content, this.createTime);
}

直接利用DateTime的compareTo方法编写排序逻辑即可：

List<Todo> todos = [
  Todo('写代码', DateTime(2024, 6, 20)),
  Todo('买咖啡', DateTime(2024, 6, 18)),
  Todo('整理文档', DateTime(2024, 6, 22)),
];

// 升序排序（日期从早到晚）
todos.sort((a, b) => a.createTime.compareTo(b.createTime));

// 降序排序（日期从晚到早）
todos.sort((a, b) => b.createTime.compareTo(a.createTime));

compareTo会返回-1、0、1三个值，完全符合.sort()方法对比较函数的要求，能保证排序逻辑正确。

场景2：对象的日期字段为字符串类型 #

如果日期是以字符串存储（比如"2024-06-20"），需要先将字符串转换为DateTime再进行比较：

class Event {
  final String name;
  final String dateStr;

  Event(this.name, this.dateStr);
}

List<Event> events = [
  Event('生日会', '2024-06-20'),
  Event('团建', '2024-06-15'),
  Event('发布会', '2024-06-25'),
];

// 标准ISO格式字符串直接用DateTime.parse转换
events.sort((a, b) {
  final dateA = DateTime.parse(a.dateStr);
  final dateB = DateTime.parse(b.dateStr);
  return dateA.compareTo(dateB);
});

如果是自定义格式的日期字符串（比如"06/20/2024"），需要借助intl包的DateFormat来解析：

import 'package:intl/intl.dart';

// 自定义日期解析函数
DateTime parseCustomDate(String dateStr) {
  return DateFormat('MM/dd/yyyy').parse(dateStr);
}

// 排序时使用自定义解析
events.sort((a, b) {
  final dateA = parseCustomDate(a.dateStr);
  final dateB = parseCustomDate(b.dateStr);
  return dateA.compareTo(dateB);
});

常见错误排查 #

• 不要直接对DateTime进行加减运算返回数值：比如return a.createTime - b.createTime是错误的，DateTime相减得到的是Duration，不是整数，必须用compareTo。
• 确保日期字符串格式正确：如果DateTime.parse报错，说明格式不符合ISO标准，必须用DateFormat指定对应格式。
• 若列表是不可变类型（比如List.unmodifiable创建的），需要先转为可变列表再排序：List<Todo> mutableTodos = List.from(todos); mutableTodos.sort(...);

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