Flutter应用发布说明插件releasenotes的使用

Flutter应用发布说明插件releasenotes的使用

简介

该插件是基于upgrader和flutter_app_version_checker两个包的理念构建的。结合这两者，创建了一个表单，仅返回特定情况所需的发布说明。

功能

此包会返回您的应用程序在应用商店下一个版本的发布说明。它不会返回本地对话框或类似的东西，其目的只是返回版本发布说明。通过这些信息，您可以根据自己的UI偏好个性化调用更新的方式。

开始使用

导入包时使用以下命令：

flutter pub add releasenotes

注意：在此示例中，我使用的是我自己开发并发布在Google Play商店中的应用程序。

使用方法

要使用该包，您需要初始化实例：

final releaseNotes = ReleaseNotes(
  appBundleId: "com.startcom.camporiImortais", // 应用程序包名
  currentVersion: "0.0.1", // 当前应用版本
);

然后，只需调用getReleaseNotes函数并传递语言和地区作为参数：

Future<ReleaseNotesModel?> getReleaseNotes() async {
  return await releaseNotes.getReleaseNotes(
    "pt", // 语言代码
    "BR", // 国家代码
    locale: "pt_BR", // 对于iOS，这个属性必须有以获取本地化的发布说明
  );
}

如果当前版本 == 商店版本 => 属性isLatest为true。这表明当前应用程序版本与商店中的版本匹配。如果有错误，值将为null。

之后，您可以根据接收到的信息配置如何处理。

完整示例Demo

以下是完整的Flutter应用程序示例，展示如何使用releasenotes插件：

import 'package:flutter/material.dart';
import 'package:releasenotes/models/release_notes_model.dart';
import 'package:releasenotes/releasenotes.dart';

void main() {
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData.dark(useMaterial3: true),
      home: const MyHomePage(),
    );
  }
}

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

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  static const String kBundleId = "com.startcom.camporiImortais"; // 应用程序包名
  static const String kCurrentVersion = "0.0.1"; // 当前应用版本

  final releaseNotes = ReleaseNotes(
    appBundleId: kBundleId,
    currentVersion: kCurrentVersion,
  );

  String? notes; // 发布说明
  String? version; // 版本号
  bool? isLatest; // 是否最新版本
  bool isLoading = false; // 加载状态

  getReleaseNotes() async {
    setState(() => isLoading = true); // 设置加载状态为true

    final ReleaseNotesModel? releaseNotesModel =
        await releaseNotes.getReleaseNotes("vi", "VN", locale: "vi_VN");
    setState(() {
      notes = releaseNotesModel?.notes ?? "没有找到发布说明";
      version = releaseNotesModel?.version ?? "没有找到版本";
      isLatest = releaseNotesModel?.isLatestVersion ?? false;
      isLoading = false; // 设置加载状态为false
    });
  }

  [@override](/user/override)
  void initState() {
    getReleaseNotes(); // 初始化时获取发布说明
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text("ReleaseNotes"), // 标题
        centerTitle: true, // 标题居中
      ),
      body: Center(
        child: isLoading
            ? const CircularProgressIndicator() // 显示加载指示器
            : Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  const Text("当前版本: $kCurrentVersion"),
                  Text("商店发布说明: $notes"),
                  Text("商店版本: $version"),
                  Text("是否最新版本: $isLatest"),
                ],
              ),
      ),
    );
  }
}