目录
Slf4j + Logback 手动导包
日志门面(日志抽象层) | 日志实现 |
JCL(Jakarta Commons Logging-属于Apache基金会) jboss-logging | JUL(java.util.logging-Java JDK自带的) |
SLF4j(Simple Logging Facade for Java) |
Log4j 、Log4j2、 Logback |
1、开发日志系统扩展性更好的应用,得从上表中左右两边各选择一个日志接口和实现进行开发,而且编码的时候应该调用左边的接口,而不是右边的实现,这样利于将来扩展。日志框架不熟悉的可以参考《日志框架简述 与 slf4j-log4j Maven 使用入门》
导入 Jar 包
1、从上图可以看出,需要导入的有:slf4j-api.jar、logback-classic.jar、logback-core.jar 三个。
下载 slf4j
1、进入 slf4j 官网下载地址即可下载,如 slf4j-1.7.26.zip 下载解压后如下所示,虽然里面有很多 Jar 包,只需要其中的 slf4j-api-1.7.26.jar(核心包)即可。
下载 logbakc
1、logbakc 有自己的官网:https://logback.qos.ch/
2、从官网下载地址即可选择下载,如 logback-1.2.3.zip。解压后如下所示,需要的就是其中的 logback-classic-1.2.3.jar 与 logback-core-1.2.3.jar 两个。
logback 配置文件
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒;当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<!-- 定义日志的根目录,value可以是绝对路径如(E:/logs),也可以是相对路径如 "./logs"-->
<property name="LOG_HOME" value="./logs"/>
<!-- 定义日志文件名称 -->
<property name="appName" value="coco"></property>
<!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!--
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%-5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==> [%thread] ==> %-5level %logger{50} - %msg%n</pattern>
</layout>
</appender>
<!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->
<appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 指定日志文件的名称 -->
<file>${LOG_HOME}/${appName}.log</file>
<!--
当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}:按天进行日志滚动
%i:当文件大小超过maxFileSize时,按照i进行文件滚动
-->
<fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动,
且maxHistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是,
那些为了归档而创建的目录也会被删除。
-->
<MaxHistory>365</MaxHistory>
<!--
当日志文件超过maxFileSize指定的大小时,根据上面提到的%i进行日志文件滚动
注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的,必须配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 日志输出格式: -->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
</layout>
</appender>
<!--
logger主要用于存放日志对象,也可以定义日志类型、级别
name:表示匹配的logger类型前缀,指定包路径,即这个包下的日志会做处理,不在此包下的即使有日志处理操作,也不会处理
level:要记录的日志级别,包括 TRACE < DEBUG < INFO < WARN < ERROR
additivity:作用在于children-logger是否使用 rootLogger配置的appender进行输出,
false:表示只用当前logger的appender-ref,true:
表示当前logger的appender-ref和rootLogger的appender-ref都有效
-->
<!-- app logger -->
<logger name="sample.slf4j" level="debug"/>
<!-- Spring framework logger -->
<logger name="org.springframework" level="debug" additivity="false"></logger>
<!--
root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应,
要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。
-->
<root level="info">
<appender-ref ref="stdout"/>
<appender-ref ref="appLogAppender"/>
</root>
</configuration>
日志的级别 由低到高 trace(跟踪) < debug(调试) < info(信息) < warn(警告) < error(错误)
1、 “<property name="LOG_HOME" value="./logs"/>” :用于指定日志文件存放的目录,可以绝对地址如 E:/logs(必须是左斜杆),也可以是相对地址。
2、<logger name="sample.slf4j" level="debug"/>:其中的 name 属性值必须修改为自己的应用包名,只要这个指定包名的下的日志才会处理,后面的 level 用于指定输出级别。
日志处理
1、因为是面向接口编程,所以 slf4j + logback 与 slf4j + log4j 编码完全是一样的。“日志记录”
Slf4j + Logback Maven 应用
1、如果是 Spring Boot 使用 slf4j + logback,则可以自己参考:《Spring Boot 日志关系 与 slf4j 默认配置及其修改》、《Spring Boot 指定 Logback 日志配置文件》
2、这里只是当做普通的 Maven 应用,有了上面的知识基础,Maven 应用完全同理,只需要将依赖导入即可。
3、如下所示为 pom.xml 文件的依赖组件,都可以在 Maven 中央仓库中找到:https://mvnrepository.com/
<dependencies>
<!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-core -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.2.3</version>
</dependency>
<!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
<!-- 不能使用 test-->
<!--<scope>test</scope>-->
</dependency>
<!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
</dependencies>
4、再次提醒一遍:配置文件中必须指向自己实际需要记录日志的包下。
5、至于编码完全和上面一样。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Hello world!
*/
public class App {
private static final Logger logger = LoggerFactory.getLogger(App.class);
public static void main(String[] args) {
logger.info("App info ...");
logger.warn("App warn ...");
logger.error("App error ...");
logger.debug("App debug ...");
logger.trace("App trace ...");
}
}