从 Perl 模块导入条件编译函数

Question

我有一组日志记录和调试功能，我想在多个模块/对象中使用它们。我希望能够使用命令行开关全局打开/关闭它们。

以下代码执行此操作，但是，我希望能够省略包名并将所有内容保存在一个文件中。

更具体地说，我想将日志记录函数名称导入每个模块，以便可以在没有任何包名称限定的情况下调用它们（类似于 C++ use namespace; 指令）并且我希望能够启用/ 从使用它们的脚本中全局禁用它们，如下面的示例代码所示。

这与我之前提出的两个问题有关，here 和 here。

另一件事 - 我不认为我完全理解为什么下面的代码有效。

#! /usr/bin/perl -w

use strict;
use Getopt::Long;

{
    package LogFuncs;

    use threads;
    use Time::HiRes qw( gettimeofday );

    # provide tcpdump style time stamp
    sub _gf_time {
        my ( $seconds, $microseconds ) = gettimeofday();
        my @time = localtime($seconds);

        return sprintf( "%02d:%02d:%02d.%06ld",
            $time[2], $time[1], $time[0], $microseconds );
    }

    sub logerr;

    sub compile {
        my %params = @_;

        *logerr = $params{do_logging}
            ? sub {
                my $msg = shift;
                warn _gf_time() . " Thread " . threads->tid() . ": $msg\n";
            }
            : sub { };
    }            
}

{
    package FooObj;

    sub new {
        my $class = shift;
        bless {}, $class; 
    };

    sub foo_work { 
        my $self = shift;
        # do some foo work
        LogFuncs::logerr($self);
    }
}

{
    package BarObj;

    sub new {
        my $class = shift;
        my $data  = { fooObj => FooObj->new() };
        bless $data, $class;
    }

    sub bar_work { 
        my $self = shift;
        $self->{fooObj}->foo_work();
        LogFuncs::logerr($self);
    }
}        

my $do_logging = 0;

GetOptions(
    "do_logging"    => \$do_logging,
);

LogFuncs::compile(do_logging => $do_logging);

my $bar = BarObj->new();
LogFuncs::logerr("Created $bar");
$bar->bar_work();

Answer 1

如果您想将所有内容保存在同一个文件中，为什么不将记录器放在文件范围词法的顶部。

GetOptions( do_logging => \$do_logging );

my $logerr = $do_logging ? sub {logging_code_here()} : sub {};

$logerr 现在可以在同一文件中该点之后定义的任何包中使用。

但是，按如下方式构建日志调用通常会更快：

my $logerr = sub { logging_code_here() };

$logerr->("some string $some_var") if $do_logging;

这样可以避免子例程调用，并且如果日志记录关闭，则不需要计算 $logerr 的字符串参数。

您还可以设置日志记录级别：

$logerr->("starting loop")     if $do_logging;

for (@big_array) {
    $logerr->("processing $_") if $do_logging > 1;
    ...
}

编辑：虽然我认为这不是最佳实践，但根据您的 cmets，这可能是您正在寻找的（编译指示）：

use 5.010;
use warnings;
use strict;
BEGIN {  # compile time
    $INC{'log.pm'}++;  # block 'require log;'
    package log;
    sub is_active {(caller 1)[10]{log}}  # test the hints hash
    sub import {
        $^H{log} = 1;  # set the hints hash for 'log'
        my $logmsg = (caller).'::logmsg';  # name of caller's sub
        no strict 'refs';
        *$logmsg = sub {print "logging: @_\n" if is_active}  # install sub
            unless *{$logmsg}{CODE}; # unless we did already
    }
    sub unimport {
        $^H{log} = 0;  # unset the hints hash
    }
}

package MyPkg;

use log;
logmsg 'hello, world!';

{
  no log;
  logmsg 'nope, not here';
}

logmsg 'back again';

Answer 2

下面是您的代码，没有用于日志记录功能的 explicit 包。我已将 LogFuncs::compile 重命名为 loggerr:setup 更明确一点，并且不会污染主命名空间。 perl 中的所有内容都有一个包，默认情况下它只是 ma​​in。我认为你之前的代码，带有一个用于日志记录功能的包实际上更干净，并且可以轻松地将其拆分为一个单独的模块，因此可以更轻松地重用它。

至于不了解代码的工作原理，我不确定如何解决，只是因为您没有确定任何您不了解的细节。我假设你的意思是包裹。 Perl 包可以被视为命名空间或类。在 LogFuncs 包的情况下，您将它用作命名空间，并且在其中创建的 subs 以 静态类方法 的形式访问（使用其他更传统的 OO 语言中可能会发光的符号这）。 FooObj 和 BarObj 包更传统地用作对象，通过提供构造函数 new()，并期望使用对象表示法 (->sub) 调用其中的子对象，自动将对象本身作为第一个传递子/方法的参数。唯一将 sub 定义为静态类方法或对象方法的是它是否希望接收对象作为第一个参数。因此，通过正确确定第一个传递的参数是什么并采取相应的行动，稍加深思熟虑和仔细的编程就可以产生对两者都适用的 subs。

#! /usr/bin/perl -w

use strict;
use Getopt::Long;

use threads;
use Time::HiRes qw( gettimeofday );

# provide tcpdump style time stamp
sub _gf_time {
my ( $seconds, $microseconds ) = gettimeofday();
my @time = localtime($seconds);

return sprintf( "%02d:%02d:%02d.%06ld",
    $time[2], $time[1], $time[0], $microseconds );
}

sub logerr;

sub logerr_setup {
    my %params = @_;

    *logerr = $params{do_logging}
        ? sub {
            my $msg = shift;
            warn _gf_time() . " Thread " . threads->tid() . ": $msg\n";
        }
        : sub { };
    }

{
    package FooObj;

    sub new {
        my $class = shift;
        bless {}, $class;
    };

    sub foo_work {
        my $self = shift;
        # do some foo work
        main::logerr($self);
    }
}

{
    package BarObj;

    sub new {
        my $class = shift;
        my $data  = { fooObj => FooObj->new() };
        bless $data, $class;
    }

    sub bar_work {
        my $self = shift;
        $self->{fooObj}->foo_work();
        main::logerr($self);
    }
}

my $do_logging = 0;

GetOptions(
    "do_logging"    => \$do_logging,
);

logerr_setup(do_logging => $do_logging);

my $bar = BarObj->new();
logerr("Created $bar");
$bar->bar_work();

Answer 3

如果您需要修补一些日志记录方法（或在开发人员环境与生产环境中有条件地执行其他操作），您可以将代码放入包的 import() 方法中，并在 use 行中使用参数启用/禁用它：

# this is in MyLogger.pm:
package MyLogger;

use strict; use warnings;
use Exporter;

our @EXPORT_OK = qw(logerr);

sub import
{
     my ($class, $debug) = @_;

     if ($debug)
     {
          # do whatever you need here - patch methods, turn up the log level to "everything", etc

          # imports logerr method
          MyLogger->export_to_level(1, 'logger');
     }
}

sub logerr
{
    # your patched method here..
}

1;

# (now in your application code...)
use MyLogger "debug";    # enables debugging mode
# or:
use MyLogger MyConfig::DEBUG;    # uses a debugging constant that you defined elsewhere