log4j 日志

https://blog.csdn.net/qq_37733625/article/details/79046227

1.为什么要使用log4j?

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。 
不管是使用何种编程语言，日志输出几乎无处不再。总结起来，日志大致有以下几种用途： 
l 问题追踪：通过日志不仅仅包括我们程序的一些bug，也可以在安装配置时，通过日志可以发现问题。

l 状态监控：通过实时分析日志，可以监控系统的运行状态，做到早发现问题、早处理问题。

l 安全审计：审计主要体现在安全上，通过对日志进行分析，可以发现是否存在非授权的操作。

2.log4j日志级别

• OFF：这是最高等级，为了关闭日志记录
• FATAL：指定非常严重的错误事件，这可能导致应用程序中止
• ERROR：错误信息（错误事件可能仍然允许应用程序继续运行）
• WARN：警告信息（指定具有潜在危害的情况）
• INFO：一般信息（指定能够突出在粗粒度级别的应用程序运行情况的信息的消息）
• DEBUG：调试信息（指定细粒度信息事件是最有用的应用程序调试） TRACE：指定细粒度比DEBUG更低的信息事件
• ALL：各级包括自定义级别

上面是从高到低的顺序，一般情况下只用ERROR,WARN,INFO,DEBUG这四种级别

3.配置文件

配置文件共有两种方式：log4j.xml格式和log4j.properties 
3.1 xml配置文件

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <!-- Appenders -->
    <!-- 每个ConsoleAppender都有一个target，表示它的输出目的地。 -->  
    <!-- 它可以是System.out，标准输出设备（缓冲显示屏） -->  
    <!-- 或者是System.err，标准错误设备（不缓冲显示屏） -->
    <appender name="console" class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%5p [%t] %d [%c] (line %L) - %m%n" />
        </layout>
    </appender>

    <!-- system default log file -->
    <!-- appender元素定义一个日志输出目的地 -->
    <!-- file 是文件的保存路径，我这里设置的是每天生成一个log文件 -->
    <!-- 当天生成的是log文件，第二天将会把前一天的log改成log_当天日期.log -->
    <!-- DatePattern设置每天保存一个.log文件 -->
    <!-- Append追加 设置true则是在原来的log文件中追加 false则是覆盖原来文件 -->
    <!-- layout 日志内容的布局 一般都使用PatternLayout -->
    <appender name="default" class="org.apache.log4j.DailyRollingFileAppender">
        <!-- 相对路径注意要配置tomcat环境变量 -->
        <param name="File" value="${catalina.base}/logs/log" />
        <param name="DatePattern" value="'_'yyyy-MM-dd'.log'" />
        <param name="Append" value="true" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="%5p [%t] %d{yy-MM-dd HH:mm:ss} %c{1} (line %L) - %m%n" />
        </layout>
        <!-- 过滤器设置输出的级别当前生成的log文件级别最高只能达到root设置的级别 -->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="levelMin" value="debug" />
            <param name="levelMax" value="warn" />
            <param name="AcceptOnMatch" value="true" />
        </filter>
    </appender>

    <!-- Application Loggers -->
    <!-- 自定义的一个logger -->  
    <!-- additivity 这个默认是true，即继承父类 root logger -->  
    <!-- 也就是说，你的这个日志也会在root的logger里面输出的，配置false，就是不继承，各走各的。 -->  
    <!-- appender-ref 也就是说这个logger的输出目的地是哪里，ref就是关联到上面声明的一个file，一个console --> 
    <logger name="org.springframework" additivity="false">
        <level value="error" />
        <appender-ref ref="">
    </logger>

    <!-- Root Logger -->
    <!-- 输出级别是info级别及以上的日志，下面的ref关联的两个appender，info及以下级别的日志都是会输出到这2个appender的 -->  
    <root>
        <priority value="info" />
        <appender-ref ref="console" />
        <appender-ref ref="default" />
    </root>

</log4j:configuration>

log4j.xml配置到web.xml

    <!-- log4j -->
    <context-param>
        <param-name>log4jConfigLocation</param-name>
        <param-value>classpath:log4j.xml</param-value>
    </context-param>
    <context-param>
        <param-name>log4jRefreshInterval</param-name>
        <param-value>3000</param-value>
    </context-param>
    <!-- 先开启Log4J,再去启动spring等一些你需要的东西，有助于报错时日志的输出 -->
    <listener>
        <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
    </listener>

3.2 log4j.properties配置文件

# 设置 
# 第一个参数debug这里是日志的级别
# 后面的则是appender每个日志文件
log4j.rootLogger = debug,stdout,D,log

# 控制台输出
# Target则是输出设备
# layout日志布局
# ConversionPattern日志输出的格式
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级别  
log4j.appender.log=org.apache.log4j.DailyRollingFileAppender  
# 设置文件输出路径，文本文件    
log4j.appender.log.file={catalina.base}/logs/log  
# 设置每天生成日志文件
# 当天生成的是log文件，第二天将会把前一天的log改成log_当天日期.log
log4j.appender.log.DatePattern='_'yyyy-MM-dd'.log '   
# 追加 设置true则在原来的log文件中追加 false覆盖原来的log文件
log4j.appender.D.Append = true
# 设置当前log文件的日志级别
# 最高允许root下设置的级别
log4j.appender.D.Threshold = DEBUG 
# 日志文件的布局  
log4j.appender.log.layout=org.apache.log4j.PatternLayout
# 日志文件的输出格式  
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

log4j配置到web.xml

   <servlet>  
    <servlet-name>log4j-init</servlet-name>  
    <servlet-class>com.xmh.servlet.Log4j.Log4jInit</servlet-class>  
    <init-param>  
        <param-name>log4j-init-file</param-name>  
        <param-value>log4j.properties</param-value>  
    </init-param>  
    <load-on-startup>1</load-on-startup>  
</servlet>  

4.配置log的输出地

Log4j提供以下几种：

• org.apache.log4j.ConsoleAppender（控制台）

• org.apache.log4j.FileAppender（文件）

• org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

• org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

• org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

5.配置log的布局

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

6.log格式中符号代表的含义

• -X号: X信息输出时左对齐；
• %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
• %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格 式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
• %r: 输出自应用启动到输出该log信息耗费的毫秒数
• %c: 输出日志信息所属的类目，通常就是所在类的全名
• %t: 输出产生该日志事件的线程名
• %l: 
  输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main 
  (TestLog4.java:10)
• %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
• %%: 输出一个”%”字符
• %F: 输出日志消息产生时所在的文件名称
• %L: 输出代码中的行号
• %m: 输出代码中指定的消息,产生的日志具体信息
• %n: 输出一个回车换行符，Windows平台为”/r/n”，Unix平台为”/n”输出日志信息换行
• 可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如： 
  1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。 
  2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，”-“号指定左对齐。 
  3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。 
  4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边较远输出的字符截掉。