（转）log4j（六）——log4j.properties简单配置样例说明

2022-11-01 20:28:58

参考:https://www.cnblogs.com/ywlaker/p/6124067.html

log4j基本用法

首先，配置log4j的jar，maven工程配置以下依赖，非maven工程从maven仓库下载jar添加到“build path”

<dependency>

    <groupId>log4j</groupId>

    <artifactId>log4j</artifactId>

    <version>1.2.17</version>

</dependency>

然后，在src/main/java目录（包的根目录即classpath）新建log4j.properties文件

log4j.rootLogger=INFO,console

log4j.additivity.org.apache=true

#console

log4j.appender.console=org.apache.log4j.ConsoleAppender

log4j.appender.console.Threshold=INFO

log4j.appender.console.ImmediateFlush=true

log4j.appender.console.Target=System.out

log4j.appender.console.layout=org.apache.log4j.PatternLayout

log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

最后，新建Main.java文件

package com.xmyself.log4j;

import org.apache.log4j.Logger;

public class Main {

    public static void main(String[] args) {

        new Test().test();

    }

}

class Test {

    final Logger log = Logger.getLogger(Test.class);

    public void test() {

        log.info("hello this is log4j info log");

    }

}

运行main方法，日志信息就出来了

-- :: [INFO] hello this is log4j info log

log4j.properties路径

og4j.properties要放在哪以及怎样配置才能被解析呢？不同工程类型配置方式不同

1、普通java或spring工程

　　这是最常见的java工程类型，写demo用的多，把log4j.properties放在src/main/java目录（包的根目录）就行了

2、spring mvc工程

　　web工程里用spring mvc构建的比较多了，把log4j.properties放在src/main/resources的conf目录（web工程配置文件通常在resources或WEB-INF目录），编辑web.xml，添加

<context-param>

    <param-name>log4jConfigLocation</param-name>

    <param-value>classpath:/conf/log4j.properties</param-value>

</context-param>

<listener>

    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>

</listener>

3、普通web工程

　　没有了spring提供的listener加载log4j.properties，我们要怎么加载这个文件呢？同样，把log4j.properties放在src/main/resources的conf目录，用servlet加载

public class Log4jServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;

    public void init(ServletConfig config) throws ServletException {

        String prefix = this.getClass().getClassLoader().getResource("/").getPath();

        String path = config.getInitParameter("log4j-path");

        PropertyConfigurator.configure(prefix + path);

    }

    public void doGet(HttpServletRequest req, HttpServletResponse res) throws IOException, ServletException {}

    public void doPost(HttpServletRequest req, HttpServletResponse res) throws IOException, ServletException {}

    public void destroy() {}

}

编辑web.xml，添加

<servlet>

    <servlet-name>log4j</servlet-name>

    <servlet-class>com.xmyself.log4j.Log4jServlet</servlet-class>

    <init-param>

        <param-name>log4j-path</param-name>

        <param-value>conf/log4j.properties</param-value>

    </init-param>

    <load-on-startup>1</load-on-startup>

</servlet>

看着是不是和spring mvc的很像，甚至你也想到了，普通java工程没有指定log4j.properties的路径，那说明log4j的jar包一定有一个默认的路径。另外，建议，log4j的配置放在第一个，因为后续加载其他组件就要开始使用日志记录了

　　现在，你可以在多种类型的java工程中打出日志了，但都是控制台的日志，输出内容也很有限，下面我们就来详细介绍log4j.properties内容怎么配置

也可以通过如下的方式，来加载配置文件

package test.log4j.test6;

/**

 * @author lxw

 * @describe通过配置文件来设置log4j

 * @date 2017年7月25日 下午6:14:28

 */

import org.apache.log4j.*;

public class UseLog4j {

    //日志记录器

    private static Logger LOGGER = LogManager.getLogger(UseLog4j.class);

    //程序入口——主函数

    public static void main(String[]args) {

        //读取使用Java的特性文件编写的配置文件

        PropertyConfigurator.configure( "C:\\Users\\prd-lxw\\Desktop\\temp\\log4j.properties" );

        //输出日志信息，测试日志级别的作用（配置在配置文件中），仅仅输出大于等于目前有效级别的日志信息

        LOGGER.debug("[1]-my level is DEBUG Godtrue 说：今天天气很好呀！");

        LOGGER.info("[2]-my level is INFO");

        LOGGER.warn("[3]-my level is WARN");

        LOGGER.error("[4]-my level is ERROR");

    }

}

log4j.properties内容

　　接下来介绍的内容看起来独立，其实相互关联，并且很有规律，

我们要输出日志，首先得有日志对象（logger），

那这些日志对象把日志输出到哪里呢，控制台还是文件，这就要设置输出位置（appender），

输出的格式与内容又是什么样的呢，这就要设置输出样式（layout），这些设置完，log4j的配置也就完了

　　在此之前，先介绍下log4j日志等级的概念，日志等级就是日志的重要程度，log4j日志分为7个等级：ALL、DEBUG、INFO、WARN、ERROR、FATAL、OFF，从左到右等级由低到高，分等级是为了设置日志输出的门槛，只有等级等于或高于这个门槛的日志才有机会输出

1、logger

　　日志实例，就是代码里实例化的Logger对象

log4j.rootLogger=LEVEL,appenderName1,appenderName2,...

log4j.additivity.org.apache=false：表示不会在父logger的appender里输出，默认true

这是全局logger的配置，LEVEL用来设定日志等级，appenderName定义日志输出器，示例中的“console”就是一个日志输出器

　　下面给出一个更清晰的例子，配置“com.demo.test”包下所有类中实例化的Logger对象

log4j.logger.com.demo.test=DEBUG,test

log4j.additivity.com.demo.test=false

2、appender

　　示例：

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=[%d{yyyy-MM-dd HH:mm:ss,SSS}]-[%t]-[%X{ip}]-[%l]-[%p] %m%n

日志输出器，指定logger的输出位置

log4j.appender.appenderName=className

appender有5种选择

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

org.apache.log4j.FileAppender（文件）

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

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

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

每种appender都有若干配置项，下面逐一介绍

ConsoleAppender（常用）

Threshold=WARN：指定日志信息的最低输出级别，默认DEBUG

ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认值是true

Target=System.err：默认值是System.out

FileAppender

Threshold=WARN：指定日志信息的最低输出级别，默认DEBUG

ImmediateFlush=true：表示所有消息都会被立即输出，设为false则不输出，默认true

Append=false：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认true

File=D:/logs/logging.log4j：指定消息输出到logging.log4j文件

　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：每分钟

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文件

3、layout

　　指定logger输出内容及格式

log4j.appender.appenderName.layout=className

layout有4种选择

org.apache.log4j.HTMLLayout（以HTML表格形式布局）

org.apache.log4j.PatternLayout（可以灵活地指定布局模式）

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）

layout也有配置项，下面具体介绍

　　HTMLLayout

LocationInfo=true：输出java文件名称和行号，默认false

Title=My Logging： 默认值是Log4J Log Messages

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)的组合，包括类全名、方法、文件名以及在代码中的行数

%c：输出日志信息所属的类目，通常就是类全名

%M：输出产生日志信息的方法名

%F：输出日志消息产生时所在的文件名

%L：输出代码中的行号

%m：输出代码中指定的具体日志信息

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

%x：输出和当前线程相关联的NDC(嵌套诊断环境)

%%：输出一个"%"字符

四、log4j完整配置示例

介绍完了log4j.properties内容，我们来配置一些常用的日志输出吧

log4j.rootLogger=DEBUG,console,dailyFile,rollingFile,logFile

log4j.additivity.org.apache=true

控制台console日志输出器

# 控制台(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=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

ps：注意查看appender和layout的配置项。

文件logFile日志输出器

# 日志文件(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=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

滚动文件rollingFile日志输出器

# 滚动文件(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=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

定期滚动文件dailyFile日志输出器

# 定期滚动日志文件(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=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

五、log4j局部日志配置

　　以上介绍的配置都是全局的，整个工程的代码使用同一套配置，意味着所有的日志都输出在了相同的地方，你无法直接了当的去看数据库访问日志、用户登录日志、操作日志，它们都混在一起，因此，需要为包甚至是类配置单独的日志输出，下面给出一个例子，为“com.demo.test”包指定日志输出器“test”，“com.demo.test”包下所有类的日志都将输出到/log/test.log文件

log4j.logger.com.demo.test=DEBUG,test

log4j.appender.test=org.apache.log4j.FileAppender

log4j.appender.test.File=/log/test.log

log4j.appender.test.layout=org.apache.log4j.PatternLayout

log4j.appender.test.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

也可以让同一个类输出不同的日志，为达到这个目的，需要在这个类中实例化两个logger

private static Logger logger1 = Logger.getLogger("myTest1");

private static Logger logger2 = Logger.getLogger("myTest2");

然后分别配置

log4j.rootLogger=INFO,console

log4j.additivity.org.apache=true

#console

log4j.appender.console=org.apache.log4j.ConsoleAppender

log4j.appender.console.Threshold=INFO

log4j.appender.console.ImmediateFlush=true

log4j.appender.console.Target=System.out

log4j.appender.console.layout=org.apache.log4j.PatternLayout

log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

log4j.logger.myTest1= DEBUG,test1

log4j.additivity.myTest1=false

log4j.appender.test1=org.apache.log4j.FileAppender

log4j.appender.test1.File=G:/STSPro/partition-work/BasicJava/log/test1.log

log4j.appender.test1.layout=org.apache.log4j.PatternLayout

log4j.appender.test1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

log4j.logger.myTest2=DEBUG,test2

log4j.appender.test2=org.apache.log4j.FileAppender

log4j.appender.test2.File=G:/STSPro/partition-work/BasicJava/log/test2.log

log4j.appender.test2.layout=org.apache.log4j.PatternLayout

log4j.appender.test2.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

程序

/**

 * Project Name:BasicJava

 * File Name:TwoLoggerForDifFile.java

 * Package Name:com.li.BasicJava.day1210

 * Date:2017年12月10日下午4:56:58

 * Copyright (c) 2017, 深圳金融电子结算中心 All Rights Reserved.

 *

*/

package com.li.BasicJava.day1210;

import org.apache.log4j.Logger;

/**

 * ClassName:TwoLoggerForDifFile <br/>

 * Function: TODO  <br/>

 * Date:     2017年12月10日 下午4:56:58 <br/>

 * @author   prd-lxw

 * @version   1.0

 * @since    JDK 1.7

 * @see

 */

public class TwoLoggerForDifFile {

    private static Logger logger1 = Logger.getLogger("myTest1");

    private static Logger logger2 = Logger.getLogger("myTest2");

    public static void testLog(){

        logger1.info("输出到logger1");

        logger2.info("输出到logger2");

    }

    public static void main(String[] args) {

        testLog();

        // TODO Auto-generated method stub

    }

}

运行程序，可以发现控制台输出:

-- :: [INFO] 输出到logger2

ps：这里test2没有配置禁止在控制台打印log4j.additivity.myTest2

test1.log输出：

-- :: [INFO] 输出到logger1

test2.log输出：

-- :: [INFO] 输出到logger2

上述程序通过不同的logger名称，实现了对日志的分类打印。

六、slf4j与log4j联合使用

slf4j是什么？slf4j只是定义了一组日志接口，但并未提供任何实现，既然这样，为什么要用slf4j呢？log4j不是已经满足要求了吗？

　　是的，log4j满足了要求，但是，日志框架并不只有log4j一个，你喜欢用log4j，有的人可能更喜欢logback，有的人甚至用jdk自带的日志框架，这种情况下，如果你要依赖别人的jar，整个系统就用了两个日志框架，如果你依赖10个jar，每个jar用的日志框架都不同，岂不是一个工程用了10个日志框架，那就乱了！

　　如果你的代码使用slf4j的接口，具体日志实现框架你喜欢用log4j，其他人的代码也用slf4j的接口，具体实现未知，那你依赖其他人jar包时，整个工程就只会用到log4j日志框架，这是一种典型的门面模式应用，与jvm思想相同，我们面向slf4j写日志代码，slf4j处理具体日志实现框架之间的差异，正如我们面向jvm写java代码，jvm处理操作系统之间的差异，结果就是，一处编写，到处运行。况且，现在越来越多的开源工具都在用slf4j了

　　那么，怎么用slf4j呢？

　　首先，得弄到slf4j的jar包，maven依赖如下，log4j配置过程完全不变

<dependency>

    <groupId>org.slf4j</groupId>

    <artifactId>slf4j-api</artifactId>

    <version>1.7.21</version>

</dependency>

然后，弄到slf4j与log4j的关联jar包，通过这个东西，将对slf4j接口的调用转换为对log4j的调用，不同的日志实现框架，这个转换工具不同

<dependency>

    <groupId>org.slf4j</groupId>

    <artifactId>slf4j-log4j12</artifactId>

    <version>1.7.21</version>

</dependency>

当然了，slf4j-log4j12这个包肯定依赖了slf4j和log4j，所以使用slf4j+log4j的组合只要配置上面这一个依赖就够了

　　最后，代码里声明logger要改一下，原来使用log4j是这样的

import org.apache.log4j.Logger;

class Test {

    final Logger log = Logger.getLogger(Test.class);

    public void test() {

        log.info("hello this is log4j info log");

    }

}

现在要改成这样

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

class Test {

    Logger log = LoggerFactory.getLogger(Test.class);

    public void test() {

        log.info("hello, my name is {}", "chengyi");

    }

}

依赖的Logger变了，而且，slf4j的api还能使用占位符，很方便

局部和全局配置

下面的配置文件也仅是列举了几个常见的输出目的地的配置方式，如有更多需求可以参看官网文档，其中输出到控制台和达到一定的阈值自动回滚的文件的方式是最常用，要重点了解

日志的级别之间的大小关系如右所示：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF

###

# 在代码中配置log4j环境的方式，我们已经见识过了，是不是感觉比较麻烦，我们试试使用配置文件的方式是否使您的应用程序更加的灵活。

# Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性的文件（键=值）。

# 下面我们先试试使用Java特性文件做为配置文件的方式

#

# 以下的设置参数，前文已经讲过是怎么回事的，这里就不再重复了

#

###

###

# 设置根记录器的配置，其语法为：log4j.rootLogger = [ level ] , appenderName1, appenderName2, …appenderNameN

# level用于设置日志记录的优先级，有系统自定义的8中类型，也可以自定义，官方建议只是用这四种 ERROR>WARN>INFO>DEBUG

# appenderNameN用于设置日志的输出地，可以设置多个，可以自定义名称

###

log4j.rootLogger = debug,stdout,D,E,F

###

# 设置日志记录的输出地，其语法为：

#     log4j.appender.appenderName = fully.qualified.name.of.appender.class

#　　 log4j.appender.appenderName.option1 = value1

#　　 …

#　　log4j.appender.appenderName.optionN = valueN

# fully.qualified.name.of.appender.class：指日志输出目的类的全路径类名，有好许多预定义，下面介绍四个常用的

# optionN/valueN ：分别是指对应的输出目的地属性和设置的属性值

#

# 如果对应的属性，仍然是对象级别的话，可以通过继续 . 的形式来设置对应的属性

#

###

###

# 输出信息到控制台，其可选的配置有如下几个：

# 1）Threshold：设置日志信息输出的级别

# 2）ImmediateFlush：设置日志信息是否被立即输出，默认为TRUE，立即输出

# 3）Target：设置日志信息输出的目标流，有两种值System.out和System.err ,默认值System.out(err为红色,out为黑色)

# 4）layout：设置日志信息输出的样式

# 5）Encoding：设置文件的编码格式，默认和系统平台的编码格式保持一致

###

log4j.appender.stdout = org.apache.log4j.ConsoleAppender

log4j.appender.stdout.Threshold = INFO

log4j.appender.stdout.Target = System.out

log4j.appender.stdout.layout = org.apache.log4j.PatternLayout

log4j.appender.stdout.Encoding = Utf-8

log4j.appender.stdout.layout.ConversionPattern = [%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n

###

# 输出信息到文件，其常用的可选的配置有如下几个：

# 1）Threshold：设置日志信息输出的级别

# 2）ImmediateFlush：设置日志信息是否被立即输出，默认为TRUE，立即输出

# 3）File：设置日志信息输出全路径，比如：E://logs/FileAppender.log

# 4）layout：设置日志信息输出的样式

# 5）Encoding：设置文件的编码格式，默认和系统平台的编码格式保持一致

# 6）Append：设置是否将日志消息追加到指定的文件中，默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容

###

log4j.appender.D = org.apache.log4j.FileAppender

log4j.appender.D.Threshold = ERROR

log4j.appender.D.File = E://logs/FileAppender.log

log4j.appender.D.layout = org.apache.log4j.PatternLayout

log4j.appender.D.Append = true

log4j.appender.D.layout.ConversionPattern = [%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n

###

# 输出信息到文件，但是这个文件是可控的，可以配置多久产生一个新的日志信息文件，其常用的可选的配置有如下几个：

# 1）Threshold：设置日志信息输出的级别

# 2）ImmediateFlush：设置日志信息是否被立即输出，默认为TRUE，立即输出

# 3）File：设置日志信息输出全路径，比如：E://logs/DailyRollingFileAppender.log

# 4）layout：设置日志信息输出的样式

# 5）Encoding：设置文件的编码格式，默认和系统平台的编码格式保持一致

# 6）Append：设置是否将日志消息追加到指定的文件中，默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容

# 7）DatePattern：设置文件回滚的时间样式

#              '.'yyyy-MM 每月

#              '.'yyyy-ww 每周

#              '.'yyyy-MM-dd 每天

#              '.'yyyy-MM-dd-a 每天两次

#              '.'yyyy-MM-dd-HH 每小时

#              '.'yyyy-MM-dd-HH-mm 每分钟

###

log4j.appender.E = org.apache.log4j.DailyRollingFileAppender

log4j.appender.E.Threshold = WARN

log4j.appender.E.File =E://logs/DailyRollingFileAppender.log

log4j.appender.E.Append = true

log4j.appender.E.DatePattern = '.'yyyy-MM-dd-HH-mm

log4j.appender.E.layout = org.apache.log4j.PatternLayout

log4j.appender.E.layout.ConversionPattern = [%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n

###

# 输出信息到文件，但是这个文件是可控的，当文件的大小达到某个阈值的时候，日志文件会自动回滚，其常用的可选的配置有如下几个：

# 1）Threshold：设置日志信息输出的级别

# 2）ImmediateFlush：设置日志信息是否被立即输出，默认为TRUE，立即输出

# 3）File：设置日志信息输出全路径，比如：E://logs/RollingFileAppender.log

# 4）layout：设置日志信息输出的样式

# 5）Encoding：设置文件的编码格式，默认和系统平台的编码格式保持一致

# 6）Append：设置是否将日志消息追加到指定的文件中，默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容

# 7）MaxFileSize：设置当文件达到此阈值的时候自动回滚，单位可以是KB，MB，GB，默认单位是KB

# 8）MaxBackupIndex：设置保存备份回滚日志的最大个数

###

log4j.appender.F = org.apache.log4j.RollingFileAppender

log4j.appender.F.File =E://logs/RollingFileAppender.log

log4j.appender.F.Append = true

log4j.appender.F.Threshold = INFO

log4j.appender.F.MaxFileSize = 1

log4j.appender.F.MaxBackupIndex = 5

log4j.appender.F.layout = org.apache.log4j.PatternLayout

log4j.appender.F.layout.ConversionPattern = [%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n

ps：上述的 layout 都采用 org.apache.log4j.PatternLayout来进行自定义的方式进行定义。

日志记录器Logger

Log4j配置中有3个重要的概念:日志记录器(Logger),输出地(Appender)以及日志格式化器(Layout)。

其中Logger负责记录日志,Appender负责输出到什么地方,Layout负责以什么格式输出,输出那些附加信息(例如时间,类名,方法名,所在行数等)

Logger的定义　　

Logger就是Java代码中的Logger,例如:

public static Logger log = Logger.getLogger(Log4jTest.class);

logger是有名字的,它的名字便是Logger.getLogger()的方法参数。如果参数为所在的类,Log4j会去类名为logger的名称,例如com.log4j.test.Log4jTes

Logger为单例模式:相同名字的Logger只会有一个实例。如果在构建一个同名的Logger，Log4j会返回先前的Logger实例。

命名规则:一般都以类名作为Logger的名称。Logger的名字类似于Java中的Package名字,大小写敏感,用点分开具有继承关系

例如com.log4j是com.log4j.test的父亲。log4j.properties中通过名称来配置Logger的属性。

Log4j中有一个根记录器rootLogger,它是所有logger的父亲

logger的配置

在log.properties配置中,log4j.logger后面配置的就是logger，

log4j.appender后面配置的是 Appender,例如:

# 配置Logger为ERROR级别,输出到A1

log4j.logger.com.log4j.test.Log4jTest=DEBUG, A1

# 配置Appender A1,输出到控制台,使用表达式布局

log4j.appender.A1=org.apache.log4j.ConsoleAppender

log4j.appender.A1.layout=org.apache.log4j.PatternLayout

log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH\:mm\:ss,SSS} [%C]-[%p] %m%n

log4j日志框架logger是存在继承关系的，我们一般都会在log4j.properties文件中定义log4j.rootLogger。其他所有logger都继承自这个rootLooger。

如某个Logger没有配置,则使用它的父亲配置,直到找到为止。一般情况下,只需配置根记录器rootLogger即可,所有Logger都会沿用rootLogger的配置

rootLogger配置

根记录器rootLogger直接使用log4j.rootLogger配置。rootLogger是所有记录器的父亲。任何记录器都可以继承rootLogger的配置

代码如下

#配置rootLogger为ERROR级别,输出地为A1

log4j.rootLogger= ERROR, A1

#配置该logger为DEBUG 级别，输出地则继承rootLogger配置

log4j.logger.com.log4j.test2.Log4jConfigTest=DEBUG

# 配置Appender A1,输出到控制台,使用正则表达式布局

log4j.appender.A1=org.apache.log4j.ConsoleAppender

log4j.appender.A1.layout=org.apache.log4j.PatternLayout

#定义输出格式

log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH\:mm\:ss,SSS} [%C]-[%p] %m%n

如果要对某个logger进行特殊输出,只需要在配置一下该logger，覆盖父亲的配置即可(rootLogger)。覆盖时，可以配置级别，输出地，也可两者都配置

类别category配置

　　logger还有个类别(Category)的概念,通过设置类别来设置该类别下所有的Logger:

#配置rootLogger为ERROR级别,输出地位A1

log4j.rootLogger= ERROR, A1

#作用于类别com.log4j.test下所有的Logger, 输出则继承rootLogger配置

log4j.category.com.log4j.test=DEBUG

# 配置Appender A1,输出到控制台,使用正则表达式布局

log4j.appender.A1=org.apache.log4j.ConsoleAppender

log4j.appender.A1.layout=org.apache.log4j.PatternLayout

#定义输出格式

log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH\:mm\:ss,SSS} [%C]-[%p] %m%n

catergory类似于Java中的Package,效果跟Logger的名字等价

举例分析

考虑下面这种场景：假如我们有2个类HelloLog4j和A。

只配置rootLogger

package com.li.BasicJava;

import org.apache.log4j.Logger;

import com.li.BasicJava.day1210.A;

/**

 * ClassName:HelloLog4j <br/>

 * Function: TODO  <br/>

 * Date:     2017年12月10日 下午5:22:12 <br/>

 * @author   prd-lxw

 * @version   1.0

 * @since    JDK 1.7

 * @see

 */

public class HelloLog4j {  

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

    public static void main(String[] args) {

        logger.debug("log in main.");

        new A().run();

    }

}

/**

 * Project Name:BasicJava

 * File Name:A.java

 * Package Name:com.li.BasicJava.day1210

 * Date:2017年12月10日下午5:22:43

 * Copyright (c) 2017, 深圳金融电子结算中心 All Rights Reserved.

 *

*/

package com.li.BasicJava.day1210;

import org.apache.log4j.Logger;

/**

 * ClassName:A <br/>

 * Function: TODO  <br/>

 * Date:     2017年12月10日 下午5:22:43 <br/>

 * @author   prd-lxw

 * @version   1.0

 * @since    JDK 1.7

 * @see

 */

public class A {  

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

    public void run() {

        logger.error("log in A.java");

    }

}

log4j.properties文件配置如下：

#rootLogger can print DEBUG to console

log4j.rootLogger=debug, 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=[%d{yyyy-MM-dd HH:mm:ss,SSS}]-[%t]-[%X{ip}]-[%l]-[%p] %m%n

运行HelloLog4j.java控制台日志如下：可以看到这2个类使用的logger都是rootLogger。

[-- ::,]-[main]-[]-[com.li.BasicJava.HelloLog4j.main(HelloLog4j.java:)]-[DEBUG] log in main.

  [-- ::,]-[main]-[]-[com.li.BasicJava.day1210.A.run(A.java:)]-[ERROR] log in A.java

配置logger

现在我们有这个需求：让A.java中日志的打印到单独的a.log日志文件中，而HelloLog4j中的日志还是打印到控制台。也就是说：我们想让A和HelloLog4j这2个类使用不同的logger。java代码不用修改，我们将log4j.properties修改如下：

#rootLogger can print DEBUG to console

log4j.rootLogger=debug, 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=[%d{yyyy-MM-dd HH:mm:ss,SSS}]-[%t]-[%X{ip}]-[%l]-[%p] %m%n  

#A.java is special.we use a individual appender for it.

#A class's full qulified qualified name is logger's name.

log4j.logger.com.li.BasicJava.day1210.A=DEBUG, testA

log4j.appender.testA=org.apache.log4j.FileAppender

log4j.appender.testA.Threshold=warn

log4j.appender.testA.ImmediateFlush=true

log4j.appender.testA.Append=true

log4j.appender.testA.File=c:/a.log

log4j.appender.testA.layout=org.apache.log4j.PatternLayout

log4j.appender.testA.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss,SSS}]-[%t]-[%X{ip}]-[%l]-[%p] %m%n  

#avoid print to parent logger.

log4j.additivity.com.li.BasicJava.day1210.A= false

这里为com.li.BasicJava.day1210.A单独配置了一个logger，然后指定了一个appender。

再次运行HelloLog4j可以看到：HelloLog4j的日志打印在控制台上，如下：

[-- ::,]-[main]-[]-[com.li.BasicJava.HelloLog4j.main(HelloLog4j.java:)]-[DEBUG] log in main.

A.java中的日志并没有打印到控制台上，而是打印到了a.log文件中：

[-- ::,]-[main]-[]-[com.li.BasicJava.day1210.A.run(A.java:)]-[ERROR] log in A.java

logger与rootLogger的继承关系

我们来解释下上面的配置：

log4j.logger.com.li.BasicJava.day1210.A=DEBUG, testA    我们用A的全类名定义了一个logger。


log4j.additivity.com.li.BasicJava.day1210.A= false     避免日志打印到rootLogger中。如果这里设置成true，那么A.java中的日志既会打印到控制台上，也会打印到a.log文件中。

现在我们可以介绍下logger的继承关系了——

比如我们上面的类com.li.BasicJava.day1210.A中使用了logger来写日志。那么log4j会先查找名称是"com.li.BasicJava.day1210.A"的logger，如果没有找到，向上查找名称是"aty.log.service"的logger，如果还没有找到那么继续向上查找，查找的最顶层就是rootLogger。

这就是log4j中logger的继承关系。

rootLogger一定要配置，其他特定类或者特定包的logger可以不用配置。

ps：如果有的类既不包含在logger中，也没有配置rootLogger，就会出现log4j错误。

比如将上述配置中的log4j.rootLogger=debug, console 注释掉，只保留log4j.logger.com.li.BasicJava.day1210.A=DEBUG, testA 。则会出现如下问题，但是在a.log文件中还是能够正常打印log4j.logger.com.li.BasicJava.day1210.A=DEBUG, testA 的日志。

log4j:WARN No appenders could be found for logger (com.li.BasicJava.HelloLog4j).

log4j:WARN Please initialize the log4j system properly.

log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.

知道了这个继承特性之后，如果我们要aty.log.dao包下所有的类都打印到同一个日志文件，那么可以进行如下配置。

# a package appender

log4j.logger.aty.log.dao=DEBUG, daoAppender

log4j.appender.daoAppender=org.apache.log4j.FileAppender

log4j.appender.daoAppender.Threshold=warn

log4j.appender.daoAppender.ImmediateFlush=true

log4j.appender.daoAppender.Append=true

log4j.appender.daoAppender.File=c:/dao.log

log4j.appender.daoAppender.layout=org.apache.log4j.PatternLayout

log4j.appender.daoAppender.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss,SSS}]-[%t]-[%X{ip}]-[%l]-[%p] %m%n

log4j.additivity.aty.log.dao= false

可以看到：利用logger的继承特性，我们可以很容易将不同的日志打印到不同的文件中，这样可以避免各种日志混杂在一起。

码农公寓

log4j基本用法

log4j.properties路径

1、普通java或spring工程

2、spring mvc工程

3、普通web工程

log4j.properties内容

1、logger

2、appender

3、layout

四、log4j完整配置示例

五、log4j局部日志配置

六、slf4j与log4j联合使用

局部和全局配置

日志记录器Logger

Logger的定义

logger的配置

rootLogger配置

类别category配置

举例分析

只配置rootLogger

配置logger

logger与rootLogger的继承关系

相关文章

Logger的定义　　