Log4j日志的下载、简介、使用及代码示例

数据库 2023-07-18 17:26:20 阅读次数: 0

Log4j日志的下载、简介、使用及代码示例

简介

Log4j（log for java）是Java主流的日志框架，是Apache的一个开放源代码项目，包名是org.apache.log4j.，它为Java开发的項目提供了一种细腻的、功能强大的、使用方便的日志管理方式。通过Log4j，我们不仅可以对输出的日志格式进行自定义，还可以自己定义日志输出的目的地，比如：控制台、GUI组件，文本文件，数据库，甚至能通过socket输出到远程套接字服务器。通过使用Log4j，我们可以控制日志信息输送的目的地（控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等）、日志的输出格式、日志的生成过程（通过定义每一条日志信息的级别）。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

通过一个配置文件，我们可以多选择的控制每条日志的输出格式和目的地；通过定义信息的级别，我们也可以灵活开关代码中的反馈信息。简单地说，log4j就是帮助开发人员进行日志输出管理的API类库。它最重要的特点就可以配置文件灵活的设置日志信息的优先级、日志信息的输出目的地以及日志信息的输出格式。也正是如此，给Log4j带来了一个缺点——需要通过java程序动态设置：如果需要修改日志输出级别等信息，则必须修改java文件，然后重新编译，很是麻烦。

下载地址

此处先给出其他博客给的官网下载地址（自己未成功）。

不同的日志框架

Java日志系统的分类如下图所示。
在这里插入图片描述

用途

在应用程序中输出日志，有三个目的：

  • 监视代码中变量的运行情况，把数据周期性的记录到文件中供其他应用进行统计分析工作。
  • 跟踪代码运行时轨迹，作为日后审计依据。
  • 充当集成开发环境中的调试器作用，向文件或控制台打印代码的调试信息。

使用log的好处：通常的做法就是在代码中嵌入许多的打印语句，这些打印语句可以输出到控制台或文件中，但这导致了大量打印语句充斥了代码主体。推荐的做法就是构造一个日志操作类 来封装此类操作，但这不依然充斥了代码主体吗？

其记录的日志可以放在控制台和日志文件中，区别在于控制台的信息是临时的，而日志文件可以永久保留。

控制台信息与日志信息的区别

与控制台输出system.out.println的区别如下图所示，system.out.println仅输出了其内的内容，而logger.info、debug除了输出其内的内容，还输出了时间、其所在的包名（yueqian.com）、其所在的类名（Log4jDemo）、其所在的方法（main）。
在这里插入图片描述

组成

在这里插入图片描述

  • Logger（记录器）：日志写出器，负责生成日志并能够对日志信息进行分类筛选——即决定输出哪些信息。

  • Appender（输出源）：日志目的地，定义了日志信息的输出目的地，指定【格式化好的日志信息】应该输出到什么地方。Log4j提供的appender有以下几种：

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

  • Layout（布局）：日志格式化器，用来把程序员的logging request格式化成字符串。

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

  • Layout.ConversionPattern：指定输出日志信息的内容和格式：

    • %m 输出代码中指定的消息
    • %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
    • %r 输出自应用启动到输出该log信息耗费的毫秒数
    • %c 输出所属的类目，通常就是所在类的全名
    • %t 输出产生该日志事件的线程名
    • %n 输出一个回车换行符，Windows平台为“rn”，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)

     
    比如Layout.ConversionPattern定义为log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n，实际输出的信息是2023-04-15 16:10:17,859 method:com.bjsasc.JavaProject.Test.generateLogFileUsingLog4j(Test.java:21)

Logger 日志记录器

Logger对象是用来取代System.out或者System.err的日志写出器，用来供程序员输出日志信息。

Appender 日志目的地（Windows下的路径分隔符）※

FileAppender

当选用org.apache.log4j.FileAppender等将日志信息存入文件的Appender时，请注意，使用Log4j在Windows操作系统下、生成日志文件时，日志文件的路径依然使用Linux的分隔符/，比如C:/Users/lu/Desktop/ljh/logFileForLog4j/debug.log，而非Windows的\！！！

JDBCAppender（用log4j将日志写入数据库）

log4j将日志写入数据库的方法详见这篇博客。

Layout 日志信息布局

layout 指定输出的样式模板？

layout = org.apache.log4j.PatternLayout

layout.ConversionPattern 指定输出的每项内容及其格式顺序

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

日志信息等级/优先级（org.apache.log4j.Level类）

每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分为：

  • off 最高等级，用于关闭所有日志记录，log4j中未提供此级别日志。
  • fatal 指出每个严重的错误事件将会导致应用程序的退出。
  • error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
  • warn 表明会出现潜在的错误情形。
  • info 一般和在粗粒度级别上，强调应用程序的运行全程。
  • debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
  • trace
  • all 最低等级，用于打开所有日志记录，log4j中未提供此级别日志。

上面这些级别是定义在org.apache.log4j.Level类中，但是Log4j只建议使用4个级别，优先级从高到低分别是error、warn、info和debug，分别用来指定这条日志信息的重要程度。通过使用日志级别，可以控制应用程序中相应级别日志信息的输出。例如，如果使用了info级别，则应用程序中所有低于info级别的日志信息(如debug)将不会被打印出来。
日志信息的输出目的地指定了日志将打印到控制台还是文件中；输出格式控制了日志信息的显 示内容。

使用的Log4j的jar包

此处先给出所用Log4j的jar包。

	<dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.14</version>
      <scope>provided</scope>
    </dependency>

使用方法

这篇博客有详细说明，待补入本文。
有人将书本中的log4j使用方法的内容发到此博客，补入本文

打印运行过程中的系统报错信息（从其他博客看到，待验证）

需在try-catch块中使用，如下图所示。
在这里插入图片描述
日志文件中的记录，如下图所示。
在这里插入图片描述

代码示例

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

XML文件

待补

log4j.properties

log4j.properties文件创建的位置如下所示，

  • Java工程：在src/main/java下，与【】存放代码的包package平级。
    在这里插入图片描述
    -SpringBoot工程：要放在src/main/resources下，
    在这里插入图片描述
    调用log4j的代码如下所示。
  • 此处创建Logger日志记录器的方法，选择了自动快速地使用缺省Log4j环境，读取log4j.properties文件。
  • 使用自定义的配置文件方式创建Logger 日志记录器的方法详见此博客。
import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Logger;

public class Test {
    
    

	public static void main(String[] args) {
    
    
		// TODO Auto-generated method stub
		Test test = new Test();
		test.generateLogFileUsingLog4j();
	}
	
	public Test() {
    
    
		// TODO Auto-generated constructor stub
	}
	
	public void generateLogFileUsingLog4j() {
    
    
		Logger log = Logger.getLogger(Test.class);
		//Logger log = Logger.getLogger(Test.class.getName());//尚未发现二者的区别，待补
		
		BasicConfigurator.configure();// 自动快速地使用缺省Log4j环境，读取log4j.properties文件。
		//  记录 debug 级别的信息   
        logger.debug("This is debug message.");  
        //  记录 info 级别的信息   
        logger.info("This is info message.");  
        //  记录 error 级别的信息   
        logger.error("This is error message.");

		//从其他博客中找到的打印各种级别日志的方法，待验证
		public void trace(Object message);
		public void debug(Object message);
		public void info(Object message);
		public void warn(Object message);
		public void error(Object message);
		public void fatal(Object message);
	}

}

 
log4j的配置文件log4j.properties内容如下所示。

### 设置###  
log4j.rootLogger = debug,console,D,E  
  
### 输出INFO? 级别以上的信息到C:/Users/lu/Desktop/ljh/logFileForLog4j/info.log日志文件
log4j.appender.console = org.apache.log4j.FileAppender
log4j.appender.console.File = C:/Users/lu/Desktop/ljh/logFileForLog4j/info.log
log4j.appender.console.Append = true
log4j.appender.console.Threshold = INFO
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern = [%-5p] %d{
    
    yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
#设置文件输出编码，待确认
log4j.appender.console.encoding=UTF-8 

 
### 输出DEBUG 级别以上的信息到C:/Users/lu/Desktop/ljh/logFileForLog4j/debug.log日志文件
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D = org.apache.log4j.FileAppender
log4j.appender.D.File = C:/Users/lu/Desktop/ljh/logFileForLog4j/debug.log
log4j.appender.D.Append = true
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
#设置文件输出编码，待确认
log4j.appender.D.encoding=UTF-8

  
### 输出ERROR 级别以上的信息到C:/Users/lu/Desktop/ljh/logFileForLog4j/error.log日志文件
log4j.appender.E = org.apache.log4j.FileAppender
log4j.appender.E.File =C:/Users/lu/Desktop/ljh/logFileForLog4j/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
#设置文件输出编码，待确认
log4j.appender.E.encoding=UTF-8

log4j的设置

将信息展示在控制台

第一行中的debug表示能输出的信息的最高级别，级别先后为debug>info>error，例如设置级别为debug，则显示 debug 、 info 、 error；设置级别为info，则显示 info 、 error；设置级别为error，则只显示error。
第一行中的stdout是控制台名，此名可以随意更改，但请注意，下方中在控制台名时，需与上面声明控制台名称保持一致。
在这里插入图片描述

将信息记录在日志文件中

将信息记录在日志文件中，比展示在控制台，要在第一行多一个参数logfile。
并且在logfile.File中定义日志文件的名字为mylog.log，如下图第一个红框所示。
输出的日志信息类型如下图第二个红框所示，分别是日志级别，日后再补。
在这里插入图片描述

日志文件中的记录，如下图所示。
在这里插入图片描述

使用Log4j打jar包时，log4j的配置文件log4j.properties需要一并放入jar包中

猜你喜欢

转载自blog.csdn.net/u010804417/article/details/130168386
今日推荐
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
GCC 14.1 发布
面壁智能发布 Eurux-8x22B 开源大模型 —— 堪称「理科状元」
开源日报 | 谷歌扶持鸿蒙上位；开源Rabbit R1；Docker加持的安卓手机；微软的焦虑和野心；海尔电器把开放平台关了
中国码农的“35岁魔咒”
蘭雅 CorelDRAW 插件 2024.5.1 国际劳动节版，免费下载
Arc Browser for Windows 1.0 正式 GA
90后程序员开发视频搬运软件、不到一年获利超 700 万，结局很刑！
周排行
Java自定义时间格式
同步整形电路
在开发中最最最常用的字符串的属性大集合
Linux 查看端口占用并杀掉
Java基础四：ArrayList
多线程之死锁就是这么简单
mysql 基础命令集
awk 命令详解
Centos6.3编译安装nginx+php步骤
OCR （Optical Character Recognition，光学字符识别）
每日归档
更多
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)
2024-05-03(19)
2024-05-02(0)
2024-05-01(4)
2024-04-30(1)
2024-04-29(40)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022