Flutter日期处理插件date_kit的使用

Flutter日期处理插件date_kit的使用

date_kit 是一个 Dart 包装器，旨在简化 DateTime 对象的操作。虽然 DateTime 对象在 Dart 中是不可变的，但 date_kit 提供了各种方法来执行与日期和时间相关的操作，使日期和时间的处理更加方便和直观。

使用说明

date_kit 包含了许多函数，可以无缝地与 DateTime 对象一起工作。以下是一些示例：

DateTime date = DateTime(2024, 1, 1);

  // 添加持续时间
  date = addDays(date, 5);
  date = addMonths(date, 3);
  date = addHours(date, 3);
  date = addBusinessDays(date, 1);
  date = addWeeks(date, 4);
  date = addYears(date, 3);
  // ... 和更多操作

  // 或者你可以使用扩展方法来执行相同的操作。
  date = date.addDays(5);
  date = date.addMonths(3);
  date = date.addHours(3);
  date = date.addBusinessDays(1);
  date = date.addWeeks(4);
  date = date.addYears(3);

  // 注意：由于 Dart 中的 `DateTime` 对象是不可变的，
  // 上述扩展方法不会改变当前实例，而是创建并返回一个新的实例。

  // 克隆日期
  date = clone(date);
  // 也可以使用扩展方法
  date = date.clone();

  // 布尔方法
  isAfter(date, DateTime.now());
  isBefore(date, DateTime.now());
  isLastDayOfMonth(date);
  isFirstDayOfMonth(date);
  isFriday(date);
  isMonday(date);
  isWeekend(date);
  isLeapYear(date);
  isThisHour(date);
  isSameYear(date, DateTime.now());
  // ... 和更多方法

  // 计算差异
  int years = differenceInYears(
    DateTime(2024, 1,  ),
    DateTime(2024, 3,  ),
  );
  int businessDays = differenceInBusinessDays(
    DateTime(2024, 1,  ),
    DateTime(2024, 3,  ),
  );
  int calendarDays = differenceInCalendarDays(
    DateTime(2024,  ,  ),
    DateTime(2024, 3,  ),
  );
  int weeks = differenceInWeeks(
    DateTime(2024,  ,  ),
    DateTime(2024, 3,  ),
  );
  // ... 更多计算

  // 结束时间实体
  endOfDay(date);
  endOfMonth(date);
  endOfYear(date);
  endOfYesterday();
  endOfToday();
  endOfYear(date);
  // ... 更多结束方法

  // 设置天、分钟、秒、年、毫秒、周、季度等
  date = setDay(date, 3);
  date = setYear(date, 2020);
  date = setWeek(date, 3);
  date = setQuarter(date, 3);

  // 格式化日期
  format(DateTime(2024,  ,  ), 'dd.MM.yyyy'); // 返回: '01.01.2024'

  // 解析日期
  DateTime? parsed = parse('01.01.2024',
      'dd.MM.yyyy'); // 返回 DateTime 对象或无效字符串时返回 null。

  // 格式化时间差
  formatTimeDifference(
    DateTime(2024,  ,  , 5, 10),
    DateTime(2024,  ,  , 6, 20),
  ); // 返回 '01:10' (1 小时 10 分钟)。

  // 也可以自定义格式
  formatTimeDifference(
    DateTime(2024,  ,  , 5, 10),
    DateTime(2024,  ,  , 6, 20),
    format: TimeDifferenceFormat.fHHMMSS,
  ); // 返回 '01:10:00'

API 文档

在这里你可以找到所有函数和方法的完整文档：Documentation

支持与反馈

如果你觉得这个包有用，请给它点赞。请将任何问题、bug 或功能请求提交到 GitHub 页面上的 GitHub 页面。

示例代码

import 'package:date_kit/date_kit.dart';
import 'package:date_kit/src/functions/format_time_difference/format_time_difference.dart';

void main() {
  DateTime date = DateTime(2024, 1, 1);

  // 添加持续时间
  date = addDays(date, 5);
  date = addMonths(date, 3);
  date = addHours(date, 3);
  date = addBusinessDays(date, 1);
  date = addWeeks(date, 4);
  date = addYears(date, 3);
  // ... 和更多操作

  // 或者你可以使用扩展方法来执行相同的操作。
  date = date.addDays(5);
  date = date.addMonths(3);
  date = date.addHours(3);
  date = date.addBusinessDays(1);
  date = date.addWeeks(4);
  date = date.addYears(3);

  // 注意：由于 Dart 中的 DateTime 对象是不可变的，
  
  // 克隆日期
  date = clone(date);
  // 也可以使用扩展方法
  date = date.clone();

  // 布尔方法
  isAfter(date, DateTime.now());
  isBefore(date, DateTime.now());
  isLastDayOfMonth(date);
  isFirstDayOfMonth(date);
  isFriday(date);
  isMonday(date);
  isWeekend(date);
  isLeapYear(date);
  isThisHour(date);
  isSameYear(date, DateTime.now());
  // ... 和更多方法

  // 计算差异
  int years = differenceInYears(
    DateTime(2024, 1, 1),
    DateTime(2024, 3, 1),
  );
  int businessDays = differenceInBusinessDays(
    DateTime(2024, 1, 1),
    DateTime(2024, 3, 1),
  );
  int calendarDays = differenceInCalendarDays(
    DateTime(2024, 1, 1),
    DateTime(2024, 3, 1),
  );
  int weeks = differenceInWeeks(
    DateTime(2024, 1, 1),
    DateTime(2024, 3, 1),
  );
  // ... 更多计算

  // 结束时间实体
  endOfDay(date);
  endOfMonth(date);
  endOfYear(date);
  endOfYesterday();
  endOfToday();
  endOfYear(date);
  // ... 更多结束方法

  // 设置天、min、秒、年、毫秒、周、季度等
  date = setDay(date, 3);
  date = setYear(date, 2020);
  date = setWeek(date, 3);
  date = setQuarter(date, 3);

  // 格式化日期
  format(DateTime(2024, 1, 1), 'dd.MM.yyyy'); // 返回: '01.01.2024'

  // 解析日期
  DateTime? parsed = parse('01.01.2024', 'dd.MM.yyyy'); // 返回 DateTime 对象或无效字符串时返回 null。

  // 格式化时间差
  formatTimeDifference(
    DateTime(2024, 1, 1, 5, 10),
    DateTime(2024, 1, 1, 6, 20),
  ); // 返回 '01:10' (1 小时 10 分钟)。

  // 也可以自定义格式
  formatTimeDifference(
    DateTime(2024, 1, 1, 5, 10),
    DateTime(2024, 1, 1, 6, 20),
    format: TimeDifferenceFormat.fHHMMSS,
  ); // 返回 '01:10:00'
}