Flutter基本设置管理插件basic_settings的使用

基本介绍

basic_settings 是一个基于 Hive 盒子和 MobX 可观察对象的基本设置模型，同时提供了与之相关的用户界面组件。它可以帮助开发者轻松地管理和展示应用的各种设置。

许可证

https://github.com/holvonix-open/basic-settings

Copyright (c) 2020 Holvonix LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

使用示例

以下是一个完整的示例代码，展示了如何使用 basic_settings 插件来管理应用的设置。

示例代码

import 'package:basic_settings/basic_settings.dart';
import 'package:flutter/material.dart';

import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';

// 定义设置类
class Settings {
  // 异步加载设置
  static Future<Settings> load(HiveInterface hive, String name) async {
    return Settings._(await hive.openBox('ex1'));
  }

  final Box _box;

  Settings._(this._box)
      // 定义各种设置项
      : dingSetting = Setting.simple(_box, 'ding', defaultValue: false),
        dinosaursSetting =
            Setting.simple(_box, 'dinosaursRawr', defaultValue: true),
        themeSetting = Setting.enumValue(_box, 'themeSetting',
            values: ThemeSetting.values, defaultValue: ThemeSetting.system),
        cacheSetting =
            Setting.simple(_box, 'cacheSetting', defaultValue: 250.0);

  // 清除所有设置
  void clear() async {
    await _box.clear();
  }

  // 各种设置项
  final Setting<bool, bool> dingSetting;
  final Setting<bool, bool> dinosaursSetting;
  final Setting<ThemeSetting, int> themeSetting;
  final Setting<double, double> cacheSetting;
}

// 定义设置页面
class SettingsPage extends StatelessWidget {
  final Settings settings;

  const SettingsPage({Key? key, required this.settings}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    // 定义设置项列表
    final children = [
      BoolSetting(settings.dingSetting, '通知',
          description: '播放叮咚音效！'),
      EnumSetting(settings.themeSetting, '主题',
          values: [ThemeSetting.system, ThemeSetting.light, ThemeSetting.dark],
          names: ['系统', '浅色', '深色']),
      RangeSetting(settings.cacheSetting, '缓存大小 (MB)', min: 0, max: 1000),
      BoolSetting(settings.dinosaursSetting, '启用恐龙模式'),
      SizedBox(
        height: 64,
      ),
    ];

    return Material(
        color: Theme.of(context).scaffoldBackgroundColor,
        child: SafeArea(
            child: ListView(
                shrinkWrap: true,
                children: ListTile.divideTiles(
                  tiles: children,
                  context: context,
                ).toList()));
  }
}

void main() async {
  // 初始化 Hive 和 Flutter
  WidgetsFlutterBinding.ensureInitialized();
  await Hive.initFlutter();

  // 加载设置
  runApp(MyApp(settings: await Settings.load(Hive, 'settings')));
}

// 主应用
class MyApp extends StatelessWidget {
  final Settings settings;

  const MyApp({Key? key, required this.settings}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter 示例',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: SettingsPage(settings: settings),
    );
  }
}