LOG4J

LOG4J

Log4j是Apache下的一款开源的日志框架，通过在项目中使用 Log4J，我们可以控制日志信息输出到控 制台、文件、甚至是数据库中。我们可以控制每一条日志的输出格式，通过定义日志的输出级别，可以 更灵活的控制日志的输出过程。方便项目的调试。

官方网站: http://logging.apache.org/log4j/1.2/

案例演示

添加pom.xml文件

 <dependencies>
        <dependency>
            <groupId>log4jgroupId>
            <artifactId>log4jartifactId>
            <version>1.2.17version>
        dependency>
        <dependency>
            <groupId>junitgroupId>
            <artifactId>junitartifactId>
            <version>4.12version>
        dependency>
    dependencies>
1
2
3
4
5
6
7
8
9
10
11
12

测试方法

    @Test
    public void testQuick() throws Exception {
        // 初始化系统配置，不需要配置文件
        BasicConfigurator.configure();
        // 创建日志记录器对象
        Logger logger = Logger.getLogger(Log4jTest.class); // 日志记录输出
        logger.info("hello log4j");
        // 日志级别
        logger.fatal("fatal");// 严重错误，一般会造成系统崩溃和终止运行
        logger.error("error");// 错误信息，但不会影响系统运行
        logger.warn("warn");// 警告信息，可能会发生问题
        logger.info("info");// 程序运行信息，数据库的连接、网络、IO操作等
        logger.debug("debug");// 调试信息，一般在开发阶段使用，记录程序的变量、参数等
        logger.trace("trace");// 追踪信息，记录程序的所有流程信息
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

使用配置文件

在org.apache.log4j.LogManager中，定义了默认的配置文件的命名log4j.properties,log4j.xml等

  static public final String DEFAULT_CONFIGURATION_FILE = "log4j.properties";
  
  static final String DEFAULT_XML_CONFIGURATION_FILE = "log4j.xml";  
  
  static final public String DEFAULT_CONFIGURATION_KEY="log4j.configuration";

  static final public String CONFIGURATOR_CLASS_KEY="log4j.configuratorClass";

  public static final String DEFAULT_INIT_OVERRIDE_KEY = "log4j.defaultInitOverride";
1
2
3
4
5
6
7
8
9

我们使用log4j.properties,在resource下创建文件

#日志的级别和输出端
log4j.rootLogger = trace,console
#控制台输出配置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.layout = org.apache.log4j.SimpleLayout
1
2
3
4
5

测试类

@Test
public void testConfig() throws Exception {
  // 创建日志记录器对象
  Logger logger = Logger.getLogger(Log4jTest.class); // 日志记录输出
  logger.info("hello log4j");
  // 日志级别
  logger.fatal("fatal");// 严重错误，一般会造成系统崩溃和终止运行
  logger.error("error");// 错误信息，但不会影响系统运行
  logger.warn("warn");// 警告信息，可能会发生问题
  logger.info("info");// 程序运行信息，数据库的连接、网络、IO操作等
  logger.debug("debug");// 调试信息，一般在开发阶段使用，记录程序的变量、参数等
  logger.trace("trace");// 追踪信息，记录程序的所有流程信息
}
1
2
3
4
5
6
7
8
9
10
11
12
13

日志的级别

日志级别从高到低分为

• fatal:指出每个严重的错误事件将会导致应用程序的退出。
• error:指出虽然发生错误事件，但仍然不影响系统的继续运行。
• warn:表明会出现潜在的错误情形。
• info:一般和在粗粒度级别上，强调应用程序的运行全程。
• debug:一般用于细粒度级别上，对调试应用程序非常有帮助。
• trace:是程序追踪，可以用于输出程序运行中的变量，显示执行的流程。

还有两个特殊的级别：

• OFF：可用来关闭日志记录
• ALL：启用所有消息的日志记录

注：一般只使用4个级别，优先级从高到低为ERROR>WARN>INFO>DEBUG

log4j组件

Log4J 主要由 Loggers (日志记录器)、Appenders(输出端)和 Layout(日志格式化器)组成。

• Loggers 控制日志的输出级别与日志是否输出
• Appenders 指定日志的输出方式(输出到控制台、文件 等)
• Layout 控制日志信息的输出格式。

loggers

日志记录器，负责收集处理日志记录，实例的命名就是类“XX”的full quailied name(类的全限定名)， Logger的名字大小写敏感，其命名有继承机制:

例如:name为org.apache.commons的logger会继承 name为org.apache的logger。

Log4J中有一个特殊的logger叫做“root”，他是所有logger的根，也就意味着其他所有的logger都会直接或者间接地继承自root。

root logger可以用Logger.getRootLogger()方法获取。

Appenders

Appender 用来指定日志输出到哪个地方，可以同时指定日志的输出目的地。Log4j 常用的输出目的地 有以下几种:

Layouts

布局器 Layouts用于控制日志输出内容的格式，让我们可以使用各种需要的格式输出日志。Log4j常用的Layouts:

Layout的格式

在 log4j.properties 配置文件中，我们定义了日志输出级别与输出端，在输出端中分别配置日志的输出 格式。

log4j 采用类似 C 语言的 printf 函数的打印格式格式化日志信息，具体的占位符及其含义如下:
        %m 输出代码中指定的日志信息
        %p 输出优先级，及 DEBUG、INFO 等
        %n 换行符(Windows平台的换行符为 "\n"，Unix 平台为 "\n")
        %r 输出自应用启动到输出该 log 信息耗费的毫秒数
        %c 输出打印语句所属的类的全名
        %t 输出产生该日志的线程全名
        %d 输出服务器当前时间，默认为 ISO8601，也可以指定格式，如:%d{yyyy年MM月dd日 HH:mm:ss}
        %l 输出日志时间发生的位置，包括类名、线程、及在代码中的行数。如:Test.main(Test.java:10)
        %F 输出日志消息产生时所在的文件名称
        %L 输出代码中的行号 %% 输出一个 "%" 字符
       
可以在 % 与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式。如:
        %5c 输出category名称，最小宽度是5，category<5，默认的情况下右对齐
        %-5c 输出category名称，最小宽度是5，category<5，"-"号指定左对齐,会有空格
        %.5c 输出category名称，最大宽度是5，category>5，就会将左边多出的字符截掉，<5不会有空格
        %20.30c category名称<20补空格，并且右对齐，>30字符，就从左边交远销出的字符截掉
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Appender的输出

控制台

在log4j.appender.Console=org.apache.log4j.ConsoleAppender这个配置中，log4j.appender.Console的Console就是输出端的名字

#指定日志的输出级别与输出端
log4j.rootLogger=INFO,Console

# 控制台输出配置 log4j.appender.Console 的Console就是名字，对应上面的Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
1
2
3
4
5
6
7

文件输出

#指定日志的输出级别与输出端
log4j.rootLogger=INFO,A

# 文件输出配置
log4j.appender.A=org.apache.log4j.DailyRollingFileAppender
#指定日志的输出路径
log4j.appender.A.File=/Users/machoul/IdeaProjects/machoul-log-test/machoul-log4j-test/logger/logger.log
log4j.appender.A.Append=true
#使用自定义日志格式化器
log4j.appender.A.layout=org.apache.log4j.PatternLayout
#指定日志的输出格式
log4j.appender.A.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %m%n
#指定日志的文件编码
log4j.appender.A.encoding=UTF-8
1
2
3
4
5
6
7
8
9
10
11
12
13
14

数据库

#指定日志的输出级别与输出端
log4j.rootLogger=INFO,logDB

#mysql
log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.logDB.layout=org.apache.log4j.PatternLayout
log4j.appender.logDB.Driver=com.mysql.jdbc.Driver
log4j.appender.logDB.URL=jdbc:mysql://172.16.140.130:3306/machoul_common_test
log4j.appender.logDB.User=machoul
log4j.appender.logDB.Password=machoul
log4j.appender.logDB.Sql=INSERT INTO sys_log(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) values('pro-service-name','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')

1
2
3
4
5
6
7
8
9
10
11
12

需要添加mysql的驱动

        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
            <version>8.0.30version>
        dependency>
1
2
3
4
5

另外建表语句

CREATE TABLE `sys_log` (
`log_id` int(11) NOT NULL AUTO_INCREMENT,
`project_name` varchar(255) DEFAULT NULL COMMENT '目项名',
`create_date` varchar(255) DEFAULT NULL COMMENT '创建时间',
`level` varchar(255) DEFAULT NULL COMMENT '优先级',
`category` varchar(255) DEFAULT NULL COMMENT '所在类的全名',
`file_name` varchar(255) DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称 ', 
`thread_name` varchar(255) DEFAULT NULL COMMENT '日志事件的线程名',
`line` varchar(255) DEFAULT NULL COMMENT '号行',
`all_category` varchar(255) DEFAULT NULL COMMENT '日志事件的发生位置',
`message` varchar(4000) DEFAULT NULL COMMENT '输出代码中指定的消息',
PRIMARY KEY (`log_id`)
);
1
2
3
4
5
6
7
8
9
10
11
12
13

自定义logger

修改配置

#指定日志的输出级别与输出端
#log4j.rootLogger=INFO,Console
# 自定义Logger
log4j.logger.com.machoul = info,A,Console
log4j.logger.org.apache = error,logDB,Console
1
2
3
4
5

添加测试类

@Test
public void testCustomLogger(){
  Logger logger1 = Logger.getLogger(Log4jTest.class);
  logger1.fatal("fatal");
  logger1.error("error");
  logger1.warn("warn");
  logger1.info("info");
  logger1.debug("debug");
  logger1.trace("trace");
  
  Logger logger2 = Logger.getLogger(Logger.class);
  logger2.fatal("fatal");
  logger2.error("error");
  logger2.warn("warn");
  logger2.info("info");
  logger2.debug("debug");
  logger2.trace("trace");
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18