Flutter系统时区获取插件system_timezone的使用

Flutter系统时区获取插件system_timezone的使用

系统时区插件 system_timezone 的介绍

system_timezone 是一个用于在 Flutter 应用中获取系统时区信息的插件。它支持多种平台，并且提供了同步 API 来获取当前系统时区名称以及已知的时区列表。

使用示例

获取当前时区

final currentTimezone = SystemTimezone.getTimezoneName();

获取已知的时区列表

final listOfTimezones = SystemTimezone.getKnownTimezoneNames();

平台约束

以下是 system_timezone 插件支持的各个平台及其最低版本要求：

• Android: minSdkVersion 19
• iOS: 2.0+
• Linux: Systemd v239 和以上版本
• Windows: Windows 10 Version 1903 和以上版本
• macOS: 10.0+
• Web: 浏览器兼容性支持 Intl.DateTimeFormat.resolvedOptions 和 Intl.supportedValuesOf

示例代码

以下是一个完整的示例代码，展示如何在 Flutter 中使用 system_timezone 插件来获取当前时区和已知时区列表。

示例代码文件：example/lib/main.dart

import 'dart:developer';

import 'package:flutter/material.dart';
import 'package:system_timezone/system_timezone.dart'; // 导入 system_timezone 插件

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(home: HomePage());
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  [@override](/user/override)
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  String? timezone; // 当前时区
  String? timezones; // 已知时区列表

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('SystemTimezone Example')), // 设置应用标题
      body: Center(
        child: SelectionArea(
          child: SingleChildScrollView(
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              children: [
                // 显示当前时区
                if (timezone == null)
                  const SizedBox.shrink()
                else
                  Text(
                    '当前时区: $timezone',
                    style: Theme.of(context).textTheme.headlineSmall,
                  ),
                // 显示已知时区列表
                if (timezones == null)
                  const SizedBox.shrink()
                else
                  Text(
                    '已知时区: $timezones',
                    style: Theme.of(context).textTheme.headlineSmall,
                  ),
                const SizedBox(height: 16), // 添加间距
                // 按钮用于触发时区获取操作
                ElevatedButton(
                  onPressed: () async {
                    if (!context.mounted) return; // 确保上下文仍然有效
                    try {
                      // 获取当前时区名称
                      final tz = SystemTimezone.getTimezoneName();
                      // 获取已知时区列表
                      final tzs = SystemTimezone.getKnownTimezoneNames();

                      // 更新 UI
                      setState(() => timezones = tzs.toString());
                      setState(() => timezone = tz.toString());
                    } catch (error, s) {
                      // 记录错误日志
                      log('获取时区失败', error: error, stackTrace: s);
                      if (!context.mounted) return;
                      // 显示错误提示
                      ScaffoldMessenger.of(context).showSnackBar(
                        SnackBar(
                          backgroundColor: Theme.of(context).primaryColor,
                          content: Text('$error'),
                        ),
                      );
                    }
                  },
                  child: const Text('获取时区信息'), // 按钮文本
                ),
              ],
            ),
          ),
        ),
      ),
    );
  }
}