专栏名称: 51CTO技术栈
有趣 | 有料 | 有内涵,为您提供最优质的内容,愿我们一起悦享技术,成就人生。
51好读  ›  专栏  ›  51CTO技术栈

别小看Log日志,它难倒了技术总监

51CTO技术栈  · 公众号  · 程序员  · 2021-01-14 18:05

正文

送福利啦

关注 鸿蒙技术社区 ,回复 【鸿蒙】 价值 399元 的鸿蒙 开发板套件 (数量有限,先到先得) ,还可以 免费下载 鸿蒙 入门资料


👇 扫码 立刻关注 👇

专注开源技术,共建鸿蒙生态

在最近的开会中,讨论到一些异常的处理,以及日志的输出。是的,这些看起来小的不能再小的事,发生了分歧。


图片来自 Pexels

因为大家普遍只对 Log4j 了解,而对其余的却基本未曾使用。我们的 Leader 也表示对 ELK 这类大规模日志由于好久不使用,也有点生疏了。所以今天总结了一下关于日志的介绍。


日志对于程序员是不可或缺的,在我们的开发过程中,写完代码需要调试的话,日志是必须的,日志可以帮助我们定位我们的问题,从而更好地帮助我们解决 Bug。


本期就给大家详细了解一下我们经常使用到的四种日志类型,帮助大家提高开发效率。


Slf4j


Slf4j 的全称是 Simple Loging Facade For Java,它仅仅是一个为 Java 程序提供日志输出的统一接口,并不是一个具体的日志实现方案,就比如 JDBC 一样,只是一种规则而已。


所以单独的 Slf4j 是不能工作的,必须搭配其他具体的日志实现方案,比如:

  • Apache 的 org.apache.log4j.Logger。

  • JDK 自带的 java.util.logging.Logger 等。


简单语法


SLF4J 不及 Log4J 使用普遍,因为许多开发者熟悉 Log4J 而不知道 SLF4J,或不关注 SLF4J 而坚持使用 Log4J。


我们先看下 Log4J 示例:
Logger.debug




    
("Hello " + name);

由于字符串拼接的问题,使用以上语句会先拼接字符串,再根据当前级别是否低于 Debug 决定是否输出本条日志,即使不输出日志,字符串拼接操作也会执行。


所以许多公司强制使用下面的语句,这样只有当前处于 Debug 级别时才会执行字符串拼接:
if (logger.isDebugEnabled()) {
  LOGGER.debug(“Hello ” + name);
}

它避免了字符串拼接问题,但有点太繁琐了是不是?相对地,SLF4J 提供下面这样简单的语法:
LOGGER.debug("Hello {}", name);

它的形式类似第一条示例,而又没有字符串拼接问题,也不像第二条那样繁琐。


日志等级 Level


Slf4j 有四个级别的 log level 可供选择,级别从上到下由低到高,优先级高的将被打印出来:

  • Debug: 简单来说,对程序调试有利的信息都可以 debug 输出。

  • info: 对用户有用的信息。

  • warn: 可能会导致错误的信息。

  • error: 顾名思义,发生错误的地方。


使用


因为是强制规约,所以直接使用 LoggerFactory 创建:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Test {
    private static final Logger logger = LoggerFactory.getLogger(Test.class);
    // ……
}

配置方式


Spring Boot 对 Slf4j 支持的很好,内部已经集成了 Slf4j,一般我们在使用的时候,会对 Slf4j 做一下配置。


application.yml 文件是 Spring Boot 中唯一一个需要配置的文件,一开始创建工程的时候是 application.properties 文件,个人比较喜欢用 yml 文件,因为 yml 文件的层次感特别好,看起来更直观。


但是 yml 文件对格式要求比较高,比如英文冒号后面必须要有个空格,否则项目估计无法启动,而且也不报错。用 properties 还是 yml 视个人习惯而定,都可以。


我们看一下 application.yml 文件中对日志的配置:
logging:
  configclasspath:logback.xml
  level:
    com.bowen.daotrace

logging.config 是用来指定项目启动的时候,读取哪个配置文件,这里指定的是日志配置文件是 classpath:logback.xml 文件,关于日志的相关配置信息,都放在 logback.xml 文件中了。


logging.level 是用来指定具体的 mapper 中日志的输出级别,上面的配置表示 com.bowen.dao 包下的所有 mapper 日志输出级别为 trace,会将操作数据库的 sql 打印出来。


开发时设置成 trace 方便定位问题,在生产环境上,将这个日志级别再设置成 error 级别即可。


常用的日志级别按照从高到低依次为:ERROR、WARN、INFO、DEBUG。


Log4j


Log4j 是 Apache 的一个开源项目,通过使用 Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI 组件,甚至是套接口服务器、NT 的事件记录器、UNIX Syslog 守护进程等。

我们也可以控制每一条日志的输出格式;通过定义每条日志信息的级别,我们能够更加细致地控制日志的生成过程。


组成架构


Log4j 由三个重要的组成构成:

  • Logger: 控制要启用或禁用哪些日志记录语句,并对日志信息进行级别限制。

  • Appenders: 指定了日志将打印到控制台还是文件中。

  • Layout: 控制日志信息的显示格式。


Log4j 中将要输出的 Log 信息定义了 5 种级别,依次为 DEBUG、INFO、WARN、ERROR 和 FATAL。


当输出时,只有级别高过配置中规定的级别的信息才能真正的输出,这样就很方便的来配置不同情况下要输出的内容,而不需要更改代码。


日志等级 Level


Log4j 日志等级主要有以下几种:

  • off: 关闭日志,最高等级,任何日志都无法输出。

  • fatal: 灾难性错误,在能够输出日志的所有等级中最高。

  • error: 错误,一般用于异常信息。

  • warn: 警告,一般用于不规范的引用等信息。

  • info: 普通信息。

  • debug: 调试信息,一般用于程序执行过程。

  • trace: 堆栈信息,一般不使用。

  • all: 打开所有日志,最低等级,所有日志都可使用。


在 Logger 核心类中, 除了 off/all 以外, 其他每个日志等级都对应一组重载的方法,用于记录不同等级的日志。当且仅当方法对应的日志等级大于等于设置的日志等级时,日志才会被记录。


使用


使用 Log4j 只需要导入一个 jar 包:
<dependency>
 <groupId>org.log4jgroupId>
   <artifactId>log4jartifactId>
   <version>1.2.9version>
dependency>e


配置方式


在 Resources Root 目录下创建一个 log4j.properties 配置文件,一定要注意:文件的位置和文件名一个都不能错,然后在 properties 文件中添加配置信息。
log4j.rootLogger=debug,cons

log4j.appender.cons=org.apache.log4j.ConsoleAppender 
log4j.appender.cons.target=System.out  
log4j.appender.cons.layout=org.apache.log4j.PatternLayout 
log4j.appender.cons.layout.ConversionPattern=%m%n

propertis 文件是最常用的配置方式。实际开发过程中,基本都是使用properties 文件。


pripertis 配置文件的配置方式为:

# 配置日志等级, 指定生效的Appender名字, AppenderA是定义的Appender的名字
log4j.rootLogger=日志等级,AppenderA,AppenderB,... 
# ---------------- 定义一个appender------------------------
# 定义一个appender, appender名字可以是任意的, 
# 如果要使该appender生效, 须加入到上一行rootLogger中, 后面为对应的Appender类
log4j.appender.appender名字=org.apache.log4j.ConsoleAppender 
log4j.appender.appender名字.target=System.out  
# 定义Appender的布局方式
log4j.appender.appender名字.layout=org.apache.log4j.SimpleLayout

Logback


简单地说,Logback 是一个 Java 领域的日志框架。它被认为是 Log4J 的继承人。Logback 是 Log4j 的升级,所以 Logback 自然比 Log4j 有很多优秀的地方。


模块组成


Logback 主要由三个模块组成:

  • logback-core

  • logback-classic

  • logback-access


logback-core 是其它模块的基础设施,其它模块基于它构建,显然,logback-core 提供了一些关键的通用机制。


logback-classic 的地位和作用等同于 Log4J,它也被认为是 Log4J 的一个改进版,并且它实现了简单日志门面 SLF4J。


logback-access 主要作为一个与 Servlet 容器交互的模块,比如说 Tomcat 或者 Jetty,提供一些与 HTTP 访问相关的功能。

三个模块


Logback 组件


Logback 主要组件如下:

  • Logger: 日志的记录器;把他关联到应用对应的 context 上;主要用于存放日志对象;可以自定义日志类型级别。

  • Appender: 用于指定日志输出的目的地;目的地可以是控制台,文件,数据库等。

  • Layout: 负责把事件转换成字符串;格式化的日志信息的输出;在 logback 中 Layout 对象被封装在 encoder 中。


Logback 优点


Logback 主要优点如下:
  • 同样的代码路径,Logback 执行更快。

  • 更充分的测试。

  • 原生实现了 SLF4J API(Log4J 还需要有一个中间转换层)。

  • 内容更丰富的文档。

  • 支持 XML 或者 Groovy 方式配置。

  • 配置文件自动热加载。

  • 从 IO 错误中优雅恢复。

  • 自动删除日志归档。







请到「今天看啥」查看全文