Flutter环境变量管理插件flutter_env_native的使用

简介

flutter_env_native 是一个用于在Flutter项目中为原生平台提供编译时变量的插件/工具。它使得通过 --dart-define 和 --dart-define-from-file 设置的环境变量可以被原生平台访问。

安装

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

dev_dependencies:
  flutter_env_native: ^0.1.0

设置指南

定义.env文件

创建一个.env文件，用于定义环境变量：

APP_NAME=batcave
APP_SUFFIX=.dev
MAPS_API_KEY=someKeyString

通过命令行参数传递给Flutter运行或构建命令：

flutter run --dart-define-from-file=.env

Android安装

修改android/app/build.gradle

确保包含以下内容：

// flutter_env_native
Project flutter_env_native = project(':flutter_env_native')
apply from: "${flutter_env_native.projectDir}/envConfig.gradle"

在AndroidManifest.xml中使用

defaultConfig {
    applicationId = "tech.mastersam.flutter_env_example"
    minSdk = flutter.minSdkVersion
    targetSdk = flutter.targetSdkVersion
    versionCode = flutterVersionCode.toInteger()
    versionName = flutterVersionName

    resValue "string", "app_name", APP_NAME ?: 'default_name'
}

<application
    android:label="flutter_env_example"
    android:name="@string/app_name"
    android:icon="@mipmap/ic_launcher">
</application>

在Kotlin文件中使用

修改build.gradle中的defaultConfig部分以创建BuildConfig字段：

buildConfigField "String", "APP_NAME", "\"${APP_NAME ?: 'default_name'}\""

然后可以在MainActivity.kt中访问这些值：

class MainActivity : FlutterActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val appName = BuildConfig.APP_NAME
        Toast.makeText(this, "APP_NAME: $appName", Toast.LENGTH_LONG).show()
    }
}

iOS安装

修改ios/Podfile

添加以下代码段：

post_install do |installer|
  installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)
  end

  flutter_env_plugin_path = File.join(Dir.pwd, '.symlinks', 'plugins', 'flutter_env_native', 'ios', 'setup_env.sh')
  root_dir = File.expand_path('..', Dir.pwd)
  
  system("sh \"#{flutter_env_plugin_path}\" \"#{root_dir}\"")
end

在Info.plist中使用

直接引用.env文件中定义的环境变量：

<key>CFBundleDisplayName</key>
<string>$(APP_NAME)</string>

在Swift文件中使用

例如，在AppDelegate.swift或其他Swift文件中：

var app_name: String = Bundle.main.infoDictionary?["APP_NAME"] as? String ?? ""
NSLog("\nHere's your app name -> \(app_name)")

示例代码

以下是使用flutter_env_native读取环境变量并在Flutter应用中显示的完整示例：

import 'package:flutter/material.dart';

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

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

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

class _MyAppState extends State<MyApp> {
  // 使用const构造函数从环境变量中获取字符串值
  String name = const String.fromEnvironment("APP_NAME");
  String suffix = const String.fromEnvironment("APP_SUFFIX");

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('name: $name\n'),
              Text('suffix: $suffix\n'),
            ],
          ),
        ),
      ),
    );
  }
}

以上就是flutter_env_native插件的基本使用方法和一个完整的示例演示。希望这能帮助你更好地理解和使用这个有用的工具！