Flutter功能定制插件flavorz的使用

Flavors 🍧

这个包将简化您管理应用程序Flavors（环境）的方式。

开始使用

确保您正在运行Dart版本 2.17.0 或更高版本。

将以下内容添加到您的package的pubspec.yaml文件中

在dev_dependencies中添加 flavorz 和 build_runner。

dev_dependencies:
  build_runner: ^2.2.0
  flavorz: ^1.0.5

运行 dart pub get 或 flutter pub get 来安装这些包。

如何使用

需要关注两个文件：

.flavorz.json 文件
.flavorz.dart 文件

上述文件在您的项目中还不存在。我们将手动创建.flavorz.json文件，并通过命令生成.flavorz.dart文件。

创建.flavorz.json文件

.flavorz.json 文件保存所有Falvors（环境）的配置，必须放在lib文件夹内的任何位置。

我们需要在lib文件夹下创建一个新文件并命名为name.flavorz.json，名称可以是任何东西，但扩展名必须相同。

因此，让我们创建一个示例文件并将其命名为env.flavorz.json。在json文件中必须有两个属性：

‘default’
‘environments’

‘default’ 是一个字符串值，应该包含我们希望设置为默认的flavor（环境）的名称。

‘environments’ 是每个flavor的配置列表。每个flavor必须具有以下属性：

_name

您可以在environments列表中添加任意多的flavor，并且可以在_name之后添加任意多的属性。

JSON文件注意事项

永远不要删除’_name’属性
最好使用camelCase格式为您的属性命名
以下划线开头的属性将被生成为私有

以下是文件的示例：

{
    "default": "dev",
    "environments": [
        {
            "_name": "dev",
            "versionNumber": "Dev 1.0.0",
            "camelCaseAttribute": ""
        },
        {
            "_name": "local",
            "versionNumber": "Local 1.0.1",
            "camelCaseAttribute": ""
        }
    ]
}

如您所见，‘environments’ 列表包含应用程序的所有不同flavor。例如：Dev、Prod、Mock。

运行构建器

在终端中运行 dart run build_runner build 或 flutter pub run build_runner build 以生成环境文件。

运行命令后，将生成一个新文件。生成的文件将与上一步中的.flavorz.json文件具有相同的名称和路径，并且其扩展名为.flavorz.dart。

生成的文件将包含整个应用程序中使用的Environment类。

开始使用Environment类

您可以从应用程序中的任何地方访问您的环境数据，在导入文件后使用工厂Environment()，如下所示。

import 'env.flavorz.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final type = Environment().type;
  print(type); // 打印 'dev'
}

运行您的应用程序

要使用特定环境运行您的应用程序，请运行以下命令 flutter run --dart-define="env=dev"。将dev替换为您要运行的环境名称。

如果您仅运行 flutter run，则它将运行在.flavorz.json文件中定义的默认环境。

注意事项

每当您修改.flavorz.json文件时，必须运行build_runner。

示例代码

以下是一个完整的示例demo，展示了如何使用flavorz插件来管理不同的环境。

// 导入生成的flavorz文件
import 'env.flavorz.dart';

/// 在运行 `dart run build_runner build` 后，
/// 可以在主函数中编写以下内容（取消注释相关行）
/// 并导入所需的文件。
///
/// 更多信息请参考README.md文件
void main() async {
  WidgetsFlutterBinding.ensureInitialized(); // 确保Flutter绑定已初始化
  final type = Environment().type; // 获取当前环境类型
  print(type); // 打印当前环境类型，例如 'dev'
  
  // 根据不同的环境执行不同的操作
  if (type == 'dev') {
    print('Running in development environment');
  } else if (type == 'local') {
    print('Running in local environment');
  }
  
  // 这里可以继续添加更多逻辑，根据不同的环境进行不同的处理
}

更多关于Flutter功能定制插件flavorz的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

bupafengyu 1楼•2 天前

更多关于Flutter功能定制插件flavorz的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

当然，关于Flutter功能定制插件flavorz的使用，下面是一个基本的示例，展示如何设置和使用flavorz来根据不同的构建风格（flavor）定制应用的功能。

首先，确保你的Flutter项目已经设置好了多个flavor。如果你还没有设置，可以通过修改ios/Runner/Info.plist和android/app/build.gradle文件来配置。

步骤 1: 安装`flavorz`包

在你的pubspec.yaml文件中添加flavorz依赖：

dependencies:
  flutter:
    sdk: flutter
  flavorz: ^x.y.z  # 请替换为最新版本号

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

步骤 2: 创建Flavor配置

在项目的根目录下创建一个名为flavorz.dart的文件，用于定义不同flavor的配置。

// flavorz.dart
import 'package:flavorz/flavorz.dart';

part 'flavorz/development.dart';
part 'flavorz/production.dart';

class MyFlavors implements Flavors {
  @override
  Flavor get flavor => Flavor.parse(String.fromEnvironment('FLAVOR', defaultValue: 'development'));
}

接下来，创建flavorz/development.dart和flavorz/production.dart文件来定义具体的flavor配置。

flavorz/development.dart

// flavorz/development.dart
part of 'flavorz.dart';

class DevelopmentFlavor implements Flavor {
  @override
  String get name => 'development';

  // 在这里定义开发环境下的配置
  bool get enableFeatureX => true;
  String get apiUrl => 'https://dev-api.example.com';
}

flavorz/production.dart

// flavorz/production.dart
part of 'flavorz.dart';

class ProductionFlavor implements Flavor {
  @override
  String get name => 'production';

  // 在这里定义生产环境下的配置
  bool get enableFeatureX => false;
  String get apiUrl => 'https://api.example.com';
}

步骤 3: 使用Flavor配置

在你的应用中，你可以通过Flavorz类来获取当前的flavor配置。

// main.dart
import 'package:flutter/material.dart';
import 'package:flavorz/flavorz.dart';
import 'flavorz.dart';

void main() {
  Flavorz.init(MyFlavors());

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    final flavor = Flavorz.of(context).flavor;
    final enableFeatureX = flavor.enableFeatureX;
    final apiUrl = flavor.apiUrl;

    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Demo Home Page'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              Text(
                'Feature X Enabled: $enableFeatureX',
              ),
              Text(
                'API URL: $apiUrl',
              ),
            ],
          ),
        ),
      ),
    );
  }
}

步骤 4: 配置构建脚本

确保你的构建脚本（例如build.yaml或使用命令行参数）能够正确传递FLAVOR环境变量。

例如，在命令行中构建开发版本：

flutter run --flavor development

构建生产版本：

flutter run --flavor production

总结

通过以上步骤，你已经成功地在Flutter项目中使用flavorz插件来根据不同的flavor定制应用的功能。这种方法非常适合需要根据不同环境（如开发、测试、生产）来调整应用行为的情况。

Flutter功能定制插件flavorz的使用