Flask接口签名sign原理与实例代码浅析
500
2022-11-28
Java日志框架之logback使用详解
为什么使用logback
记得前几年工作的时候,公司使用的日志框架还是log4j,大约从16年中到现在,不管是我参与的别人已经搭建好的项目还是我自己主导的项目,日志框架基本都换成了logback,总结一下,logback大约有以下的一些优点:
内核重写、测试充分、初始化内存加载更小,这一切让logback性能和log4j相比有诸多倍的提升
logback非常自然地直接实现了slf4j,这个严格来说算不上优点,只是这样,再理解slf4j的前提下会很容易理解logback,也同时很容易用其他日志框架替换logback
logback有比较齐全的200多页的文档
logback当配置文件修改了,支持自动重新加载配置文件,扫描过程快且安全,它并不需要另外创建一个扫描线程
支持自动去除旧的日志文件,可以控制已经产生日志文件的最大数量
总而言之,如果大家的项目里面需要选择一个日志框架,那么我个人非常建议使用logback。
logback加载
我们简单分析一下logback加载过程,当我们使用logback-classic.jar时,应用启动,那么logback会按照如下顺序进行扫描:
在系统配置文件System Properties中寻找是否有logback.configurationFile对应的value
在classpath下寻找是否有logback.groovy(即logback支持groovy与xml两种配置方式)
在classpath下寻找是否有logback-test.xml
在classpath下寻找是否有logback.xml
以上任何一项找到了,就不进行后续扫描,按照对应的配置进行logback的初始化,具体代码实现可见ch.qos.logback.classic.util.ContextInitializer类的findURLOfDefaultConfigurationFile方法。
当所有以上四项都找不到的情况下,logback会调用ch.qos.logback.classic.BasicConfigurator的configure方法,构造一个ConsoleAppender用于向控制台输出日志,默认日志输出格式为"%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"。
logback的configuration
logback的重点应当是Appender、Logger、Pattern,在这之前先简单了解一下logback的
scan:当scan被设置为true时,当配置文件发生改变,将会被重新加载,默认为true
scanPeriod:检测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认为毫秒,当scan=true时这个值生效,默认时间间隔为1分钟
debug:当被设置为true时,将打印出logback内部日志信息,实时查看logback运行信息,默认为false
先从最基本的
name:用来指定受此logger约束的某一个包或者具体的某一个类
level:用来设置打印级别,五个常用打印级别从低至高依次为TRACE、DEBUG、INFO、WARN、ERROR,如果未设置此级别,那么当前logger会继承上级的级别
additivity:是否向上级logger传递打印信息,默认为true
public LoggerContext() {
super();
this.loggerCache = new ConcurrentHashMap
this.loggerContextRemoteView = new LoggerContextVO(this);
this.root = new Logger(Logger.ROOT_LOGGER_NAME, null, this);
this.root.setLevel(Level.DEBUG);
loggerCache.put(Logger.ROOT_LOGGER_NAME, root);
initEvaluatorMap();
size = 1;
this.frameworkPackages = new ArrayList
}
Logger的构造函数为:
Logger(String name, Logger parent, LoggerContext loggerContext) {
this.name = name;
this.parent = parent;
this.loggerContext = loggerContext;
}
看到第一个参数就是Root的name,而这个Logger.ROOT_LOGGER_NAME的定义为final public String ROOT_LOGGER_NAME = "ROOT",由此可以看出
接着写一段代码来测试一下:
public class Slf4jTest {
@Test
public void testSlf4j() {
Logger logger = LoggerFactory.getLogger(Object.class);
logger.trace("=====trace=====");
logger.debug("=====debug=====");
logger.info("=====info=====");
logger.warn("=====warn=====");
logger.error("=====error=====");
}
}
logback.xml的配置为:
root将打印级别设置为"info"级别,
2018-03-26 22:57:48.779 [main] INFO java.lang.Object - =====info=====
2018-03-26 22:57:48.782 [main] WARN java.lang.Object - =====warn=====
2018-03-26 22:57:48.782 [main] ERROR java.lang.Object - =====error=====
logback.xml的意思是,当Test方法运行时,root节点将日志级别大于等于info的交给已经配置好的名为"STDOUT"的
接着理解一下
注意这个name表示的是LoggerFactory.getLogger(XXX.class),XXX的包路径,包路径越少越是父级,我们测试代码里面是Object.class,即name="java"是name="java.lang"的父级,root是所有
2018-03-27 23:02:02.963 [main] DEBUG java.lang.Object - =====debug=====
2018-03-27 23:02:02.965 [main] INFO java.lang.Object - =====info=====
2018-03-27 23:02:02.966 [main] WARN java.lang.Object - =====warn=====
2018-03-27 23:02:02.966 [main] ERROR java.lang.Object - =====error=====
出现这样的结果是因为:
没有配置additivity,那么additivity=true,表示此
没有配置
由此可知,
接着,我们再配置一个
如果读懂了上面的例子,那么这个例子应当很好理解:
LoggerFactory.getLogger(Object.class),首先找到name="java.lang"这个
name="java.lang"这个
name="java"这个
由此分析,得出最终的打印结果为:
2018-03-27 23:12:16.147 [main] WARN java.lang.Object - =====warn=====
2018-03-27 23:12:16.150 [main] ERROR java.lang.Object - =====error=====
举一反三,上面的name="java"这个
接着看一下
name指定
class指定
其中,encoder表示对参数进行格式化。我们和上一部分的例子对比一下,发现这里是有所区别的,上面使用了
最常用的FileAppender和它的子类的期望是使用
关于
它的几个节点为:
接着来看一下RollingFileAppender,RollingFileAppender的作用是滚动记录文件,先将日志记录到指定文件,当符合某个条件时再将日志记录到其他文件,RollingFileAppender配置比较灵活,因此使用得更多,示例为:
这种是仅仅指定了
向其他还有SizeBasedTriggeringPolicy,用于按照文件大小进行滚动,可以自己查阅一下资料。
异步写日志
日志通常来说都以文件形式记录到磁盘,例如使用
接着我们看下如何使用logback进行异步写日志配置:
即,我们引入了一个AsyncAppender,先说一下AsyncAppender的原理,再说一下几个参数:
当我们配置了AsyncAppender,系统启动时会初始化一条名为"AsyncAppender-Worker-ASYNC"的线程当Logging Event进入AsyncAppender后,AsyncAppender会调用appender方法,appender方法中再将event填入Buffer(使用的Buffer为BlockingQueue,具体实现为ArrayBlockingQueye)前,会先判断当前Buffer的容量以及丢弃日志特性是否开启,当消费能力不如生产能力时,AsyncAppender会将超出Buffer容量的Logging Event的级别进行丢弃,作为消费速度一旦跟不上生产速度导致Buffer溢出处理的一种方式。上面的线程的作用,就是从Buffer中取出Event,交给对应的appender进行后面的日志推送从上面的描述我们可以看出,AsyncAppender并不处理日志,只是将日志缓冲到一个BlockingQueue里面去,并在内部创建一个工作线程从队列头部获取日志,之后将获取的日志循环记录到附加的其他appender上去,从而达到不阻塞主线程的效果。因此AsyncAppender仅仅充当的是事件转发器,必须引用另外一个appender来做事。
从上述原理,我们就能比较清晰地理解几个参数的作用了:
discardingThreshold,假如等于20则表示,表示当还剩20%容量时,将丢弃TRACE、DEBUG、INFO级别的Event,只保留WARN与ERROR级别的Event,为了保留所有的events,可以将这个值设置为0,默认值为queueSize/5
queueSize比较好理解,BlockingQueue的最大容量,默认为256
includeCallerData表示是否提取调用者数据,这个值被设置为true的代价是相当昂贵的,为了提升性能,默认当event被加入BlockingQueue时,event关联的调用者数据不会被提取,只有线程名这些比较简单的数据
appender-ref表示AsIFytAgyncAppender使用哪个具体的
把日志信息转换为字节数组
把字节数组写到输出流
目前PatternLayoutEncoder是唯一有用的且默认的encoder,有一个
转换符
作 用
是否避免使用
c{length}
lo{length}
logger{length}
输出日志的logger名称,可有一个整型参数来缩短
1、不输入表示输出完整的
2、输入0表示只输出
3、输入其他数字表示输出小数点最后边点号之前的字符数量
否
C{length}
class{length}
输出指定记录的请求的调用者的全限定名,length同上
是
d{pattern}
date{pattern}
输出时间格式,模式语法同java.text.SimpleDateFormat兼容
否
caller{depth}
输出生成日志的调用者的位置信息,整数选项表示输出信息深度
否
L
输出执行日志的请求行号
是
m
msg
message
输出应用程序提供的信息
否
m
输入执行日志请求的方法名
是
n
输出平台相关的分行符"\n"或者"\r\n",即换行
否
p
le
level
输出日志级别
否
r
relative
输出从程序启动到创建日志记录的时间,单位为毫秒
否
t
thread
输出产生日志的线程名称
否
Filter
最后来看一下
看一下输出:
2018-03-31 22:22:58.843 [main] WARN java.lang.Object - =====warn=====
看到尽管
再看一下ThresholdFilter,配置为:
看一下输出为:
2018-03-31 22:41:32.353 [main] INFO java.lang.Object - =====info=====
2018-03-31 22:41:32.358 [main] WARN java.lang.Object - =====warn=====
2018-03-31 22:41:32.359 [main] ERROR java.lang.Object - =====error=====
因为ThresholdFilter的策略是,会将日志级别小于
版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
发表评论
暂时没有评论,来抢沙发吧~