作为一个有追求的程序猿,你了解你见到的各种日志吗?JDK的日志、Tomcat的日志、还有Logback的日志,他们之间只什么关系?
一、JavaWeb中的各种log
-
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,这个配置文件位于
<jre-home>/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
- FileHandler.pattern:用来指定生成的日志文件的路径名称;
/
:本地路径名分隔符;%t
:系统临时目录;%h
:"user.home" 系统属性的值;%g
:区分循环日志的生成号;%u
:解决冲突的惟一号码;%%
:转换为单个百分数符号"%" ; - FileHandler.limit:用来限制文件的大小,以字节为单位,0表示没有限制;
- FileHandler.count:指定有多少输出文件参与循环(默认为1);
- FileHandler.formatter:指定要使用的 Formatter 类的名称(默认为java.util.logging.XMLFormatter)。 另外一个是:java.util.logging.SimpleFormatter。XMLFormatter是以xml样式输出,SimpleFormatter是以普通样式输出。
- FileHandler.append:指定是否应该将 FileHandler 追加到任何现有文件上(默认为false);
- SimpleFormatter.format:用来自定义SimpleFormatter的输出样式;如:
%4$s: %5$s [%1$tc]%n
,即输出样式为:<level>: <log message> [<date/time>]
- FileHandler.pattern:用来指定生成的日志文件的路径名称;
- 日志打印级别的配置:
- 全局输出级别设置
[java.util.logging.ConsoleHandler/FileHandler].level=<level-name>
- 具体包名的输出级别设置
<package-name>.level=<level-name>
- 全局输出级别设置
- 默认情况下,日志的输出都是在控制台直接输出的,并没有输出到文件中,这是因为在JRE默认配置中,只配置了一个ConsoleHandler,这个配置文件位于
-
Tomcat的API
- 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"
- 这两个参数配置给java虚拟机配置了两个东东, 一个是日志的配置文件还有一个日志管理器;
- 在这个配置文件中,我们发现默认情况下,Tomcat支持文件和控制台两种输出方式;还有就是Tomcat的handler都带有一个数字前缀,自然就想到如果使用系统默认的类加载器的话,肯定会出错,Tomcat使用的是自定义的ClassLoader来解析这个数字前缀;而增加数字前缀的目的就是为了使得一个类模板生成多个实例,每个实例都管理一种类型的日志,如:
- 前缀1对应的日志:文件名以
catalina.
开头 - 前缀2对应的日志:文件名以
localhost.
开头 - 前缀3对应的日志:文件名以
manager.
开头 - 前缀4对应的日志:文件名以
host-manager.
开头
- 前缀1对应的日志:文件名以
- Tomcat与JDK日志的配置
- 有一点不同,JRE的logging.properties文件中使用
handlers
配置输出途径,而在Tomcat中使用.handlers
配置,使用handlers
配置上面4中不同的文件日志 - Tomcat的详细配置可查看:http://tomcat.apache.org/tomcat-8.0-doc/config [/valve.html]
- 有一点不同,JRE的logging.properties文件中使用
-
Logback的API(Log4j)
-
提起这个日志框架,就不得不提起另外另个东东:slf4j和log4j,这三个框架(?)什么关系呢?网上找到一张图:
- slf4j的全称是:The Simple Logging Facade for(4) Java,即slf4j是一个门面,而log4j和logback则是这些接口的实现;log4j和logback是由同一个人完成的,前者是apache实现的,logback是为了替代log4j,logback可以说是slf4j的原生实现,目前除了老的项目,新项目的日志基本上都是使用logback;
- logback是直接实现了slf4j的接口,不消耗内存和计算开销的。slf4j的api在调用log4j时需要一个适配层;
- log4j和logback可以单独的使用,也可以绑定slf4j一起使用:单独使用的时候,分别调用框架自己的方法来输出日志信息;绑定slf4j一起使用,调用slf4j的api来输入日志信息,具体使用与底层日志框架无关,但是需要底层框架的配置文件;
- 其实说到这里就能发现这个
门面
扮演什么角色,其实就是为了解决众口难调的问题,因为项目中我们用到很多的框架,如果每个框架都有自己的日志输出框架,难么项目中的日志维护便成了一个大问题,为了解决这个大问题,log4j和logback框架横空出世:我们项目中的所有框架的日志输出都交给slf4j,然后统一对消息进行处理;
-
文章中还有很多可以深入的地方,如果需要,后面继续更新
文章参考:Tomcat的Logging、slf4j log4j logback关系详解和相关用法、为什么要使用SLF4J而不是Log4J、从Log4j迁移到LogBack的理由