Flutter日期选择插件Dateable的使用

Dateable是一个帮助您轻松管理日期的Dart包。它可用于存储、格式化、转换、构造、解析和序列化日期。以下是该插件的详细使用方法和一个完整的示例demo。

导入

在您的.dart文件中导入Dateable：

import 'package:dateable/dateable.dart';

使用方法

构造函数

Dateable提供了多种构造函数，以实现灵活性和与其他类型的互操作性。

final date = Date(31, 12, 2019);
final dateFromDateTime = Date.fromDateTime(DateTime(2019, 12, 31, 19, 1)); // 时间部分被截断
final dateParseIso8601 = Date.parseIso8601('2019-12-31T18:23:48.956871'); // 时间部分被截断
final dateParse = Date.parse('31122019');
final dateToday = Date.today();
final dateYesterday = Date.yesterday();
final dateTomorrow = Date.tomorrow();

还有方便的DateTime扩展方法：

final date = DateTime(2019, 12, 31, 13, 26).toDate(); // 时间部分被截断

所有上述代码都会生成相同的date对象！

获取属性

有四个简单的getter可以获取日期的各个部分。

final date = Date(11, 3, 2002);
print(date.day); // 输出11
print(date.month); // 输出3
print(date.year); // 输出2002
print(date.weekday); // 输出1，因为是周一

转换方法

Date允许无缝且容易地转换为最常用的表示形式。

final date = Date(11, 3, 2002);
final dateTime = date.toDateTime(); // 时间部分设置为零
print(date.toIso8601()); // 输出2002-03-11T00:00:00.000
print(date.toIso8601(includeTime: false)); // 输出2002-03-11
print(date.toString()); // 输出11032002

验证

您可以使用isValid静态方法轻松验证日期。

print(Date.isValid(day: 11, month: 3, year: 2002)); // 输出true
print(Date.isValid(day: 29, month: 2, year: 2021)); // 输出false
print(Date.isValid(day: 40, month: 50, year: -99999)); // 输出true

比较

比较工作方式与熟悉的DateTime对象相同。

final earlier = Date(11, 3, 2002);
final later = Date(21, 9, 2004);
print(earlier.isBefore(later)); // 输出true
print(later.isAfter(earlier)); // 输出true

此外，还支持操作符>（之后）、<（之前）、<=、>=和==。

if (DateTime(2002, 3, 11, 14, 56, 28).isTheSameDate(Date(11, 3, 2002))) {
  print('日期相同');
}

格式化

您可以将Date格式化为String，既可以使用顶级常量也可以使用字符串字面量。

final date = Date(11, 3, 2002);
print(date.format(['dd', '-', 'mm', '-', 'yyyy'])); // 输出11-03-2002

修改器

每个Date对象默认是不可变的，因此每次修改都会创建一个新的Date对象。

final newDate = date.addDays(2);
final anotherNewDate = date.subtractDays(7);
final copiedDate = date.copyWith(day: 21, month: 9);

排序也很简单：

final dates = [Date(21, 9, 2004), Date(24, 12, 2006), Date(11, 3, 2002)];
dates.sort((a, b) => a.compareTo(b));
print(dates); // 输出[Date(11, 3, 2002), Date(21, 9, 2004), Date(24, 12, 2006)]

示例Demo

以下是一个完整的示例，展示了如何使用Dateable插件：

import 'package:dateable/dateable.dart';

void main() {
  final date = Date(21, 3, 2002);

  if (date == Date.fromDateTime(DateTime(2002, 3, 21))) {
    print('True!');
  }

  if (date == DateTime(2002, 3, 21).toDate()) {
    print('Also true!');
  }

  if (date == Date.parse('21032002')) {
    print('This is awesome.');
  }

  if (date == Date.parseIso8601('2002-03-21T14:35:26.896')) {
    print('Very useful.');
  }

  if (Date(1, 1, 2020) - 2 == Date(1, 1, 2020).subtractDays(2)) {
    print('Yes, they do!');
  }

  if (Date(31, 12, 2021) + 18 == Date(1, 1, 2022).addDays(17)) {
    print(':)');
  }

  if (Date(21, 3, 2002) < Date(21, 9, 2004)) {
    print('Spoiler: it is true.');
  }

  if (Date(21, 3, 2002).isBefore(Date(21, 9, 2004))) {
    print('This is also true.');
  }

  if (DateTime(2002, 3, 11, 14, 6).isTheSameDate(Date(11, 3, 2002))) {
    print('A really nice extension.');
  }

  if (date.isToday() || date.isTomorrow() || date.isYesterday()) {
    print('The star is born.');
  }

  print(Date.yesterday().toString() +
      Date.today().toString() +
      Date.tomorrow().toString());

  if (Date(21, 3, 2002).toDateTime() == DateTime(2002, 3, 21)) {
    print('Nice.');
  }
  if (Date(21, 3, 2002).toIso8601() == '2002-03-21T00:00:00.000') {
    print('Nice!');
  }
  if (Date(21, 3, 2002).toString() == '21032002') {
    print('<3');
  }

  if (Date(11, 3, 2002).copyWith(day: 21, month: 9) == Date(21, 9, 2002)) {
    print('Useful for short, idiomatic mutations.');
  }

  print(date.format(['dd', '-', 'mm', '-', 'yyyy']));

  final result = [Date(21, 9, 2004), Date(24, 12, 2006), Date(11, 3, 2002)];
  result.sort((a, b) => a.compareTo(b));
  print(result); // 输出[11032002, 21092004, 24122006]
}