Flutter日期处理插件datify的使用

简介

Datify 是一个强大的Flutter日期处理插件，可以轻松地从各种格式的字符串中提取日期。无论是数字格式、文字描述还是不同语言的月份名称，Datify都能很好地处理。

主要功能

• 支持多种日期格式：
  • 数字日期：如 20.02.2020, 09/07/2000, 9-1-2005
  • 英文和多语言（如俄语、乌克兰语）的月份名称：如 20 of January, 6 липня 2021
  • 混合分隔符：如 23-02/2022

安装

在 pubspec.yaml 文件中添加依赖：

dependencies:
  datify: ^最新版本号

然后运行 flutter pub get 来安装插件。

使用示例

以下是一个完整的示例代码，展示了如何使用Datify来解析日期字符串并进行相应的操作：

import 'package:datify/datify.dart';

typedef SearchRequest = Map<String, String>;

String handleRequest(SearchRequest searchRequest) {
  final dateQuery = searchRequest['date'];

  // Datify handles all the parsing inside freeing you from even thinking about it!
  final res = Datify.parse(dateQuery).result;

  // make the search request
  final response =
      Events.query(year: res.year, month: res.month, day: res.day) ?? 'No events found for this query 👀';

  return response;
}

void main() {
  // define dates in different formats
  const dates = [
    '31.12.2021',     // common digit-only date format
    '2022-02-23',     // another commonly-used date format
    '23-02/2022',     // the supported separators can be combined in the string
    '20 of January',  // date is incomplete but still correctly parsed
    'May',            // just a month name
    '14 лютого 2022', // Ukrainian date which stands for 14.02.2022
    'not a date',     // not a date at all
  ];

  // 'request' all the dates
  for (var date in dates) {
    print('$date: ${handleRequest({'date': date})}');
  }
}

abstract class Events {
  static const _records = {
    Date(year: 2021, month: 12, day: 31): 'New Year party 🎄',
    Date(year: 2022, month: 1, day: 20): 'Birthday celebration 🎁',
    Date(year: 2022, month: 2, day: 14): 'St. Valentines Day 💖',
    Date(year: 2022, month: 2, day: 23): 'The cinema attendance 📽',
    Date(year: 2022, month: 5, day: 23): 'A long-awaited Moment 🔥',
  };

  static String? query({int? year, int? month, int? day}) {
    if (year == null && month == null && day == null) {
      return null;
    }

    final res = _records.entries
        .firstWhere(
            (record) => record.key.satisfies(year: year, month: month, day: day),
            orElse: () => MapEntry(Date.empty(), ''))
        .value;
    return (res.isEmpty ? null : res);
  }
}

class Date {
  final int? year;
  final int? month;
  final int? day;

  const Date.empty() : this();

  const Date({this.year, this.month, this.day});

  bool satisfies({int? year, int? month, int? day}) {
    return (year == null || this.year == null || this.year == year) &&
        (month == null || this.month == null || this.month == month) &&
        (day == null || this.day == null || this.day == day);
  }

  bool get empty => year == null && month == null && day == null;
}

输出结果：

31.12.2021: New Year party 🎄
2022-02-23: The cinema attendance 📽
23-02/2022: The cinema attendance 📽
20 of January: Birthday celebration 🎁
May: A long-awaited Moment 🔥
14 лютого 2022: St. Valentines Day 💖
not a date: No events found for this query 👀

配置与自定义

你可以通过 DatifyConfig 类来定制Datify的行为，比如添加新的分隔符或支持更多语言的月份名称：

// 添加新的分隔符
DatifyConfig.splitters.add('#');

// 添加新的月份名称
DatifyConfig.addNewMonthName(9, 'Septembre');

// 添加新的语言支持
const frenchMonths = [
   'Janvier', 'Février', 'Mars', 'Avril', 'Peut', 'Juin',
   'Juillet', 'Août', 'Septembre', 'Octobre', 'Novembre', 
   'Décembre'
];
DatifyConfig.addNewMonthsLocale(frenchMonths);

总结

Datify插件为Flutter应用提供了强大的日期解析能力，能够处理多种格式的日期字符串，并且支持自定义配置。通过简单的API调用，你可以在应用中轻松实现日期解析和处理的功能。