spring使用Log4j

作者: 爱撒谎的男孩 | 来源:发表于2018-10-07 22:30 被阅读10次

    spring使用Log4j

    常用日志框架介绍

    • 转载自https://blog.csdn.net/liupeifeng3514/article/details/79624446

    • Log4j Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的,现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一;

    • Log4j 2 Apache Log4j 2是apache开发的一款Log4j的升级产品;

    • Commons Logging Apache基金会所属的项目,是一套Java日志接口,之前叫Jakarta Commons Logging,后更名为Commons Logging;

    • Slf4j 类似于Commons Logging,是一套简易Java日志门面,本身并无日志的实现。(Simple Logging Facade for Java,缩写Slf4j);

    • Logback 一套日志组件的实现(slf4j阵营);

    • Jul (Java Util Logging),自Java1.4以来的官方日志实现。

    日志切换

    • springBoot处切换

    添加依赖

            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.16</version>
            </dependency>
    

    日志配置

    日志的输出级别的设置

    ​ 1、OFF - FATAL - WARN - INFO - DEBUG - TRACE - ALL

    ​ 2、Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。 比如在这里定义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来。 程序会打印高于或等于所设置级别的日志,设置的日志等级越高,打印出来的日志就越少。 如果设置级别为INFO,则优先级高于等于INFO级别(如:INFO、WARN、 ERROR)的日志信息将可以被输出,小于该级别的如DEBUG将不会被输出。

    ## level:设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别,Log4j建议只使用中间四个级别。通过在这里设定级别,您可以控制应用程序中相应级别的日志信息的开关,比如在这里设定了INFO级别,则应用程序中所有DEBUG级别的日志信息将不会被打印出来。
    
    ## appenderName:就是指定日志信息要输出到哪里。可以同时指定多个输出目的地,用逗号隔开。例如:log4j.rootLogger=INFO,A1,B2,C3
    log4j.rootLogger=[level],appenderName1,appenderName2
    

    配置日志的输出地

    ​ 1、appenderName:自定义appderName,在log4j.rootLogger设置中使用;

    ​ 2、className:可设值如下:

    ​ (1) org.apache.log4j.ConsoleAppender(控制台)

    ​ (2) org.apache.log4j.FileAppender(文件)

    ​ (3) org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)

    ​ (4) org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)

    ​ (5) org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)

    log4j.appender.appenderName = className
    

    (1) ConsoleAppender选项:

    • Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
    • ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
    • Target=System.err:默认值是System.out。

    (2 )FileAppender选项:

    • Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
    • ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
    • Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
    • File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。

    (3) DailyRollingFileAppender选项:

    • Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
    • ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
    • Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
    • File=D:/logs/logging.log4j:指定当前消息输出到logging.log4j文件中。
    • DatePattern=’.’yyyy-MM:每月滚动一次日志文件,即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j,前一个月的日志文件名为logging.log4j.yyyy-MM。
      另外,也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:
      • 1)’.’yyyy-MM:每月
      • 2)’.’yyyy-ww:每周
      • 3)’.’yyyy-MM-dd:每天
      • 4)’.’yyyy-MM-dd-a:每天两次
      • 5)’.’yyyy-MM-dd-HH:每小时
      • 6)’.’yyyy-MM-dd-HH-mm:每分钟

    (4) RollingFileAppender选项:

    • Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
    • ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
    • Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
    • File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。
    • MaxFileSize=100KB:后缀可以是KB, MB或者GB。在日志文件到达该大小时,将会自动滚动,即将原来的内容移到logging.log4j.1文件中。
    • MaxBackupIndex=2:指定可以产生的滚动文件的最大数,例如,设为2则可以产生logging.log4j.1,logging.log4j.2两个滚动文件和一个logging.log4j文件。

    配置日志信息的输出格式(Layout)

    log4j.appender.appenderName.layout=className
    

    className:可设值如下:

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

    (1) HTMLLayout选项:

    • LocationInfo=true:输出java文件名称和行号,默认值是false。
    • Title=My Logging: 默认值是Log4J Log Messages。

    (2)PatternLayout选项:

    • ConversionPattern=%m%n:设定以怎样的格式显示消息。
    • 格式说明如下
    %p:输出日志信息的优先级,即DEBUG,INFO,WARN,ERROR,FATAL。
    %d:输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。
    %r:输出自应用程序启动到输出该log信息耗费的毫秒数。
    %t:输出产生该日志事件的线程名。
    %l:输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。例如:test.TestLog4j.main(TestLog4j.java:10)。
    %c:输出日志信息所属的类目,通常就是所在类的全名。
    %M:输出产生日志信息的方法名。
    %F:输出日志消息产生时所在的文件名称。
    %L:输出代码中的行号。
    %m:输出代码中指定的具体日志信息。
    %n:输出一个回车换行符,Windows平台为"rn",Unix平台为"n"。
    %x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
    %%:输出一个"%"字符。
    
    另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如:
    1) c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。
    2) %-20c:"-"号表示左对齐。
    3) %.30c:指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。
    

    Log4j比较全面的配置

    log4j.rootLogger=DEBUG,console,dailyFile,im
    log4j.additivity.org.apache=true
    # 控制台(console)
    log4j.appender.console=org.apache.log4j.ConsoleAppender
    log4j.appender.console.Threshold=DEBUG
    log4j.appender.console.ImmediateFlush=true
    log4j.appender.console.Target=System.err
    log4j.appender.console.layout=org.apache.log4j.PatternLayout
    log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    
    # 日志文件(logFile)
    log4j.appender.logFile=org.apache.log4j.FileAppender
    log4j.appender.logFile.Threshold=DEBUG
    log4j.appender.logFile.ImmediateFlush=true
    log4j.appender.logFile.Append=true
    log4j.appender.logFile.File=D:/logs/log.log4j
    log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
    log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    # 回滚文件(rollingFile)
    log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
    log4j.appender.rollingFile.Threshold=DEBUG
    log4j.appender.rollingFile.ImmediateFlush=true
    log4j.appender.rollingFile.Append=true
    log4j.appender.rollingFile.File=D:/logs/log.log4j
    log4j.appender.rollingFile.MaxFileSize=200KB
    log4j.appender.rollingFile.MaxBackupIndex=50
    log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
    log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    # 定期回滚日志文件(dailyFile)
    log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
    log4j.appender.dailyFile.Threshold=DEBUG
    log4j.appender.dailyFile.ImmediateFlush=true
    log4j.appender.dailyFile.Append=true
    log4j.appender.dailyFile.File=D:/logs/log.log4j
    log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
    log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
    log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    # 应用于socket
    log4j.appender.socket=org.apache.log4j.RollingFileAppender
    log4j.appender.socket.RemoteHost=localhost
    log4j.appender.socket.Port=5001
    log4j.appender.socket.LocationInfo=true
    # Set up for Log Factor 5
    log4j.appender.socket.layout=org.apache.log4j.PatternLayout
    log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    # Log Factor 5 Appender
    log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
    log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
    # 发送日志到指定邮件
    log4j.appender.mail=org.apache.log4j.net.SMTPAppender
    log4j.appender.mail.Threshold=FATAL
    log4j.appender.mail.BufferSize=10
    log4j.appender.mail.From = xxx@mail.com
    log4j.appender.mail.SMTPHost=mail.com
    log4j.appender.mail.Subject=Log4J Message
    log4j.appender.mail.To= xxx@mail.com
    log4j.appender.mail.layout=org.apache.log4j.PatternLayout
    log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    # 应用于数据库
    log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender
    log4j.appender.database.URL=jdbc:mysql://localhost:3306/test
    log4j.appender.database.driver=com.mysql.jdbc.Driver
    log4j.appender.database.user=root
    log4j.appender.database.password=
    log4j.appender.database.sql=INSERT INTO LOG4J (Message) VALUES('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')
    log4j.appender.database.layout=org.apache.log4j.PatternLayout
    log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    
    # 自定义Appender
    log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
    log4j.appender.im.host = mail.cybercorlin.net
    log4j.appender.im.username = username
    log4j.appender.im.password = password
    log4j.appender.im.recipient = corlin@cybercorlin.net
    log4j.appender.im.layout=org.apache.log4j.PatternLayout
    log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    

    Spring使用Log4j日志框架

    1、log4j框架指定日志输出文件只能使用绝对路径,但是我们的项目是跟着系统走的,因此我们需要将日志存放在项目的路径中,这样就需要获取到当前项目的路径,这里只需要在web.xml中添加一个Log4j的监听器即可实现,如下:

    <!-- 设置根目录,必须每个项目的值都不相同,否则将会发生冲突如果一个tomcat部署多个项目的话 -->
        <context-param>
            <param-name>webAppRootKey</param-name>
            <param-value>lifecrystal.root</param-value>
        </context-param>
        
        <!-- 指定log4j配置文件的位置,项目路径下 -->
        <context-param>
            <param-name>log4jConfigLocation</param-name>
            <param-value>classpath:log4j.properties</param-value>
        </context-param>
        
        <!-- 3000表示 开一条watchdog线程每60秒扫描一下配置文件的变化;这样便于日志存放位置的改变 -->
        <context-param>
            <param-name>log4jRefreshInterval</param-name>
            <param-value>3000</param-value>
        </context-param>
        
        <!-- 1、log4j监听器,将webAppRootKey设置的值加载到系统参数中,这样就可以在配置文件中引用项目的路径
             2、项目运行期间,每次改变配置文件中的值都会被监听到
         -->
        <listener>
            <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
        </listener>
    

    2、此时我们就可以在log4j.properties中使用${lifecrystal.root}获取到项目的路径,实际使用的就是System.getProperty()

    #LOG 输出级别和输出的地方,分别为Console和File,这里到值可以随意改变,但是在下文一定要和这里的一样
    log4j.rootLogger=DEBUG,Console,File
    
    #################################输出到控制台,级别为DEBUG#############################################
    #输出目的地方为控制台
    log4j.appender.Console=org.apache.log4j.ConsoleAppender
    ## 以system.out的格式输出,黑色的
    log4j.appender.Console.Target=System.out
    ## 只有在DEBUG的模式下才会在控制台输出
    log4j.appender.console.Threshold=DEBUG
    #在控制台输出的格式  
    log4j.appender.Console.layout = org.apache.log4j.PatternLayout
    log4j.appender.Console.layout.ConversionPattern=[%p]:[%c]:[%d{yyyy/MM/dd HH:mm:ss}] - %m%n
    
    
    #################################输出到文件中,级别为DEBUG#############################################
    
    #文件大小到一定尺寸产生一个新文件
    log4j.appender.File = org.apache.log4j.RollingFileAppender
    #指定输出目录
    log4j.appender.File.File = ${lifecrystal.root}/logs/debug/logs.log
    #定义文件最大大小
    log4j.appender.File.MaxFileSize = 1000MB
    #DEBUG 日志
    log4j.appender.File.Threshold = DEBUG
    log4j.appender.File.layout = org.apache.log4j.PatternLayout
    log4j.appender.File.layout.ConversionPattern =[%p] [%d{yyyy-MM-dd HH\:mm\:ss }][%c]%m%n
    
    
    
    
    ##################################Mybatis的sql语句的输出,DEBUG级别#####################################################
    log4j.logger.com.ibatis=DEBUG log4j.logger.com.ibatis.common.jdbc.SimpleDataSource=DEBUG 
    log4j.logger.com.ibatis.common.jdbc.ScriptRunner=DEBUG
    log4j.logger.com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate=DEBUG
    log4j.logger.java.sql.Connection=DEBUG log4j.logger.java.sql.Statement=DEBUG 
    log4j.logger.java.sql.PreparedStatement=DEBUG
    

    3、在方法中使用Log4j调试一些内容,如下:

    @Controller
    public class TestController {
        private static Logger logger=Logger.getLogger(TestController.class);   //获取Logger对象
        
        @RequestMapping("/test/test")
        @ResponseBody
        public String test(){
            System.out.println("这个是测试方法");
            
            logger.debug("debug信息");
            logger.info("info信息");
            
            logger.error("这个是error级别的信息");
            System.out.println(10/0);
            
            return "test";
        }
    }
    

    参考文章

    1、https://blog.csdn.net/qq_35029429/article/details/78826936

    相关文章

      网友评论

        本文标题:spring使用Log4j

        本文链接:https://www.haomeiwen.com/subject/havraftx.html