日志组件slf4j介绍及配置详解
下文笔者讲述slf4j框架的简介说明,如下所示
slf4j简介说明
作为java程序员 我们都熟悉各种各样的日志框架 如: java.util.logging、Apache log4j、logback 但是现在有一个新的日志框架,它是SLF4J(Simple logging facade for Java) 它不用于处理日志, 而是一个抽象层,允许你使用任意一种日志框架 这就是SLF4J的用途 通过以上的描述,我们可以得知SLF4J是一个日志门面, 可用于任意一种日志框架,使后台切换任意日志框架变得容易
SLF4J同Log4J,logback和java.util.Logging优点
1.占位符的用不同 SLF4J使用 {} 占位符,非常简洁和方便 2.无字符串拼接,所以其效率会稍稍高一些
SLF4J的使用说明
maven依赖
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.21</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.7.21</version> </dependency>
日志系统配置
import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class Main { private static final Logger logger = LoggerFactory.getLogger(Main.class); public static void main(String[] args) { int status = 0; if (status == 0) { logger.info("status:{}", status); } else { logger.info("status:{}", status); } logger.info("end!"); } }
properties文件的定义
log4j.properties
log4j.rootLogger=info, ServerDailyRollingFile, stdout log4j.appender.ServerDailyRollingFile=org.apache.log4j.DailyRollingFileAppender log4j.appender.ServerDailyRollingFile.DatePattern='.'yyyy-MM-dd log4j.appender.ServerDailyRollingFile.File=logs/notify-subscription.log log4j.appender.ServerDailyRollingFile.layout=org.apache.log4j.PatternLayout log4j.appender.ServerDailyRollingFile.layout.ConversionPattern=%d - %m%n log4j.appender.ServerDailyRollingFile.Append=true log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH\:mm\:ss} %p [%c] %m%n
logback的配置
依赖<dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.1.7</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.1.7</version> </dependency> logback.xml配置<?xml version="1.0" encoding="UTF-8"?> <configuration debug="true"> <!-- 应用名称 --> <property name="APP_NAME" value="logtest" /> <!--日志文件的保存路径,首先查找系统属性-Dlog.dir,如果存在就使用其;否则,在当前目录下创建名为logs目录做日志存放的目录 --> <property name="LOG_HOME" value="${log.dir:-logs}/${APP_NAME}" /> <!-- 日志输出格式 --> <property name="ENCODER_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{80} - %msg%n" /> <contextName>${APP_NAME}</contextName> <!-- 控制台日志:输出全部日志到控制台 --> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <Pattern>${ENCODER_PATTERN}</Pattern> </encoder> </appender> <!-- 文件日志:输出全部日志到文件 --> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_HOME}/output.%d{yyyy-MM-dd}.log</fileNamePattern> <maxHistory>7</maxHistory> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${ENCODER_PATTERN}</pattern> </encoder> </appender> <!-- 错误日志:用于将错误日志输出到独立文件 --> <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_HOME}/error.%d{yyyy-MM-dd}.log</fileNamePattern> <maxHistory>7</maxHistory> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${ENCODER_PATTERN}</pattern> </encoder> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>WARN</level> </filter> </appender> <!-- 独立输出的同步日志 --> <appender name="SYNC_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_HOME}/sync.%d{yyyy-MM-dd}.log</fileNamePattern> <maxHistory>7</maxHistory> </rollingPolicy> <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> <pattern>${ENCODER_PATTERN}</pattern> </encoder> </appender> <logger name="log.sync" level="DEBUG" addtivity="true"> <appender-ref ref="SYNC_FILE" /> </logger> <root> <level value="DEBUG" /> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /> <appender-ref ref="ERROR_FILE" /> </root> </configuration>日志系统配置说明
输出级别的种类
ERROR 为严重错误 主要是程序的错误 WARN 为一般警告,比如session丢失 INFO 为一般要显示的信息,比如登录登出 DEBUG 为程序的调试信息配置日志信息的输出位置
log4j.appender.appenderName=?? org.apache.log4j.ConsoleAppender(控制台) org.apache.log4j.FileAppender(文件) org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件) org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件) org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)配置日志信息的格式
log4j.appender.appenderName.layout = ?? org.apache.log4j.HTMLLayout(以HTML表格形式布局) org.apache.log4j.PatternLayout(可以灵活地指定布局模式) org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串) org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)ConsoleAppender选项
Threshold=DEBUG:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 Target=System.err:默认情况下是System.out,指定输出控制台FileAppender 选项
Threshold=DEBUG:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 File=mylog.txt:指定消息输出到mylog.txt文件。 Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。RollingFileAppender 选项
Threshold=DEBUG:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 File=mylog.txt:指定消息输出到mylog.txt文件。 Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。 MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到mylog.log.1文件。 MaxBackupIndex=2:指定可以产生的滚动文件的最大数。日志信息格式中几个符号所代表的含义
-X号: X信息输出时左对齐; %p: 输出日志信息优先级,即DEBUG,INFO,WARN,ERROR,FATAL, %d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS} 输出类似:2022年8月6日 20:11:10 %r: 输出自应用启动到输出该log信息耗费的毫秒数 %c: 输出日志信息所属的类目,通常就是所在类的全名 %t: 输出产生该日志事件的线程名 %l: 输出日志事件的发生位置,相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程,以及在代码中的行数。 例:Testlog4.main (TestLog4.java:10) %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。 %%: 输出一个”%”字符 %F: 输出日志消息产生时所在的文件名称 %L: 输出代码中的行号 %m: 输出代码中指定的消息,产生的日志具体信息 %n: 输出一个回车换行符,Windows平台为”\r\n”,Unix平台为”\n”输出日志信息换行配置文件示例
log4j.debug=true log4j.rootLogger=DEBUG,D,E log4j.appender.E = org.apache.log4j.DailyRollingFileAppender log4j.appender.E.File = logs/logs.log log4j.appender.E.Append = true log4j.appender.E.Threshold = DEBUG log4j.appender.E.layout = org.apache.log4j.PatternLayout log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n log4j.appender.D = org.apache.log4j.DailyRollingFileAppender log4j.appender.D.File = logs/error.log log4j.appender.D.Append = true log4j.appender.D.Threshold = ERROR log4j.appender.D.layout = org.apache.log4j.PatternLayout log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n过滤器
过滤器,执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一 返回DENY,日志将立即被抛弃不再经过其他过滤器;返回NEUTRAL 有序列表里的下个过滤器过接着处理日志;返回ACCEPT 日志会被立即处理,不再经过剩余过滤器。 过滤器被添加到<Appender> 中,为<Appender> 添加一个或多个过滤器后,可以用任意条件对日志进行过滤 <Appender> 有多个过滤器时,按照配置顺序执行常用的过滤器LevelFilter 级别过滤器 根据日志级别进行过滤 如果日志级别等于配置级别 过滤器会根据onMath 和 onMismatch接收或拒绝日志。有以下子节点: <level>:设置过滤级别 <onMatch>:用于配置符合过滤条件的操作 <onMismatch>:用于配置不符合过滤条件的操作 ThresholdFilter: 临界值过滤器,过滤掉低于指定临界值的日志 当日志级别等于或高于临界值时 过滤器返回NEUTRAL 当日志级别低于临界值时,日志会被拒绝。 例 过滤掉所有低于INFO级别的日志。 EvaluatorFilter: 求值过滤器, 评估、鉴别日志是否符合指定条件。有一下子节点: <evaluator>: 鉴别器,常用的鉴别器是JaninoEventEvaluato 也是默认的鉴别器,它以任意的Java布尔值表达式作为求值条件 求值条件在配置文件解释过成功被动态编译 布尔值表达式返回true就表示符合过滤条件 evaluator有个子标签<expression>,用于配置求值条件。日志输出字段说明
Name | Type | Description |
event | LoggingEvent | 与记录请求相关联的原始记录事件 下面所有变量都来自event,例如,event.getMessage()返回下面”message”相同的字符串 |
message | String | 日志的原始消息 例设有logger mylogger,”name”的值是”AUB”,对于 mylogger.info(“Hello {}”,name); “Hello {}”就是原始消息 |
formatedMessage | String | 日志被各式话的消息 例设有logger mylogger,”name”的值是”AUB”,对于 mylogger.info(“Hello {}”,name); “Hello java265”就是格式化后的消息 |
logger | String | logger 名 |
loggerContext | LoggerContextVO | 日志所属的logger上下文 |
level | int | 级别对应的整数值,所以 level > INFO 是正确的表达式 |
timeStamp | long | 创建日志的时间戳 |
marker | Marker | 与日志请求相关联的Marker对象,注意“Marker”有可能为null 所以你要确保它不能是null。 |
mdc | Map | 包含创建日志期间的MDC所有值得map。访问方法是:mdc.get(“myKey”) mdc.get()返回的是Object不是String 要想调用String的方法就要强转,例((String) mdc.get(“k”)).contains(“val”) . MDC可能为null,调用时注意 |
throwable | java.lang.Throwable | 当没有异常与日志关联”throwable” 变量为 null. 不幸的是 “throwable” 不能被序列化。在远程系统上永远为null,对于与位置无关的表达式请使用下面的变量throwableProxy |
throwableProxy | IThrowableProxy | 与日志事件关联的异常代理 当没有异常与日志事件关联,则变量”throwableProxy” 为 null 当异常被关联到日志事件时,”throwableProxy” 在远程系统上不会为null <onMatch>:用于配置符合过滤条件的操作 <onMismatch>:用于配置不符合过滤条件的操作 |
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。