请选择 进入手机版 | 继续访问电脑版

Perl中捕获警告信息、异常信息并写入日志详解

[复制链接]
查看590 | 回复0 | 2020-7-16 08:01:40 | 显示全部楼层 |阅读模式
虽然建议在每个Perl脚本和模块中开启警告,可是你又不想用户看到Perl发出的警告。
一方面你想在代码前面使用use warnings作为你的安全网,另一方面,通常警告会出现在屏幕上。多数情况下,客户不知道如何处理这些警告。如果幸运的话这些警告仅仅让客户惊讶一下,当然,不幸的是他们尝试着去修复它们... (这里说的不是Perl程序员。)
第三方面,你或许想要保存这些警告供之后分析。
此外,在很多地方还有很多Perl脚本和应用程序没有使用use warnings也没有在#!行中使用-w。加上了use warnings就可能会产生大量的警告。
长远来看,当然是要消除这些警告,但是短期来说呢?
即便是长期计划,你也不能写出完全没有BUG的代码,你也不能确保应用将来永远不会打印出警告信息。
你能么?
你可以在警告打印到屏幕之前捕获它们。
信号
Perl有一个叫做%SIG的内建hash表,其中的键是操作系统信号的名字。对应的值是函数(大多数是函数引用),这些函数会在特定的信号触发时被调用。
除了系统提供的标准信号以外,Perl还添加了两个内部“信号”。其中一个是<h__warn__< span="">,它在每次代码调用warn()函数的时候触发。另外一个是__DIE__,它在每次调用die()时触发。
在本文中,我们会看到这些是怎样影响警告信息的。
匿名函数
sub { }是匿名函数,也就是一个只有函数体而没有名字的函数。(在这个例子中函数体也是空的,但是我希望你能明白我的意思。)
捕获警告--不处理
如果添加如下代码:
  1.   local $SIG{__WARN__} = sub {
  2.      # 此处可以获得警告信息
  3.   };
复制代码
这实际上表示每次程序的某个地方产生了警告信息时,不做任何处理。基本上,这会隐藏所有的警告。
捕获警告--并转换成异常
You could also write: 你也可以写成:
  1.   local $SIG{__WARN__} = sub {
  2.     die;
  3.   };
复制代码
这样会在每次产生警告的时候调用die(),也就是把每个警告转换成异常。
如果你想在异常中包含警告信息,可以这么写:
  1.   local $SIG{__WARN__} = sub {
  2.     my $message = shift;
  3.     die $message;
  4.   };
复制代码
实际的警告信息会作为唯一的参数传递给匿名函数。
捕获警告--并写入日志
你可能想在中间做些其他事情:
过滤嘈杂的警告信息,留待后来分析:
  1.   local $SIG{__WARN__} = sub {
  2.     my $message = shift;
  3.     logger($message);
  4.   };
复制代码
这里我们假设logger()是你实现的写日志函数。
写日志
假设你的应用程序已经有日志机制。如果没有的话,最好加上。即便你不能添加,你也需要操作系统的内建日志机制。例如Linux的syslog,MS Windows的Event Logger,其它操作系统也有它们内部的日志机制。
在本文的例子里,我们使用一个自制logger()函数来代表这个想法。
捕获并写日志的完整例子
  1.   #!/usr/bin/perl
  2.   use strict;
  3.   use warnings;
  4.   local $SIG{__WARN__} = sub {
  5.     my $message = shift;
  6.     logger('warning', $message);
  7.   };
  8.   my $counter;
  9.   count();
  10.   print "$counter\n";
  11.   sub count {
  12.     $counter = $counter + 42;
  13.   }
  14.   sub logger {
  15.     my ($level, $msg) = @_;
  16.     if (open my $out, '>>', 'log.txt') {
  17.         chomp $msg;
  18.         print $out "$level - $msg\n";
  19.     }
  20.   }
复制代码
上面的代码会在log.txt文件中添加下面一行:
  1.   Use of uninitialized value in addition (+) at code_with_warnings.pl line 14.
复制代码
变量$counter和函数count()仅是产生警告示例的一部分。
警告处理函数中的警告信息
__WARN__在其处理函数执行过程中是自动被禁用的。所以在警告处理函数执行过程中产生的(新)警告信息不会导致无限循环。
你可以在perlvar文档中了解到更多细节。

Avoid multiple warnings

需要注意的是重复的警告信息可能会充斥日志文件。我可以使用一个简单的类似缓存的特性来减少重复警告信息的数量。
  1. #!/usr/bin/perl
  2.   use strict;
  3.   use warnings;
  4.   my %WARNS;
  5.   local $SIG{__WARN__} = sub {
  6.       my $message = shift;
  7.       return if $WARNS{$message}++;
  8.       logger('warning', $message);
  9.   };
  10.   my $counter;
  11.   count();
  12.   print "$counter\n";
  13.   $counter = undef;
  14.   count();
  15.   sub count {
  16.     $counter = $counter + 42;
  17.   }
  18.   sub logger {
  19.     my ($level, $msg) = @_;
  20.     if (open my $out, '>>', 'log.txt') {
  21.         chomp $msg;
  22.         print $out "$level - $msg\n";
  23.     }
  24.   }
复制代码
可以看到,我们把$counter变量赋值成undef,然后再次调用count()函数来产生同样的警告。
我们也把__WARN__的处理函数替换成一个稍微复杂的版本:
  1.   my %WARNS;
  2.   local $SIG{__WARN__} = sub {
  3.       my $message = shift;
  4.       return if $WARNS{$message}++;
  5.       logger('warning', $message);
  6.   };
复制代码
在调用logger之前,会检查一下当前字符串是否已经在%WARNShash表中。如果没有的话,会添加它并调用logger()。如果已经有了,就调用return,并不二次记录同样的事件。
你可能回忆起我们在unique values in an array也使用了同样的点子。
local是什么?
在上面所有的例子中,我使用local函数來局部化(警告处理)效果。严格来说,在这些例子中我们没有必要这么做,因为假设这些代码是主脚本的第一部分。这种情况下就无所谓了,毕竟是在全局作用域里面。
然而,最好是这么用。
local对于在模块中限制(对警告)的改变是很重要的。特别是要发布的模块。如果没有局部化,会影响整个应用程序。limit则会把影响限制在所在的闭合代码块里。
避免使用全局的%WARNS
如果你正在使用Perl 5.10或者更新的版本,你可以改写一下代码来替换掉全局变量%WARNS。要这么做的话,需在脚本的开头使用use v5.10;,然后在匿名函数内部使用state关键词来声明变量。
  1.   #!/usr/bin/perl
  2.   use strict;
  3.   use warnings;
  4.   use v5.10;
  5.   local $SIG{__WARN__} = sub {
  6.       state %WARNS;
  7.       my $message = shift;
  8.       return if $WARNS{$message}++;
  9.       logger('warning', $message);
  10.   };
复制代码

买目录提供泛目录、二级目录、租目录、出租网站建设资源、编程学习类,提供asp、php、asp.net、javascript、jquery、vbscript、dos批处理、网页制作、网络编程、网站建设等编程资料。
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则