JavaWeb 开发日志管理详解(内含Slf4j底层实现原理 + log4j + logback框架介绍)

日志管理系统的使用背景

我们在日常软件开发中,避免不了使用日志管理系统,它是为我们展示系统运行状况的重要手段,当我们的系统在上线运行后,每个模块代码的执行,或者产生的结果乃至突发的错误,我们都可以通过日志管理系统记录下来,在我们需要某些数据或者处理突发错误时能够快速定位问题代码的位置或者原因时,会非常的便利和高效。如果我们没有采取任何的代码执行记录,那一旦我们的系统出现问题,或者业务逻辑出现问题,我们在维护起来会非常的麻烦,因为我们无法定位问题所在的地方,也无法得知系统运行中数据的状态,那只能将所有代码一点一点的过滤,来确定错误所在位置,对于小的软件系统还勉强说得过去,稍微大一点的系统,这完全就是在大海捞针。所以,在我们日常的软件系统开发过程中,利用日志管理系统来即时记录代码运行结果或者异常处理时的位置,对于我们后期维护是非常必要的。

日志管理系统是什么?

其实“日志管理系统”是我们业内的专有名词,它的本质其实就是我们在业务代码中,穿插一些特殊的代码,这些特殊的代码用来记录一些我们想记录的内容。比如:当我们还是小白的时候,很多时候我们在排错的时候,喜欢使用System.out.println() 来打印一些变量的值,用于我们的检查,或者是打印一些我们制定的字符串内容,用来表示是否进入到了我们指定的方法里。其实,日志管理系统,做的就是这种事情,因为我们在实际开发和项目运行后,是不会用打印语句在控制台窗口上查看我们打印内容的,这样会产生非常多没用的代码,仅仅是用来方便我们开发人员排错或者监管系统运行,所以,我们不能用打印语句这种Low的办法,取而代之的,就是咱们说的日志管理系统。所谓管理系统,其实就是在书写核心业务逻辑代码的同时,再写一套关于打印出我们指定的内容的系统,但是,这种系统,其实开发一次就足够了,因为功能应该都是一样的,比如:什么时候打印,需要打印什么内容,把内容打印到哪里去?(是控制台上,还是可以单独的用IO输出成磁盘文件已达到持久化)那有了这些基本的内容,我们就可以自己去开发一套这样的系统了,然后在我们的每个项目中都可以引入使用。
那既然说到这里了,那么业内常说的log4j、logback、Apache common logging 其实都是日志框架,至于做了什么事,现在大家应该很清楚了吧,这种日志框架,其实就是前辈们自己写的一套作日志记录的系统代码,然后把它进行了封装,可以给现在的我们直接配置使用,就不用我们自己再去花费物力财力脑力开发了。那有同学可能会问,SUN公司官方jdk有没有直接提供一套这种日志框架呢,其实是有的,叫JDKLog,JDKLog 的优点是使用非常简单,直接在 JDK 中就可以使用。但 JDKLog 功能比较太过于简单,不支持占位符显示,拓展性比较差,所以现在用的人也很少。比如把JDKLog、log4j、logback同时对比的话,JDKLog就是小刀,Log4j是大炮,Logback是原子弹,这种形象的对比,相信不用多说大家就知道他们的分量了,那么具体的差别,请继续往下看。

Java Web中的各种日志管理系统?
1. JDK原生日志API
  • JDK中内置了原生的日志打印的API:java.util.logging.Logger,这个API不依赖于任何的第三方框架,是JDK内置的
  • 这个Logger的级别: SEVERE → WARNING → INFO → CONFIG → FINE → FINER → FINESET
  • 用法如下:
private Logger logger = Logger.getLogger("<class-name>");
logger.severe("<severe-msg>");
logger.warning("<warning-msg>");
logger.info("<info-msg>");
logger.config("<config-msg>");
logger.fine("<fine-msg>");
logger.finer("<finer-msg>");
logger.finest("<finest-msg>");
  • JDK日志配置
    默认情况下,日志的输出都是在控制台直接输出的,并没有输出到文件中,这是因为在JRE默认配置中,只配置了一个ConsoleHandler,这个配置文件位于/lib/logging.properties,注意一般情况下我在安装JDK的时候是不会安装公共JRE的,因为JDK中就已经安装过了,不过最新的JDK貌似已经把二者分开了,总之,根据自己的情况找到JRE的家目录,即可找到该文件;
    在logging.properties这个文件中有个handlers,其值只有一个handlers= java.util.logging.ConsoleHandler,如果想要同时输出到文件中, 只需要在后面追加java.util.logging.FileHandler,多个handler之间使用英文都好隔开即可;
    在增加了FileHanlder之后,那么FileHanlder的各种配置就生效了,就可以根据需要进行配置了,如:
java.util.logging.FileHandler.pattern = %h/java%u.log
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
  1. FileHandler.pattern:用来指定生成的日志文件的路径名称;/:本地路径名分隔符;%t:系统临时目录;%h:“user.home” 系统属性的值;%g:区分循环日志的生成号;%u:解决冲突的惟一号码;%%:转换为单个百分数符号"%" ;
  2. FileHandler.limit:用来限制文件的大小,以字节为单位,0表示没有限制;
  3. FileHandler.count:指定有多少输出文件参与循环(默认为1);
  4. FileHandler.formatter:指定要使用的 Formatter 类的名称(默认为java.util.logging.XMLFormatter)。 另外一个是:java.util.logging.SimpleFormatter。XMLFormatter是以xml样式输出,SimpleFormatter是以普通样式输出。
  5. FileHandler.append:指定是否应该将 FileHandler 追加到任何现有文件上(默认为false);
  6. SimpleFormatter.format:用来自定义SimpleFormatter的输出样式;如:%4 s : s: %5 s:s [%1$tc]%n,即输出样式为:: [<date/time>]
  • 日志打印级别的配置:
  1. 全局输出级别设置
[java.util.logging.ConsoleHandler/FileHandler].level=<level-name>
  1. 具体包名的输出级别设置
<package-name>.level=<level-name>
2. Apache common logging
  • Tomcat是Apache的一个开源项目,Apache旗下还有一个开源项目,名为Apache common logging,而Tomcat中的日志框架juli正是这个开源框架的一个易名项目,究其根源来说,Apache common logging是对JDK打印API的修改封装;

  • 为了不影响JDK中的Logger的正常使用,Tomcat中增加了自定义的Log配置,这个配置存在于Tomcat的脚本catalina.bat和catalina.sh中,如下:

LOGGING_CONFIG="-Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties"
LOGGING_MANAGER="-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager"
  1. 这两个参数配置给java虚拟机配置了两个东东, 一个是日志的配置文件还有一个日志管理器;
  • 在这个配置文件中,我们发现默认情况下,Tomcat支持文件和控制台两种输出方式;还有就是Tomcat的handler都带有一个数字前缀,自然就想到如果使用系统默认的类加载器的话,肯定会出错,Tomcat使用的是自定义的ClassLoader来解析这个数字前缀;而增加数字前缀的目的就是为了使得一个类模板生成多个实例,每个实例都管理一种类型的日志,如:
  1. 前缀1对应的日志:文件名以catalina.开头
  2. 前缀2对应的日志:文件名以localhost.开头
  3. 前缀3对应的日志:文件名以manager.开头
  4. 前缀4对应的日志:文件名以host-manager.开头
  • Tomcat与JDK日志的配置
  1. 有一点不同,JRE的logging.properties文件中使用handlers配置输出途径,而在Tomcat中使用.handlers配置,使用handlers配置上面4中不同的文件日志
  2. Tomcat的详细配置可查看:http://tomcat.apache.org/tomcat-8.0-doc/config [/valve.html]
3. Logback的API(Log4j)

提起这个日志框架,就不得不提起另外另个东东:slf4j和log4j,这三个框架什么关系呢?网上找到一张图:
在这里插入图片描述

  • slf4j的全称是:The Simple Logging Facade for(4) Java,即slf4j是一个门面,而log4j和logback则是这些接口的实现;log4j和logback是由同一个人完成的,前者是apache实现的,logback是为了替代log4j,logback可以说是slf4j的原生实现,目前除了老的项目,新项目的日志基本上都是使用logback;
  1. logback是直接实现了slf4j的接口,不消耗内存和计算开销的。slf4j的api在调用log4j时需要一个适配层;
  2. log4j和logback可以单独的使用,也可以绑定slf4j一起使用:单独使用的时候,分别调用框架自己的方法来输出日志信息;绑定slf4j一起使用,调用slf4j的api来输入日志信息,具体使用与底层日志框架无关,但是需要底层框架的配置文件;
  • 其实说到这里就能发现这个门面扮演什么角色,其实就是为了解决众口难调的问题,因为项目中我们用到很多的框架,如果每个框架都有自己的日志输出框架,那么项目中的日志维护便成了一个大问题,为了解决这个大问题,log4j和logback框架横空出世:我们项目中的所有框架的日志输出都交给slf4j,然后统一对消息进行处理;
slf4j 又是什么?

刚才看完了上面几种日志框架的介绍,想必同学们也对日志框架多少了解了一些,不光知道了框架有多种多样,同时配置起来也是各不相同,甚至功能也相差甚远。但是,可能有的同学在读到上面一段内容时,遇到了Slf4j这个名词,对它并不熟悉,其实它是干啥的呢?我们为什么要用它呢?
slf4j是门面模式的典型应用,因此在讲slf4j前,我们先简单回顾一下门面模式,
门面模式,其核心为外部与一个子系统的通信必须通过一个统一的外观对象进行,使得子系统更易于使用。用一张图来表示门面模式的结构为࿱

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值