细说log4j

可能做过java项目的基本上都是用过log4j,它是用来做java日志的。比如我们做一个项目分为很多的模块,那我们怎么想要知道它什么时候启动了,这时候我们可以使用log4j标记某某模块启动了。

努力的人绝对不会成为落后的标兵,加油!废话不多说,进入log4j。

一、log4j简介

1.1、log4j概述

  log for java(java日志)

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

  其他日志组件:JDK Logger、Monolog、JTraceDump、Commons Logging等

1.2、作用

  lg4j用来做java日志

1.3、log4j的特点和优点 

  1)可以控制日志信息输送的目的地是控制台、文件、GUI组件,甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等。   2)可以控制每一条日志的输出格式   3)可以更加细致地控制日志的级别   4)以上三点通过一个配置文件来地进行配置   5)Log4j其他语言接口,您可以在C、C++、.Net、PL/SQL程序中使用Log4j,其语法和用法与在Java程序中一样,使得多语言分布式系统得到一个统一一致的日志组件模块。   6)通过使用各种第三方扩展,您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。

二、log4j的使用

环境:IntelliJ IDEA、log4j-1.2.17.jar

  1)在项目的根目录下创建一个conf用来存放配置文件,创建一个lib目录用来存放jar包

  log4j.properties:             

             #日志级别,appender的名字

  2)创建一个类TestLog4j_0010,在main方法中写:

        PropertyConfigurator.configure("conf/log4j.properties");
        Logger logger = Logger.getRootLogger();
        logger.debug("debug message");
        logger.info("info message");
        logger.warn("warn message");
        logger.error("error message");     

  3)结果

    好奇的宝宝,想问为什么debug的打印没有输出呢?接下来我们就来研究研究。

三、日志级别 

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

  级别大小顺序:ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF

四、配置文件详解

Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的,它可接key=value格式的设置或xml格式的设置信息。通过配置,可以创建出Log4J的运行环境。

Log4j支持两种配置文件格式,一种是XML(标准通用标记语言下的一个应用)格式的文件,一种是Java特性文件log4j.properties(键=值)。

下面将介绍使用log4j.properties文件作为配置文件的方法:

4.1、配置根Logger

  Logger 负责处理日志记录的大部分操作   其语法为:

log4j.rootLogger = [ level ] , appenderName, appenderName, …

  其中,level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。 Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。   比如在这里定义了INFO级别,只有等于及高于这个级别的才进行处理,则应用程序中所有DEBUG级别的日志信息将不被打印出来。   ALL:打印所有的日志,OFF:关闭所有的日志输出。 appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。

4.2、配置日志信息输出目的地 Appender

  Appender 负责控制日志记录操作的输出   其语法为:

log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN

  这里的appenderName为Appender类的实例,可任意起名。

  4.2.1、Log4j提供的appender有以下几种

  1)org.apache.log4j.ConsoleAppender

     输出到控制台   继承WriterAppender

  2)org.apache.log4j.FileAppender

     输出到文件 继承WriterAppender

  3)org.apache.log4j.DailyRollingFileAppender

     输出到文件(每日一个日志文件) 继承FileAppender

  4)org.apache.log4j.RollingFileAppender

     输出到文件(日志文件达到指定大小后创建新的日志文件,默认10MB)  继承FileAppender

    可通过log4j.appender.R.MaxFileSize=100KB设置文件大小,还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件

  5)org.apache.log4j.WriterAppender

    将日志信息以流格式发送到任意指定的地方

  还有很多的Appender:   

  JDBCAppender 输出到数据库
  JMSAppender 输出到JMS服务器
  SMTPAppender 输出到SMTP服务器
  SocketAppender 输出到网络套接字
  SocketHubAppender   
  SyslogAppender
  TelnetAppender
  ............. 

  看它的set方法就知道怎么配置了,就可以给它设置相应的选项

  4.2.2、Appender的配置 

  1)输出端共同选项 Threshold=WARN:指定日志消息的输出最低级别。(这是指定的是appender的日志级别) ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出   2)ConsoleAppender选项

Target=System.err:默认情况下是:System.out,指定输出控制台   3)文件输出端共同选项 File=mylog.txt:指定消息输出到mylog.txt文件。  Append=false:默认值是true,     即将消息增加到指定文件中,     false指将消息覆盖指定的文件内容。   4)DailyRollingFileAppender 选项 DatePattern=yyyy-ww:每周滚动一次文件,     即每周产生一个新的文件。     当然也可以指定按月、周、天、时和分。     即对应的格式如下:       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: 每分钟

  5)RollingFileAppender 选项 MaxFileSize=100KB:     后缀可以是KB, MB 或者是 GB.     在日志文件到达该大小时,将会自动滚动,     即将原来的内容移到mylog.log.1文件。 MaxBackupIndex=2:     指定可以产生的滚动文件的最大数。

4.3、配置日志信息的格式(布局)Layout

  Layout 负责格式化Appender的输出

  其语法为:  

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN

  4.3.1、log4j提供的layout有以下几种 

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

  4.3.2、org.apache.log4j.PatternLayout

  log4j.appender.stdout.layout.ConversionPattern= [%p] %d{yyyy年M月dd日 HH:mm:ss,SSS} method:%l%m%n   如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern,具体参数:     %m 输出代码中指定的消息     %p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL     %r 输出自应用启动到输出该log信息耗费的毫秒数     %c 输出所属的类目,通常就是所在类的全名     %t 输出产生该日志事件的线程名     %n 输出一个回车换行符,Windows平台为"\r\n”,Unix平台为"\n”     %d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy MM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921   %l 输出日志事件的发生位置,       包括类目名、发生的线程,以及在代码中的行数。     %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。     %%: 输出一个”%”字符     %F: 输出日志消息产生时所在的文件名称     %M: 输出执行方法     %L: 输出代码中的行号   可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如:     1) c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。     2)%-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,”-”号指定左对齐。     3)%.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。     4) .30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边交远销出的字符截掉。       [APPName]是log信息的开头,可以为任意字符,一般为项目简称。

五、程序中使用log4j

5.1、加载配置文件 

DOMConfigurator.configure("conf/log4j.xml");
PropertyConfigurator.configure("conf/log4j.properties");

  加载顺序:  

    1)加载本工程中src下的配置文件(xml,properties)。名字不能改变,不然就不能自动加载了     2)加载jar 包中的配置文件(jar包中一般没有配置文件)     3)加载系统类路径的配置文件

5.2、获取Logger

获取根logger
Logger logger = Logger.getRootLogger();

Logger logger = Logger.getLogger()
Logger logger = LogManager.getLogger()

  我们在配置文件中加上,可以自定义logger

#自定义logger可以是一个类名,也可以是一个字符串
#log4j.logger.com.zyh.log4j.TestLog4_0010=INFO,stdout

#这个我们的自定义logger的消息要不要发送给rootLogger
log4j.additivity.definelogger=false

5.3、日志信息 

      logger.trace("This is trace message.");// 记录trace级别的信息     
        logger.debug("This is debug message.");   // 记录debug级别的信息        
        logger.info("This is info message."); // 记录info级别的信息        
        logger.warn("This is warn message."); // 记录warn级别的信息  
        logger.error("This is error message.");// 记录error级别的信息         
        logger.fatal("This is fatal message."); // 记录fatal级别的信息      

5.4、获取message的详细过程 

  1)logger.info(message);   2)logger对象会把message封装成loggingEvent(封装了很多东西)   3)按照配置(logger的日志级别)进行过滤   4)把剩下的日志信息交给appender   5)按照配置(appender的日志级别)进行过滤   6)如果需要layout的话,把日志交给layout进行格式化   7)输出到相应的位置

六、log4j进阶之自定义appender

6.1、步骤详解

  1)扩展 AppenderSkeleton 抽象类。如果是通过流方式实现读写数据的话,自定义appender可以从WriterAppender继承,     这样只需要把我们自己的OutputStream连接到WriterAppender.qw上就可以了。更方便快捷。   2)指定您的 appender 是否需要 layout。这个由requiresLayout()方法确定。   3)如果某些属性必须同时激活,则应该在 activateOptions() 方法内完成。该方法上在Appender的构造函数之后被调用的。   4)实现 close() 方法。它必须把 closed 字段的值设置为 true 。记得释放所有资源。   5)可选地指定要使用的默认 ErrorHandler 对象。系统默认为OnlyOnceErrorHandler,     它发送出第一个错误的消息并忽略其余的所有错误,错误消息将输出到 System.err。   6)编写 append() 方法的代码。这个方法负责附加日志记录事件,并在错误发生时负责调用错误处理程序。     我们主要的日志记录等处理任务实际上是在该append()方法内完成的。

6.2、实战

  1)TestLog4_0011.java

package com.zyh.log4j;

import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;

public class TestLog4_0011 {
    public static void main(String[] args) {
        PropertyConfigurator.configure("conf/log4jdefine.properties");
        Logger logger = Logger.getRootLogger();
        logger.info("meinv");
        logger.error("shuaige");
    }
}

  2)log4jdefine.properties或log4j.xml

log4j.rootLogger = DEBUG,stdout

log4j.appender.stdout = com.zyh.log4j.MyAppender
log4j.appender.stdout.Target = System.err
log4j.appender.stdout.File=logs/definelog.txt
log4j.appender.stdout.Threshold = DEBUG
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%m%n


#这里创建两个MyAppender会出现空指针异常原因在创建第一个的时候out对象并没有创建
#log4j.appender.stdfile = com.zyh.log4j.MyAppender
#log4j.appender.stdfile.File=logs/definelog.txt
#log4j.appender.stdfile.Threshold = DEBUG
#log4j.appender.stdfile.layout = org.apache.log4j.PatternLayout
#log4j.appender.stdfile.layout.ConversionPattern = [%p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%m%n
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>
<appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n"/>
</layout>
</appender>
<appender name="RollingFileAppender" class="org.apache.log4j.RollingFileAppender">
<param name="Append" value="true"/>
<param name="File" value="logs/xml.log"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n"/>
</layout>
</appender>
<!-- 
<appender name="JDBCAppender" class="org.apache.log4j.jdbc.JDBCAppender">
<param name="URL" value="jdbc:oracle:thin:@127.0.0.1:1521:mumu"/>
<param name="user" value="liulibo"/> 
<param name="password" value="liulibo"/> 
<param name="driver" value="oracle.jdbc.driver.OracleDriver"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="insert into log4j(createdate,thread,level_,class,message) values(\'%d\',\'%t\',\'%-5p\',\'%c\',\'%m\')"/>
</layout>
</appender>
 -->
<root>
<priority value ="debug" />
<appender-ref ref="ConsoleAppender"/>
<appender-ref ref="RollingFileAppender"/>
<!--   <appender-ref ref="JDBCAppender"/> -->
</root>
</log4j:configuration>

 3)MyAppender.java

package com.zyh.log4j;

import org.apache.log4j.AppenderSkeleton;
import org.apache.log4j.spi.LoggingEvent;

import java.io.*;

/**
 * Created by Shinelon on 2017-9-26.
 */
public class MyAppender extends AppenderSkeleton {
    private OutputStream target;
    private OutputStream out;


    @Override
    protected void append(LoggingEvent loggingEvent) {
        String log = "zyh----"+getLayout().format(loggingEvent);
        try {
            byte[] bytes = log.getBytes();
            target.write(bytes);
            out.write(bytes);
            target.flush();
            out.flush();
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

    public void setTarget(String target) {
        if (target.equals("System.out")){
            this.target = System.out;
        }else if(target.equals("System.err")){
            this.target = System.err;
        }
    }

    public void setFile(String path) {
        System.out.println(path);
       /* File f = new File(path);
        if(f.exists()){
            if (f.isDirectory()){
                path=path+"/definelog.log";
            }else {
                int i = path.lastIndexOf("/");
                String dir = path.substring(i);
                File df = new File(dir);
                df.mkdirs();
            }
        }*/
        try {
            out = new FileOutputStream(path);
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        }
    }


    @Override
    public void close() {
        closed = true;
        //这里我们不能关闭流,因为这样只会输出一条日志
//        try {
//            target.close();
//        } catch (IOException e) {
//            e.printStackTrace();
//        }
    }

    @Override
    public boolean requiresLayout() {
        return true;
    }
}

七、log4j 与 log4j 2 的不同

依赖包: log4j: log4j-1.2.17.jar log4j 2: log4j-api-2.9.0.jar、log4j-core-2.9.0.jar

配置文件: log4j: 采用properties的文件作为主配置文件,(xml也可以) log4j 2: 采用xml,json或者jsn这种文件作为主配置文件

默认配置文件: log4j的配置文件名是log4j.xml或者是log4j.properties, log4j2的配置文件名是log4j2.xml

使用: log4j: import org.apache.log4j.Logger; private final Logger LOGGER = Logger.getLogger(Test.class.getName());

import org.apache.logging.log4j.Level; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; private static Logger logger = LogManager.getLogger(Test.class.getName());

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏菩提树下的杨过

maven学习(上)- 基本入门用法

一、下载及安装 1.1 下载maven 3.1.1 先到官网http://maven.apache.org/download.cgi 下载最新版本(目前是3.1...

2168
来自专栏lgp20151222

spring boot注入error,Consider defining a bean of type 'xxx' in your configuration问题解决方案

经常出现这问题一定是非spring生态圈的@标签 没被spring引入,如mybatis等

7511
来自专栏不想当开发的产品不是好测试

性能测试 -- 实际问题

现象: 自动化云主机(10.199.146.xx )上的osp-cart服务过一段时间会自动停掉 分析过程: 1、通过top命令,查看整理的资源情况,发现osp...

1979
来自专栏王清培的专栏

spring rest 容易被忽视的后端服务 chunked 性能问题

spring boot 容易被忽视的后端服务 chunked 性能问题 标签(空格分隔): springboot springmvc chunked 背景 sp...

5248
来自专栏web编程技术分享

三分钟学会用SpringMVC搭建最小系统(超详细)

4788
来自专栏大魏分享(微信公众号:david-share)

重点来了:事务一致性的深入研究&EJB的全生命周期 | 从开发角度看应用架构5

1414
来自专栏蓝天

Unix编程/应用问答中文版 ---6./etc/system可调资源限制

本文出自:[url]http://www.nsfocus.com[/url] 维护:小四 6. /etc/system可调资源限制 6.1 Solari...

873
来自专栏运维

Redis3.0.7集群部署完整版

Redis集群没有出来前,一直使用Codis集群,现在部署Redis集群看看效果如何。

2732
来自专栏web编程技术分享

【Java框架型项目从入门到装逼】第七节 - 学生管理系统项目搭建

2987
来自专栏用户2442861的专栏

用GDB调试程序(一)

http://blog.csdn.net/haoel/article/details/2879

971

扫码关注云+社区

领取腾讯云代金券