Log4j日志
- 用于对输出的内容进行分级别显示
- 实例化记录器(使用第一步)
- private static Logger logger = Logger.getLogger(类名.class);
- private static Logger logger = Logger.getLogger(类名.class.getName() );
- private static Log logger = LogFactory.getLog(Yourclass.class);
- 插入记录信息(使用第二步)
- Logger.debug ( Object message ) ;
- 三个主要组件
- Loggers(记录器) //日志类别
- Appenders (输出源) //日志要输出的地方
- Layouts(布局) //日志以何种形式输出
- Loggers组件
- 级别顺序为:ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF
- 只输出级别大于等于设定级别的日志信息,例设定级别为error,则输出error、fatal、off的日志
- OFF | 关闭:最高级别,不打印日志
- FATAL | 致命:指明非常严重的可能会导致应用终止执行错误事件。
- ERROR | 错误:指明错误事件,但应用可能还能继续运行。
- WARN | 警告:指明可能潜在的危险状况。
- INFO | 信息:指明描述信息,从粗粒度上描述了应用运行过程。
- DEBUG | 调试:指明细致的事件信息,对调试应用最有用。
- TRACE | 跟踪:指明程序运行轨迹,比DEBUG级别的粒度更细。
- ALL | 所有:所有日志级别,包括定制级别。
- properties格式配置根Logger
- 语法:log4j.rootLogger = [ level ] , appenderName, appenderName, …
- level 是日志记录的级别
- Appenders组件
- 允许把日志输出到不同的地方,如控制台(Console)、文件(Files)等
- 可根据天数或文件大小产生新的文件,可用流的形式发送到其它地方等
- properties格式配置日志信息输出目的地Appender
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN
org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
- Layouts组件
- 根据自己的喜好格式化自己的日志输出
- 在Appenders的后面附加Layouts来完成这个功能
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
org.apache.log4j.HTMLLayout(以HTML表格形式布局)
org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等信息)
SLF4j日志(日志门面即抽象层)
- log4j与Logback都是SLF4j日志实现
- SpringBoot的底层是Spring框架,Spring框架默认是用JCL日志门面(Apache)
- SpringBoot则选用SLF4j和logback日志框架
- 实际使用调用抽象层的方法,不应该来直接调用日志的实现类
- 其他日志框架可通过jar包替换成SLF4j
- 例Commons logging → jcl-over-slf4j.jar
- log4j → log4j-over-slf4j.jar
- java.util.logging → jul-to–slf4j.jar
- SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可
- maven依赖
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
<!-- SpringBoot依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐logging</artifactId>
</dependency>
<!-- 排除Spring依赖的日志框架并替换 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring‐core</artifactId>
<exclusions>
<exclusion>
<groupId>commons‐logging</groupId>
<artifactId>commons‐logging</artifactId>
</exclusion>
</exclusions>
</dependency>
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
public static void main(String[] args) {
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info("Hello World");
}
}
- 日志级别
- 由低到高 trace<debug<info<warn<error 高级别可在低级别生效
- 默认为info级别
- 输出格式
- %d表示日期时间
- %thread表示线程名
- %‐5level:级别从左显示5个字符宽度
- %logger{50} 表示logger名字最长50个字符,否则按照句点分割
- %msg:日志消息
- %n是换行符
- SpringBoot的主配置文件指定输出格式
- 输出路径
- SpringBoot的主配置文件指定输出路径
- 属性logging.file=指定文件名:输出日志到指定文件名文件,未指定路径则在当前项目下生成springboot.log日志
- 属性logging.path=目录:输出到指定目录的 spring.log 文件中
- 都未指定则只在控制台输出
- 自定义日志配置文件
| 日志框架 | 特定名字的文件 |
|---|
| Logback | logback-spring.xml(推荐),logback-spring.groovy,logback.xml,logback.groovy |
| Log4j2 | log4j2-spring.xml,log4j2.xml |
| Java Util Logging | logging.properties |
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!--
上下文变量设置,用来定义变量值,其中name的值是变量的名称,value的值是变量定义的值
通过<property>定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量
-->
<property name="CONTEXT_NAME" value="logback-test"/>
<!--定义日志文件的存储地址勿在 LogBack 的配置中使用相对路径-->
<property name="LOG_HOME" value="E:/logs"/>
<!--配置规则类的位置-->
<conversionRule conversionWord="ip" converterClass="com.zyu.webmoudle.Config.IPLogConfig" />
<!-- 上下文名称:<contextName>, 每个logger都关联到logger上下文
默认上下文名称为“default”。但可以使用<contextName>设置成其他名字,用于区分不同应用程序的记录,一旦设置,不能修改
-->
<contextName>${CONTEXT_NAME}</contextName>
<!--
<appender>是<configuration>的子节点,是负责写日志的组件。
有两个必要属性name和class name指定appender名称,class指定appender的实现类
默认情况下,ConsoleAppender 会输出 DEBUG 级别及以上的日志
-->
<!--控制台日志,控制台输出 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!-- 对日志进行格式化。 -->
<encoder>
<pattern>
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%msg:日志消息,%n是换行符-->
主机名:%contextName|IP:%ip|timestamp:%d{yyyy-MM-dd HH:mm:ss.SSS}|logLevel:%level|Class:%class|Thred:%thread|Method:%method|Line:%line|Message:%msg%n
</pattern>
</encoder>
</appender>
<!--info文件日志-->
<appender name="infofile" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<!--过滤 INFO-->
<level>INFO</level>
<!--匹配到就禁止-->
<onMatch>ACCEPT</onMatch>
<!--没有匹配到就允许-->
<onMismatch>DENY</onMismatch>
</filter>
<!--
rollingPolicy:用来设置日志的滚动策略,当达到条件后会自动将条件前的日志生成一个备份日志文件
条件后的日志输出到最新的日志文件中。常用的是按照时间来滚动(使用的类TimeBaseRollingPolicy)
还有一种就是基于索引来实现(使用的类FixedWindowRollingPolicy)
-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<FileNamePattern>${LOG_HOME}/logback-info.%d{yyyyMMdd}.%i.log</FileNamePattern>
<!-- 日志文件最大尺寸 -->
<maxFileSize>100MB</maxFileSize>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
<!--窗口索引最小值-->
<minIndex>1</minIndex>
<!--窗口索引最大值-->
<maxIndex>1</maxIndex>
</rollingPolicy>
<!-- 激活滚动的条件 -->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<!-- 活动文件的大小,默认值是10MB-->
<maxFileSize>30MB</maxFileSize>
</triggeringPolicy>
<!-- 对记录事件进行格式化。 -->
<encoder>
<charset>UTF-8</charset>
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>
主机名:%contextName|IP:%ip|timestamp:%d{yyyy-MM-dd HH:mm:ss.SSS}|logLevel:%level|Class:%class|Thred:%thread|Method:%method|Line:%line|Message:%msg%n
</pattern>
</encoder>
</appender>
<!--debug日志-->
<appender name="debugfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>debug</level>
<!--匹配到就禁止-->
<onMatch>ACCEPT</onMatch>
<!--没有匹配到就允许-->
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<FileNamePattern>${LOG_HOME}/logback-debug_%d{yyyy-MM-dd}.log</FileNamePattern>
<MaxHistory>30</MaxHistory>
<maxFileSize>50MB</maxFileSize>
</rollingPolicy>
<encoder>
<Pattern>
主机名:%contextName|IP:%ip|timestamp:%d{yyyy-MM-dd HH:mm:ss.SSS}|logLevel:%level|Class:%class|Thred:%thread|Method:%method|Line:%line|Message:%msg%n
</Pattern>
</encoder>
</appender>
<!--error日志-->
<appender name="errorfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>error</level>
<!--匹配到就禁止-->
<onMatch>ACCEPT</onMatch>
<!--没有匹配到就允许-->
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<FileNamePattern>${LOG_HOME}/logback-error_%d{yyyy-MM-dd}.log</FileNamePattern>
<MaxHistory>30</MaxHistory>
<maxFileSize>50MB</maxFileSize>
</rollingPolicy>
<encoder>
<Pattern>
主机名:%contextName|IP:%ip|timestamp:%d{yyyy-MM-dd HH:mm:ss.SSS}|logLevel:%level|Class:%class|Thred:%thread|Method:%method|Line:%line|Message:%msg%n
</Pattern>
</encoder>
</appender>
<!--warn日志-->
<appender name="warnfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<!--匹配到就禁止-->
<onMatch>ACCEPT</onMatch>
<!--没有匹配到就允许-->
<onMismatch>DENY</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<FileNamePattern>${LOG_HOME}/logback-warn_%d{yyyy-MM-dd}.log</FileNamePattern>
<MaxHistory>30</MaxHistory>
<maxFileSize>50MB</maxFileSize>
</rollingPolicy>
<encoder>
<Pattern>
主机名:%contextName|IP:%ip|timestamp:%d{yyyy-MM-dd HH:mm:ss.SSS}|logLevel:%level|Class:%class|Thred:%thread|Method:%method|Line:%line|Message:%msg%n
</Pattern>
</encoder>
</appender>
<!--
特殊的<logger>元素,是根logger。只有一个level属性,应为已经被命名为"root".
level:设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。
<root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger
-->
<root>
<level value="info,debug,warn,error"/>
<appender-ref ref="stdout"/>
<appender-ref ref="infofile"/>
<appender-ref ref="debugfile"/>
<appender-ref ref="warnfile"/>
<appender-ref ref="errorfile"/>
</root>
<!--
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>,
name:用来指定受此logger约束的某一个包或者具体的某一个类。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。
additivity:是否向上级logger传递打印信息。默认是true。(这个logger的上级就是上面的root)
<logger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个logger
-->
<logger name="zyu.logback.test" level="DEBUG" additivity="true">
</logger>
</configuration>
- logback-spring.xml
- logback.xml:直接会被日志框架识别
- logback-spring.xml:由SpringBoot解析日志配置,可以使用SpringBoot 的高级Profile功能
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<!-- 某个环境下生效指定某段配置 -->
<springProfile name="dev">
<pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} --- [%thread]</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} === [%thread]</pattern>
</springProfile>
</layout>
</appender>
- 日志框架切换
- 由slf4j+Logback切换为slf4j+log4j的方式
- 排除Logback与log4j的替换层
- 加入log4j适配层jar包依赖
- 加入log4j框架依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>logback‐classic</artifactId>
<groupId>ch.qos.logback</groupId>
</exclusion>
<exclusion>
<artifactId>log4j‐over‐slf4j</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j‐log4j12</artifactId>
</dependency>
<!-- 切换log4j2的依赖与spring‐boot‐starter‐logging不可同时存在,因而排除 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring‐boot‐starter‐logging</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐log4j2</artifactId>
</dependency>