关于log的一点设想

最近在写代码中，有一点想法，记录下来。

   这点想法就是log。 在系统维护中，才发现，log真是超级重要的工具，log记录的好，问题出在什么地方立刻就能确定；写的不好，就只能明白其中的意思，不知道具体的细节，还是需要翻看代码才能查明原因。差一点的，压根没有记录。但是最差的，是错误的log，修改代码的同时，没有修改log，造成南辕北辙，害人不浅啊。

    例如，在验证数据时，优秀的log会输出：

        【VERR02】BX validation ERROR,line 23

   其中VERR02是业务错误的编号，可以通过这个编号到文档中查找解释，后面的是解释，最后指明错误是在哪一行出现的。这样的log，可以说给系统维护带来了极大的方便。

   刚才提及log中的编号和错误地点记录，尤其是错误编号，实际上是对系统的一个要求，有点超出了log的范围，但是这是要在log中体现出来的。这种编号，也是优秀系统设计的标志，看看WAS下面的log，就能体会到。至于编号，则着实能体现程序人员的水平和素质。

  

   我心目中理想的log应该是这样的，方法级：

      

     function xx( param1，param2){

      

     ENTRY_LOG(param1,param2); 

      

     var result;

 

     //process...........

  

    STEP_LOG(STEP1);

     

    var condition1= xxx&yyy;

   

   CONDITION_LOG(condition1);

   

    if(param1=='xxx'){

 

      ///......

    }

   

 

    

      EXIT_LOG(param1,param2,result);

 

    }

 

   log写的好，少不了开发时多花功夫，不过考虑到后期的维护成本，这些功夫，还是值得的。

 

   一点想法，记录与此。

评论

1 楼 qgyang 2009-10-23  

深有同感！