Flutter通用功能插件common_flutter的使用

简介

common_flutter 是一个用于Flutter项目的通用功能插件。它提供了跨平台的功能实现，包括Android和iOS。该插件可以帮助开发者快速集成一些常用的功能，减少重复开发的工作量。

开始使用

安装插件

首先，在 pubspec.yaml 文件中添加 common_flutter 插件：

dependencies:
  common_flutter: ^版本号

然后运行以下命令以安装依赖：

flutter pub get

初始化插件

在Flutter项目中初始化 common_flutter 插件并获取平台信息。

示例代码

以下是一个完整的示例代码，展示了如何使用 common_flutter 插件来获取平台版本信息。

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

void main() {
  runApp(const MyApp()); // 启动应用
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  State<MyApp> createState() => _MyAppState(); // 创建状态管理类
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = '未知'; // 平台版本信息
  final _commonFlutterPlugin = CommonFlutter(); // 初始化插件实例

  @override
  void initState() {
    super.initState();
    initPlatformState(); // 初始化平台状态
  }

  // 异步方法：获取平台版本信息
  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      platformVersion = await _commonFlutterPlugin.getPlatformVersion() ?? '未知平台版本'; // 获取平台版本
    } catch (e) {
      platformVersion = '获取平台版本失败'; // 捕获异常
    }

    // 如果组件已被移除，则不更新UI
    if (!mounted) return;

    setState(() { // 更新UI
      _platformVersion = platformVersion;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold( // 主界面
        appBar: AppBar(
          title: const Text('插件示例应用'), // 设置标题
        ),
        body: Center( // 居中显示内容
          child: ListView( // 列表视图
            children: [
              Text('运行于: $_platformVersion\n'), // 显示平台版本
            ],
          ),
        ),
      ),
    );
  }
}

功能说明

1. 获取平台版本

通过调用 _commonFlutterPlugin.getPlatformVersion() 方法可以获取当前设备的操作系统版本信息。

2. 示例效果

运行上述代码后，应用会显示类似以下内容：

运行于: Android 12

其他功能

除了获取平台版本外，common_flutter 还支持其他通用功能，例如存储加密数据等。以下是存储加密数据的示例：

示例代码

import 'package:secure_storage/secure_storage.dart'; // 导入安全存储库

void storeData() async {
  // 写入token
  await secureStorage.write(key: "access_token", value: token);

  // 写入headers
  final headers = {"x-customer-id": "4"};
  await secureStorage.write(key: "headers", value: jsonEncode(headers));
}