SSM框架之Log4j配置

╰+攻爆jí腚メ 2021-11-09 08:18 366阅读 0赞

# 前言 #

--------------------

之前搭建SSM框架的时候我们曾经配置过**log4j.properties**文件，那么这个文件主要是干什么的呢？配置的格式有哪些？在本文中会进行相关的讲解。

# log4j.properties #

--------------------

什么是Log4j？

Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。**最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。**  
  所以简单的来说，Log4j可以理解为一个通过配置文件进行配置的日志操作工具。

这个文件干什么的？

我们都知道对一个web应用来说，日志是非常重要的。**log4j.properties**这个文件就是采用Log4j操作包完成日志部分的操作配置。

如何让SSM框架知道这个文件？

这是一个非常关键的问题，之前讲道我们采用配置Log4j来完成日志部分的操作，但是SSM框架是如何知道这个配置文件的存在并让它起作用呢？  
  在我们之间搭建的工程中**web.xml**文件有如下代码描述：

<context-param>
            <param-name>log4jConfigLocation</param-name>
            <param-value>classpath:log4j.properties</param-value>
        </context-param>

**这里就告诉了框架我们采用了Log4j配置，配置文件位置是classpath路径下的log4j.properties文件。**

这个文件配置的格式？

Log4j配置文件的基本格式如下：

#配置根Logger
    log4j.rootLogger = [level] , appenderName1 , appenderName2 , …
    #配置日志信息输出目的地Appender
    log4j.appender.appenderName  =  fully.qualified.name.of.appender.class 
    log4j.appender.appenderName.option1  =  value1 
    … 
    log4j.appender.appenderName.optionN  =  valueN 
    #配置日志信息的格式（布局）
    log4j.appender.appenderName.layout  =  fully.qualified.name.of.layout.class 
    log4j.appender.appenderName.layout.option1  =  value1 
    … 
    log4j.appender.appenderName.layout.optionN  =  valueN

对比我们之前的log4j.properties文件，我们讲解一下各部分的格式具体含义：

log4j.rootLogger=INFO,Console,File
    #控制台日志
    log4j.appender.Console=org.apache.log4j.ConsoleAppender
    log4j.appender.Console.Target=System.out
    log4j.appender.Console.layout=org.apache.log4j.PatternLayout
    log4j.appender.Console.layout.ConversionPattern=[%p][%t][%d{yyyy-MM-dd HH\:mm\:ss}][%C] - %m%n
    #普通文件日志
    log4j.appender.File=org.apache.log4j.RollingFileAppender
    log4j.appender.File.File=logs/ssm.log
    log4j.appender.File.MaxFileSize=10MB
    #输出日志，如果换成DEBUG表示输出DEBUG以上级别日志
    log4j.appender.File.Threshold=ALL
    log4j.appender.File.layout=org.apache.log4j.PatternLayout
    log4j.appender.File.layout.ConversionPattern=[%p][%t][%d{yyyy-MM-dd HH\:mm\:ss}][%C] - %m%n

首先对于基本格式中的**配置根Logger**这部分来说  
`log4j.rootLogger = [level] , appenderName1 , appenderName2 , …`  
  我们的**log4j.properties**文件相应内容如下：  
`log4j.rootLogger=INFO,Console,File`  
  其中**\[level\]**是日志输出级别分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。**比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。**  
  **appenderName**:就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。例如：`log4j.rootLogger=INFO,Console,File` 配置了2个输出地方，这个名字可以任意（如上面的Console和File）,但必须与我们在后面进行的设置名字对应。例如：`log4j.appender.Console`中的**Console** 和 `log4j.appender.File`中的**File**就是对应之前写的名称。

在看接下来**配置日志信息输出目的地Appender**和**配置日志信息的格式（布局）**的部分。  
  **Appender** 为日志输出目的地，Log4j提供的appender有以下几种：

org.apache.log4j.ConsoleAppender（控制台），
    org.apache.log4j.FileAppender（文件），
    org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
    org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
    org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

**Layout**为日志输出格式，Log4j提供的layout有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
    org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
    org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
    org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

那么，我们**log4j.properties**的内容是否不难理解了。

#控制台日志
    log4j.appender.Console=org.apache.log4j.ConsoleAppender
    log4j.appender.Console.Target=System.out
    log4j.appender.Console.layout=org.apache.log4j.PatternLayout
    log4j.appender.Console.layout.ConversionPattern=[%p][%t][%d{yyyy-MM-dd HH\:mm\:ss}][%C] - %m%n

**appenderName为Console的日志输出目的地为控制台，采用了可以灵活地指定布局模式的格式。**  
  至于其他的格式可以参考文章 [配置Log4j][Log4j]

# 总结 #

--------------------

> 到这里，关于SSM框架日志部分Log4j的配置讲解结束了。

以上就是我的分享，有收获的朋友们可以点个关注哦，如果想学习更多Java方面的知识可以进一下我的一个后端群，群里收集了很多Java架构资料，大家可以进群免费领取资料，群号：680075317，也可以进群一起交流，比如遇到技术瓶颈、面试不过的，大家一些交流学习！

[Log4j]: https://link.jianshu.com?t=http%3A%2F%2Fwww.blogjava.net%2FzJun%2Farchive%2F2006%2F06%2F28%2F55511.html