log4j入门贴

最新推荐文章于 2023-11-09 13:26:29 发布
原创 最新推荐文章于 2023-11-09 13:26:29 发布 · 845 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#log4j MDC #log4j NDC #log4j入门

本文介绍了log4j作为日志框架的基础使用，重点讲解了log4j的配置，包括logger、appender和layout的构成及作用。通过示例展示了如何将日志输出到控制台和文件，并详细解析了PatternLayout的转换模式，如%d、%t、%m等。此外，还探讨了NDC和MDC在多线程日志记录中的应用，以帮助区分不同请求的日志。

apache log4j是项目很常用的日志框架，这篇文章我们来学习下log4j。我使用的是1.2.17版本的log4j。log4j没有第三方依赖，直接将这个jar加入到项目的build path中就可以使用了。java代码中使用log4j很容易，如下：

package aty.log;

import org.apache.log4j.Logger;

public class HelloLog4j 
{

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

	public static void main(String[] args) 
	{
		logger.debug("This is debug message.");
		logger.info("This is info message.");
		logger.error("This is error message.");
		logger.fatal("This is fatal message.");	
	}
}

在classpath下建立一个log4j.properties，log4j会自动加载classpath下的log4j.properties文件。



我们主要看下log4j的配置，这个才是log4j入门最需要掌握的东西。log4j主要由三大类组件构成：logger、appender和layout。logger决定什么级别的日志可以输出，什么级别的日志不能输出。appender决定日志输出的目的地。layout用来对输出的日志进行格式化。一个logger可以有多个appender，但是每个appende只能对应一个layout。


例子1：将日志输出到控制台

log4j.rootLogger=debug, console

#配置实现类
log4j.appender.console=org.apache.log4j.ConsoleAppender

#ConsoleAppender的配置
log4j.appender.console.Threshold=warn
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,SS}-[%t]-[%l]-%p %m%n


例子2：日志输出到文件中 
log4j.rootLogger=debug, file

#配置实现类
log4j.appender.file=org.apache.log4j.FileAppender

#FileAppender的配置
log4j.appender.file.Threshold=warn
log4j.appender.file.ImmediateFlush=true
log4j.appender.file.File=c:/app.log
log4j.appender.file.Append=true

#日志输出格式
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SS}-[%t]-[%l]-%p %m%n

例子3：日志同时输出到控制台和文件

log4j.rootLogger=debug, console, file

#配置实现类
log4j.appender.console=org.apache.log4j.ConsoleAppender

#ConsoleAppender的配置
log4j.appender.console.Threshold=warn
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,SS}-[%t]-[%l]-%p %m%n


#配置实现类
log4j.appender.file=org.apache.log4j.FileAppender

#FileAppender的配置
log4j.appender.file.Threshold=warn
log4j.appender.file.ImmediateFlush=true
log4j.appender.file.File=c:/app.log
log4j.appender.file.Append=true

#日志输出格式
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SS}-[%t]-[%l]-%p %m%n


（一）配置logger： 
log4j.rootLogger=debug, console, file
配置显示什么级别的日志、以及日志要输出到哪里。这里我们定义了2个目的地：console和file，这是appender的名称，后面配置具体的appender和layout的时候需要用。


（二）配置appender：

log4j提供了多种appender，不同的appender将日志输出到不同的目的地。比较常用的有4个：ConsoleAppender、FileAppender、DailyRollingFileAppender、RollingFileAppender。不同的appender，有着不同的类名，不同的配置属性。

1.ConsoleAppender的配置：

#配置ConsoleAppender的全类名
log4j.appender.console=org.apache.log4j.ConsoleAppender

#设置输出日志的最低级别。如果没有设置，那么使用log4j.rootLogger中配置的级别。
log4j.appender.console.Threshold=warn

#默认值是true,意谓着所有的消息都会被立即输出。如果设置成false，那么当缓存区达到一定大小才会输出。
log4j.appender.console.ImmediateFlush=true

#设置输出控制台，默认情况下是：System.out
log4j.appender.console.Target=System.err


2.FileAppender配置： 
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.Threshold=warn
log4j.appender.file.ImmediateFlush=true

#设置日志输出到app.log文件中
log4j.appender.file.File=c:/app.log

#默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
log4j.appender.file.Append=true

3.DailyRollingFileAppender配置： 
log4j.appender.DailyRollingFileAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.DailyRollingFileAppender.Threshold=warn
log4j.appender.DailyRollingFileAppender.ImmediateFlush=true
log4j.appender.DailyRollingFileAppender.File=c:/app.log

#经过我的实验,如果想要按照不同频率产生新文件,append一定要设置成true
log4j.appender.DailyRollingFileAppender.Append=true

#设置是按照什么频率产生新文件
#'.'yyyy-MM: 每月
#'.'yyyy-ww: 每周 
#'.'yyyy-MM-dd: 每天
#'.'yyyy-MM-dd-a: 每天两次
#'.'yyyy-MM-dd-HH: 每小时
#'.'yyyy-MM-dd-HH-mm: 每分钟
log4j.appender.DailyRollingFileAppender.DatePattern='.'yyyy-MM-dd-HH-mm

4.RollingFileAppender配置 
log4j.appender.RollingFileAppender=org.apache.log4j.RollingFileAppender
log4j.appender.RollingFileAppender.Threshold=warn
log4j.appender.RollingFileAppender.ImmediateFlush=true
log4j.appender.RollingFileAppender.File=c:/app.log
log4j.appender.RollingFileAppender.Append=true

#后缀可以是KB,MB或者是GB.在日志文件到达该大小时，将会自动滚动，即将原来的内容移到app.log.1文件。
log4j.appender.RollingFileAppender.MaxFileSize=10KB
#设置可以产生的滚动文件的最大数。
log4j.appender.RollingFileAppender.MaxBackupIndex=5


（三）配置layout

layout设置日志输出的格式，常见的有HTMLLayout、PatternLayout、SimpleLayout、TTCCLayout。项目中使用的都是PatternLayout，其他三种layout输出日志信息太简单，不能满足定位问题的需要。我们主要看下PatternLayout。

log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS}-[%t]-[%l]-%p %m%n
ConversionPattern配置采用什么样的格式输出日志。
%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL。

%d: 输出日志时间点的时间.比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2015-12-23 15:41:13,933。

%t: 输出产生该日志事件的线程名。

%m: 输出代码中指定的消息,产生的日志具体信息。

%n: 输出一个回车换行符，Windows平台为"\r\n"，Unix平台为"\n"输出日志信息换行。

%l: 输出日志事件的发生位置，包括类名、方法名、文件名以及在代码中的行数。

%x: 输出和当前线程相关联的NDC。

%X:输出和当前线程相关的MDC。

当然ConversionPattern还有别的格式可以设置，比如%r、%c等。不过上面介绍的几个格式，就已经能够满足项目使用了。现在我们介绍下MDC和NDC。我们知道对于servlet这种应用来说，日志里面仅仅打印%t线程名是不够的。因为tomcat等容器会建立一个线程池，复用这些线程处理不同的客户端请求。那么就会出现：处理A请求和B请求的是同一个线程，这样就会导致日志文件中不能按照请求来搜索。如果按照线程名来搜索，那么A和B这2个不同请求的日志合在一起了，需要程序员自己去辨别：哪儿些是A请求的日志，哪儿些是B请求的日志。

实际上不同的请求肯定是有差别的，比如IP不同、session不同或者是业务上的主键不同。我们就可以使用NDC或者MDC将这些能够唯一区分请求的信息，写入日志文件。这样找某个请求的日志就简单多了。

使用NDC：

package aty.log;

import org.apache.log4j.Logger;
import org.apache.log4j.NDC;

public class HelloLog4j {

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

	public static void main(String[] args) {
		// 模拟从客户端获得IP地址的例子
		String[] ips = { "192.168.0.10", "192.168.0.27" };

		for (int i = 0; i < ips.length; i++) {
			NDC.push(ips[i]);
			logger.error("print ip in log.");
			NDC.pop();
		}

	}
}
log4j.rootLogger=debug, console
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=warn
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}-[%x]-[%t]-[%l]-%p %m%n


使用MDC：

package aty.log;

import org.apache.log4j.Logger;
import org.apache.log4j.MDC;

public class HelloLog4j {

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

	public static void main(String[] args) {
		// 模拟从客户端获得IP地址的例子
		String[] ips = { "192.168.0.10", "192.168.0.27" };

		for (int i = 0; i < ips.length; i++) {
			MDC.put("ip", ips[i]);
			logger.error("print ip in log.");
			MDC.remove("ip");
		}

	}
}

log4j.rootLogger=debug, console
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=warn
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}-[%X{ip}]-[%t]-[%l]-%p %m%n


下面给出我们项目实际用的ConversionPattern配置，一般的项目都是这么配置的。 
log4j.appender.console.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss,SSS}]-[%t]-[%X{user_name}]-[%l]-[%p] %m%n


Logger之Logger.getLogger(CLass)
lixwjava的专栏
05-24 4万+
之前一直在使用System.out.println()来调试.但是用这种方式开发项目部署到生产环境,会因为众多的控制台输出降低应用的性能.这时候Log4J就成为可平衡开发和部署应用的利器了.   在项目中使用Log4J并不是一件困难的事情,简单粗暴的方式就是在每个类A中声明一个Logger私有属性 private static Logger logger = Logger.getLogg
java：log4j：private static Logger logger = Logger.getLogger(MstNinushiAction.class); 什么意思？
不花的花和尚的博客
03-20 6109
后面的.class有什么作用？ Logger.getLogger(Class clazz) 语法 **.class是将你要加入日志的类加进入 假如你的myclass这个类需要加日志信息就在 private static Logger logger = Logger.getLogger(myclass.class); 这是获取一个myclass类的loggermyclass内定义的日志信息就能...
login4j使用总结
01-09
不错的总结，情大家注意下载
换掉 Log4j2..tinylog 横空出世，无需定义 logger 变量，简单、轻量、性能爆炸。。
Java技术栈，分享最主流的Java技术
01-19 280
背景 前段时间，日志框架各种爆雷，包括：Log4j 1.x, Log4j 2.x, Logback 等都有爆雷，几乎是团灭： Log4j 2.3.1 发布！又是什么鬼？？ Logback 也爆雷了，惊爆了。。。 Log4j, Logback 都是主流的日志框架，功能也非常强大，不仅仅是日志记录，所以，功能多，自然也会带来更多的漏洞。。 其实我们使用日志框架，最多的还是记录系统日志，其他的乱七八糟的功能用的非常少，所以，如果你想寻求一款简单的日志记录框架，可以试试这款轻量级的开源日志框架——tinylog
封装SLF4J/Log4j，不再处处定义logger变量
weixin_33860528的博客
10-19 491
转载请注明出处: 封装SLF4J/Log4j，不再处处定义logger变量懒得看实现过程的可以直接跳到最后看实现流程图和代码实现。Logback和log4j是内部实现相似，所以可以用类似的思路实现。 自从开始使用日志组件后， 每个类都是这样子的结构: public class A { public static final L...
login4j
shine4j的专栏
08-29 1079
import java.io.IOException; import javax.servlet.Filter; import javax.servlet.FilterChain; import javax.servlet.FilterConfig; import javax.servlet.ServletException; import javax.servlet.Servlet
login4j生成日志文件
04-01
login4j生成日志文件，能够方便的输出你的程序运行的信息，很好很强大！
Log4j日志配置详解
最新发布
想象之中丶
11-09 3946
Level综合使用这三个组件能轻松地记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。
Log4j 2.x 配置详解及详细配置例子
weixin_33775582的博客
07-24 718
转自：https://blog.youkuaiyun.com/why_still_confused/article/details/79116565 本文主要内容分为以下两部分：　　1.Log4j 2.x的官方配置详解的翻译总结　　2.Log4j 2.x的详细配置例子及注释更多有关Log4j的内容详见Log4j 2.x的体系架构详解配置语法　　从版本2.9开始，出于安全原因，L...
Log4j日志实现
06-03 983
简介 本篇是关于Log4j日志框架的介绍。 阅读本文请至少了解JUL日志框架，因为大部分的知识点是类似的。 Log4j日志框架 Log4j全称是Log for Java，它是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输出的位置是控制台、文件还是GUI组件，输出位置甚至可以是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等； 使用Log4j也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。 入门案例 所使用的项目使用.
idea: 程序包org.apache.logging.log4j.Logger不存在
qq_21954477的博客
10-28 9879
在git上拉了一个SpringBoot的项目（未提交iml文件）到本地，代码在编译器中未标红，打包也没问题，但是在启动项目build时，报错： Error:(3, 32) java: 程序包org.apache.logging.log4j.Logger不存在 Error:(3, 32) java: 程序包org.apache.commons.lang3.StringUtils不存在 Error:(3, 32) java: 程序包org.springframework.boot不存在 … 很多包都找不到。 1
private static Logger logger =Logger.getLogger(AssembleMsgService.class)什么意思？
Dustmicro的博客
08-05 3226
作为一个新人中的菜鸡，最近在看一个项目的代码其中有这么一段看得我很是费解 public class AssembleMsgService { private static Logger logger = Logger.getLogger(AssembleMsgService.class); 1、Logger logger = logger.getlogger(); 看到这个会想到这是log4j下的一个方法,log4j是一个开源项目，通过在项目中使用Log4J我们可以控制日志信息输出到控制台、文件、GUI
log4j教程 6、Logger方法
weixin_30642267的博客
07-14 293
Logger类提供了多种方法来处理日志活动。 Logger类不允许实例化一个新的记录器实例，但它提供了两个静态方法获得一个 Logger 对象： public static Logger getRootLogger(); public static Logger getLogger(String name); 此处两种方法的第一个返回应用程序实例根记录器并没有名字。任...
java 日志管理类_Java日志管理
weixin_39569894的博客
02-24 198
第一、Logger.getLogger()和LogFactory.getLog()的区别1.Logger.getLogger()是使用log4j的方式记录日志；2.LogFactory.getLog()则来自apache的common-logging包。common-logging组件： Jakarta Commons Logging (JCL)提供的是一个日志(Log)接口(in...
java logger
siwenqi的博客
03-08 379
 之前一直在使用System.out.println()来调试.但是用这种方式开发项目部署到生产环境,会因为众多的控制台输出降低应用的性能.这时候Log4J就成为可平衡开发和部署应用的利器了.  在项目中使用Log4J并不是一件困难的事情,简单粗暴的方式就是在每个类A中声明一个Logger私有属性[html] view plain copyprivate static Logger logger ...
log4j2 你真的会用吗
Wengy的博客
06-10 3779
大家一提到log4j2的优化，可能就会有人说，采用异步日志 最近因为工作的原因最近在做压测，由于某个项目中的日志量特别的大，于是就在网上搜了很多文章，网上有许多讲log4j2配置调优配置，但实际验证下来，却有很大的出入（误人子弟）。没办法，只能自己亲自验证，分析。 首先先抛出结论： 开启异步日志以后，如果日志的生产速度，大于消费速度的话，那么异步的效率反而会比同步的低。在官网的一句描述中找到原因 参考:https://logging.apache.org/log4j/2.x/manual/async.h
logback性能优化详解
弹指天下
06-06 5536
不正确的日志打印不但会降低程序运行性能，还会占用大量IO资源和硬盘存储空间。本文主要总结一些能提高日志打印性能的手段。
log4j的用法---含例子
weixin_50797718的博客
02-25 772
log4j的一些配置文章 http://www.cnblogs.com/gaishishengzhu/articles/1735441.html http://www.ibm.com/developerworks/cn/java/l-connpoolproxy/ http://www.iteye.com/topic/378077 http://hi.baidu.com/annleecn/blog/item/1ffedba3692f6fabcaefd048.html log4j是一个非常强大的log记录软件，
Logback详解
热门推荐
霓虹深处
09-13 5万+
简介 Logback是SpringBoot内置的日志处理框架,你会发现spring-boot-starter其中包含了spring-boot-starter-logging，该依赖内容就是 Spring Boot 默认的日志框架 logback。官方文档：http://logback.qos.ch/manual/ SpringBoot默认Logback配置 在我们启动SpringBoot，发现我们并没有主动去配置过任何和日志打印的相关配置，但是控制台却打印了相关的启动日志；因为SpringBoot为Logb
Log4j入门与高级配置详解
本篇教程旨在为初学者提供 Log4j 的全面入门指导。 **1. Log4j 简介** Log4j 的核心目标是通过一个配置文件，实现对日志输出的灵活控制，包括目的地（如控制台、文件、GUI、网络服务等）、输出格式、以及日志级别...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值