Log4j日志使用记录

Log4j是Apache下的一个功能强大日志组件，用于提供开发过程中的日志记录。

一、入门实例

1、在maven下向pom文件中导入依赖

<!--日志-->
<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>

2、resources目录下创建一个log4j .propeties文件

### 设置###
log4j.rootLogger = debug,stdout,D,E

### 输出信息到控制抬 ###
# 控制台输出，stdout在这里就对应了上面的变量，consoleAppender 看名字也可以明白这个是控制台输出日志信息
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
# 这里没人的是System.out，也就是输出 out输出是黑色字体，err输出的字体是红色
log4j.appender.stdout.Target = System.out
# layout是指布局，也就是说输出日志信息的格式样式，在这里我们使用的是log4j提供的
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 级别以上的日志到=/home/duqi/logs/debug.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
# 指定日志输出位置
log4j.appender.D.File = /home/duqi/logs/debug.log
#这个的意思是指是追加还是覆盖 默认是 true  true是追加 false是覆盖
log4j.appender.D.Append = true
# 这个是指日志输出的级别在这里指定的是 DEBUG级别
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 输出ERROR 级别以上的日志到=/home/admin/logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =/home/admin/logs/error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

3、使用

public class UserTest {

    private static Logger logger = Logger.getLogger(UserTest.class);

    ApplicationContext applicationContext =
            new ClassPathXmlApplicationContext("applicationContext.xml");

    @Test
    public void test(){
        UserMapper userMapper = applicationContext.getBean(UserMapper.class);
        logger.info("测试");
        List<User> list = userMapper.select();
        System.out.println(list);
    }
}

控制台输出：

指定地方的日志：

二、Log4j基本使用方法

Log4j由三个重要组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。

日志信息的优先级从高到低有：ERROR、WARN、INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。

2.1 定义配置文件

其实你也可以完全不用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使你的应用程序更加灵活。Log4j支持两种配置文件格式，一种是XML格式的文件，一种是java特性文件（键=值）。下面介绍使用java特定文件作为配置文件的方法：

配置根Logger，其语法为：

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

其中，level是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或你定义的级别。Log4j建议只使用4个级别，优先级从高到低分别为ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。appenderName就是指 把日志信息输出到哪个地方。你可以同时指定多个输出目的地，例如上述例子我们制定了stdout、D、e这三个地方。

配置文件的输出目的地Appender，一般，配置代码的格式如下：

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

其中，Log4j提供的appender有以下几种：

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

配置日志信息的格式（布局），其语法为：

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

其中，Log4j提供的layout有以下几种：

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

Log4j采用类似c语言中的printf函数的打印格式格式化日志信息，打印参数如下：

%m：输出代码中指定的消息

%p：输出优先级，即DEBUG、INFO、WARN、ERROR、FATAL

%r：输出自应用启动到输出该log信息耗费的毫秒数

%c：输出所属的类目，通常就是所在类的类名

%t：输出产生该日志事件的线程名

%n：输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”

%d：输出日志时间点的日期或时间，默认格式是ISO8601，也可以在其后指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS},输出类似：2002年10月18日22：10：28，921

%l：输出日志时间发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

2.2 在代码中使用Log4j

获取记录器

使用Log4j，第一步就是获取日志记录器，这个日志记录器将负责控制日志信息。其语法为：

public static Logger getLogger( String name)；

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录其。Name一般取本类的名字，如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )。

读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。  
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。  
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，

你就可以轻松的使用不同优先级别的日志记录语句插入到你想记录日志的任何地方，其语法：

Logger.debug ( Object message ) ;  
Logger.info ( Object message ) ;  
Logger.warn ( Object message ) ;  
Logger.error ( Object message ) ;

2.3 日志级别

每个Logger都有一个日志级别，

用来控制日志信息的输出。

日志级别从高到低分为：

1、off 最高等级，用于关闭所有日志记录。

2、fatal 指出每个严重的错误事件将会导致应用程序的退出

3、error 指出虽然发生错误事件，但仍然不影响系统的继续运行。

4、warm 表明会出现前置的错误情形。

5、info 一般和在粗粒度级别上，强调应用程序的运行过程

6、debug 一般用于细粒度级别上，对调式应用程序非常有帮助

7、all 最低级别，用于打开所有日志记录。

上面这些级别是定义在org.apache.log4j.Level类中。Log4j只建议使用4个级别，优先级从高到低分别是error、warn、info和debug。通过使用日志级别，可以控制应用程序中相应级别日志的输出。例如，如果使用了info级别，则应用程序中所有低于info级别的日志信息（如debug）将不会被打印出来。

转载注：https://yq.aliyun.com/articles/54081