log4j的基本使用详解

清疚 2022-08-22 04:45 165阅读 0赞

# Log4j的基本使用方法 #

log4j由三个重要的组件组成：日志信息的优先级（Logger）、日志信息的输出目的地（Appender）、日志信息的输出格式（Layout）。日志信息的优先级从高到低有ERROR、WARN、INFO、DEBUG等，分别指定日志信息的重要程度。日志信息的输出目的地指定了日志将打印到控制台还是日志文件中。而输出格式则控制了日志信息的显示内容和格式。

> ## 一.  Log4j的配置：有三种    ##

### 1. 配置文件.properties    ###

> 先给出一个配置文件的示例，然后再详解  
> 
> 
>     ###  配置根Logger  ###
>     log4j.rootLogger = debug,stdout,D,E
>     
>     ### 输出信息到控制抬 ###
>     log4j.appender.stdout = org.apache.log4j.ConsoleAppender
>     log4j.appender.stdout.Target = System.out
>     log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
>     log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
>     
>     ### 输出DEBUG 级别以上的日志到=E://logs/error.log ###
>     log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
>     log4j.appender.D.File = E://logs/log.log
>     log4j.appender.D.Append = true
>     log4j.appender.D.Threshold = DEBUG 
>     log4j.appender.D.layout = org.apache.log4j.PatternLayout
>     log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
>     
>     ### 输出ERROR 级别以上的日志到=E://logs/error.log ###
>     log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
>     log4j.appender.E.File =E\://logs/error.log 
>     log4j.appender.E.Append = true
>     log4j.appender.E.Threshold = ERROR 
>     log4j.appender.E.layout = org.apache.log4j.PatternLayout
>     log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH\:mm\:ss}  [ %t\:%r ] - [ %p ]  %m%n
> 
> 1. 配置根Logger，其语法为：
> 
>     log4j.rootLogger = [ level ] , appenderName, appenderName, …
> 
>         其中：level是日志的优先级，分为分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 appenderName就是指B日志信息输出到哪个地方。您可以同时指定多个输出目的地。
> 
> 2. 配置日志信息的输出目的地Appender,其语法为：
> 
>     log4j.appender.appenderName = fully.qualified.name.of.appender.class  
>         log4j.appender.appenderName.option1 = value1  
>         ……
>         log4j.appender.appenderName.option = valueN
> 
> > 其中：Log4j提供支持的Appender有如下几种：
> 
>     org.apache.log4j.ConsoleAppender（控制台），  
>         org.apache.log4j.FileAppender（文件），  
>         org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），  
>         org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），  
>         org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
> 
>          每个 Appender 对象都有不同的属性，这些属性决定了该对象的行为。
> 
> <table> 
>  <tbody> 
>   <tr> 
>    <th style="width:25%">属性</th> 
>    <th>描述</th> 
>   </tr> 
>   <tr> 
>    <td>layout</td> 
>    <td>Appender 使用 Layout 对象和与之关联的模式来格式化日志信息。</td> 
>   </tr> 
>   <tr> 
>    <td>target</td> 
>    <td>目的地可以是控制台、文件，或依赖于 appender 的对象。</td> 
>   </tr> 
>   <tr> 
>    <td>level</td> 
>    <td>级别用来控制过滤日志信息。</td> 
>   </tr> 
>   <tr> 
>    <td>threshold</td> 
>    <td>Appender 可脱离于日志级别定义一个阀值级别，Appender 对象会忽略所有级别低于阀值级别的日志。</td> 
>   </tr> 
>   <tr> 
>    <td>filter</td> 
>    <td>Filter 对象可在级别基础之上分析日志信息，来决定 Appender 对象是否处理或忽略一条日志记录。</td> 
>   </tr> 
>  </tbody> 
> </table>
> 
>   
> 
> 
> 3. 配置日志信息的格式（Layout），其语法为：
> 
>     log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class  
>         log4j.appender.appenderName.layout.option1 = value1  
>         …  
>         log4j.appender.appenderName.layout.option = valueN
> 
> > 其中：Log4j提供的layout类有以下几种：
> 
>     org.apache.log4j.HTMLLayout（以HTML表格形式布局），  
>         org.apache.log4j.PatternLayout（可以灵活地指定布局模式），  
>         org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），  
>         org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
> 
> > Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息
> 
>     %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL  
>         %r 输出自应用启动到输出该log信息耗费的毫秒数  
>         %c 输出所属的类目，通常就是所在类的全名  
>         %t 输出产生该日志事件的线程名  
>         %n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”  
>         %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921  
>         %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

### 2. 通过java代码    ###

> 暂时没用到就不讲了。  
>

### 3. 通过.xml文件    ###

> 暂时没用到就不讲了。  
>

> ## 二. 在代码中使用Log4j ##

### 方法1. 直接在src目录下配置.properties文件： ###

> 这时系统会默认读取该目录（src/）下的配置文件，所以不需要我们手动的载入配置文件路径。只需要获取Logger就行：  
>

>     private static Logger logger = Logger.getLogger(TestLog.class);
> 
>   
> 下面就可以使用logger打印日志了。  
>

### 方法2. .properties文件放在我们自定义的包里面： ###

> 如下如所示：我把.properties文件 放在我自定义的src/config下：
> 
> ![Center][]
> 
> 这时就需要我们自己手动的载入配置文件，代码如下：
> 
>     //1.得到记录器
>     	private static Logger logger = Logger.getLogger(TestLog.class);
>     //2. 读取配置文件
>             //自动快速地使用缺省 Log4j 环境。
>     	BasicConfigurator.configure();
>             //读取使用 Java 的特性文件编写的配置文件。
>     	PropertyConfigurator.configure("./src/config/log4j.properties");
> 
>   
>

[Center]: /images/20220722/5f9dcf41997949238603a4f7c467971e.png