Flutter环境信息获取插件flutter_environment的使用

Flutter环境信息获取插件flutter_environment的使用

安装

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

dependencies:
  flutter_environment: ^latest_version

1. 使用命令行安装它：

$ flutter pub get

1. 在Dart代码中导入：

import 'package:flutter_environment/flutter_environment.dart';

使用

在你的主函数中设置flutter_environment，我们建议你在主函数的顶部设置它，以便可以在应用的任何位置使用Environment.instance。

void main() {
  EnvironmentType environmentType = EnvironmentConfig.environmentType;
  Environment(
    environmentType: environmentType,
    color: Colors.red.shade900,
    values: EnvironmentValues(
      environmentType == EnvironmentType.dev
          ? 'https://www.duckma.org'
          : 'https://www.duckma.com',
    ),
  );

  // 打印环境信息
  debugPrint('Is development environment: ${Environment.isDevelopment}');
  debugPrint('Is alpha environment: ${Environment.isAlpha}');
  debugPrint('Is beta environment: ${Environment.isBeta}');
  debugPrint('Is production environment: ${Environment.isProduction}');
  debugPrint(Environment.instance.values.baseUrl);

  runApp(const MyApp());
}

为了根据environmentType设置值，可以使用Environment.instance.environment并使用switch语句：

String _getSomeValue(EnvironmentType environmentType) {
  switch (environmentType) {
    case EnvironmentType.dev:
    case EnvironmentType.alpha:
      return 'Users angry';
    case EnvironmentType.beta:
    case EnvironmentType.prod:
      return 'Users happy';
  }
}

注意：这不适用于EnvironmentValues.baseUrl，因为Environment尚未初始化，所以我们使用EnvironmentConfig.environmentType。

如果你需要更多的EnvironmentValues，可以通过扩展EnvironmentValues来实现。我们这样做是因为单例静态getter无法处理类型参数。

extension EnvironmentValuesE on EnvironmentValues {
  String get envKey => 'DEV';

  String get userStatus => _getSomeValue(Environment.instance.environment);
}

获取信息

你可以通过以下方式获取当前的EnvironmentType信息：

print('Is development environment: ${Environment.isDevelopment}');
print('Is alpha environment: ${Environment.isAlpha}');
print('Is beta environment: ${Environment.isBeta}');
print('Is production environment: ${Environment.isProduction}');

例如，在API类中使用：

class Api {
  final baseUrl = Environment.instance.values.baseUrl;
}

完整示例

以下是完整的示例代码：

// Copyright (c) 2022 DuckMa Srl. All rights reserved.
// Use of this source code is governed by a MIT-style license that can be
// found in the LICENSE file.

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

String _getSomeValue(EnvironmentType environmentType) {
  switch (environmentType) {
    case EnvironmentType.dev:
    case EnvironmentType.alpha:
      return 'Users angry';
    case EnvironmentType.beta:
    case EnvironmentType.prod:
      return 'Users happy';
  }
}

extension EnvironmentValuesE on EnvironmentValues {
  String get envKey => 'DEV';

  String get userStatus => _getSomeValue(Environment.instance.environment);
}

void main() {
  EnvironmentType environmentType = EnvironmentConfig.environmentType;
  Environment(
    environmentType: environmentType,
    color: Colors.red.shade900,
    values: EnvironmentValues(
      environmentType == EnvironmentType.dev
          ? 'https://www.duckma.org'
          : 'https://www.duckma.com',
    ),
  );

  debugPrint('Is development environment: ${Environment.isDevelopment}');
  debugPrint('Is alpha environment: ${Environment.isAlpha}');
  debugPrint('Is beta environment: ${Environment.isBeta}');
  debugPrint('Is production environment: ${Environment.isProduction}');
  debugPrint(Environment.instance.values.baseUrl);

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return EnvironmentBanner(
      child: Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              const Text(
                'You have pushed the button this many times:',
              ),
              Text(
                '$_counter',
                style: Theme.of(context).textTheme.headline4,
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: _incrementCounter,
          tooltip: 'Increment',
          child: const Icon(Icons.add),
        ),
      ),
    );
  }
}