日志是代码调试、生产运维必备工具,基本所有软件都会有日志记录。
1.常用日志框架介绍
1.Logging
jdk1.5自带日志工具类,位于java.util.logging;
2.Log4j
市场占有率最高的一个日志框架,注意2015/08/05这一天,Apache宣布停止维护了,用户需要切到Log4j2上面去;
3.commons-logging,
apache最早提供的日志门面接口,用户可以根据自己喜欢选择不同日志实现框架,而不必改动日志定义。
4.slf4j
simple logging facade for java,也是日志门面接口框架,和 Apache 的 commons-logging 是一样的概念,它们都不是具体的日志框架,你可以指定其他主流的日志实现框架。使用 Slf4j 可以很灵活的使用占位符进行参数占位,简化代码,拥有更好的可读性。
5.Logback
是 Slf4j 的原生实现框架,同样也是出自 Log4j 一个人之手,但拥有比 log4j 更多的优点、特性和更做强的性能,现在基本都用来代替 log4j 成为主流。
2.日志级别
Log4j 的级别类 org.apache.log4j.Level 里面定义了日志级别,日志输出优先级由高到底分别为以下8种。
OFF,关闭,不输出日志
FATAL,致命,输出非常严重的可能会导致应用程序终止的错误
ERROR,错误,应用程序还能继续运行
WARN,警告,输出可能潜在的危险状况
INFO,信息,输出应用运行过程的详细信息
DEBUG,调试,输出更细致的对调试应用有用的信息
TRACE,跟踪,输出更细致的程序运行轨迹
ALL,所有,输出所有级别的信息
如果应用程序的日志级别设为L,一个级别为P的输出日志只有P >= L时才会输出。
3.日志打印规范
1.正确定义
private static final Logger LOG = LoggerFactory.getLogger(ClassName.getClass); //变量类型Log是门面接口框架中的类,实现类可以是Log4j、Logback,不要把实现类定义为变量类型,否则日志切换不方便,也不符合抽象编程思想。
2.使用参数化形式{}占位,[]进行参数隔离
LOG.debug("Save order with order no:[{}], and order amount:[{}]");
如果日志框架不支持参数化形式,且日志输出时不支持该日志级别时会导致对象冗余创建,浪费内存,此时就需要使用 isXXEnabled 判断,
if(LOG.isDebugEnabled()){
LOG.debug("orderid:" + orderno + ",amount:" + amount);
}
推荐使用SLF4J的门面接口,可以用参数化形式输出日志,debug级别也不必用if判断,简化代码。
3.代码中日志级别使用
项目中常用日志级别ERROR、WARN、INFO、DEBUG四种
ERROR,一般永安里记录程序任何异常信息(catch时使用)或者业务逻辑出错。
WARN,一般用来记录一些用户输入错误。
INFO,用来记录程序的一些有用信息,输入输出参数、耗时、开始结束等。
DEBUG,程序运行过程中的中间参数,只希望开发环境出现,线上不需要的信息。
4.常见不要
<1>不要使用System.out.print...
<2>不要使用e.printStactTrack(),该方法本质是调用System.err输出到tomcat的控制台,不会记录到日志文件中。
<3>不要抛出自定义异常前,又输出日志,而是应该由最终捕获方法进行异常处理。
<4>不要使用具体的日志实现类
<5>不要只输出部分异常信息
LOG.error("***发生异常",e.getMessage()); //不好
LOG.error("***发生异常", e); //正确
<6>不要再千层嵌套中输出日志,容易拖累应用程序,而是应该用变量记录要点,循环外打印。
<7>禁止在线上环境开启debug, 非常重要,一个是项目本身Debug日志太多,而是各大框架大量使用Debug的日志,线上业务调用多,很快就会把磁盘打满。
以上参考
4.log4j.xml文件配置讲解
1.Log4j支持两种配置文件格式,一种是XML格式文件,一种是properties格式的文件。这里介绍xml格式
(1) Appender:日志输出器,配置日志的输出级别、输出位置等,包括以下几类
ConsoleAppender::输出到控制台
FileAppender:输出到文件
RollingFileAppender:输出到文件,文件达到一定阈值,自动备份日志文件
DailyRollingFileAppender:可定期备份日志文件,默认一天一个文件,也可以设置为每分钟一个,每小时一个
WriterAppender:可自定义日志输出位置
(2)日志级别
虽然日志级别包括八种,但常用的四个包括、DEBUG/INFO/WARN/ERROR
(3)输出格式
支持格式包括
1.org.apache.log4j.HTMLLayout(以HTML表格形式布局),
2.org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
3.org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
4.org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
Log4J最常用的日志输出格式为:org.apache.log4j.PatternLayOut,其主要参数为:
%n - 换行
%m - 日志内容
%p - 日志级别(FATAL, ERROR,WARN, INFO,DEBUG or custom)
%r - 程序启动到现在的毫秒数
%t - 当前线程名
%d - 日期和时间, 一般使用格式 %d{yyyy-MM-dd HH:mm:ss, SSS}
%l - 输出日志事件的发生位置, 同 %F%L%C%M
%F - java 源文件名
%L - java 源码行数
%C - java 类名,%C{1} 输出最后一个元素
%M - java 方法名
5.log4j.xml示例
demo1
`
demo2
以上参考
其他参考
properties文件配置参考
Java日志的前世今生