Flutter配置管理插件tridev_config的使用

tridev_config 是一个用于将 YAML 配置文件映射到 Dart 对象的库。它通过键值对的方式确保 YAML 文件中的类型在运行时得到检查，并且不会出现任何键名拼写错误。

基本用法

tridev_config 简单地将 YAML 文件映射为 Dart 对象，使用键作为属性名称。这种映射确保了 YAML 中值的类型在运行时被检查，并且不会出现键名拼写错误。

假设你想要配置应用的端口和服务器头信息。你可以定义一个 Configuration 的子类，并包含这些属性：

class ApplicationConfiguration extends Configuration {
    ApplicationConfiguration(String fileName) :
        super.fromFile(File(fileName));

    int port;
    String serverHeader;
}

你的 YAML 文件应该包含这两个大小写敏感的键：

port: 8000
serverHeader: booyah/1

读取配置文件的方法如下：

var config = new ApplicationConfiguration("config.yaml");
print("${config.port}"); // -> 8000
print("${config.serverHeader}"); // -> "booyah/1"

如果 port 不是一个整数或者缺失，你会收到一个异常。 如果 serverHeader 不是一个字符串或者缺失，你也会收到一个异常。

实用用法

你可以将 Configuration 中的某些属性标记为可选。

class ApplicationConfiguration extends Configuration {
    ApplicationConfiguration(String fileName) :
        super.fromFile(File(fileName));

    int port;

    @optionalConfiguration
    String serverHeader;
}

如果在读取 YAML 文件时省略了 serverHeader，其值将为 null 并且不会抛出异常。

内置的 Configuration 包括 DatabaseConfiguration 和 APIConfiguration，它们包含了常见的配置值。

你可以像嵌套对象一样嵌套 Configuration：

class ApplicationConfiguration extends Configuration {
    ApplicationConfiguration(String fileName) :
        super.fromFile(File(fileName));

    int port;

    DatabaseConfiguration userDatabase;
}

对应的 YAML 文件可能如下所示：

port: 8000
userDatabase:
  databaseName: dartstuff
  host: stablekernel.com
  port: 5432

你还可以使用数组和映射，其中的值可以是基本类型或 Configuration 子类。

class ApplicationConfiguration extends Configuration {
    ApplicationConfiguration(String fileName) :
        super.fromFile(File(fileName));

    Map<String, DatabaseConfiguration> databases;
}

这里的 YAML 可能如下所示：

databases:
  db1:
    databaseName: dartstuff
    host: stablekernel.com
    port: 5432
  db2:
    databaseName: otherstuff
    host: somewhereoutthere.com
    port: 5432

然后，你可以这样访问它：

var config = new ApplicationConfig("config.yaml");

var databaseOne = config.databases["db1"];
await database.connect(databaseOne.host,
    databaseOne.port,
    databaseOne.databaseName);

配置可以有多种 YAML 表达方式。例如，DatabaseConfiguration 可以表示为每个组件（用户名、主机等）的 Map<String, dynamic>。它也可以表示为连接字符串，例如 "postgres://user:password@host:port/database"。你可以通过在 Configuration 的子类中重写 decode 方法来允许这种行为：

class AuthorityConfiguration extends Configuration {
  String username;
  String password;

  void decode(dynamic anyValue) {
    if (anyValue is! String) {
      throw new ConfigurationException("Expected a String for AuthorityConfiguration.");
    }

    username = anyValue.split(":").first;
    password = anyValue.split(":").last;
  }
}

这个配置可以在以下两种场景中读取：

authority:
    username: "Bob"
    password: "Fred"

// 或者

authority: "Bob:Fred"

配置还可以重定向使用环境变量。要在配置文件中引用环境变量，可以使用 $VARIABLE 语法作为值：

port: $PORT