Flutter日期格式化与相对时间显示插件 lit_relative_date_time 的使用

简介

lit_relative_date_time 是一个用于生成相对日期的 Flutter 包，它以本地化和人类可读的格式展示时间差异。该包可以帮助开发者轻松地在应用中显示相对时间。

截图

英文语言环境	德文语言环境

工作原理

RelativeDateTime 接受两个 DateTime 对象并计算它们之间的时间差。这个相对时间差随后被用于本地化和格式化为人类可读的表达式。

使用方法

1. 设置本地化

首先，在 MaterialApp 中声明委托和受支持的语言环境，以便启用应用程序的本地化：

localizationsDelegates: [
  GlobalMaterialLocalizations.delegate,
  GlobalWidgetsLocalizations.delegate,
  GlobalCupertinoLocalizations.delegate,
],
supportedLocales: [
  const Locale('en'), // 英语
  const Locale('de'), // 德语
  const Locale('ru'), // 俄语
],

2. 创建 RelativeDateTime 对象

创建一个 RelativeDateTime 对象来表示两个时间点之间的相对时间差：

RelativeDateTime _relativeDateTime =
    RelativeDateTime(dateTime: DateTime.now(), other: _otherDateTime);

3. 初始化 RelativeDateFormat 对象

初始化 RelativeDateFormat 对象以格式化之前创建的 RelativeDateTime：

RelativeDateFormat _relativeDateFormatter = RelativeDateFormat(
    Localizations.localeOf(context),
);

如果需要自定义本地化内容，可以通过传递 localizations 参数来实现：

RelativeDateLocalization customLocalization = RelativeDateLocalization(
  languageCode: 'en',
  timeUnitsSingular: ['second', 'minute', 'hour', 'day', 'week', 'month', 'year'],
  timeUnitsPlural: ['seconds', 'minutes', 'hours', 'days', 'weeks', 'months', 'years'],
  prepositionPast: 'ago',
  prepositionFuture: 'in',
  atTheMoment: 'now',
  formatOrderPast: [FormatComponent.value, FormatComponent.unit, FormatComponent.preposition],
  formatOrderFuture: [FormatComponent.preposition, FormatComponent.value, FormatComponent.unit],
);

4. 格式化并显示相对时间

调用 RelativeDateFormat 的 format() 方法来格式化 RelativeDateTime 并将其显示在 Text 小部件中：

Text(_relativeDateFormatter.format(_relativeDateTime))

5. 动态更新相对时间

可以使用 AnimatedRelativeDateTimeBuilder 来动态更新相对时间值。该组件每秒渲染一次，允许每隔一秒更新一次构建器：

AnimatedRelativeDateTimeBuilder(
  date: _lastPressed!,
  builder: (relDateTime, formatted) {
    return Text(formatted);
  },
);

示例 Demo

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 lit_relative_date_time 插件：

import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:lit_relative_date_time/lit_relative_date_time.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'LitRelativeDateTime',
      localizationsDelegates: [
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
      ],
      supportedLocales: [
        const Locale('en'),
        const Locale('de'),
        const Locale('ru'),
      ],
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> with TickerProviderStateMixin {
  DateTime? _lastPressed;

  void _onPressed() {
    setState(() {
      _lastPressed = DateTime.now();
    });
  }

  void _addWeek() {
    setState(() {
      _lastPressed = _lastPressed!.add(Duration(days: 7));
    });
  }

  void _subtractWeek() {
    setState(() {
      _lastPressed = _lastPressed!.subtract(Duration(days: 7));
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Colors.black,
        title: Text("LitRelativeDateTime"),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _onPressed,
        child: Icon(_lastPressed != null ? Icons.restore : Icons.play_arrow),
      ),
      body: Column(
        crossAxisAlignment: CrossAxisAlignment.center,
        mainAxisAlignment: MainAxisAlignment.center,
        mainAxisSize: MainAxisSize.max,
        children: [
          Center(
            child: Padding(
              padding: const EdgeInsets.all(16.0),
              child: Text(
                "Last pressed:",
                textAlign: TextAlign.end,
              ),
            ),
          ),
          Center(
            child: Padding(
              padding: const EdgeInsets.all(16.0),
              child: _lastPressed != null
                  ? Column(
                      children: [
                        AnimatedRelativeDateTimeBuilder(
                          animateOpacity: true,
                          date: _lastPressed!,
                          builder: (relDateTime, formatted) {
                            return Text(formatted);
                          },
                        ),
                        SizedBox(height: 4.0),
                        ElevatedButton(
                          onPressed: _addWeek,
                          child: Text("add one week".toUpperCase()),
                        ),
                        ElevatedButton(
                          onPressed: _subtractWeek,
                          child: Text("sub one week".toUpperCase()),
                        ),
                      ],
                    )
                  : Text("Not Pressed Yet"),
            ),
          ),
        ],
      ),
    );
  }
}

以上代码展示了一个简单的 Flutter 应用，其中包含一个按钮，点击按钮后会记录当前时间，并通过 AnimatedRelativeDateTimeBuilder 显示相对于当前时间的时间差。用户还可以通过点击其他按钮来增加或减少时间。