java sl4j 日志_Java日志框架Slf4j+Log4j入门

一.日志系统介绍

slf4j，即简单日志门面(Simple Logging Facade for Java)，不是具体的日志解决方案，它只服务于各种各样的日志系统。简答的讲就是slf4j是一系列的日志接口，而log4j是具体实现了的日志框架。

slf4j与常用日志框架绑定关系

二.导入jar包

Maven导入slf4j和log4j，编辑pom.xml

org.slf4j

slf4j-log4j12

1.7.25

三.配置log4j

log4j日志框架配置，编辑resources/log4j.xml

log4j的xml配置方式基本步骤有3个，第一步：配置appender；第二步：配置logger；第三步：配置root。

四.日志调用示例

Slf4j初始化时自动查找CLASSPATH路径下的log4j.xml配置文件

@Controller

@RequestMapping("/server")

public class IndexController {

private static final Logger LOGGER = LoggerFactory.getLogger(IndexController.class);

@ResponseBody

@RequestMapping("/hello")

public Object hello(String username) {

LOGGER.debug("Debug level log: username = " + username);

LOGGER.info("Info level log: username = " + username);

try {

throw new Exception("Error level log");

} catch (Exception e) {

LOGGER.error("Error level log: username = " + username, e);

}

return "hello " + username;

}

}

控制台日志，输出debug、info、error级别日志

日志文件log4j.log，输出info和error级别日志，未输出debug级别日志

五.日志输出格式符号含义

%p:输出日志信息优先级，即TRACE，DEBUG，INFO，WARN，ERROR，FATAL

%d:输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式

%r:输出自应用启动到输出该log信息耗费的毫秒数

%c:输出日志信息所属的类目，通常就是所在类的全名

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

%l:输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数

%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中

%%:输出一个"%"字符

%F:输出日志消息产生时所在的文件名称

%L:输出代码中的行号

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

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

六.阿里巴巴日志规约

1.【强制】应用中不可直接使用日志系统 (Log 4 j 、Logback) 中的 API ,而应依赖使用日志框架SLF4J中的 API ,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Abc.class);

2.【强制】日志文件推荐至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。

3.【强制】应用中的扩展日志 ( 如打点、临时监控、访问日志等 ) 命名方式:appName _ logType _ logName . log 。 logType :日志类型,推荐分类有stats / desc / monitor / visit 等 ;logName :日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。

正例: mppserver 应用中单独监控时区转换异常,如:

mppserver _ monitor _ timeZoneConvert . log

说明:推荐对日志进行分类,如将错误日志和业务日志分开存放,便于开发人员查看,也便于通过日志对系统进行及时监控。

4.【强制】对 trace / debug / info 级别的日志输出,必须使用条件输出形式或者使用占位符的方式。

说明: logger . debug( " Processing trade with id : " + id + " and symbol : " + symbol);如果日志级别是 warn ,上述日志不会打印,但是会执行字符串拼接操作,如果 symbol 是对象,会执行 toString() 方法,浪费了系统资源,执行了上述操作,最终日志却没有打印。

正例: ( 条件 )

if (logger.isDebugEnabled()) {

logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);

}

正例: ( 占位符 )

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

5.【强制】避免重复打印日志,浪费磁盘空间,务必在 log 4 j . xml 中设置 additivity = false 。

正例:

6.【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过关键字 throws 往上抛出。

正例: logger.error(各类参数或者对象 toString+ "_" + e.getMessage(), e);

7.【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志 ; 有选择地输出 info 日志 ; 如果使用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。

说明:大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。记录日志时请思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?

8.【参考】可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适从。注意日志输出的级别, error 级别只记录系统逻辑出错、异常等重要的错误信息。如非必要,请不要在此场景打出 error 级别。