美文网首页
Log4j教程

Log4j教程

作者: Franck_ | 来源:发表于2019-10-24 15:00 被阅读0次

    Log4j是日志的实现包。用来记录日志。

    入门

    需要使用的话，首先引入包

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

    然后在src下创建一个log4j.properties配置文件。

    配置文件内容如下：

    log4j.rootLogger = debug,console

log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

    然后在方法里面这样写，就可以在控制台输出日志了.

    private Logger log = Logger.getLogger(当前类名.class);

private void test(){
  log.info("输出日志");
}

    ===============================================================

    整体结构

    可以将log4j的配置理解为三个部分：
    1 输出哪些信息(日志级别)到哪里去 :logger
    2 输出到哪里(输出目的地：控制台、文件等) : appender
    3 使用什么格式输出(输出格式) :layout

    对应成配置的话如下所示：

    #输出哪些信息到哪里去
log4j.rootLogger = 

 #日志输出源（输出方式）配置
log4j.appender.console = 
log4j.appender.console.layout =  #输出格式配置
log4j.appender.console.layout.ConversionPattern = #输出格式配置

    ===============================================================

    详细配置

    下面详细解释每个配置：

    根logger的语法如下：
    log4j.rootLogger = [level],appender1,appender2...

    首先要指明日志输出的等级，然后逗号，后面写输出源，有多个输出源的话，用逗号隔开。

    level ：

    log4j有7个日志等级。而且等级是有高低之分:
    OFF < FATAL < ERROR < WARN < INFO < DEBUG < ALL
    Log4j建议只使用四个级别 ：ERROR < WARN < INFO < DEBUG。配置后，只会输出比配置等级低的日志。例如配置为INFO的话，那么DEBUG级别的日志将不会输出。

    appenderName：

    配置需要输出日志的地方。可以配置多个，输出源的名字是自己取的。

    下面看就一个例子：

    #将DEBUG级别以下的日志，输出到A1,A2,A3这3个地方。
log4j.rootLogger =DEBUG,A1,A2,A3
    输出源配置

    输出源的配置形式如下，输出源的格式配置，也是输出源的配置之一：

    log4j.appender.输出目的地名称= 类名 #指定输出源的形式，常用类看解释
log4j.appender.输出目的地名称.属性1 = 值1
log4j.appender.输出目的地名称.属性2 = 值2
log4j.appender.输出目的地名称.属性N = 值N
#下面是配置输出源格式的形式：
log4j.appender.输出目的地名称.layout =  类名 #指定输出格式类,常用类看解释
log4j.appender.输出目的地名称.layout.属性1 = 值1
log4j.appender.输出目的地名称.layout.属性2 = 值2
log4j.appender.输出目的地名称.layout.属性N= 值N

    输出源的类名：可设值如下：

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

    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。
      另外，也可以指定按周、天、时、分等来滚动日志文件，对应的格式如下：
      '.'yyyy-MM：每月
      '.'yyyy-ww：每周
      '.'yyyy-MM-dd：每天
      '.'yyyy-MM-dd-a：每天两次
      '.'yyyy-MM-dd-HH：每小时
      '.'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.输出目的地名称.layout=类名
    类名：可设值如下：

    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平台为"\r\n"，Unix平台为"\n"。
    %x：输出和当前线程相关联的NDC(嵌套诊断环境)，尤其用到像java servlets这样的多客户多线程的应用中。
    %%：输出一个"%"字符。
    另外，还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如：

    c：指定输出category的名称，最小的长度是20，如果category的名称长度小于20的话，默认的情况下右对齐。
    2)%-20c："-"号表示左对齐。
    3)%.30c：指定输出category的名称，最大的长度是30，如果category的名称长度大于30的话，就会将左边多出的字符截掉，但小于30的话也不会补空格。

    附：Log4j比较全面的配置

    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

    附: 输出独立日志文件

    配置某个类输出到特定的日志，从整体的日志脱离，形成单独的日志文件。需要配置一个logger来写日志就可以了。

    
#cn.com.Test类
log4j.logger.com.Test= DEBUG, test
log4j.appender.test=org.apache.log4j.FileAppender
log4j.appender.test.File=${myweb.root}/WEB-INF/log/test.log
log4j.appender.test.layout=org.apache.log4j.PatternLayout
log4j.appender.test.layout.ConversionPattern=%d %p [%c] - %m%n

    这样配置的话， Test类里面的日志对象就应该这样获取。
    private static Log logger = LogFactory.getLog(Test.class);

    这样，相当于这个logger输出debug等级以上的日志，输出到名称为test的appender。
    如果希望只输出到test.log文件，而不输出到其他文件的话，需要设置这个logger不继承父logger的配置。默认所有logger都是rootLogger的子logger，默认都是继承根logger的。

    #不继承父logger，可以实现只在特定某个文件输出日志。
log4j.additivitycom.Test= false

    参考文章：
    Java日志体系(log4j)
    Log4j.properties配置详解

    相关文章

      网友评论

          本文标题：Log4j教程

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

          延伸阅读

          深度阅读

          • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

          栏目导航

          热点阅读

          关于我们|服务条款|联系我们|Log4j教程|投稿指南|网站地图|RSS订阅|排版工具|手机版

          提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

          Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

          备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

          本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

          所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！