[发明专利]一种检测未判断日志输出级别而直接输出日志的方法

说明书

 

技术领域

本发明涉及计算机技术，具体地说是一种检测未判断日志输出级别而直接输出日志的方法，用于检测在j2ee软件应用中使用了Log4j的日志输出功能却未判断日志输出级别的问题。

背景技术

Log4j是广泛应用于j2ee应用的开源框架，用来输出j2ee应用运行过程中产生的日志，如果使用不当将对系统性能造成影响，并发量高、大数量时甚至会导致宕机的情况。具体应用错误的情况如下：输出日志时未先判断日志输出级别是否被允许输出，当该级别不允许输出时，在运行时，仍然会先构建传入方法内的作为输出内容的参数字符串，这个过程占用的CPU和内存资源是没有价值的。

现有技术中，仅能通过在运行环境中实际执行操作，然后再分析JVM内存的方式去发现使用Log4j框架时未判断日志输出级别而直接输出日志的问题，这种方式由于需要部署运行环境并要实际执行操作，所以会消耗更多的成本和更多的时间。而且，对于操作未执行到的语句无法找出它的问题，对于内存消耗不明显的语句也无法找出它的问题。

发明内容

本发明的技术任务是针对上述现有技术的不足，提供一种检测周期短、成本低的检测未判断日志输出级别而直接输出日志的方法。

本发明的技术任务是按以下方式实现的：一种检测未判断日志输出级别而直接输出日志的方法，包括以下步骤：

A、分析JAVA代码的类文件，遍历所有的命令代码，找出使用了Log4j日志输出级别判断的命令;

B、分析JAVA代码的类文件，遍历所有的命令代码，找出使用了Log4j框架输出日志功能的命令，并判断在调用前是否已经判断了日志输出级别。

进一步的，该方法包括以下步骤：

A、分析JAVA代码的类文件，遍历所有的命令代码，找出使用了Log4j日志输出级别判断的命令:

打开JAVA代码的类文件，逐条命令进行解析，找出Log4j日志输出级别判断的判定语句的语句块范围,

a1、若命令的操作码为IFEQ，说明该命令是一个判定语句，取得该命令的范围，该范围标明了判定语句开始执行的位置和结束的位置;

a2、若命令的操作码为INVOKEVIRTUAL，且执行的方法名为isDebugEnabled或isInfoEnabled或isEnabledFor，说明该命令调用了Log4j的日志输出级别判断的功能，取得该命令所处的位置，判断该命令是否处于判定语句块内，如果判断日志输出级别的语句处于判定语句块中，就记录下判定语句块的开始位置和结束位置;

a3、重复a1和a2的过程，将该类文件中所有已经调用了Log4j的日志输出级别判断的功能的判定语句块找出并记录语句块的开始位置和结束位置;

B、分析JAVA代码的类文件，遍历所有的命令代码，找出使用了Log4j框架输出日志功能的命令，并判断在调用前是否已经判断了日志输出级别:

打开JAVA代码的类文件，逐条命令进行解析，若符合以下所有条件，判定该命令使用了Log4j输出日志的功能：

该命令的操作码为INVOKEVIRTUAL;

操作类的类名为org.apache.Log4j.Logger;

执行的方法名为debug或info或error或fatal或warn;

如果判定结果为该命令使用了Log4j输出日志的功能，且该命令的位置大于A中记录的判定语句块的开始位置小于结束位置，则可认为它位于判定语句块内，可判定该处的日志输出已经提前进行了日志级别是否允许输出的判定，否则，可判定此处存在使用Log4j框架时未判断日志输出级别而直接输出日志的错误用法。

本发明的检测未判断日志输出级别而直接输出日志的方法与现有技术相比具有以下突出的有益效果：

（一）                   该方法采用的是全新的静态分析的方法，只需要源代码编译后的类文件，不需要运行环境，极大地降低了检测成本;

（二）                   开发人员编写完代码就可以检查他的代码是否存在使用Log4j框架时未判断日志输出级别而直接输出日志的问题，不需要发布到运行环境，也不需要人工去执行它，所以极大地降低了检测周期;

（三）                   可对所有的java类文件进行检测，检测时遍历了程序的所有命令，所以可以找出所有使用Log4j框架时未判断日志输出级别而直接输出日志的问题;