首页 > 其他分享> 文章详细

Log4j 使用

2020-11-28 16:04:25 阅读：147 来源： 互联网

标签：输出文件 log4j slf4j 使用 org 日志 Log4j

（一）概述

一个完整的软件，日志是必不可少的。程序从开发、测试、维护、运行等环节，都需要向控制台或文件等位置输出大量信息。这些信息的输出，在很多时候是使用 System.out.println() 无法完成的。

日志信息根据用途与记录内容的不同，分为调试日志、运行日志、异常日志等。

Log4j 的全称为 Log for java，即专门用于 Java 语言的日志记录工具。

（二）Log4j 日志级别

为了方便对于日志信息的输出显示，对日志内容进行了分级管理。日志级别由高到低，共分 6 个级别：

fatal(致命的)
error
warn
info
debug
trace(堆栈)

为什么要对日志进行分级

无论是将日志输出到控制台，还是文件，其输出都会降低程序的运行效率。但由于调试、运行维护的需要，客户的要求等原因，需要进行必要的日志输出。这时就必须要在代码中加入日志输出语句。

这些输出语句若在程序运行时全部执行，则势必会降低运行效率。例如，使用 System.out.println() 将信息输出到控制台，则所有的该输出语句均将执行。会大大降低程序的执行效率。而要使其不输出，唯一的办法就是将这些输出语句逐个全部删除。这是个费时费力的过程。

将日志信息进行分级管理，便可方便的控制信息输出内容及输出位置：哪些信息需要输出，哪些信息不需要输出，只需在一个日志输出控制文件中稍加修改即可。而代码中的输出语句不用做任何修改。

从这个角度来说，代码中的日志编写，其实就是写大量的输出语句。只不过，这些输出语句比较特殊，它们具有级别，在程序运行期间不一定被执行。它们的执行是由另一个控制文件控制。

（三）Log4j 日志输出控制文件

1、日志输出简介

Log4j 的日志输出控制文件，主要由三个部分构成：

日志信息的输出位置：控制日志信息将要输出的位置，是控制台还是文件等。
日志信息的输出格式：控制日志信息的显示格式，即以怎样的字符串形式显示。
日志信息的输出级别：控制日志信息的显示内容，即显示哪些级别的日志信息。

有了日志输出控制文件，代码中只要设置好日志信息内容及其级别即可，通过控制文件便可控制这些日志信息的输出了。

2、日志属性配置文件

日志属性文件 log4j.properties 是专门用于控制日志输出的。其主要进行三方面控制：

输出位置：控制日志将要输出的位置，是控制台还是文件等。
输出布局：控制日志信息的显示形式。
输出级别：控制要输出的日志级别。

日志属性文件由两个对象组成：日志附加器与根日志。

根日志，即为 Java 代码中的日志记录器，其主要由两个属性构成：日志输出级别与日志附加器。

日志附加器，则由日志输出位置定义，由其它很多属性进行修饰，如输出布局、文件位置、文件大小等。

3、什么是日志附加器？

所谓日志附加器，就是为日志记录器附加上很多其它设置信息。附加器的本质是一个接口，其定义语法为：log4j.appender.appenderName = 输出位置

常用的附加器实现类

org.apache.log4j.ConsoleAppender：日志输出到控制台
org.apache.log4j.FileAppender：日志输出到文件
org.apache.log4j.RollingFileAppender：当日志文件大小到达指定尺寸的时候将产生一个新的日志文件
org.apache.log4j.DailyRollingFileAppender：每天产生一个日志文件

4、常用布局类型

org.apache.log4j.HTMLLayout：网页布局，以 HTML 表格形式布局
org.apache.log4j.SimpleLayout：简单布局，包含日志信息的级别和信息字符串
org.apache.log4j.PatternLayout：匹配器布局，可以灵活地指定布局模式。其主要是通过设置 PatternLayout 的 ConversionPattern 属性值来控制具体输出格式的。

打印参数: Log4J 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息

%m：输出代码中指定的消息
%p：输出优先级，即 DEBUG，INFO，WARN，ERROR，FATAL
%r：输出自应用启动到输出该 log 信息耗费的毫秒数
%c：输出所属的类目，通常就是所在类的全名
%t：输出产生该日志事件的线程名
%n：输出一个回车换行符，Windows 平台为 /r/n，Unix 平台为 /n
%d：输出日志时间点的日期或时间，默认格式为 ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss , SSS}，输出类似：2002年10月18日 22:10:28,921
%l：输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java: 10 )

（四）第一个 Log4j 日志文件

1、Slf4j 简介

slf4j 的全称是 Simple Loging Facade For Java，即它仅仅是一个为 Java 程序提供日志输出的统一接口，并不是一个具体的日志实现方案，就比如 JDBC 一样，只是一种规则而已。所以单独的 slf4j 是不能工作的，必须搭配其他具体的日志实现方案，比如 apache 的 org.apache.log4j.Logger，JDK 自带的 java.util.logging.Logger 以及 log4j 等。

2、POM

继续之前的项目，pom.xml 配置如下：

    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.cmcc</groupId>
        <artifactId>hello-spring</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>4.3.17.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-log4j12</artifactId>
                <version>1.7.25</version>
            </dependency>
        </dependencies>
    </project>

日志配置相关说明：

log4j.rootLogger：根日志，配置了日志级别为 INFO，预定义了名称为 console、file 两种附加器
log4j.appender.console：console 附加器，日志输出位置在控制台
log4j.appender.console.layout：console 附加器，采用匹配器布局模式
log4j.appender.console.layout.ConversionPattern：console 附加器，日志输出格式为：日期日志级别 [类名] - 消息换行符
log4j.appender.file：file 附加器，每天产生一个日志文件
log4j.appender.file.File：file 附加器，日志文件输出位置 logs/log.log
log4j.appender.file.layout：file 附加器，采用匹配器布局模式
log4j.appender.A3.MaxFileSize：日志文件最大值
log4j.appender.A3.MaxBackupIndex：最多纪录文件数
log4j.appender.file.layout.ConversionPattern：file 附加器，日志输出格式为：日期日志级别 [类名] - 消息换行符

3、测试日志输出

创建一个测试类，并测试日志输出效果，代码如下：

    package com.cmcc.hello.spring;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class MyTest {
    
        public static final Logger logger = LoggerFactory.getLogger(MyTest.class);
    
        public static void main(String[] args) {
            logger.info("slf4j for info");
            logger.debug("slf4j for debug");
            logger.error("slf4j for error");
            logger.warn("slf4j for warn");
    
            String message = "Hello SLF4J";
            logger.info("slf4j message is : {}", message);
        }
    }

此时控制台显示为：

    2018-06-07 05:15:42,914 INFO [com.cmcc.hello.spring.MyTest] - slf4j for info
    2018-06-07 05:15:42,915 ERROR [com.cmcc.hello.spring.MyTest] - slf4j for error
    2018-06-07 05:15:42,915 WARN [com.cmcc.hello.spring.MyTest] - slf4j for warn
    2018-06-07 05:15:42,916 INFO [com.cmcc.hello.spring.MyTest] - slf4j message is : Hello SLF4J

项目根目录下也会多出 logs/log.log 目录及文件

4、附：占位符说明

打日志的时候使用了 {} 占位符，这样就不会有字符串拼接操作，减少了无用 String 对象的数量，节省了内存。并且，记住，在生产最终日志信息的字符串之前，这个方法会检查一个特定的日志级别是不是打开了，这不仅降低了内存消耗而且预先降低了 CPU 去处理字符串连接命令的时间。

转自：有梦想的咸鱼

标签：输出,文件,log4j,slf4j,使用,org,日志,Log4j
来源： https://www.cnblogs.com/zjq-blogs/p/14052870.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9