Flutter共享偏好设置内容提供插件shared_preferences_content_provider的使用

Flutter共享偏好设置内容提供插件shared_preferences_content_provider的使用

shared_preferences_content_provider 是一个支持 Android 内容提供者的共享偏好设置插件。它允许你在多个应用程序之间共享 SharedPreferences 数据，但仅限于 Android 平台。

使用方法

要使用此插件，请在你的 pubspec.yaml 文件中添加 shared_preferences_content_provider 作为依赖项。

示例

1. 修改 AndroidManifest.xml

你需要根据应用程序的角色（提供者应用或消费者应用）修改 AndroidManifest.xml 文件。

提供者应用 (Host App)

<manifest>
    <application>
         <provider
           android:name="com.zhgwu.shared_preferences_content_provider.SharedPreferencesContentProvider"
           android:authorities="your_authority"  <!-- 替换为你的 authority -->
           android:readPermission="shared_preferences.permission.READ_DATA"
           android:writePermission="shared_preferences.permission.WRITE_DATA"
           android:enabled="true"
           android:exported="true" />
    </application>
</manifest>

消费者应用 (Consumer App)

<manifest>
    <queries>
        <package android:name="com.example.host" />  <!-- 替换为提供者应用的包名 -->
    </queries>
    <uses-permission android:name="shared_preferences.permission.WRITE_DATA" />
    <uses-permission android:name="shared_preferences.permission.READ_DATA" />
</manifest>

2. 初始化 SharedPreferencesContentProvider

在 Dart 代码中，首先需要初始化 SharedPreferencesContentProvider，并传入提供者的 authority。

// The content provider must be set up first
await SharedPreferencesContentProvider.init(
    providerAuthority: 'your_authority',  // 替换为 AndroidManifest.xml 中的 authority
);

3. 存储和读取数据

你可以使用 putBool、putString、putInt 和 putDouble 方法来存储不同类型的数据。使用 get 方法可以读取这些数据。

// Put values
await SharedPreferencesContentProvider.putBool('MY_BOOL_KEY', true);
await SharedPreferencesContentProvider.putString('MY_STRING_KEY', 'STRING_VALUE');
await SharedPreferencesContentProvider.putInt('MY_INT_KEY', 42);
await SharedPreferencesContentProvider.putDouble('MY_DOUBLE_KEY', 9.9);

// Get values
final bool boolValue = await SharedPreferencesContentProvider.get('MY_BOOL_KEY');
final String stringValue = await SharedPreferencesContentProvider.get('MY_STRING_KEY');
final int intValue = await SharedPreferencesContentProvider.get('MY_INT_KEY');
final double doubleValue = await SharedPreferencesContentProvider.get('MY_DOUBLE_KEY');

你也可以使用 getAll 方法获取所有存储的数据：

final Map<String, dynamic> data = await SharedPreferencesContentProvider.getAll();

4. 监听数据变化

你可以监听特定键值的变化，或者监听所有键值的变化。

// Listen when value change value of key ('123') change
SharedPreferencesContentProvider.listen((event) {
    print(event);
}, 
key: '123',  // 如果你想监听所有变化，移除此行
);

完整示例 Demo

以下是一个完整的示例，展示了如何在 Flutter 应用中使用 shared_preferences_content_provider 插件。

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 初始化 SharedPreferencesContentProvider
  await SharedPreferencesContentProvider.init(
    providerAuthority: 'your_authority',  // 替换为 AndroidManifest.xml 中的 authority
  );

  runApp(MyApp());
}

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

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

class _HomeScreenState extends State<HomeScreen> {
  String _stringValue = '';
  bool _boolValue = false;
  int _intValue = 0;
  double _doubleValue = 0.0;

  [@override](/user/override)
  void initState() {
    super.initState();
    _loadData();
  }

  Future<void> _loadData() async {
    // 读取存储的数据
    final String stringValue = await SharedPreferencesContentProvider.get('MY_STRING_KEY') ?? '';
    final bool boolValue = await SharedPreferencesContentProvider.get('MY_BOOL_KEY') ?? false;
    final int intValue = await SharedPreferencesContentProvider.get('MY_INT_KEY') ?? 0;
    final double doubleValue = await SharedPreferencesContentProvider.get('MY_DOUBLE_KEY') ?? 0.0;

    setState(() {
      _stringValue = stringValue;
      _boolValue = boolValue;
      _intValue = intValue;
      _doubleValue = doubleValue;
    });
  }

  Future<void> _saveData() async {
    // 存储数据
    await SharedPreferencesContentProvider.putString('MY_STRING_KEY', 'Hello, World!');
    await SharedPreferencesContentProvider.putBool('MY_BOOL_KEY', true);
    await SharedPreferencesContentProvider.putInt('MY_INT_KEY', 42);
    await SharedPreferencesContentProvider.putDouble('MY_DOUBLE_KEY', 9.9);

    // 重新加载数据以反映更改
    await _loadData();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('SharedPreferences Content Provider Demo'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            Text('String Value: $_stringValue'),
            Text('Bool Value: $_boolValue'),
            Text('Int Value: $_intValue'),
            Text('Double Value: $_doubleValue'),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: _saveData,
              child: Text('Save Data'),
            ),
          ],
        ),
      ),
    );
  }
}