简化PL/SQL调试的记录一致性错误日志

dn001 2007-12-01 22:04:56

从事Oracle数据库方面的工作已有一年有余了，我最喜欢的部分是PL/SQL。这是Oracle的数据可编程语言，使用它可以将过程化代码与SQL代码结合在一起。

最令人喜欢的是我们可以使用它在一个地方开发整个应用。所有的数据选择和更新，所有与LDAP交互的HTTP和HTML输出，以及其它所有事情都可以使用一种语言在一个地方完成。

但是其缺点是应用程序十分复杂。因为PL/SQL代码中的一个特定过程或函数可能要完成上面诸多任务中的任何一个，这样当出现问题时，调试查找错误变得十分困难。

这是数据库的问题，还是使用LDAP时HTTP的问题？问题在哪里?在每个PL/SQL项目中我喜欢使用一种简单的错误日志记录机制，这样当出现问题时，我有一个可以查看的简单数据表来跟踪所有错误。

我通过构建一个日志数据表开始介绍：

CREATE TABLE ERRORLOG
(
IDNUMBERNOT NULL,
TIMEDATENOT NULL,
CODEVARCHAR2(9 BYTE)NOT NULL,
MESSAGEVARCHAR2(2000 BYTE)NOT NULL,
PACKAGE_NAMEVARCHAR2(100 BYTE),
PROCEDURE_NAMEVARCHAR2(100 BYTE)NOT NULL,
LOCATIONNUMBER,
PARAMETERSVARCHAR2(4000 BYTE)
);

与其它大多数数据库不同，Oracle中没有内置的用于对ID自动增加的字段域。所以，我们需要创建一个序列，然后添加某些机制实现在一个新值插入时赋予一个序列值。下面是我们的序列：

CREATE SEQUENCE ERRORLOG_ID_SEQ
MINVALUE 1
MAXVALUE 999999999999999999999999999
INCREMENT BY 1
START WITH 1
CACHE 20
NOORDER
NOCYCLE ;

我们可以使用触发器插入时间戳，我们稍后会在提供日志接口的包中实现。该触发器完成的操作是利用我们上面创建的序列递增ID域。

CREATE OR REPLACE TRIGGER T_ERRORLOG_BI
BEFORE INSERT
ON ERRORLOG
REFERENCING OLD AS OLD NEW AS NEW
FOR EACH ROW
begin
if :new.id is null then
select errorlog_id_seq.nextval
into :new.id
from dual;
end if;
end t_errorlog_bi;

在实际应用中对数据表提供一个主键是十分有益的。我知道我们可以在创建表格时设定主键，但是我喜欢以后单独完成这项工作。我不知道为什么，只是感觉这样做更清楚一些。

ALTER TABLE ERRORLOG ADD (PRIMARY KEY (ID));

PL/SQL是基于古老的Ada程序设计语言的，因此在创建一个包时，需要提供两部分：规格说明（接口）部分和主体部分接口的真正实现。对于我们简单的错误日志记录包，规格说明部分只提供一个单一过程：

CREATE OR REPLACE package pkg_error is
procedure log (p_error_code errorlog.code%type,
p_error_message errorlog.message%type,
p_package errorlog.package_name%type default null,
p_procedure errorlog.procedure_name%type,
p_location errorlog.location%type default null,
p_parameters errorlog.parameters%type default null);
end pkg_error;

在主体部分，可以包含任意多个你想要的过程和函数。至少，它必须实现规格说明中的过程和函数。在本例中，包的主体部分只实现规格说明中的一个过程：

CREATE OR REPLACE package body pkg_error is
procedure log (p_error_code errorlog.code%type,
p_error_message errorlog.message%type,
p_package errorlog.package_name%type default null,
p_procedure errorlog.procedure_name%type,
p_location errorlog.location%type default null,
p_parameters errorlog.parameters%type default null) is
pragma autonomous_transaction;
begin
insert
into errorlog
(time,
code,
message,
package_name,
procedure_name,
location,
parameters)
values (sysdate,
p_error_code,
p_error_message,
p_package,
p_procedure,
p_location,
p_parameters);
commit;
end log;
end pkg_error;

其中pragma autonomous_transaction部分是十分重要的，因为你保证log方法能够将日志数据提交到数据表中，否则要提交过程中导致错误发生的任何相关信息。这就是pragma段完成的功能。它告诉Oracle将该过程作为原子操作，不能影响早期调用堆栈中的任何信息。

当然最后一步是将日志信息应用到代码中。例如，比如说你有一个简单的小函数，并且无论何时发生异常，你都希望能够记录它且还要避免再次发生错误。换句话说，记录错误并使应用能够继续运行。你可能需要做以下工作：

CREATE OR REPLACE FUNCTION hello_world RETURN VARCHAR2 IS
v_ procedure errorlog.procedure_name%TYPE default 'hello_world';
v_ location errorlog.location%TYPE;
BEGIN
v_location := 1000;
return ('hello, world');
EXCEPTION
when others then
pkg_error.log(p_error_code => substr(sqlerrm,1,9),
p_error_message => substr(sqlerrm,12),
p_package => 'FUNCTION',
p_procedure => v_procedure,
p_location => v_location);
END;

很明显，如果是在包内，你需要根据你创建的包的实际名称创建一个全局变量，并将它传递给p_package参数替代我们此处使用的字符串常量。

这非常相似，我并不想说这是PL/SQL中记录错误的最好方法。我从事这方面的工作只有一年多，所以无论如何我都不是一个专家。

但是这种记录方法使得调试我的应用程序变得十分简单。如果出现某个错误，我们会有一个所有出错过程和函数的记录，因此，我们可以很快追踪问题的根源。