Flutter偏好设置管理插件onepref的使用

OnePref 是一个用于Flutter项目的包，它简化了共享偏好设置（SharedPreferences）的使用，并且为应用内购买（In-App Purchase）提供了便捷的方法，以加速开发进程。下面将详细介绍如何使用 OnePref 包。

Features

OnePref 提供与 shared_preferences 包相同的功能，但是使用起来更加友好。同时，如果你的应用中加入了应用内购买功能，它还提供了一些额外的功能来帮助你快速实现这些特性。

Getting started

安装

首先，在你的项目中添加依赖：

flutter pub add onepref

然后在 Dart 文件中导入：

import 'package:onepref/onepref.dart';

初始化

在使用 OnePref 之前需要确保已经初始化。通常是在 main.dart 文件中的 main 方法里完成这一步骤：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await OnePref.init();
  runApp(const MyApp());
}

Usage

写入和读取偏好设置

写入字符串类型的偏好设置：

OnePref.setString("key", "value here");

获取存储的字符串值：

const value = OnePref.getString("key");

对于布尔类型、整型等其他类型的数据操作，OnePref 也提供了相应的方法如 setBool, getInt 等等。

获取产品列表 (针对应用内购买)

要从商店获取可用的产品列表，可以使用以下代码：

IApEngine iApEngine = IApEngine();

void getProducts() async {
  await iApEngine.getIsAvailable().then((isAvailable) async {
    if (isAvailable) {
      await iApEngine.queryProducts(_productIds).then((value) => {
            setState(() {
              _products.addAll(value.productDetails);
              _notFoundIds.addAll(value.notFoundIDs);
              _purchasePending = false;
            })
          });
    }
  });
}

其中 _productIds 是你要查询的产品ID列表。

处理购买

当用户点击购买按钮时，你可以调用如下方法来处理购买逻辑：

TextButton(
  onPressed: () {
    iApEngine.handlePurchase(_products[selectedProduct ?? 0], _productIds);
  },
  child: Text("Buy $reward",
    textAlign: TextAlign.center,
    style: const TextStyle(
      color: Colors.white, fontSize: 14,
      fontWeight: FontWeight.normal,
    ),
  ),
),

此外，为了监听购买状态的变化，还需要订阅 purchaseStream，并在适当的时候更新UI或执行其他业务逻辑。

示例代码

这里给出一个完整的示例代码片段，展示了如何结合 OnePref 和 In-App Purchase 来构建一个简单的界面：

import 'package:flutter/material.dart';
import 'package:onepref/onepref.dart';
import 'package:in_app_purchase/in_app_purchase.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await OnePref.init();
  runApp(const MyApp());
}

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late final List<ProductDetails> _products = [];
  late final List<PurchaseDetails> _currentPurchaseDetails = [];

  IApEngine iApEngine = IApEngine();
  bool isSubscribed = false;
  bool oneTimeProductPurchased = false;

  final List<ProductId> _productIds = [
    ProductId(id: "test_remove_ads1", isConsumable: false, isOneTimePurchase: true),
  ];

  @override
  void initState() {
    super.initState();
    isSubscribed = OnePref.getPremium()!;
    
    // 监听购买事件
    iApEngine.inAppPurchase.purchaseStream.listen(listener, onDone: () {}, onError: (error) {});

    getProducts();
  }

  void listener(List<PurchaseDetails> purchaseDetailsList) async {
    await iApEngine.purchaseListener(purchaseDetailsList: purchaseDetailsList, productsIds: _productIds).then((value) {
      if (value['purchaseRestore'] || value['purchaseComplete']) {
        setState(() {
          subExisting = true;
        });
      }
    });
  }

  void getProducts() async {
    await iApEngine.getIsAvailable().then((value) async {
      if (value) {
        await iApEngine.queryProducts(_productIds).then((value) {
          setState(() {
            _products.addAll(value.productDetails);
          });
        });
      }
    });
  }

  void updateOneTimePurchaseAndSubscription(String purchasedProductId) {
    var productId = _productIds.firstWhere((element) => element.id == purchasedProductId);

    if (productId.isOneTimePurchase ?? false) {
      setState(() {
        oneTimeProductPurchased = true;
        OnePref.setBool("oneTimePurchase", true);
      });
    } else if (productId.isSubscription ?? false) {
      setState(() {
        OnePref.setPremium(true);
        isSubscribed = OnePref.getPremium() ?? false;
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(primarySwatch: Colors.blue),
      home: Scaffold(
        appBar: AppBar(title: Text('Flutter Demo')),
        body: Column(
          children: [
            // UI elements for displaying products and handling purchases...
          ],
        ),
      ),
    );
  }
}

请注意，以上代码仅为示例，实际应用时可能需要根据具体需求进行调整。例如，你需要定义自己的 ProductId 类以及相关常量，并且根据实际情况设计合适的UI组件。