Flutter注解支持插件shared_preferences_annotation的使用

Flutter注解支持插件shared_preferences_annotation的使用

shared_preferences_annotation 是一个用于生成代码的插件，它与 shared_preferences_gen 一起使用，可以简化在 Flutter 应用中使用 SharedPreferences 的过程。以下是详细的使用指南和一个完整的示例。

包信息

使用说明

shared_preferences_annotation 提供了一些注解，这些注解会被 shared_preferences_gen 读取并生成对应的代码。这使得开发者可以在应用中更方便地操作 SharedPreferences。

安装依赖

首先，在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter:
    sdk: flutter

dev_dependencies:
  shared_preferences_annotation: ^0.1.0
  build_runner: ^2.0.0
  shared_preferences_gen: ^0.1.0

然后运行 flutter pub get 来安装这些依赖。

创建模型类

接下来，创建一个模型类，并使用 @SharedPreferencesSerializable 注解来标记该类。同时，还需要导入生成器包并调用 serializable() 方法。

import 'package:shared_preferences_annotation/shared_preferences_annotation.dart';

part 'example.g.dart'; // 这个文件将由生成器自动生成

class Example {
  @SharedPreferencesKey(name: 'example_key')
  String value;

  Example(this.value);
}

生成代码

在命令行中运行以下命令来生成必要的代码：

flutter pub run build_runner build

这会生成一个名为 example.g.dart 的文件，其中包含了序列化和反序列化的逻辑。

使用示例

现在你可以像下面这样使用 SharedPreferences：

import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:shared_preferences/shared_preferences.dart';
import 'example.g.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Home(),
    );
  }
}

class Home extends StatefulWidget {
  [@override](/user/override)
  _HomeState createState() => _HomeState();
}

class _HomeState extends State<Home> {
  Example example;

  [@override](/user/override)
  void initState() {
    super.initState();
    example = Example('初始值');
    _loadSharedPreferences();
  }

  Future<void> _loadSharedPreferences() async {
    final prefs = await SharedPreferences.getInstance();
    example = _$ExampleFromJson(prefs.getString('example_key') ?? '');
    setState(() {});
  }

  Future<void> _saveSharedPreferences() async {
    final prefs = await SharedPreferences.getInstance();
    await prefs.setString('example_key', _$ExampleToJson(example));
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('SharedPreferences 示例')),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text('当前值: ${example.value}'),
            ElevatedButton(
              onPressed: () {
                setState(() {
                  example.value = '新值';
                  _saveSharedPreferences();
                });
              },
              child: Text('更新值'),
            ),
          ],
        ),
      ),
    );
  }
}