Flutter配置管理插件flavor_getter的使用

Flavor Getter 插件简介

Flavor Getter 是一个Flutter插件，它帮助开发者直接从Flutter代码中检索应用程序当前运行的风味（或变体）。此插件目前支持iOS和Android平台。

安装

1. 添加依赖

在项目的pubspec.yaml文件中添加以下依赖：

dependencies:
  flavor_getter: ^0.0.3

请根据需要替换^0.0.3为你想要的Flavor Getter插件版本。

2. 获取依赖

运行以下命令来获取依赖项：

flutter pub get

3. 导入包

在Dart代码中导入Flavor Getter包：

import 'package:flavor_getter/flavor_getter.dart';

开始使用

要使用Flavor Getter插件，你需要根据目标平台执行一些设置步骤。请注意，本指南假设你已经为iOS和Android项目设置了风味（或变体）。

平台支持

设置

iOS 设置

1. 在Xcode中打开你的Flutter项目，导航至ios/Runner.xcworkspace。
2. 在Xcode中选择你的应用目标（Runner），然后转到Build Settings标签页。
3. 在User-Defined部分，添加一个新的构建设置名为FLAVOR，并为每个方案设置所需的风味值。
4. 打开位于ios/Runner目录下的Info.plist文件。
5. 向信息属性列表添加一个新条目，键为FLAVOR，值为$(FLAVOR)。这将确保风味值可以在Info.plist文件中访问。
6. 保存Info.plist文件。
7. 使用所需方案和风味构建并运行你的应用程序。

Android 设置

1. 在Android Studio中打开你的Flutter项目。

2. 找到android/app/build.gradle文件。

3. 在android块内，确保defaultConfig部分包含以下行：

   android {
       namespace "com.example.myapp" // 替换为你的命名空间
       // ...
       defaultConfig {
           // ...
           applicationId "com.example.myapp" // 替换为你的applicationId；确保与命名空间相似
           // ...
       }
   }
   

   applicationId应与你在AndroidManifest.xml文件中定义的包名匹配。

4. 要添加风味，在android块中添加以下行：

   flavorDimensions "default"
   
   productFlavors {
       dev {
           applicationIdSuffix ".dev"  // com.example.myapp.dev
       }
       prod {
           applicationIdSuffix ".prod"  // com.example.myapp.prod
       }
   }
   

   自定义风味名称（如dev和prod）和applicationIdSuffix（如.dev和.prod）以匹配你所需的风味。

5. 当启用Proguard时（这是Android发布构建的默认设置），BuildConfig Java类会在混淆过程中被重命名，并阻止库引用它。为了避免这种情况，在android/app/proguard-rules.pro中添加规则：

   -keep class com.example.yourPackageName.BuildConfig { *; }
   

   包名应与app/src/main/AndroidManifest.xml文件中的android:label值匹配。

使用

要在Flutter代码中检索当前风味，你可以使用getFlavor()函数。

import 'package:flavor_getter/flavor_getter.dart';

void main() async {
    String currentFlavor = await FlavorGetter().getFlavor();
    print('Running in flavor: $currentFlavor');
}

示例

下面是一个完整的示例，展示了如何在Flutter应用中使用flavor_getter插件：

/*
 * File: main.dart
 * Flutter Plugin: Flavor Getter
 * Description: A plugin to retrieve the current flavor of the Flutter application.
 * Version: 0.0.3
 * Author: Momar Talla Cisse
 * License: BSD 3-Clause
 * Created: 2023-06-18
 * Last Modified: 2023-06-21
 */

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

import 'package:flutter/services.dart';
import 'package:flavor_getter/flavor_getter.dart';

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

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

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

class _MyAppState extends State<MyApp> {
  String _flavor = 'Unknown';
  final _flavorGetterPlugin = FlavorGetter();

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String flavor;
    // Platform messages may fail, so we use a try/catch PlatformException.
    // We also handle the message potentially returning null.
    try {
      flavor = await _flavorGetterPlugin.getFlavor() ?? 'Unknown flavor';
    } on PlatformException {
      flavor = 'Failed to get flavor';
    }

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _flavor = flavor;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('flavor_getter example app'),
        ),
        body: Center(
          child: Text('Running in flavor: $_flavor\n'),
        ),
      ),
    );
  }
}

通过这个示例，你可以在Flutter应用启动时显示当前的应用程序风味。