Perl 模块 Config::Any

简介

可透明地从各种不同类型的文件中加载配置信息；如：JSON，XML，YAML，INI等

use Config::Any;
 
my $cfg = Config::Any->load_stems({stems => \@filepath_stems, ... });
# or
my $cfg = Config::Any->load_files({files => \@filepaths, ... });
 
for (@$cfg) {
    my ($filename, $config) = %$_;
    $class->config($config);
    warn "loaded config from file: $filename";
}

Config::Any 为perl的应用程序提供了一种从不同类型的配置文件加载配置信息的方法。它支持的文件格式有：XML、YAML、JSON、INI、Perl代码.
这个模块的基本原理如下 ：
Perl程序会部署到不同的平台并且会运行在很多不同的系统环境下。系统管理员和最终用户可能比开发人员更喜欢不同的配置格式。多种格式的配置文件可以有很大的灵活性让用户做出不同的选择，而开发人员并没有增加额外的工作量。作为开发人员，只需要学习如何使用一个接口让不同格式的配置文件在适合的时间被加载。

接口

load_files(%args)

Config::Any->load_files( { files => \@files } );
Config::Any->load_files( { files => \@files, filter  => \&filter } );
Config::Any->load_files( { files => \@files, use_ext => 1 } );
Config::Any->load_files( { files => \@files, flatten_to_hash => 1 } );

load_files() 尝试从参数中给出的文件列表(files)中加载配置文件，前提是文件存在。

如果参数 filter 存在，它会被当作一个回调方法(callback)，被用来处理加载后返回之前的配置项。一个hash-reference 参数被传递给它。

如果参数 use_ext 参数被定义，加载程序将尝试解析每个文件的扩展名，并跳过不能与标准的插件扩展名相匹配的文件。只有与标准 的插件扩展名相匹配的文件才会使用对应的插件进行解析。出于效率的原因，这是被鼓励使用的。但是这也将失去灵活性。例如：一个文件命名为myapp.cfg 内容是 YAML 数据，这时它不会被 YAML 的插件解析，因为只有 .yml 或 .yaml 类型的文件才会被 YAML 插件解析。

当 flatten_to_hash 参数被定义时，加载器会返回一个以文件名为键、以内容为值的哈希，而不是返回一个单键哈希的列表。

load_files() 还可以接受一个名为 force_plugins的参数，它的值应该是一个以插件名为元素的arrayref。它的作用是允许你使用一个非标准的扩展名，并指定一个特定的解析器来处理他，此配置项与 use_ext 不兼容。

你还可以提供一个 driver_args hashref 传递给个别的解析对象。如下代码：

Config::Any->load_files( { files => \@files, driver_args => {
    General => { -LowerCaseNames => 1 }
} )

load_stems(%args)

Config::Any->load_stems( { stems => \@stems } );
Config::Any->load_stems( { stems => \@stems, filter  => \&filter } );
Config::Any->load_stems( { stems => \@stems, use_ext => 1 } );
Config::Any->load_stems( { stems => \@stems, flatten_to_hash => 1 } );

load_stems 首先遍历所有可用插件，把插件可处理的所有扩展名与 stems 列表中给出的没有扩展名的文件相结合生成一个插件可处理的文件列表。然后它将调用 load_files对生成的文件列表进行处理。

sub load_stems {
    my ( $class, $args ) = @_;
 
    unless ( $args && exists $args->{ stems } ) {
        warn "No stems specified!";
        return;
    }
 
    my $stems = delete $args->{ stems };
    my @files;
    for my $s ( @$stems ) {
        for my $ext ( $class->extensions ) {
            push @files, "$s.$ext";
        }
    }
 
    $args->{ files } = \@files;
    return $class->_load( $args );
}

finder()

这个方法 finder 返回 Module::Pluggable::Object 对象 用来加载插件。

plugins()

这个方法 plugins 通过使用 Module::Pluggable::Object 模块的对象 得到配置文件加载器插件的名称。

extensions()

这个方法 extensions 返回插件可处理的所有可能的扩展名。如果你设置了 use_ext 那么 load_stems和 load_files 都需要用到它。

相关文章

Perl 模块 Config::Any 之 Config::Any::Base