Java日志 - log4j

矫情吗；* 2023-09-28 12:23 14阅读 0赞

## 一、Log4j学习 ##

### 1、Log4J ###

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

### 2、Log4j入门 ###

3、日志的级别

* 每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分
    为：
    	fatal 指出每个严重的错误事件将会导致应用程序的退出。
    	error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
    	warn 表明会出现潜在的错误情形。
    	info 一般和在粗粒度级别上，强调应用程序的运行全程。
    	debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
    	trace 是程序追踪，可以用于输出程序运行中的变量，显示执行的流程。
    * 还有两个特殊的级别：
    	OFF，可用来关闭日志记录。
    	ALL，启用所有消息的日志记录。

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

### 3、Log4j组件 ###

**1、Appenders**  
Appender 用来指定日志输出到哪个地方，可以同时指定日志的输出目的地。Log4j 常用的输出目的地  
有以下几种  
![在这里插入图片描述][9230d42af7d04f22aa3482588758fb66.png]

**2、Layouts**  
布局器 Layouts用于控制日志输出内容的格式，让我们可以使用各种需要的格式输出日志。Log4j常用  
的Layouts  
![在这里插入图片描述][c3e3ea212db34f5aa6e729b9298b66e4.png]

**3.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字符，就从左边交远销出的字符截掉

### 4、入门案例 ###

**1、导入依赖**

<dependencies>
    	<dependency>
    		<groupId>log4j</groupId>
    		<artifactId>log4j</artifactId>
    		<version>1.2.17</version>
    	</dependency>
    	<dependency>
    		<groupId>junit</groupId>
    		<artifactId>junit</artifactId>
    		<version>4.12</version>
    	</dependency>
    </dependencies>

**2、java代码**

**打印结果：**  
![在这里插入图片描述][b7e1251a24e64ceb8c671da545923685.png]

### 5、以时间或文件大小拆分日志记录信息 ###

#### 1、按照文件大小拆分的appender对象 ####

**log4j.properties**

#指定日志的输出级别与输出端
    # 指定日志级别=trace 使用apeender = Console
    log4j.rootLogger=trace,rollingFile
    # 控制台输出配置
    log4j.appender.Console=org.apache.log4j.ConsoleAppender
    # 指定消息格式 layout
    log4j.appender.Console.layout=org.apache.log4j.PatternLayout
    # 指定消息格式的内容
    log4j.appender.Console.layout.ConversionPattern = %d [%t] %-5p [%c] - %m%n
    
    
    # 按照文件大小拆分的appender对象
    # 文件输出配置
    log4j.appender.rollingFile = org.apache.log4j.RollingFileAppender
    # 指定日志的输出路径
    log4j.appender.rollingFile.file = E:/log/rollingfile.log
    # 使用自定义日志格式化器
    log4j.appender.rollingFile.layout = org.apache.log4j.PatternLayout
    # 指定日志的输出格式
    log4j.appender.rollingFile.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r] -[%p] %m%n
    # 指定日志的文件编码
    log4j.appender.rollingFile.encoding = UTF-8
    # 指定日期拆分规则
    log4j.appender.rollingFile.maxFileSize = 1MB
    # 指定日志文件的数量
    log4j.appender.rollingFile.maxBackupIndex = 10

打印到日志记录中的文件  
![在这里插入图片描述][5575c76356f94c968c3875cf3e9a1e34.png]

#### 2、按照时间规则拆分的appender对象 ####

1、java代码不改变  
2、配置文件使用daily

#指定日志的输出级别与输出端
    # 指定日志级别=trace 使用apeender = Console
    log4j.rootLogger=trace,dailyFile
    # 控制台输出配置
    log4j.appender.Console=org.apache.log4j.ConsoleAppender
    # 指定消息格式 layout
    log4j.appender.Console.layout=org.apache.log4j.PatternLayout
    # 指定消息格式的内容
    log4j.appender.Console.layout.ConversionPattern = %d [%t] %-5p [%c] - %m%n
    
    # 按照时间规则拆分的appender对象
    # 文件输出配置
    log4j.appender.dailyFile = org.apache.log4j.DailyRollingFileAppender
    # 指定日志的输出路径
    log4j.appender.dailyFile.File = E:/log/log4j.log
    log4j.appender.dailyFile.Append = true
    # 使用自定义日志格式化器
    log4j.appender.dailyFile.layout = org.apache.log4j.PatternLayout
    # 指定日志的输出格式
    log4j.appender.dailyFile.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%t:%r] -[%p] %m%n
    # 指定日志的文件编码
    log4j.appender.dailyFile.encoding = UTF-8
    # 指定日期拆分规则
    log4j.appender.dailyFile.datePattern = '.'yyyy-MM-dd

**以上配置时按照每天生成一个日志文件，当天的日志信息都是追加到同一个文件中。**  
![在这里插入图片描述][34c51fd33dd84711a806839ea2ab0b56.png]

**以秒为单位拆分规则**

log4j.appender.dailyFile.datePattern = '.'yyyy-MM-dd-HH-mm-ss

![在这里插入图片描述][41a9a7980ac24d7d8db22e1507073675.png]

### 6、将日志信息添加到数据库表中 ###

**1、创建表**

CREATE TABLE `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`)
    );

**2、引入mysql依赖**

<dependency>
         <groupId>mysql</groupId>
         <artifactId>mysql-connector-java</artifactId>
         <version>5.1.47</version>
     </dependency>

**3、log配置文件**

# 指定日志的输出级别与输出端
    # 指定日志级别=trace 使用apeender = Console
    log4j.rootLogger=trace,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://localhost:3306/test
    log4j.appender.logDB.User=root
    log4j.appender.logDB.Password=123456
    log4j.appender.logDB.Sql=INSERT INTO log(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) values('itcast','%d{yyyy-MM-ddHH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')

**4、执行测试代码，查看数据库log表，发现日志信息已经加入表中**  
![在这里插入图片描述][6f487ed2dd4b4cf0876410f6006cdada.png]

### 7、自定义logger ###

1、配置文件

#指定日志的输出级别与输出端
    # 指定日志级别=trace 使用apeender = Console
    log4j.rootLogger=trace,Console
    
    # 自定义logger对象设置
    log4j.logger.com.atguigu.redis_springboot.log4j = debug,file
    # 自定义apache类型对象设置
    log4j.logger.org.apache = error

2、测试代码

@Test
        public void testQuick() {
        
            // 初始化配置信息，在入门案例中暂时不使用配置文件
    //         BasicConfigurator.configure();
    
            // 开启log4j内置日志记录
            LogLog.setInternalDebugging(true);
    
            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"); // 追踪信息，记录程序的所有流程信息
    
    
            // 创建一个apache类型的logger
            Logger logger1 = Logger.getLogger(Logger.class);
            logger1.fatal("fatal"); // 严重错误，一般会造成系统崩溃和终止运行
            logger1.error("error"); // 错误信息，但不会影响系统运行
            logger1.warn("warn"); // 警告信息，可能会发生问题
            logger1.info("info"); // 程序运行信息，数据库的连接、网络、IO操作等
            logger1.debug("debug"); // 调试信息，一般在开发阶段使用，记录程序的变量、参数等
            logger1.trace("trace"); // 追踪信息，记录程序的所有流程信息
        }

打印控制台  
Log4jTest是debug级别的  
Logger：error级别的  
![在这里插入图片描述][db3021f24f4b4dabbc9e26a97fec2453.png]

## 二、JCL学习 ##

### 1、代码实现 ###

**1、导入依赖**

<dependency>
        <groupId>commons-logging</groupId>
        <artifactId>commons-logging</artifactId>
        <version>1.2</version>
     </dependency>

**2、测试代码**  
**如果pom文件中导入了log4j依赖，则底层使用的还是log4j日志技术，体现了jcl面向接口开发**

public class JclTest {
        
    
        /**
         * 如果pom文件中导入了log4j依赖，则底层使用的还是log4j日志技术，体现了jcl面向接口开发
         */
        @Test
        public void testQuick(){
        
            Log log = LogFactory.getLog(JclTest.class);
            log.info("hello jcl");
        }
    }

**控制台输出信息**  
![在这里插入图片描述][f0857d396d0b40e58cd482525014a60c.png]

### 2、我们为什么要使用日志门面 ###

1.  面向接口开发，不再依赖具体的实现类。减少代码的耦合
2.  项目通过导入不同的日志实现类，可以灵活的切换日志框架
3.  统一API，方便开发者学习和使用
4.  统一配置便于项目日志的管理

![在这里插入图片描述][90064b44fc8040af947396a04c7a01d5.png]

[9230d42af7d04f22aa3482588758fb66.png]: https://img-blog.csdnimg.cn/9230d42af7d04f22aa3482588758fb66.png
[c3e3ea212db34f5aa6e729b9298b66e4.png]: https://img-blog.csdnimg.cn/c3e3ea212db34f5aa6e729b9298b66e4.png
[b7e1251a24e64ceb8c671da545923685.png]: https://img-blog.csdnimg.cn/b7e1251a24e64ceb8c671da545923685.png
[5575c76356f94c968c3875cf3e9a1e34.png]: https://img-blog.csdnimg.cn/5575c76356f94c968c3875cf3e9a1e34.png
[34c51fd33dd84711a806839ea2ab0b56.png]: https://img-blog.csdnimg.cn/34c51fd33dd84711a806839ea2ab0b56.png
[41a9a7980ac24d7d8db22e1507073675.png]: https://img-blog.csdnimg.cn/41a9a7980ac24d7d8db22e1507073675.png
[6f487ed2dd4b4cf0876410f6006cdada.png]: https://img-blog.csdnimg.cn/6f487ed2dd4b4cf0876410f6006cdada.png
[db3021f24f4b4dabbc9e26a97fec2453.png]: https://img-blog.csdnimg.cn/db3021f24f4b4dabbc9e26a97fec2453.png
[f0857d396d0b40e58cd482525014a60c.png]: https://img-blog.csdnimg.cn/f0857d396d0b40e58cd482525014a60c.png
[90064b44fc8040af947396a04c7a01d5.png]: https://img-blog.csdnimg.cn/90064b44fc8040af947396a04c7a01d5.png